Browse Source

Switching paths to relative

v5.0.0-beta
Eli Perelman 8 years ago
parent
commit
c87d0f133b
  1. 54
      docs/SUMMARY.md
  2. 6
      docs/api/README.md
  3. 2
      docs/cli/README.md
  4. 4
      docs/contributing/README.md
  5. 2
      docs/contributing/development.md
  6. 3
      docs/customization/advanced.md
  7. 6
      docs/customization/simple.md
  8. 2
      docs/middleware/README.md
  9. 2
      docs/middleware/neutrino-middleware-banner/README.md
  10. 2
      docs/middleware/neutrino-middleware-chunk/README.md
  11. 2
      docs/middleware/neutrino-middleware-clean/README.md
  12. 2
      docs/middleware/neutrino-middleware-compile-loader/README.md
  13. 2
      docs/middleware/neutrino-middleware-copy/README.md
  14. 2
      docs/middleware/neutrino-middleware-env/README.md
  15. 4
      docs/middleware/neutrino-middleware-eslint/README.md
  16. 2
      docs/middleware/neutrino-middleware-font-loader/README.md
  17. 2
      docs/middleware/neutrino-middleware-hml-template/README.md
  18. 2
      docs/middleware/neutrino-middleware-hot/README.md
  19. 2
      docs/middleware/neutrino-middleware-html-loader/README.md
  20. 2
      docs/middleware/neutrino-middleware-image-loader/README.md
  21. 2
      docs/middleware/neutrino-middleware-loader-merge/README.md
  22. 2
      docs/middleware/neutrino-middleware-minify/README.md
  23. 2
      docs/middleware/neutrino-middleware-named-modules/README.md
  24. 2
      docs/middleware/neutrino-middleware-progress/README.md
  25. 2
      docs/middleware/neutrino-middleware-start-server/README.md
  26. 2
      docs/middleware/neutrino-middleware-style-loader/README.md
  27. 12
      docs/presets/neutrino-preset-airbnb-base/README.md
  28. 12
      docs/presets/neutrino-preset-jest/README.md
  29. 10
      docs/presets/neutrino-preset-karma/README.md
  30. 12
      docs/presets/neutrino-preset-mocha/README.md
  31. 10
      docs/presets/neutrino-preset-node/README.md
  32. 16
      docs/presets/neutrino-preset-react/README.md
  33. 10
      docs/presets/neutrino-preset-web/README.md
  34. 2
      docs/project-layout.md
  35. 4
      docs/usage.md

54
docs/SUMMARY.md

