Skip to content

Commit 0473b7d

Browse files
committed
Run formatting over *.md files to prevent conflicts
1 parent 61c0ba3 commit 0473b7d

File tree

7 files changed

+65
-67
lines changed

7 files changed

+65
-67
lines changed

README.md

+32-30
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@
22

33
Create React apps with no build configuration.
44

5-
* [Creating an App](#creating-an-app) – How to create a new app.
6-
* [User Guide](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md) – How to develop apps bootstrapped with Create React App.
5+
- [Creating an App](#creating-an-app) – How to create a new app.
6+
- [User Guide](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md) – How to develop apps bootstrapped with Create React App.
77

88
Create React App works on macOS, Windows, and Linux.<br>
99
If something doesn’t work, please [file an issue](https://github.com/facebook/create-react-app/issues/new).
@@ -16,7 +16,7 @@ cd my-app
1616
npm start
1717
```
1818

19-
*([npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) comes with npm 5.2+ and higher, see [instructions for older npm versions](https://gist.github.com/gaearon/4064d3c23a77c74a3614c498a8bb1c5f))*
19+
_([npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) comes with npm 5.2+ and higher, see [instructions for older npm versions](https://gist.github.com/gaearon/4064d3c23a77c74a3614c498a8bb1c5f))_
2020

2121
Then open [http://localhost:3000/](http://localhost:3000/) to see your app.<br>
2222
When you’re ready to deploy to production, create a minified bundle with `npm run build`.
@@ -44,21 +44,23 @@ To create a new app, you may choose one of the following methods:
4444
npx create-react-app my-app
4545
```
4646

47-
*([npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) comes with npm 5.2+ and higher, see [instructions for older npm versions](https://gist.github.com/gaearon/4064d3c23a77c74a3614c498a8bb1c5f))*
47+
_([npx](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b) comes with npm 5.2+ and higher, see [instructions for older npm versions](https://gist.github.com/gaearon/4064d3c23a77c74a3614c498a8bb1c5f))_
4848

4949
### npm
5050

5151
```sh
5252
npm init react-app my-app
5353
```
54-
*`npm init <initializer>` is available in npm 6+*
54+
55+
_`npm init <initializer>` is available in npm 6+_
5556

5657
### Yarn
5758

5859
```sh
5960
yarn create react-app my-app
6061
```
61-
*`yarn create` is available in Yarn 0.25+*
62+
63+
_`yarn create` is available in Yarn 0.25+_
6264

6365
It will create a directory called `my-app` inside the current folder.<br>
6466
Inside that directory, it will generate the initial project structure and install the transitive dependencies:
@@ -173,24 +175,24 @@ Please refer to the [User Guide](https://github.com/facebook/create-react-app/bl
173175

174176
## Philosophy
175177

176-
* **One Dependency:** There is just one build dependency. It uses Webpack, Babel, ESLint, and other amazing projects, but provides a cohesive curated experience on top of them.
178+
- **One Dependency:** There is just one build dependency. It uses Webpack, Babel, ESLint, and other amazing projects, but provides a cohesive curated experience on top of them.
177179

178-
* **No Configuration Required:** You don't need to configure anything. Reasonably good configuration of both development and production builds is handled for you so you can focus on writing code.
180+
- **No Configuration Required:** You don't need to configure anything. Reasonably good configuration of both development and production builds is handled for you so you can focus on writing code.
179181

180-
* **No Lock-In:** You can “eject” to a custom setup at any time. Run a single command, and all the configuration and build dependencies will be moved directly into your project, so you can pick up right where you left off.
182+
- **No Lock-In:** You can “eject” to a custom setup at any time. Run a single command, and all the configuration and build dependencies will be moved directly into your project, so you can pick up right where you left off.
181183

182184
## What’s Included?
183185

184186
Your environment will have everything you need to build a modern single-page React app:
185187

186-
* React, JSX, ES6, and Flow syntax support.
187-
* Language extras beyond ES6 like the object spread operator.
188-
* Autoprefixed CSS, so you don’t need `-webkit-` or other prefixes.
189-
* A fast interactive unit test runner with built-in support for coverage reporting.
190-
* A live development server that warns about common mistakes.
191-
* A build script to bundle JS, CSS, and images for production, with hashes and sourcemaps.
192-
* An offline-first [service worker](https://developers.google.com/web/fundamentals/getting-started/primers/service-workers) and a [web app manifest](https://developers.google.com/web/fundamentals/engage-and-retain/web-app-manifest/), meeting all the [Progressive Web App](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md#making-a-progressive-web-app) criteria. (*Note: Using the service worker is opt-in as of `[email protected]` and higher*)
193-
* Hassle-free updates for the above tools with a single dependency.
188+
- React, JSX, ES6, and Flow syntax support.
189+
- Language extras beyond ES6 like the object spread operator.
190+
- Autoprefixed CSS, so you don’t need `-webkit-` or other prefixes.
191+
- A fast interactive unit test runner with built-in support for coverage reporting.
192+
- A live development server that warns about common mistakes.
193+
- A build script to bundle JS, CSS, and images for production, with hashes and sourcemaps.
194+
- An offline-first [service worker](https://developers.google.com/web/fundamentals/getting-started/primers/service-workers) and a [web app manifest](https://developers.google.com/web/fundamentals/engage-and-retain/web-app-manifest/), meeting all the [Progressive Web App](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md#making-a-progressive-web-app) criteria. (_Note: Using the service worker is opt-in as of `[email protected]` and higher_)
195+
- Hassle-free updates for the above tools with a single dependency.
194196

195197
Check out [this guide](https://github.com/nitishdayal/cra_closer_look) for an overview of how these tools fit together.
196198

@@ -200,25 +202,25 @@ The tradeoff is that **these tools are preconfigured to work in a specific way**
200202

201203
Create React App is a great fit for:
202204

203-
* **Learning React** in a comfortable and feature-rich development environment.
204-
* **Starting new single-page React applications.**
205-
* **Creating examples** with React for your libraries and components.
205+
- **Learning React** in a comfortable and feature-rich development environment.
206+
- **Starting new single-page React applications.**
207+
- **Creating examples** with React for your libraries and components.
206208

207209
Here’s a few common cases where you might want to try something else:
208210

209-
* If you want to **try React** without hundreds of transitive build tool dependencies, consider [using a single HTML file or an online sandbox instead](https://reactjs.org/docs/try-react.html).
211+
- If you want to **try React** without hundreds of transitive build tool dependencies, consider [using a single HTML file or an online sandbox instead](https://reactjs.org/docs/try-react.html).
210212

211-
* If you need to **integrate React code with a server-side template framework** like Rails or Django, or if you’re **not building a single-page app**, consider using [nwb](https://github.com/insin/nwb), or [Neutrino](https://neutrino.js.org/) which are more flexible. For Rails specifically, you can use [Rails Webpacker](https://github.com/rails/webpacker).
213+
- If you need to **integrate React code with a server-side template framework** like Rails or Django, or if you’re **not building a single-page app**, consider using [nwb](https://github.com/insin/nwb), or [Neutrino](https://neutrino.js.org/) which are more flexible. For Rails specifically, you can use [Rails Webpacker](https://github.com/rails/webpacker).
212214

213-
* If you need to **publish a React component**, [nwb](https://github.com/insin/nwb) can [also do this](https://github.com/insin/nwb#react-components-and-libraries), as well as [Neutrino's react-components preset](https://neutrino.js.org/packages/react-components/).
215+
- If you need to **publish a React component**, [nwb](https://github.com/insin/nwb) can [also do this](https://github.com/insin/nwb#react-components-and-libraries), as well as [Neutrino's react-components preset](https://neutrino.js.org/packages/react-components/).
214216

215-
* If you want to do **server rendering** with React and Node.js, check out [Next.js](https://github.com/zeit/next.js/) or [Razzle](https://github.com/jaredpalmer/razzle). Create React App is agnostic of the backend, and just produces static HTML/JS/CSS bundles.
217+
- If you want to do **server rendering** with React and Node.js, check out [Next.js](https://github.com/zeit/next.js/) or [Razzle](https://github.com/jaredpalmer/razzle). Create React App is agnostic of the backend, and just produces static HTML/JS/CSS bundles.
216218

217-
* If your website is **mostly static** (for example, a portfolio or a blog), consider using [Gatsby](https://www.gatsbyjs.org/) instead. Unlike Create React App, it pre-renders the website into HTML at the build time.
219+
- If your website is **mostly static** (for example, a portfolio or a blog), consider using [Gatsby](https://www.gatsbyjs.org/) instead. Unlike Create React App, it pre-renders the website into HTML at the build time.
218220

219-
* If you want to use **TypeScript**, consider using [create-react-app-typescript](https://github.com/wmonk/create-react-app-typescript).
221+
- If you want to use **TypeScript**, consider using [create-react-app-typescript](https://github.com/wmonk/create-react-app-typescript).
220222

221-
* Finally, if you need **more customization**, check out [Neutrino](https://neutrino.js.org/) and its [React preset](https://neutrino.js.org/packages/react/).
223+
- Finally, if you need **more customization**, check out [Neutrino](https://neutrino.js.org/) and its [React preset](https://neutrino.js.org/packages/react/).
222224

223225
All of the above tools can work with little to no configuration.
224226

@@ -237,9 +239,9 @@ Check out [Create React Native App](https://github.com/react-community/create-re
237239

238240
We are grateful to the authors of existing related projects for their ideas and collaboration:
239241

240-
* [@eanplatter](https://github.com/eanplatter)
241-
* [@insin](https://github.com/insin)
242-
* [@mxstbr](https://github.com/mxstbr)
242+
- [@eanplatter](https://github.com/eanplatter)
243+
- [@insin](https://github.com/insin)
244+
- [@mxstbr](https://github.com/mxstbr)
243245

244246
## License
245247

packages/babel-preset-react-app/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
This package includes the Babel preset used by [Create React App](https://github.com/facebook/create-react-app).<br>
44
Please refer to its documentation:
55

6-
* [Getting Started](https://github.com/facebook/create-react-app/blob/master/README.md#getting-started) – How to create a new app.
7-
* [User Guide](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md) – How to develop apps bootstrapped with Create React App.
6+
- [Getting Started](https://github.com/facebook/create-react-app/blob/master/README.md#getting-started) – How to create a new app.
7+
- [User Guide](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md) – How to develop apps bootstrapped with Create React App.
88

99
## Usage in Create React App Projects
1010

packages/confusing-browser-globals/README.md

+1-4
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,12 @@ handleClick() { // missing `event` argument
1818

1919
This package exports a list of globals that are often used by mistake. You can feed this list to a static analysis tool like ESLint to prevent their usage without an explicit `window.` qualifier.
2020

21-
2221
## Installation
2322

2423
```
2524
npm install --save confusing-browser-globals
2625
```
2726

28-
2927
## Usage
3028

3129
If you use Create React App, you don't need to configure anything, as this rule is already included in the default `eslint-config-react-app` preset.
@@ -38,11 +36,10 @@ var restrictedGlobals = require('confusing-browser-globals');
3836
module.exports = {
3937
rules: {
4038
'no-restricted-globals': ['error'].concat(restrictedGlobals),
41-
}
39+
},
4240
};
4341
```
4442

45-
4643
## License
4744

4845
MIT

packages/create-react-app/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@
33
This package includes the global command for [Create React App](https://github.com/facebook/create-react-app).<br>
44
Please refer to its documentation:
55

6-
* [Getting Started](https://github.com/facebook/create-react-app/blob/master/README.md#getting-started) – How to create a new app.
7-
* [User Guide](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md) – How to develop apps bootstrapped with Create React App.
6+
- [Getting Started](https://github.com/facebook/create-react-app/blob/master/README.md#getting-started) – How to create a new app.
7+
- [User Guide](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md) – How to develop apps bootstrapped with Create React App.

packages/eslint-config-react-app/README.md

+17-17
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,8 @@
33
This package includes the shareable ESLint configuration used by [Create React App](https://github.com/facebook/create-react-app).<br>
44
Please refer to its documentation:
55

6-
* [Getting Started](https://github.com/facebook/create-react-app/blob/master/README.md#getting-started) – How to create a new app.
7-
* [User Guide](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md) – How to develop apps bootstrapped with Create React App.
6+
- [Getting Started](https://github.com/facebook/create-react-app/blob/master/README.md#getting-started) – How to create a new app.
7+
- [User Guide](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md) – How to develop apps bootstrapped with Create React App.
88

99
## Usage in Create React App Projects
1010

@@ -18,19 +18,19 @@ If you want to use this ESLint configuration in a project not built with Create
1818

1919
First, install this package, ESLint and the necessary plugins.
2020

21-
```sh
22-
npm install --save-dev eslint-config-react-app babel-eslint@^7.2.3 eslint@^4.1.1 eslint-plugin-flowtype@^2.34.1 eslint-plugin-import@^2.6.0 eslint-plugin-jsx-a11y@^5.1.1 eslint-plugin-react@^7.1.0
23-
```
21+
```sh
22+
npm install --save-dev eslint-config-react-app babel-eslint@^7.2.3 eslint@^4.1.1 eslint-plugin-flowtype@^2.34.1 eslint-plugin-import@^2.6.0 eslint-plugin-jsx-a11y@^5.1.1 eslint-plugin-react@^7.1.0
23+
```
2424

2525
Then create a file named `.eslintrc` with following contents in the root folder of your project:
2626

27-
```js
28-
{
29-
"extends": "react-app"
30-
}
31-
```
27+
```js
28+
{
29+
"extends": "react-app"
30+
}
31+
```
3232

33-
That's it! You can override the settings from `eslint-config-react-app` by editing the `.eslintrc` file. Learn more about [configuring ESLint](http://eslint.org/docs/user-guide/configuring) on the ESLint website.
33+
That's it! You can override the settings from `eslint-config-react-app` by editing the `.eslintrc` file. Learn more about [configuring ESLint](http://eslint.org/docs/user-guide/configuring) on the ESLint website.
3434

3535
## Accessibility Checks
3636

@@ -57,11 +57,11 @@ The following rules from the [eslint-plugin-jsx-a11y](https://github.com/evcohen
5757

5858
If you want to enable even more accessibility rules, you can create an `.eslintrc` file in the root of your project with this content:
5959

60-
```json
61-
{
62-
"extends": ["react-app", "plugin:jsx-a11y/recommended"],
63-
"plugins": ["jsx-a11y"]
64-
}
65-
```
60+
```json
61+
{
62+
"extends": ["react-app", "plugin:jsx-a11y/recommended"],
63+
"plugins": ["jsx-a11y"]
64+
}
65+
```
6666

6767
However, if you are using [Create React App](https://github.com/facebook/create-react-app) and have not ejected, any additional rules will only be displayed in the [IDE integrations](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md#displaying-lint-output-in-the-editor), but not in the browser or the terminal.

packages/react-scripts/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,5 +3,5 @@
33
This package includes scripts and configuration used by [Create React App](https://github.com/facebook/create-react-app).<br>
44
Please refer to its documentation:
55

6-
* [Getting Started](https://github.com/facebook/create-react-app/blob/master/README.md#getting-started) – How to create a new app.
7-
* [User Guide](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md) – How to develop apps bootstrapped with Create React App.
6+
- [Getting Started](https://github.com/facebook/create-react-app/blob/master/README.md#getting-started) – How to create a new app.
7+
- [User Guide](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md) – How to develop apps bootstrapped with Create React App.

packages/react-scripts/fixtures/kitchensink/README.md

+9-10
Original file line numberDiff line numberDiff line change
@@ -18,11 +18,11 @@ Each time a new feature is added, it is advised to add at least one test coverin
1818

1919
Features are categorized by their scope:
2020

21-
- *env*, all those which deal with environment variables (e.g. `NODE_PATH`)
22-
23-
- *syntax*, all those which showcase a single EcmaScript syntax feature that is expected to be transpiled by **Babel**
21+
- _env_, all those which deal with environment variables (e.g. `NODE_PATH`)
2422

25-
- *webpack*, all those which make use of webpack settings, loaders or plugins
23+
- _syntax_, all those which showcase a single EcmaScript syntax feature that is expected to be transpiled by **Babel**
24+
25+
- _webpack_, all those which make use of webpack settings, loaders or plugins
2626

2727
### Using it as Unit Tests
2828

@@ -41,13 +41,12 @@ Test are written in `integration/{env|syntax|webpack}.test.js`, depending on the
4141

4242
For every test case added there is just a little chore to do:
4343

44-
- a `case` statement must be added in `src/App.js`, which simply perform a dynamic `import()` of the feature
44+
- a `case` statement must be added in `src/App.js`, which simply perform a dynamic `import()` of the feature
45+
46+
- add a test case in the appropriate integration test file, which calls and awaits `initDOM` with the previous `SwitchCase` string
4547

46-
- add a test case in the appropriate integration test file, which calls and awaits `initDOM` with the previous `SwitchCase` string
47-
4848
An usual flow for the test itself is something similar to:
49-
50-
- add an `id` attribute in a target HTML tag in the feature itself
5149

52-
- since `initDOM` returns a `Document` element, the previous `id` attribute is used to target the feature's DOM and `expect` accordingly
50+
- add an `id` attribute in a target HTML tag in the feature itself
5351

52+
- since `initDOM` returns a `Document` element, the previous `id` attribute is used to target the feature's DOM and `expect` accordingly

0 commit comments

Comments
 (0)