diff --git a/docs/creating-presets.md b/docs/creating-presets.md index dca6190..0da0cab 100644 --- a/docs/creating-presets.md +++ b/docs/creating-presets.md @@ -44,11 +44,11 @@ with and makes changes through this config, which is all available to your prese Neutrino exposes events for various stages of the build process your preset can hook into **if necessary**. -- `prestart`: Triggered prior to creating a development bundle or launching a dev server. +- `prestart`: Triggered before creating a development bundle or launching a dev server. - `start`: Triggered after the development bundle has finished or the dev server has been stopped. -- `prebuild`: Triggered prior to creating a production build. +- `prebuild`: Triggered before creating a production build. - `build`: Triggered after the production build has completed. -- `pretest`: Triggered prior to invoking any test runners. +- `pretest`: Triggered before invoking any test runners. - `test`: Triggered when test runners can start, or after they have all completed. _Example: Log to the console when a build finishes._ @@ -64,7 +64,7 @@ module.exports = neutrino => { If your preset depends on other Neutrino presets, or you are creating a preset that is a combination of multiple presets, you can install them as dependencies and simply call them from your preset, providing them with your Neutrino instance. When users install your preset, they will bring along your dependencies defined with your package without -needing to also include your extended presets in their own commands. +needing also to include your extended presets in their own commands. _Example: Define a Neutrino preset which combines Node.js and Mocha presets._ @@ -140,7 +140,7 @@ module.exports = neutrino => { ## Working with paths When working with paths, remember that your preset will be running in the context of a project. You should take care -to define application paths by referencing the current working directory with `process.cwd()`. For example if you +to define application paths by referencing the current working directory with `process.cwd()`. For example, if you wanted to work with the project's "src" directory, you would merge the path via `path.join(process.cwd(), 'src')` ## Loader and Babel modules diff --git a/docs/installation.md b/docs/installation.md index 82a7f72..1702d68 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -3,7 +3,7 @@ ## Requirements Installing Neutrino requires Node.js v6+, and either [Yarn](https://yarnpkg.com/lang/en/docs/install/) or -npm. At a minimum you will be installing Neutrino and a Neutrino preset, such as `neutrino-preset-react`. +npm. At a minimum, you will be installing Neutrino and a Neutrino preset, such as `neutrino-preset-react`. ## Yarn Installation diff --git a/docs/project-layout.md b/docs/project-layout.md index f7890d1..dcd82a6 100644 --- a/docs/project-layout.md +++ b/docs/project-layout.md @@ -1,19 +1,19 @@ # Project Layout -Out of the box Neutrino presets expect a project to have a particular structure in order to make the +Out of the box, Neutrino presets expect a project to have a particular structure to make the development process for new projects as quick as possible. This is broken up into three directories: - Source code - Build assets - Testing -Each of these directories are set up via convention by a Neutrino preset, but each can be customized as +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. ## Source Code -By default Neutrino presets expect all project source code to live in a directory named `src` in the +By default, Neutrino presets expect all project source code to 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. diff --git a/docs/usage.md b/docs/usage.md index 21d805f..93fb078 100644 --- a/docs/usage.md +++ b/docs/usage.md @@ -72,7 +72,7 @@ Putting this into your `package.json` will allow you to build your project using Neutrino provides the command `neutrino test` for invoking a set of tests included in your project. Using `neutrino test` sets the Node.js environment variable to `test` using the `NODE_ENV` environment variable, which is available in your project source code. How your source code is built and consumed from tests -is determined by the preset your are using. Running suites that are built the same as source files are encouraged +is determined by the preset you are using. Running suites that are built the same as source files are encouraged to use a Neutrino-compatible preset. Neutrino currently provides three core testing presets: Karma, Jest, and Mocha. ```bash @@ -104,7 +104,7 @@ neutrino test --presets PRESET_A PRESET_B -- a_test.js b_test.js ## Using multiple presets All Neutrino commands support the `--presets` command line parameter, but having to specify this for each script target -can be cumbersome, especially if you have many presets. Fortunately Neutrino also supports specifying presets using the +can be cumbersome, especially if you have many presets. Fortunately, Neutrino also supports specifying presets using the `config.presets` field in your project's package.json file. By omitting the `--presets` flag and specifying a `config.presets` array, every call to a Neutrino command will look up which presets are configured in your package.json.