Baseline for Neutrino v5 #86

eliperelman · 2017-03-01T16:47:44Z

Summary

BREAKING CHANGES

webpack-chain upgraded to v3, which has a lot more shorthand methods, but also breaks how configs are extended for plugins and rule-loaders. Now the extension handler is either passed the args or options directly, removing a level of nesting:

config.plugin('env').use(EnvironmentPlugin, ['NODE_ENV']);
config.plugin('env').tap(args => [...args, 'SECRET_KEY']);

// ...

config.rule('compile')
  .use('babel')
    .loader('babel-loader')
    .options({ presets: ['es2015'] });

config.rule('compile')
  .use('babel')
    .tap(options => merge(options, { plugins: ['object-rest-spread'] }));

webpack-chain also has moved rule includes and excludes to ChainedMaps:

config.rule('compile')
  .include
    .add(...).add(...).end()
  .exclude
    .add(...).add(...).end()

package.json presets configuration now under top-level neutrino object.

{
  "neutrino": {
    "presets": []
  }
}

package.json custom options now under top-level neutrino object. No more neutrino.custom.

{
  "neutrino": {
    "options": {
      "jest": { "bail": true },
      "mocha": { "reporter": "nyan" }
    }
  }
}

neutrino.options.jest.bail // true
neutrino.options.mocha.reporter // "nyan"

package.json webpack-chain overrides now under top-level neutrino object.

{
  "neutrino": {
    "config": {
      "devServer": { "port": 3000 }
    }
  }
}

Web preset rule for CSS has been renamed from css to style, i.e. config.module.rule('style').
Jest upgraded to v19, which changes option from testPathDirs to roots. Jest options through package.json are now done via neutrino.options.jest solely.
No more lint base, now neutrino-middleware-eslint.
When using eslint middleware, RC method moved from neutrino.custom.eslintrc() to neutrino.eslintrc().
API no longer accepts presets in constructor. Constructor now takes an options object to store at .options.
API no longer does preset module resolution. This has been moved to the CLI. API users must now pass a preset as a function to api.use() or call it with the API and options, i.e. preset(neutrino, options).
getWebpackOptions() no longer caches calls.
Using a node target no longer skips the watcher for a builder, it now uses the Webpack watcher, i.e. neutrino start && node build is obsolete. neutrino build && node build would work to start a Node instance for production-built bundles.

Features

Added options for setting or overriding a number of paths Neutrino uses, from package.json, middleware, or the API. These paths can be provided absolutely or relative to neutrino.options.root, or for entry, relative to neutrino.options.source:

neutrino.options.root, // defaults to process.cwd()
neutrino.options.source, // defaults to process.cwd()/src
neutrino.options.output, // defaults to process.cwd()/build
neutrino.options.tests, // defaults to process.cwd()/test
neutrino.options.entry, // defaults to process.cwd()/src/index.js
neutrino.options.node_modules // defaults to process.cwd()/node_modules

Added --inspect flag to output a string representation of the Webpack configuration object. Can be used to diff configuration changes:

neutrino build --inspect --presets alpha > alpha.config
neutrino build --inspect --presets alpha beta > beta.config

git diff alpha.config beta.config

HMR for Node.js!
Dynamic imports for Web AND Node.js!

const { default: Home } = await import('./home');

