This repository has been archived by the owner on Feb 18, 2024. It is now read-only.
Update docs for Neutrino 9 changes #1108
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The `webpack*` and `neutrino` packages have been intentionally left off the package install lists for everything but the top-level build presets, since: - the test presets already state a requirement on a build preset - the more advanced "building block" presets will be added to an already configured project by an advanced user I've also intentionally not used a tilde version range for the new peer dependencies (webpack/eslint/...) since it: - makes the instructions more cluttered - prevents yarn/npm from adding the full latest version number - means more we have to update when bumping the peer dep numbers If a new major version is released that is not compatible, we can always add tilde ranges at that point. (Like already done for `stylelint@^8`)
This was already the case for the top-level presets, but not the lower-level ones.
* Removes references to the Neutrino CLI (eg `--use` and `neutrino lint`)
* Updates example `.eslintrc.js` (and removes the footgun "custom
middleware example" - we shouldn't be encouraging people to diverge
configs)
* Adds example package.json scripts `lint` entry using ESlint CLI
* Corrects `semi` rule name to `babel/semi`
* Adds `{ options: { root: __dirname } }` to all .neutrinorc.js
examples, since that's the new recommended approach
* Syncs defaults with what's actually set * Removes incorrect mention of `open` being an "extra" option, since it's supported natively by the already-linked devServer options.
Since otherwise it wraps
Using HTML rather than markdown means mkdocs / mkdocs-material won't treat these lines as linkable sections, that get put in the right-hand side table of contents.
This intentionally doesn't list exact commands to run for inspect, since they may get out of date with reality (given that we can't update this file once projects have already been created).
edmorley
force-pushed
the
neutrino-9-docs
branch
from
b228c3d
to
a2b1e69
Compare
|
Yup fail. |
edmorley
commented
Sep 19, 2018
| "test": "neutrino test" | ||
| "start": "webpack-dev-server --mode development", | ||
| "build": "webpack --mode production", | ||
| "test": "jest" |
There was a problem hiding this comment.
Should we add a lint entry here and say @neutrinojs/airbnb to the preset lists in this multi-preset example? (In lieu of a linting section on this page; or even in addition to, should we add one?)
This was referenced Sep 19, 2018
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
I think this is mostly done now, apart from:
docs/api.mdanddocs/usage.md(NB making sure to describe--modeandNODE_ENVimplications)Fixes #896.