@ -1,30 +1,30 @@
# Summary
* [Introduction](/README.md)
* [Installation](/installation.md)
* [Usage](/usage.md)
* [Project Layout](/project-layout.md)
* [FAQ](/FAQ.md)
* [Middleware](/middleware/README.md)
* [Presets](/presets/README.md)
* [Web](/presets/neutrino-preset-web/README.md)
* [React](/presets/neutrino-preset-react/README.md)
* [Node.js](/presets/neutrino-preset-node/README.md)
* [Airbnb](/presets/neutrino-preset-airbnb-base/README.md)
* [Karma](/presets/neutrino-preset-karma/README.md)
* [Mocha](/presets/neutrino-preset-mocha/README.md)
* [Jest](/presets/neutrino-preset-jest/README.md)
* [Community presets](/presets/community-presets.md)
* [Customization](/customization/README.md)
* [Simple](/customization/simple.md)
* [Advanced](/customization/advanced.md)
* [Creating presets](/creating-presets.md)
* [Creating linting presets](/presets/neutrino-lint-base/README.md)
* [Learning Resources](/learning-resources.md)
* [API](/api/README.md)
* [CLI](/cli/README.md)
* [Upgrading from v4 to v5](/upgrading-neutrino.md)
* [Introduction](./README.md)
* [Installation](./installation.md)
* [Usage](./usage.md)
* [Project Layout](./project-layout.md)
* [FAQ](./FAQ.md)
* [Middleware](./middleware/README.md)
* [Presets](./presets/README.md)
* [Web](./presets/neutrino-preset-web/README.md)
* [React](./presets/neutrino-preset-react/README.md)
* [Node.js](./presets/neutrino-preset-node/README.md)
* [Airbnb](./presets/neutrino-preset-airbnb-base/README.md)
* [Karma](./presets/neutrino-preset-karma/README.md)
* [Mocha](./presets/neutrino-preset-mocha/README.md)
* [Jest](./presets/neutrino-preset-jest/README.md)
* [Community presets](./presets/community-presets.md)
* [Customization](./customization/README.md)
* [Simple](./customization/simple.md)
* [Advanced](./customization/advanced.md)
* [Creating presets](./creating-presets.md)
* [Creating linting presets](./presets/neutrino-lint-base/README.md)
* [Learning Resources](./learning-resources.md)
* [API](./api/README.md)
* [CLI](./cli/README.md)
* [Upgrading from v4 to v5](./upgrading-neutrino.md)
* [v4 Documentation](https://github.com/mozilla-neutrino/neutrino-dev/tree/docs-v4/docs)
* [Contributing](/contributing/README.md)
* [Development Process](/contributing/development.md)
* [Code of Conduct](/contributing/code-of-conduct.md)
* [Contributing](./contributing/README.md)
* [Development Process](./contributing/development.md)
* [Code of Conduct](./contributing/code-of-conduct.md)

6
docs/api/README.md

@ -1,6 +1,6 @@
# Neutrino API
When using Neutrino via the [CLI](/cli/README.md), it creates an instance of the Neutrino API which picks up
When using Neutrino via the [CLI](../cli/README.md), it creates an instance of the Neutrino API which picks up
any presets and arguments passed on the command line or located in package.json. If you desire, you can also create your
own instance of the Neutrino API and interact with it programmatically.
@ -27,7 +27,7 @@ const api = new Neutrino(options);
## Loading middleware
Using the Neutrino API you can load [middleware](/middleware/README.md) and presets (which are also just middleware)
Using the Neutrino API you can load [middleware](../middleware/README.md) and presets (which are also just middleware)
using the `use` method. The `use` method takes in a middleware function, and optionally any options that should be
passed to the middleware function.
@ -241,7 +241,7 @@ that resolves when the process receives a `SIGINT` event to stop.
```js
api
._devServer()
.devServer()
.then(() => console.log('Exiting process...'));
```

2
docs/cli/README.md

@ -126,7 +126,7 @@ Options:
```
Using the command `neutrino test` will execute every test file located in your
[testing directory](/project-layout#Testing). You may also provide to this command the specific test files you wish
[testing directory](../project-layout#Testing). You may also provide to this command the specific test files you wish
to run individually. It is important to note that when combined with the `--presets` parameter, you should use two
dashes after the last preset to denote the end of the presets and the beginning of the test files.

4
docs/contributing/README.md

@ -9,7 +9,7 @@ community.
### Participation Conduct
In order to ensure everyone has a fair, pleasant, and inclusive experience contributing to Neutrino, we ask that you
abide by our [community participation guidelines](/contributing/code-of-conduct.md), based on the
abide by our [community participation guidelines](./code-of-conduct.md), based on the
[Contributor Covenant](http://contributor-covenant.org/). Please read and understand it for everyone's benefit.
Following these guidelines helps to communicate that you respect the time of the developers managing
@ -63,7 +63,7 @@ possible.
## Getting started
Most contributions will involve working with the neutrino-dev codebase. Please refer to the [development
documentation](/contributing/development.md) for technical details on getting started.
documentation](./development.md) for technical details on getting started.
## Filing bugs and issues

2
docs/contributing/development.md

@ -171,7 +171,7 @@ in order to add files that should be committed. Give your changes a descriptive
Now if you open the GitHub page for your repository, GitHub should display a button to open a pull request for
the branch and commit you just pushed. When filling out the details of the pull request, try to be as descriptive
as possible, following our detailed [contribution guidelines](/contributing/README.md).
as possible, following our detailed [contribution guidelines](./README.md).
### Congrats!

3
docs/customization/advanced.md

@ -30,7 +30,7 @@ receives arguments to modify a request or response along its lifecycle. There ca
that Express can load, each one potentially modifying a request or response in succession.
When you customize Neutrino with an override, you export a Neutrino middleware function, except this is typically used
to override Neutrino's configuration. Every preset or middleware the Neutrino has loaded follows this same middleware
to override Neutrino's configuration. Every preset or middleware that Neutrino has loaded follows this same middleware
pipeline.
At the moment our custom override isn't doing anything, but it does get us far enough to be able to tell Neutrino
@ -85,6 +85,7 @@ module.exports = neutrino => {
.rule('compile')
.loader('babel', options => {
options.presets[0][1].targets.node = 4.2;
return options;
});
};

6
docs/customization/simple.md

@ -7,12 +7,12 @@ configuration.
_Note: Using package.json for customization tends to be quite verbose for anything more than simple overrides. If this
is not to your liking, consider moving your overrides to their own file using
[Advanced Customization](/customization/advanced.md)._
[Advanced Customization](./advanced.md)._
## Prepare package.json
First, you will need to define a `neutrino` section within your package.json. You
[may have already done this](/usage.md#using-multiple-presets) if you
[may have already done this](../usage.md#using-multiple-presets) if you
specified your presets through `neutrino` as opposed to flags through `scripts`:
```json
@ -239,4 +239,4 @@ _Example: Change the Webpack performance options to error when exceeding perform
With the options defined above in your package.json, you can perform a variety of build customizations on a per-project
basis. In the event that you need more customization than what is afforded through JSON, consider either switching to
[advanced configuration](/customization/advanced.md), or [creating your own preset](/creating-presets.md).
[advanced configuration](./advanced.md), or [creating your own preset](../creating-presets.md).

2
docs/middleware/README.md

@ -74,7 +74,7 @@ module.exports = neutrino => {
## Configuring
If your middleware requires configuration _outside_ of the options necessary for _running_ the middleware, you create
If your middleware requires configuration _outside_ of the options necessary for _running_ the middleware,
use a closure technique for simplifying this for your middleware consumers. In short, your module will provide a
function to consumers which, when executed, will return a Neutrino middleware function. Describing this in code:

2
docs/middleware/neutrino-middleware-banner/README.md

@ -62,7 +62,7 @@ The following is a list of plugins and their identifiers which can be overridden
This preset is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
containing all resources for developing Neutrino and its core presets. Follow the
[contributing guide](/contributing/README.md) for details.
[contributing guide](../../contributing/README.md) for details.
[npm-image]: https://img.shields.io/npm/v/neutrino-middleware-banner.svg
[npm-downloads]: https://img.shields.io/npm/dt/neutrino-middleware-banner.svg

2
docs/middleware/neutrino-middleware-chunk/README.md

@ -62,7 +62,7 @@ points.
This preset is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
containing all resources for developing Neutrino and its core presets. Follow the
[contributing guide](/contributing/README.md) for details.
[contributing guide](../../contributing/README.md) for details.
[npm-image]: https://img.shields.io/npm/v/neutrino-middleware-chunk.svg
[npm-downloads]: https://img.shields.io/npm/dt/neutrino-middleware-chunk.svg

2
docs/middleware/neutrino-middleware-clean/README.md

@ -58,7 +58,7 @@ The following is a list of plugins and their identifiers which can be overridden
This preset is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
containing all resources for developing Neutrino and its core presets. Follow the
[contributing guide](/contributing/README.md) for details.
[contributing guide](../../contributing/README.md) for details.
[npm-image]: https://img.shields.io/npm/v/neutrino-middleware-clean.svg
[npm-downloads]: https://img.shields.io/npm/dt/neutrino-middleware-clean.svg

2
docs/middleware/neutrino-middleware-compile-loader/README.md

@ -59,7 +59,7 @@ The following is a list of rules and their identifiers which can be overridden:
This preset is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
containing all resources for developing Neutrino and its core presets. Follow the
[contributing guide](/contributing/README.md) for details.
[contributing guide](../../contributing/README.md) for details.
[npm-image]: https://img.shields.io/npm/v/neutrino-middleware-compile-loader.svg
[npm-downloads]: https://img.shields.io/npm/dt/neutrino-middleware-compile-loader.svg

2
docs/middleware/neutrino-middleware-copy/README.md

@ -64,7 +64,7 @@ The following is a list of plugins and their identifiers which can be overridden
This preset is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
containing all resources for developing Neutrino and its core presets. Follow the
[contributing guide](/contributing/README.md) for details.
[contributing guide](../../contributing/README.md) for details.
[npm-image]: https://img.shields.io/npm/v/neutrino-middleware-copy.svg
[npm-downloads]: https://img.shields.io/npm/dt/neutrino-middleware-copy.svg

2
docs/middleware/neutrino-middleware-env/README.md

@ -58,7 +58,7 @@ The following is a list of plugins and their identifiers which can be overridden
This preset is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
containing all resources for developing Neutrino and its core presets. Follow the
[contributing guide](/contributing/README.md) for details.
[contributing guide](../../contributing/README.md) for details.
[npm-image]: https://img.shields.io/npm/v/neutrino-middleware-env.svg
[npm-downloads]: https://img.shields.io/npm/dt/neutrino-middleware-env.svg

4
docs/middleware/neutrino-middleware-eslint/README.md

@ -103,7 +103,7 @@ document that clearly in your middleware.
`neutrino-middleware-eslint` also provides a method for getting the ESLint configuration suitable for use in an eslintrc
file. Typically this is used for providing hints or fix solutions to the development environment, e.g. IDEs and text
editors. Doing this requires [creating an instance of the Neutrino API](/api/README.md) and providing the presets uses.
editors. Doing this requires [creating an instance of the Neutrino API](../../api/README.md) and providing the presets uses.
If you keep this information in `neutrino.presets` in package.json, this should be relatively straightforward. By
providing all the presets used to Neutrino, you can ensure all the linting options used across all presets will be
merged together for your development environment, without the need for copying, duplication, or loss of organization and
@ -126,7 +126,7 @@ module.exports = api.eslintrc();
This preset is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
containing all resources for developing Neutrino and its core presets. Follow the
[contributing guide](/contributing/README.md) for details.
[contributing guide](../../contributing/README.md) for details.
[npm-image]: https://img.shields.io/npm/v/neutrino-middleware-eslint.svg
[npm-downloads]: https://img.shields.io/npm/dt/neutrino-middleware-eslint.svg

2
docs/middleware/neutrino-middleware-font-loader/README.md

@ -61,7 +61,7 @@ The following is a list of rules and their identifiers which can be overridden:
This preset is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
containing all resources for developing Neutrino and its core presets. Follow the
[contributing guide](/contributing/README.md) for details.
[contributing guide](../../contributing/README.md) for details.
[npm-image]: https://img.shields.io/npm/v/neutrino-middleware-font-loader.svg
[npm-downloads]: https://img.shields.io/npm/dt/neutrino-middleware-font-loader.svg

2
docs/middleware/neutrino-middleware-hml-template/README.md

@ -66,7 +66,7 @@ The following is a list of plugins and their identifiers which can be overridden
This preset is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
containing all resources for developing Neutrino and its core presets. Follow the
[contributing guide](/contributing/README.md) for details.
[contributing guide](../../contributing/README.md) for details.
[npm-image]: https://img.shields.io/npm/v/neutrino-middleware-html-template.svg
[npm-downloads]: https://img.shields.io/npm/dt/neutrino-middleware-html-template.svg

2
docs/middleware/neutrino-middleware-hot/README.md

@ -52,7 +52,7 @@ The following is a list of plugins and their identifiers which can be overridden
This preset is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
containing all resources for developing Neutrino and its core presets. Follow the
[contributing guide](/contributing/README.md) for details.
[contributing guide](../../contributing/README.md) for details.
[npm-image]: https://img.shields.io/npm/v/neutrino-middleware-hot.svg
[npm-downloads]: https://img.shields.io/npm/dt/neutrino-middleware-hot.svg

2
docs/middleware/neutrino-middleware-html-loader/README.md

@ -51,7 +51,7 @@ The following is a list of rules and their identifiers which can be overridden:
This preset is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
containing all resources for developing Neutrino and its core presets. Follow the
[contributing guide](/contributing/README.md) for details.
[contributing guide](../../contributing/README.md) for details.
[npm-image]: https://img.shields.io/npm/v/neutrino-middleware-html-loader.svg
[npm-downloads]: https://img.shields.io/npm/dt/neutrino-middleware-html-loader.svg

2
docs/middleware/neutrino-middleware-image-loader/README.md

@ -61,7 +61,7 @@ The following is a list of rules and their identifiers which can be overridden:
This preset is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
containing all resources for developing Neutrino and its core presets. Follow the
[contributing guide](/contributing/README.md) for details.
[contributing guide](../../contributing/README.md) for details.
[npm-image]: https://img.shields.io/npm/v/neutrino-middleware-image-loader.svg
[npm-downloads]: https://img.shields.io/npm/dt/neutrino-middleware-image-loader.svg

2
docs/middleware/neutrino-middleware-loader-merge/README.md

@ -65,7 +65,7 @@ for extending the options for a rule loader which has create its own conventions
This preset is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
containing all resources for developing Neutrino and its core presets. Follow the
[contributing guide](/contributing/README.md) for details.
[contributing guide](../../contributing/README.md) for details.
[npm-image]: https://img.shields.io/npm/v/neutrino-middleware-loader-merge.svg
[npm-downloads]: https://img.shields.io/npm/dt/neutrino-middleware-loader-merge.svg

2
docs/middleware/neutrino-middleware-minify/README.md

@ -53,7 +53,7 @@ The following is a list of plugins and their identifiers which can be overridden
This preset is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
containing all resources for developing Neutrino and its core presets. Follow the
[contributing guide](/contributing/README.md) for details.
[contributing guide](../../contributing/README.md) for details.
[npm-image]: https://img.shields.io/npm/v/neutrino-middleware-minify.svg
[npm-downloads]: https://img.shields.io/npm/dt/neutrino-middleware-minify.svg

2
docs/middleware/neutrino-middleware-named-modules/README.md

@ -51,7 +51,7 @@ The following is a list of plugins and their identifiers which can be overridden
This preset is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
containing all resources for developing Neutrino and its core presets. Follow the
[contributing guide](/contributing/README.md) for details.
[contributing guide](../../contributing/README.md) for details.
[npm-image]: https://img.shields.io/npm/v/neutrino-middleware-named-modules.svg
[npm-downloads]: https://img.shields.io/npm/dt/neutrino-middleware-named-modules.svg

2
docs/middleware/neutrino-middleware-progress/README.md

@ -51,7 +51,7 @@ The following is a list of plugins and their identifiers which can be overridden
This preset is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
containing all resources for developing Neutrino and its core presets. Follow the
[contributing guide](/contributing/README.md) for details.
[contributing guide](../../contributing/README.md) for details.
[npm-image]: https://img.shields.io/npm/v/neutrino-middleware-progress.svg
[npm-downloads]: https://img.shields.io/npm/dt/neutrino-middleware-progress.svg

2
docs/middleware/neutrino-middleware-start-server/README.md

@ -60,7 +60,7 @@ The following is a list of plugins and their identifiers which can be overridden
This preset is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
containing all resources for developing Neutrino and its core presets. Follow the
[contributing guide](/contributing/README.md) for details.
[contributing guide](../../contributing/README.md) for details.
[npm-image]: https://img.shields.io/npm/v/neutrino-middleware-start-server.svg
[npm-downloads]: https://img.shields.io/npm/dt/neutrino-middleware-start-server.svg

2
docs/middleware/neutrino-middleware-style-loader/README.md

@ -52,7 +52,7 @@ The following is a list of rules and their identifiers which can be overridden:
This preset is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
containing all resources for developing Neutrino and its core presets. Follow the
[contributing guide](/contributing/README.md) for details.
[contributing guide](../../contributing/README.md) for details.
[npm-image]: https://img.shields.io/npm/v/neutrino-middleware-style-loader.svg
[npm-downloads]: https://img.shields.io/npm/dt/neutrino-middleware-style-loader.svg

12
docs/presets/neutrino-preset-airbnb-base/README.md

@ -37,7 +37,7 @@ another Neutrino preset for building your application source code.
## Project Layout
`neutrino-preset-airbnb-base` follows the standard [project layout](/project-layout.md) specified by Neutrino. This
`neutrino-preset-airbnb-base` follows the standard [project layout](../../project-layout.md) specified by Neutrino. This
means that by default all project source code should live in a directory named `src` in the root of the
project.
@ -135,7 +135,7 @@ error Command failed with exit code 1.
## Customizing
To override the build configuration, start with the documentation on [customization](/customization/README.md).
To override the build configuration, start with the documentation on [customization](../../customization/README.md).
`neutrino-preset-airbnb-base` creates some conventions to make overriding the configuration easier once you are ready to
make changes.
@ -148,7 +148,7 @@ inherited from `neutrino-middleware-eslint`.
### Simple customization
By following the [customization guide](/customization/simple.md) and knowing the rule and loader IDs above,
By following the [customization guide](../../customization/simple.md) and knowing the rule and loader IDs above,
you can override and augment the linting configuration directly from package.json. _Note: Using the simple customization
approach for linting changes can be quite verbose. Consider using advanced configuration below if this bothers you._
@ -183,7 +183,7 @@ project.
### Advanced configuration
By following the [customization guide](/customization/advanced.md) and knowing the rule and loader IDs above,
By following the [customization guide](../../customization/advanced.md) and knowing the rule and loader IDs above,
you can override and augment the build by creating a JS module which overrides the config. This preset is also
Neutrino middleware, making it easy to compose and extend the configuration.
@ -222,7 +222,7 @@ module.exports = neutrino => {
`neutrino-lint-airbnb-base` also provides a method for getting the ESLint configuration suitable for use in an eslintrc
file. Typically this is used for providing hints or fix solutions to the development environment, e.g. IDEs and text
editors. Doing this requires [creating an instance of the Neutrino API](/api/README.md) and providing the presets uses.
editors. Doing this requires [creating an instance of the Neutrino API](../../api/README.md) and providing the presets uses.
If you keep this information in `neutrino.presets` in package.json, this should be relatively straightforward. By
providing all the presets used to Neutrino, you can ensure all the linting options used across all those preset will be
merged together for your development environment, without the need for copying, duplication, or loss of organization and
@ -250,7 +250,7 @@ module.exports = api.eslintrc();
This preset is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
containing all resources for developing Neutrino and its core presets. Follow the
[contributing guide](/contributing/README.md) for details.
[contributing guide](../../contributing/README.md) for details.
[npm-image]: https://img.shields.io/npm/v/neutrino-preset-airbnb-base.svg
[npm-downloads]: https://img.shields.io/npm/dt/neutrino-preset-airbnb-base.svg

12
docs/presets/neutrino-preset-jest/README.md

@ -58,7 +58,7 @@ testing with this approach.
## Project Layout
`neutrino-preset-jest` follows the standard [project layout](/project-layout.md) specified by Neutrino. This
`neutrino-preset-jest` follows the standard [project layout](../../project-layout.md) specified by Neutrino. This
means that by default all project test code should live in a directory named `test` in the root of the
project. Test files end in either `_test.js`, `.test.js`, `_test.jsx`, or `.test.jsx`.
@ -150,7 +150,7 @@ For more details on specific Jest usage, please refer to their [documentation](h
## Executing single tests
By default this preset will execute every test file located in your test directory ending in the appropriate file
extension. Use the command line [`files` parameters](/cli/README.md#neutrino-test) to execute individual tests.
extension. Use the command line [`files` parameters](../../cli/README.md#neutrino-test) to execute individual tests.
## Watching for changes
@ -182,7 +182,7 @@ more configuration options for generating coverage reports.
## Customizing
To override the test configuration, start with the documentation on [customization](/customization/README.md).
To override the test configuration, start with the documentation on [customization](../../customization/README.md).
`neutrino-preset-jest` creates some conventions to make overriding the configuration easier once you are ready to make
changes.
@ -195,7 +195,7 @@ Contains a single loader named `babel`.
### Simple customization
By following the [customization guide](/customization/simple.md) and knowing the rule, and loader IDs above,
By following the [customization guide](../../customization/simple.md) and knowing the rule, and loader IDs above,
you can override and augment the build directly from package.json.
Jest configuration settings can also be modified directly from package.json, but it is not required.
@ -226,7 +226,7 @@ _Example: Turn off bailing on test failures._
### Advanced configuration
By following the [customization guide](/customization/advanced.md) and knowing the rule, and loader IDs above,
By following the [customization guide](../../customization/advanced.md) and knowing the rule, and loader IDs above,
you can override and augment testing by creating a JS module which overrides the config.
You can also modify Jest settings by overriding with any options Jest accepts. In a standalone Jest project this is
@ -248,7 +248,7 @@ module.exports = neutrino => {
This preset is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
containing all resources for developing Neutrino and its core presets. Follow the
[contributing guide](/contributing/README.md) for details.
[contributing guide](../../contributing/README.md) for details.
[npm-image]: https://img.shields.io/npm/v/neutrino-preset-jest.svg
[npm-downloads]: https://img.shields.io/npm/dt/neutrino-preset-jest.svg

10
docs/presets/neutrino-preset-karma/README.md

@ -37,7 +37,7 @@ another Neutrino preset for building your application source code.
## Project Layout
`neutrino-preset-karma` follows the standard [project layout](/project-layout.md) specified by Neutrino. This
`neutrino-preset-karma` follows the standard [project layout](../../project-layout.md) specified by Neutrino. This
means that by default all project test code should live in a directory named `test` in the root of the
project. Test files end in `_test.js` by default.
@ -163,20 +163,20 @@ before_install:
## Customizing
To override the test configuration, start with the documentation on [customization](/customization/README.md).
To override the test configuration, start with the documentation on [customization](../../customization/README.md).
`neutrino-preset-karma` creates some conventions to make overriding the configuration easier once you are ready to make
changes.
### Simple customization
By following the [customization guide](/customization/simple.md) you can override and augment the test configuration
By following the [customization guide](../../customization/simple.md) you can override and augment the test configuration
directly from package.json. `neutrino-preset-karma` will import Karma configuration from your package.json's
`neutrino.options.karma` object if defined. The format is defined on the
[Karma documentation site](http://karma-runner.github.io/1.0/config/configuration-file.html).
### Advanced configuration
By following the [customization guide](/customization/advanced.md) you can override and augment testing by creating a
By following the [customization guide](../../customization/advanced.md) you can override and augment testing by creating a
JS module which overrides the config.
You can also modify Karma settings by overriding with any options Karma accepts. In a standalone Karma project this is
@ -197,7 +197,7 @@ module.exports = neutrino => {
This preset is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
containing all resources for developing Neutrino and its core presets. Follow the
[contributing guide](/contributing/README.md) for details.
[contributing guide](../../contributing/README.md) for details.
[npm-image]: https://img.shields.io/npm/v/neutrino-preset-karma.svg
[npm-downloads]: https://img.shields.io/npm/dt/neutrino-preset-karma.svg

12
docs/presets/neutrino-preset-mocha/README.md

@ -35,7 +35,7 @@ another Neutrino preset for building your application source code.
## Project Layout
`neutrino-preset-mocha` follows the standard [project layout](/project-layout.md) specified by Neutrino. This
`neutrino-preset-mocha` follows the standard [project layout](../../project-layout.md) specified by Neutrino. This
means that by default all project test code should live in a directory named `test` in the root of the
project. Test files end in `_test.js` by default.
@ -123,11 +123,11 @@ For more details on specific Mocha usage, please refer to their [documentation](
## Executing single tests
By default this preset will execute every test file located in your test directory ending in `_test.js`.
Use the command line [`files` parameters](/cli/README.md#neutrino-test) to execute individual tests.
Use the command line [`files` parameters](../../cli/README.md#neutrino-test) to execute individual tests.
## Customizing
To override the test configuration, start with the documentation on [customization](/customization/README.md).
To override the test configuration, start with the documentation on [customization](../../customization/README.md).
`neutrino-preset-mocha` creates some conventions to make overriding the configuration easier once you are ready to make
changes.
@ -140,7 +140,7 @@ Babel configuration from other presets that have been loaded.
### Simple customization
By following the [customization guide](/customization/simple.md) you can override and augment the test configuration
By following the [customization guide](../../customization/simple.md) you can override and augment the test configuration
directly from package.json. `neutrino-preset-mocha` will import Mocha configuration from your package.json's
`neutrino.options.mocha` object if defined. The format is defined on the
[Mocha documentation site](https://mochajs.org/#usage), with command-line flags mapping to camel-cased options
@ -148,7 +148,7 @@ in `neutrino.options.mocha`.
### Advanced configuration
By following the [customization guide](/customization/advanced.md) and knowing the rule, and loader IDs above,
By following the [customization guide](../../customization/advanced.md) and knowing the rule, and loader IDs above,
you can override and augment testing by creating a JS module which overrides the config.
You can modify Mocha settings by overriding the preset with any options Mocha accepts. This is stored in the
@ -179,7 +179,7 @@ module.exports = neutrino => {
This preset is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
containing all resources for developing Neutrino and its core presets. Follow the
[contributing guide](/contributing/README.md) for details.
[contributing guide](../../contributing/README.md) for details.
[npm-image]: https://img.shields.io/npm/v/neutrino-preset-mocha.svg
[npm-downloads]: https://img.shields.io/npm/dt/neutrino-preset-mocha.svg

10
docs/presets/neutrino-preset-node/README.md

@ -52,7 +52,7 @@ If you want to have automatically wired sourcemaps added to your project, add `s
## Project Layout
`neutrino-preset-node` follows the standard [project layout](/project-layout.md) specified by Neutrino. This
`neutrino-preset-node` follows the standard [project layout](../../project-layout.md) specified by Neutrino. This
means that by default all project source code should live in a directory named `src` in the root of the
project. This includes JavaScript files that would be available to your compiled project.
@ -196,7 +196,7 @@ modification during development.
## Customizing
To override the build configuration, start with the documentation on [customization](/customization/README.md).
To override the build configuration, start with the documentation on [customization](../../customization/README.md).
`neutrino-preset-node` creates some conventions to make overriding the configuration easier once you are ready to make
changes.
@ -228,7 +228,7 @@ The following is a list of plugins and their identifiers which can be overridden
### Simple customization
By following the [customization guide](/customization/simple.md) and knowing the rule, loader, and plugin IDs above,
By following the [customization guide](../../customization/simple.md) and knowing the rule, loader, and plugin IDs above,
you can override and augment the build directly from package.json.
_Example: Allow importing modules with an `.mjs` extension._
@ -249,7 +249,7 @@ _Example: Allow importing modules with an `.mjs` extension._
### Advanced configuration
By following the [customization guide](/customization/advanced.md) and knowing the rule, loader, and plugin IDs above,
By following the [customization guide](../../customization/advanced.md) and knowing the rule, loader, and plugin IDs above,
you can override and augment the build by creating a JS module which overrides the config.
_Example: Allow importing modules with an `.mjs` extension._
@ -264,7 +264,7 @@ module.exports = neutrino => {
This preset is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
containing all resources for developing Neutrino and its core presets. Follow the
[contributing guide](/contributing/README.md) for details.
[contributing guide](../../contributing/README.md) for details.
[npm-image]: https://img.shields.io/npm/v/neutrino-preset-node.svg
[npm-downloads]: https://img.shields.io/npm/dt/neutrino-preset-node.svg

16
docs/presets/neutrino-preset-react/README.md

@ -9,7 +9,7 @@
- Modern Babel compilation adding JSX and object rest spread syntax.
- Support for React Hot Loader
- Write JSX in .js or .jsx files
- Extends from [neutrino-preset-web](/presets/neutrino-preset-web/README.md)
- Extends from [neutrino-preset-web](../neutrino-preset-web/README.md)
- Modern Babel compilation supporting ES modules, last 2 major browser versions, async functions, and dynamic imports
- Webpack loaders for importing HTML, CSS, images, icons, and fonts
- Webpack Dev Server during development
@ -46,7 +46,7 @@ React development.
## Project Layout
`neutrino-preset-react` follows the standard [project layout](/project-layout.md) specified by Neutrino. This
`neutrino-preset-react` follows the standard [project layout](../../project-layout.md) specified by Neutrino. This
means that by default all project source code should live in a directory named `src` in the root of the
project. This includes JavaScript files, CSS stylesheets, images, and any other assets that would be available
to your compiled project.
@ -123,14 +123,14 @@ You can either serve or deploy the contents of this `build` directory as a stati
## Customizing
To override the build configuration, start with the documentation on [customization](/customization/README.md).
To override the build configuration, start with the documentation on [customization](../../customization/README.md).
`neutrino-preset-react` does not use any additional named rules, loaders, or plugins that aren't already in use by the
Web preset. See the [Web documentation customization](/presets/neutrino-preset-web#customizing)
Web preset. See the [Web documentation customization](../neutrino-preset-web#customizing)
for preset-specific configuration to override.
### Simple customization
By following the [customization guide](/customization/simple.md) and knowing the rule, loader, and plugin IDs above,
By following the [customization guide](../../customization/simple.md) and knowing the rule, loader, and plugin IDs above,
you can override and augment the build directly from package.json.
#### Vendoring
@ -181,7 +181,7 @@ manifest.29ee4d0db8f2534cc643.bundle.js 1.44 kB 2 [emitted] manifest
#### HTML files
If you wish to override how HTML files are created for your React app, refer to the [relevant section on
neutrino-preset-web](/presets/neutrino-preset-web/README.md#html-files).
neutrino-preset-web](../neutrino-preset-web/README.md#html-files).
_Example: Change the application mount ID from "root" to "app":_
@ -199,7 +199,7 @@ _Example: Change the application mount ID from "root" to "app":_
### Advanced configuration
By following the [customization guide](/customization/advanced.md) and knowing the rule, loader, and plugin IDs from
By following the [customization guide](../../customization/advanced.md) and knowing the rule, loader, and plugin IDs from
neutrino-preset-web, you can override and augment the build by creating a JS module which overrides the config.
#### Vendoring
@ -269,7 +269,7 @@ load();
This preset is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
containing all resources for developing Neutrino and its core presets. Follow the
[contributing guide](/contributing/README.md) for details.
[contributing guide](../../contributing/README.md) for details.
[npm-image]: https://img.shields.io/npm/v/neutrino-preset-react.svg
[npm-downloads]: https://img.shields.io/npm/dt/neutrino-preset-react.svg

10
docs/presets/neutrino-preset-web/README.md

@ -40,7 +40,7 @@
## Project Layout
`neutrino-preset-web` follows the standard [project layout](/project-layout.md) specified by Neutrino. This
`neutrino-preset-web` follows the standard [project layout](../../project-layout.md) specified by Neutrino. This
means that by default all project source code should live in a directory named `src` in the root of the
project. This includes JavaScript files, CSS stylesheets, images, and any other assets that would be available
to your compiled project.
@ -155,7 +155,7 @@ modification during development.
## Customizing
To override the build configuration, start with the documentation on [customization](/customization/README.md).
To override the build configuration, start with the documentation on [customization](../../customization/README.md).
`neutrino-preset-web` creates some conventions to make overriding the configuration easier once you are ready to make
changes.
@ -188,7 +188,7 @@ The following is a list of plugins and their identifiers which can be overridden
### Simple customization
By following the [customization guide](/customization/simple.md) and knowing the rule, loader, and plugin IDs above,
By following the [customization guide](../../customization/simple.md) and knowing the rule, loader, and plugin IDs above,
you can override and augment the build directly from package.json.
#### Vendoring
@ -237,7 +237,7 @@ _Example: Change the application mount ID from "root" to "app":_
### Advanced configuration
By following the [customization guide](/customization/advanced.md) and knowing the rule, loader, and plugin IDs above,
By following the [customization guide](../../customization/advanced.md) and knowing the rule, loader, and plugin IDs above,
you can override and augment the build by creating a JS module which overrides the config.
#### Vendoring
@ -272,7 +272,7 @@ module.exports = neutrino => {
This preset is part of the [neutrino-dev](https://github.com/mozilla-neutrino/neutrino-dev) repository, a monorepo
containing all resources for developing Neutrino and its core presets. Follow the
[contributing guide](/contributing/README.md) for details.
[contributing guide](../../contributing/README.md) for details.
[npm-image]: https://img.shields.io/npm/v/neutrino-preset-web.svg
[npm-downloads]: https://img.shields.io/npm/dt/neutrino-preset-web.svg

2
docs/project-layout.md

@ -9,7 +9,7 @@ development process for new projects as quick as possible. This is broken up int
Each of these directories is set up via convention by a Neutrino preset, but each can be customized as
desired by overriding the preset's configuration or using a different preset. See
[Custom Configuration](/custom-configuration.md) for detailed instructions.
[Custom Configuration](./customization/README.md) for detailed instructions.
## Source Code

4
docs/usage.md

@ -6,7 +6,7 @@ scripts defined in your project's `package.json`.
## Setup
After completing the [installation](/installation.md) of Neutrino and your Neutrino preset, you will
After completing the [installation](./installation.md) of Neutrino and your Neutrino preset, you will
want to define some scripts in your project's `package.json` in order to simply build your project.
In a typical project:
@ -93,7 +93,7 @@ Putting this into your `package.json` will allow you to test your project using
```
Using the command `neutrino test` will execute every test file located in your
[testing directory](/project-layout#Testing). You may also provide to this command the specific test files you wish
[testing directory](./project-layout#Testing). You may also provide to this command the specific test files you wish
to run individually. It is important to note that when combined with the `--presets` parameter, you should use two
dashes after the last preset to denote the end of the presets and the beginning of the test files.

Loading…
Cancel
Save