This repository was archived by the owner on Feb 18, 2024. It is now read-only.
Update documentation to reflect changes in API from switching to external CLI tools #896
Comments
3 tasks
eliperelman
added a commit
that referenced
this issue
May 23, 2018
… tools (#852) __Edited to reflect current state of PR.__ Fixes #708. Fixes #736. Fixes #870. Fixes #842. Closes #773. Closes #839. Closes #849. Outstanding issues to file: - [x] Update docs to reflect these API changes (#896) - [x] ~~Determine need for config-loading bins instead of forcing config file boilerplate (still unsure if we should do this because of IDE integration)~~ - [x] Modify stats to produce friendlier build output (#897) This patch is a work-in-progress, and is quite the overhaul of Neutrino into something different. Right now there is no change to the documentation, which I will change if we decide to move forward with this. This patch morphs Neutrino into a "preset engine" for transforming managed webpack configuration into a format that can be consumed by other CLI tools. No longer would we wrap external CLI tools like webpack, eslint, jest, karma, mocha, stylelint, etc. Instead, Neutrino could augment these tools by exposing methods for returning usable configuration. This approach gives the user control of their CLI tool back, and they can programmatically invoke Neutrino to load their configuration, and override however they like: ```bash webpack --mode production ``` ```js // webpack.config.js const neutrino = require('neutrino'); // Load with no config overrides: module.exports = neutrino().webpack(); // Load with config overrides: module.exports = neutrino().webpack(config => { // return whatever config you want }); // Load with no config overrides using low-level API: module.exports = neutrino().output('webpack'); // Load with config overrides using low-level API: module.exports = neutrino().output('webpack', config => { // return whatever config you want }); ``` The same works for ESLint and friends too (except for mocha, since it has no config file we can be required from): ```bash eslint src ``` ```js // .eslintrc.js const neutrino = require('neutrino'); // Load with no config overrides: module.exports = neutrino().eslintrc(); // Load with config overrides: module.exports = neutrino().eslintrc(config => { // return whatever config you want, like manipulating rules, etc. }); ``` --- - This approach is predicated on having middleware defined in `.neutrinorc.js`, which shouldn't change at all. - ~~This does do away with a bunch of CLI functionality like `--inspect` or `--use`, but those become less useful if we are just an interface to external CLI tools. We can discuss potentially bringing those back.~~ This is now back in the form of the CLI with `neutrino --inspect`. - ~~All environment variables are gone. We rely only on webpack's `mode` value.~~ We internally only use webpack's `mode` value, but still set `process.env.NODE_ENV` if not set based on the mode, or defaulted to `production`. - ~~There is no longer a create-project tool, since we cannot force users to choose between competing tools like webpack-cli or webpack-command, and webpack-dev-server or webpack-serve.~~ The create-project tool is back, and we opt for `webpack-cli` and `webpack-dev-server` as opinions for now. I'm sure there are other major things I am neglecting to mention. Let's discuss! I see so many benefits to this, including reduced maintenance burden and the ability to allow people to use Neutrino without dumping their existing tools. cc: @mozilla-neutrino/core-contributors
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
In #852 we made significant changes to the Neutrino API and how it is consumed. This issue is to update all the documentation based on these changes. This is also blocked on @edmorley's new docs implementation.
The text was updated successfully, but these errors were encountered: