Docs: Polish @wordpress/scripts README and related tutorial #14484
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
gziolo
requested review from
aduth,
ajitbohra,
chrisvanpatten,
mkaz,
nerrad,
oandregal,
notnownikki,
ntwb and
youknowriad
as code owners
gziolo
commented
Mar 18, 2019
| @@ -1,16 +1,16 @@ | |||
| # JavaScript Build Setup | |||
|
|
|||
| This page covers how to set up your development environment to use the ESNext syntax. ESNext is JavaScript code written using features that are only available in a specification greater than ECMAScript 5 (ES5 for short) or that includes a custom syntax such as [JSX](https://reactjs.org/docs/introducing-jsx.html). | |||
| This page covers how to set up your development environment to use the ESNext and [JSX](https://reactjs.org/docs/introducing-jsx.html) syntaxes. ESNext is JavaScript code written using features that are only available in a specification greater than ECMAScript 5 (ES5 for short). JSX is a custom syntax extension to JavaScript which helps you to describe what the UI should look like. | |||
There was a problem hiding this comment.
@mkaz - I found this statement confusing and updated it to make it explicit that JSX is not a subset of ESNext as one could understand before.
youknowriad
approved these changes
Mar 18, 2019
mcsf
reviewed
Mar 18, 2019
docs/designers-developers/developers/tutorials/javascript/js-build-setup.md
Show resolved
Hide resolved
| ## webpack config | ||
| #### Advanced information | ||
|
|
||
| It uses [Jest](https://jestjs.io/) behind the scenes and you are able to utilize all of its [CLI options](https://jestjs.io/docs/en/cli.html). You can also run `./node_modules/.bin/wp-scripts test-unit-js --help` or `npm run test:unit:help` (as presented earlier) to view all of the available options. By default, it uses the set of recommended options defined in [@wordpress/jest-preset-default](https://www.npmjs.com/package/@wordpress/jest-preset-default) npm package. You can override them with your own options as described in [Jest documentation](https://jestjs.io/docs/en/configuration). Learn more in the [Advanced Usage](#advanced-usage) section. |
There was a problem hiding this comment.
See suggestions for test-e2e.
youknowriad
pushed a commit
that referenced
this pull request
Mar 20, 2019
* Clarify that JSX is not part of ESNext in JS build setup tutorial * Docs: Polish @wordpress/scripts README and related tutorial * Emphasize that build and start scripts should be used with the default config * Add Advanced information subsection for all scripts * Link the existing tutorial for build and start scripts
youknowriad
pushed a commit
that referenced
this pull request
Mar 20, 2019
* Clarify that JSX is not part of ESNext in JS build setup tutorial * Docs: Polish @wordpress/scripts README and related tutorial * Emphasize that build and start scripts should be used with the default config * Add Advanced information subsection for all scripts * Link the existing tutorial for build and start scripts
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This PR adds a few changes to the existing docs:
@wordpress/scriptspackage's README@wordpress/scriptspackage provides the recommended config files