Testing via AVA, just add tests to packages/*/test
Running tests in Travis

Bugs

various

…rt fix

eliperelman · 2017-03-04T00:27:49Z

Updated description with current list of breaking changes. Will update with features and bugs soonish.

eliperelman · 2017-03-04T00:30:41Z

@helfi92 feel free to start reviewing this whenever. I will add docs in a different PR.

cc: @tj @TheLarkInn @ev1stensberg for any comments or opinions they may have. :)

tj · 2017-03-04T01:15:40Z

packages/neutrino-middleware-env/index.js

@@ -0,0 +1,5 @@
+const { EnvironmentPlugin } = require('webpack');
+
+module.exports = ({ config }, envs = []) => config


Is the second argument automatically scoped to the middleware from the "options" in package.json? Or the whole object? Or neither hahah

EDIT: nvm I see, presets are slightly different than middleware accessing neutrino.options instead of passing that object.

At the moment, no, it's just whatever gets passed to the middleware.

https://github.com/mozilla-neutrino/neutrino-dev/pull/86/files#diff-ada11b9ab390b81e1edbc18574ff967aR30

Although it would be cool to map a name to preset/middleware options automatically, but that would probably require passing a name along with the preset/middleware. Which is possible.

Might be cool to unify middleware/presets in some way like that, not a big deal though

tj · 2017-03-04T01:25:31Z

awesome LGTM at a quick glance! Thanks a ton for working on this, amazing how much work it removes

SpencerCDixon · 2017-03-04T12:18:23Z

packages/neutrino-middleware-progress/package.json

+  "bugs": "https://github.com/mozilla-neutrino/neutrino-dev/issues",
+  "dependencies": {
+    "progress-bar-webpack-plugin": "^1.9.3",
+    "webpack": "^2.2.1"


Does this middleware need webpack as a dep??

Nope, that's a mistake lol.

helfi92 · 2017-03-05T02:41:22Z

packages/neutrino-preset-karma/package.json

  "description": "Neutrino preset for testing Neutrino projects with Karma",
-  "main": "src/index.js",
+  "main": "index.js",


Is there a reason you took index.js outside src?

Just to flatten the directory structure for packages that don't need the extra complexity.

helfi92 · 2017-03-05T14:55:48Z

packages/neutrino/bin/neutrino

+
+try {
+  pkg = require(join(cwd, 'package.json'));
+} catch (ex) {}


Should we throw an exception message?

No, we try to load data from package.json if it exists, but it's not going to affect anything if we can't find it.

Ah ok, makes sense.

evenstensberg · 2017-03-06T18:49:53Z

@eliperelman Want to exhange emails instead? I need some insight on the entire thing from multiple sources, so I can elaborate better :)

eliperelman · 2017-03-07T15:24:28Z

@ev1stensberg sure, eli@mozilla.com.

eliperelman · 2017-03-07T15:52:42Z

If there are no major objections, I plan on merging this later today.

eliperelman · 2017-03-08T15:07:49Z

I made some changes to webpack-chain, now v3, which makes interacting with some APIs different, but more extensible.

The Neutrino API now also defines defaults for options which mostly eliminate the need for presets to do their own path lookups:

neutrino.options : {
  root, // defaults to process.cwd()
  source, // defaults to process.cwd()/src
  output, // defaults to process.cwd()/build
  tests, // defaults to process.cwd()/test
  entry, // defaults to process.cwd()/src/index.js
  node_modules // defaults to process.cwd()/node_modules
};

All the presets now use these at neutrino.options! 🎉

This also means that you can easily override how a single option affects a number of configuration changes:

{
  "neutrino": {
    "options": {
      "source": "lib",
      "entry": "entry.js"
    }
  }
}

const api = new Neutrino({ source: 'lib', entry: 'entry.js' });

module.exports = neutrino => {
  neutrino.options.source = 'lib';
  neutrino.options.entry = 'entry.js';
}

For example, the Web preset needs the source directory (not to mention other directories) for:

Babel compilation directory
Dev server content base
Copying plugin

w00t!

eliperelman · 2017-03-08T15:10:23Z

Just to contrast, let's say you wanted to change the web/react presets to use lib instead of src for your source directory (v4):

module.exports = ({ config }) => {
  const oldSrc = path.join(__dirname, 'src');
  const newSrc = path.join(__dirname, 'lib');
  const oldEntry = path.join(oldSrc, 'index.js');
  const newEntry = path.join(newSrc, 'index.js');
  
  config
    .entry('index')
    .delete(oldEntry)
    .add(newEntry);

  config.module
    .rule('compile')
      ._include.delete(oldSrc);

  config.module.rule('compile').add(newSrc)
  config.devServer.contentBase(newSrc);

  if (process.env.NODE_ENV !== 'development') {
    config
      .plugin('copy')
      .inject((Plugin, args) => {
        args[0].context = newSrc;
        return new Plugin(...args);
      });
  }
};

eww.

Now v5:

{
  "neutrino": {
    "options": {
      "source": "lib"
    }
  }
}

Or from override file:

neutrino.options.source = 'lib';

Ahh.

eliperelman · 2017-03-08T17:03:58Z

packages/neutrino-middleware-clean/index.js

+const merge = require('deepmerge');
+
+module.exports = ({ config }, options) => {
+  const { paths, root } = merge({ paths: [], root: process.cwd() }, options);


Need to switch this to neutrino.options.root.

eliperelman · 2017-03-08T18:03:38Z

SOON

edmorley · 2017-03-08T19:44:29Z

.travis.yml

+  yarn: true
+  directories:
+    - node_modules
+    - packages/neutrino-middleware-chunk/node_modules


Should this list also include these entries?

packages/neutrino-middleware-banner/node_modules

packages/neutrino/node_modules

edmorley · 2017-03-08T19:46:09Z

.travis.yml

+    - packages/neutrino-preset-react/node_modules
+    - packages/neutrino-preset-web/node_modules
+before_script:
+  - yarn


Travis by default runs yarn install as part of the install step (if not overridden), so this additional yarn invocation is a duplicate, eg:
https://travis-ci.org/mozilla-neutrino/neutrino-dev/jobs/209062877#L274

Good catch! This is an artifact left over from when I switched from install to before_script in 573c821. I'll update. 👍

eliperelman · 2017-03-08T20:31:12Z

I will add README.md's to the middleware packages after this and #98 have been merged.

…all directive

eliperelman · 2017-03-08T20:45:28Z

🎉

eliperelman · 2017-03-08T20:45:36Z

edmorley · 2017-03-09T13:09:24Z

Aside from #58, is there much else to do before v5 is published? I'm just trying to work out whether we should switch to v5 now for the Treeherder Neutrino PR, or wait until later.

eliperelman · 2017-03-09T13:11:29Z

@edmorley right now nothing more is planning regarding functionality, and late last night I published beta packages of everything to npm, e.g. neutrino@beta, neutrino-preset-web@beta, which all point to the v5 changes. If you want, feel free to try it and let me know if there are any issues.

* Docs: Sync the READMEs in docs/ and packages/ Since the content had drifted out of sync. * Docs: Use consistent case for Hot Module Replacement * Docs: Sync the react and web preset feature lists * Docs: Correct the loader name for the 'html' rule Since the loader name was changed from `file` to `html` in #219. * Docs: Correct the rule name for neutrino-middleware-style-loader Since it was changed from `css` to `style` in #86.

eliperelman added this to the v5 milestone Mar 1, 2017

eliperelman mentioned this pull request Mar 2, 2017

API: Presets as code, middleware injection #79

Closed

eliperelman added 5 commits March 2, 2017 16:56

Baseline for Neutrino v5

96ce5bf

Refining middleware concept, splitting presets into middleware packages

f202977

Switch packages licenses to MPL v2, add AVA to start test implementation

e1ee626

Trying out use(loader, options)

73ef503

Node.js HMR, source watching, named modules for Node and Web

e3c7b60

This was referenced Mar 3, 2017

Add Hot Module Replacement (HMR) for Node.js #59

Closed

Build watcher doesn't output any information to console #44

Closed

Adding rudimentary testing

47e9b52

eliperelman closed this Mar 3, 2017

eliperelman reopened this Mar 3, 2017

eliperelman closed this Mar 3, 2017

eliperelman reopened this Mar 3, 2017

eliperelman added 4 commits March 3, 2017 15:14

Travis changes

573c821

Fixing json extension

74f6f65

Adding dynamic import syntax, babel-polyfill by default, devserver po…

34d845a

…rt fix

Dynamic import() for Node

ac48dbf

eliperelman mentioned this pull request Mar 3, 2017

Adding dynamic import capabaility via import() #46

Closed

eliperelman added 2 commits March 3, 2017 18:18

Allow linting overrides to airbnb preset

7b4b1b3

Simplify deep picking with pathOr

99db808

eliperelman requested a review from helfi92 March 4, 2017 00:28

eliperelman self-assigned this Mar 4, 2017

tj reviewed Mar 4, 2017

View reviewed changes

SpencerCDixon reviewed Mar 4, 2017

View reviewed changes

helfi92 reviewed Mar 5, 2017

View reviewed changes

Pointing package.json respository to tree location

a594ef9

Cleaning up unused gitignores

c35c84d

eliperelman added 2 commits March 8, 2017 08:38

Upgrading to webpack-chain v3, add more tests for full presets

49b9e29

Normalize API paths based on absolute or relative location

c33480f

eliperelman added 3 commits March 8, 2017 09:19

Moving peerDeps of deps to devDeps

112f88d

Attempting to cache packages' node_modules via wildcard

aa16fa6

Manually caching monorepo package node_modules for travis

05e4b09

eliperelman commented Mar 8, 2017

View reviewed changes

Switching clean middleware to use options.root

eafadf2

edmorley reviewed Mar 8, 2017

View reviewed changes

Adding missing packages to travis cache, removing duplicate yarn inst…

bd51085

…all directive

eliperelman merged commit f88b557 into neutrinojs:master Mar 8, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Baseline for Neutrino v5 #86

Baseline for Neutrino v5 #86

eliperelman commented Mar 1, 2017 •

edited

Loading

eliperelman commented Mar 4, 2017 •

edited

Loading

eliperelman commented Mar 4, 2017

tj Mar 4, 2017 •

edited

Loading

eliperelman Mar 4, 2017

eliperelman Mar 4, 2017

tj Mar 4, 2017

tj commented Mar 4, 2017

SpencerCDixon Mar 4, 2017

eliperelman Mar 5, 2017

helfi92 Mar 5, 2017

eliperelman Mar 5, 2017

helfi92 Mar 5, 2017

eliperelman Mar 5, 2017

helfi92 Mar 5, 2017

evenstensberg commented Mar 6, 2017

eliperelman commented Mar 7, 2017

eliperelman commented Mar 7, 2017 •

edited

Loading

eliperelman commented Mar 8, 2017

eliperelman commented Mar 8, 2017 •

edited

Loading

eliperelman Mar 8, 2017

eliperelman commented Mar 8, 2017 •

edited

Loading

edmorley Mar 8, 2017

eliperelman Mar 8, 2017

edmorley Mar 8, 2017 •

edited

Loading

eliperelman Mar 8, 2017

eliperelman commented Mar 8, 2017

eliperelman commented Mar 8, 2017

eliperelman commented Mar 8, 2017

edmorley commented Mar 9, 2017

eliperelman commented Mar 9, 2017 •

edited

Loading

		@@ -0,0 +1,5 @@
		const { EnvironmentPlugin } = require('webpack');

		module.exports = ({ config }, envs = []) => config

Baseline for Neutrino v5 #86

Baseline for Neutrino v5 #86

Conversation

eliperelman commented Mar 1, 2017 • edited Loading

Summary

BREAKING CHANGES

Features

Bugs

eliperelman commented Mar 4, 2017 • edited Loading

eliperelman commented Mar 4, 2017

tj Mar 4, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

tj commented Mar 4, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

evenstensberg commented Mar 6, 2017

eliperelman commented Mar 7, 2017

eliperelman commented Mar 7, 2017 • edited Loading

eliperelman commented Mar 8, 2017

eliperelman commented Mar 8, 2017 • edited Loading

Choose a reason for hiding this comment

eliperelman commented Mar 8, 2017 • edited Loading

SOON

Choose a reason for hiding this comment

Choose a reason for hiding this comment

edmorley Mar 8, 2017 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eliperelman commented Mar 8, 2017

eliperelman commented Mar 8, 2017

eliperelman commented Mar 8, 2017

edmorley commented Mar 9, 2017

eliperelman commented Mar 9, 2017 • edited Loading

eliperelman commented Mar 1, 2017 •

edited

Loading

eliperelman commented Mar 4, 2017 •

edited

Loading

tj Mar 4, 2017 •

edited

Loading

eliperelman commented Mar 7, 2017 •

edited

Loading

eliperelman commented Mar 8, 2017 •

edited

Loading

eliperelman commented Mar 8, 2017 •

edited

Loading

edmorley Mar 8, 2017 •

edited

Loading

eliperelman commented Mar 9, 2017 •

edited

Loading