Fix docs code style (#7937)

This commit is contained in:
fisker Cheung authored and GitHub committed 2020-04-03 18:44:03 +08:00
1 parent 54766f11a2
commit 096c28f080
4 files changed
+44 -40

No files matched your search

+3 -3
View File
@@ -52,14 +52,14 @@ prettier --check "src/**/*.js"
Console output if all files are formatted: Console output if all files are formatted:
``` ```console
Checking formatting... Checking formatting...
All matched files use Prettier code style! All matched files use Prettier code style!
``` ```
Console output if some of the files require re-formatting: Console output if some of the files require re-formatting:
``` ```console
Checking formatting... Checking formatting...
src/fileA.js src/fileA.js
src/fileB.js src/fileB.js
@@ -192,7 +192,7 @@ _abc.css_
_shell_ _shell_
```bash ```console
$ cat abc.css | prettier --stdin-filepath abc.css $ cat abc.css | prettier --stdin-filepath abc.css
.name { .name {
display: none; display: none;
+20 -20
View File
@@ -79,9 +79,9 @@ Valid options:
- `"consistent"` - If at least one property in an object requires quotes, quote all properties. - `"consistent"` - If at least one property in an object requires quotes, quote all properties.
- `"preserve"` - Respect the input use of quotes in object properties. - `"preserve"` - Respect the input use of quotes in object properties.
| Default | CLI Override | API Override | | Default | CLI Override | API Override |
| ------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | | ------------- | ----------------------------------------------- | ----------------------------------------------- |
| `"as-needed"` | <code>--quote-props <as-needed&#124;consistent&#124;preserve></code> | <code>quoteProps: "<as-needed&#124;consistent&#124;preserve>"</code> | | `"as-needed"` | `--quote-props <as-needed|consistent|preserve>` | `quoteProps: "<as-needed|consistent|preserve>"` |
## JSX Quotes ## JSX Quotes
@@ -103,9 +103,9 @@ Valid options:
- `"none"` - No trailing commas. - `"none"` - No trailing commas.
- `"all"` - Trailing commas wherever possible (including function arguments). This requires node 8 or a [transform](https://babeljs.io/docs/plugins/syntax-trailing-function-commas/). - `"all"` - Trailing commas wherever possible (including function arguments). This requires node 8 or a [transform](https://babeljs.io/docs/plugins/syntax-trailing-function-commas/).
| Default | CLI Override | API Override | | Default | CLI Override | API Override |
| ------- | ------------------------------------------------------ | ------------------------------------------------------ | | ------- | --------------------------------- | --------------------------------- |
| `"es5"` | <code>--trailing-comma <es5&#124;none&#124;all></code> | <code>trailingComma: "<es5&#124;none&#124;all>"</code> | | `"es5"` | `--trailing-comma <es5|none|all>` | `trailingComma: "<es5|none|all>"` |
## Bracket Spacing ## Bracket Spacing
@@ -129,7 +129,7 @@ Valid options:
- `true` - Example: - `true` - Example:
<!-- prettier-ignore --> <!-- prettier-ignore -->
``` ```jsx
<button <button
className="prettier-class" className="prettier-class"
id="prettier-id" id="prettier-id"
@@ -141,7 +141,7 @@ Valid options:
- `false` - Example: - `false` - Example:
<!-- prettier-ignore --> <!-- prettier-ignore -->
``` ```jsx
<button <button
className="prettier-class" className="prettier-class"
id="prettier-id" id="prettier-id"
@@ -166,9 +166,9 @@ Valid options:
- `"always"` - Always include parens. Example: `(x) => x` - `"always"` - Always include parens. Example: `(x) => x`
- `"avoid"` - Omit parens when possible. Example: `x => x` - `"avoid"` - Omit parens when possible. Example: `x => x`
| Default | CLI Override | API Override | | Default | CLI Override | API Override |
| ---------- | ----------------------------------------------- | ----------------------------------------------- | | ---------- | ------------------------------- | ------------------------------- |
| `"always"` | <code>--arrow-parens <always&#124;avoid></code> | <code>arrowParens: "<always&#124;avoid>"</code> | | `"always"` | `--arrow-parens <always|avoid>` | `arrowParens: "<always|avoid>"` |
At first glance, avoiding parentheses may look like a better choice because of less visual noise. At first glance, avoiding parentheses may look like a better choice because of less visual noise.
However, when Prettier removes parentheses, it becomes harder to add type annotations, extra arguments or default values as well as making other changes. However, when Prettier removes parentheses, it becomes harder to add type annotations, extra arguments or default values as well as making other changes.
@@ -292,9 +292,9 @@ Valid options:
- `"never"` - Do not wrap prose. - `"never"` - Do not wrap prose.
- `"preserve"` - Wrap prose as-is. _First available in v1.9.0_ - `"preserve"` - Wrap prose as-is. _First available in v1.9.0_
| Default | CLI Override | API Override | | Default | CLI Override | API Override |
| ------------ | ----------------------------------------------------------- | ----------------------------------------------------------- | | ------------ | -------------------------------------- | -------------------------------------- |
| `"preserve"` | <code>--prose-wrap <always&#124;never&#124;preserve></code> | <code>proseWrap: "<always&#124;never&#124;preserve>"</code> | | `"preserve"` | `--prose-wrap <always|never|preserve>` | `proseWrap: "<always|never|preserve>"` |
## HTML Whitespace Sensitivity ## HTML Whitespace Sensitivity
@@ -310,9 +310,9 @@ Valid options:
- `"strict"` - Whitespaces are considered sensitive. - `"strict"` - Whitespaces are considered sensitive.
- `"ignore"` - Whitespaces are considered insensitive. - `"ignore"` - Whitespaces are considered insensitive.
| Default | CLI Override | API Override | | Default | CLI Override | API Override |
| ------- | ------------------------------------------------------------------------ | ----------------------------------------------------------------------- | | ------- | --------------------------------------------------- | -------------------------------------------------- |
| `"css"` | <code>--html-whitespace-sensitivity <css&#124;strict&#124;ignore></code> | <code>htmlWhitespaceSensitivity: "<css&#124;strict&#124;ignore>"</code> | | `"css"` | `--html-whitespace-sensitivity <css|strict|ignore>` | `htmlWhitespaceSensitivity: "<css|strict|ignore>"` |
## Vue files script and style tags indentation ## Vue files script and style tags indentation
@@ -361,6 +361,6 @@ Valid options:
- `"auto"` - Maintain existing line endings - `"auto"` - Maintain existing line endings
(mixed values within one file are normalised by looking at what's used after the first line) (mixed values within one file are normalised by looking at what's used after the first line)
| Default | CLI Override | API Override | | Default | CLI Override | API Override |
| ------- | ----------------------------------------------------------- | ---------------------------------------------------------- | | ------- | --------------------------------- | -------------------------------- |
| `"lf"` | <code>--end-of-line <lf&#124;crlf&#124;cr&#124;auto></code> | <code>endOfLine: "<lf&#124;crlf&#124;cr&#124;auto>"</code> | | `"lf"` | `--end-of-line <lf|crlf|cr|auto>` | `endOfLine: "<lf|crlf|cr|auto>"` |
+17 -15
View File
@@ -13,7 +13,7 @@ See the [vim-prettier](https://github.com/prettier/vim-prettier) readme for inst
The best way to install Neoformat is with your favorite plugin manager for Vim, such as [vim-plug](https://github.com/junegunn/vim-plug): The best way to install Neoformat is with your favorite plugin manager for Vim, such as [vim-plug](https://github.com/junegunn/vim-plug):
``` ```vim
Plug 'sbdchd/neoformat' Plug 'sbdchd/neoformat'
``` ```
@@ -21,7 +21,7 @@ Run `:Neoformat` or `:Neoformat prettier` in a supported file to run Prettier.
To have Neoformat run Prettier on save: To have Neoformat run Prettier on save:
``` ```vim
autocmd BufWritePre *.js Neoformat autocmd BufWritePre *.js Neoformat
``` ```
@@ -32,7 +32,7 @@ You can also make Vim format your code more frequently, by setting an `autocmd`
For example, you can format on both of the above events together with `BufWritePre` like this: For example, you can format on both of the above events together with `BufWritePre` like this:
``` ```vim
autocmd BufWritePre,TextChanged,InsertLeave *.js Neoformat autocmd BufWritePre,TextChanged,InsertLeave *.js Neoformat
``` ```
@@ -40,7 +40,7 @@ See `:help autocmd-events` in Vim for details.
It's recommended to use a [config file](configuration.md), but you can also add options in your `.vimrc`: It's recommended to use a [config file](configuration.md), but you can also add options in your `.vimrc`:
``` ```vim
autocmd FileType javascript setlocal formatprg=prettier\ --single-quote\ --trailing-comma\ es5 autocmd FileType javascript setlocal formatprg=prettier\ --single-quote\ --trailing-comma\ es5
" Use formatprg when available " Use formatprg when available
let g:neoformat_try_formatprg = 1 let g:neoformat_try_formatprg = 1
@@ -54,7 +54,7 @@ ALE requires either Vim 8 or Neovim as ALE makes use of the asynchronous abiliti
The best way to install ALE is with your favorite plugin manager for Vim, such as [vim-plug](https://github.com/junegunn/vim-plug): The best way to install ALE is with your favorite plugin manager for Vim, such as [vim-plug](https://github.com/junegunn/vim-plug):
``` ```vim
Plug 'dense-analysis/ale' Plug 'dense-analysis/ale'
``` ```
@@ -64,7 +64,7 @@ ALE will try to use Prettier installed locally before looking for a global insta
Enable the Prettier fixer for the languages you use: Enable the Prettier fixer for the languages you use:
``` ```vim
let g:ale_fixers = { let g:ale_fixers = {
\ 'javascript': ['prettier'], \ 'javascript': ['prettier'],
\ 'css': ['prettier'], \ 'css': ['prettier'],
@@ -73,7 +73,7 @@ let g:ale_fixers = {
ALE supports both _linters_ and _fixers_. If you don't specify which _linters_ to run, **all available tools for all supported languages will be run**, and you might get a correctly formatted file with a bunch of lint errors. To disable this behavior you can tell ALE to run only linters you've explicitly configured (more info in the [FAQ](https://github.com/dense-analysis/ale/blob/ed8104b6ab10f63c78e49b60d2468ae2656250e9/README.md#faq-disable-linters)): ALE supports both _linters_ and _fixers_. If you don't specify which _linters_ to run, **all available tools for all supported languages will be run**, and you might get a correctly formatted file with a bunch of lint errors. To disable this behavior you can tell ALE to run only linters you've explicitly configured (more info in the [FAQ](https://github.com/dense-analysis/ale/blob/ed8104b6ab10f63c78e49b60d2468ae2656250e9/README.md#faq-disable-linters)):
``` ```vim
let g:ale_linters_explicit = 1 let g:ale_linters_explicit = 1
``` ```
@@ -81,13 +81,13 @@ You can then run `:ALEFix` in a JavaScript or CSS file to run Prettier.
To have ALE run Prettier on save: To have ALE run Prettier on save:
``` ```vim
let g:ale_fix_on_save = 1 let g:ale_fix_on_save = 1
``` ```
It's recommended to use a [config file](configuration.md), but you can also add options in your `.vimrc`: It's recommended to use a [config file](configuration.md), but you can also add options in your `.vimrc`:
``` ```vim
let g:ale_javascript_prettier_options = '--single-quote --trailing-comma es5' let g:ale_javascript_prettier_options = '--single-quote --trailing-comma es5'
``` ```
@@ -96,26 +96,28 @@ let g:ale_javascript_prettier_options = '--single-quote --trailing-comma es5'
Prettier extension for [coc.nvim](https://github.com/neoclide/coc.nvim) which requires neovim or vim8.1. Prettier extension for [coc.nvim](https://github.com/neoclide/coc.nvim) which requires neovim or vim8.1.
Install coc.nvim with your favorite plugin manager, such as [vim-plug](https://github.com/junegunn/vim-plug): Install coc.nvim with your favorite plugin manager, such as [vim-plug](https://github.com/junegunn/vim-plug):
``` ```vim
Plug 'neoclide/coc.nvim', {'do': { -> coc#util#install()}} Plug 'neoclide/coc.nvim', {'do': { -> coc#util#install()}}
``` ```
And install coc-prettier by command: And install coc-prettier by command:
``` ```vim
CocInstall coc-prettier CocInstall coc-prettier
``` ```
Setup `Prettier` command in your `init.vim` or `.vimrc` Setup `Prettier` command in your `init.vim` or `.vimrc`
``` ```vim
command! -nargs=0 Prettier :call CocAction('runCommand', 'prettier.formatFile') command! -nargs=0 Prettier :call CocAction('runCommand', 'prettier.formatFile')
``` ```
Update your `coc-settings.json` for languages that you want format on save. Update your `coc-settings.json` for languages that you want format on save.
``` ```json
"coc.preferences.formatOnSaveFiletypes": ["css", "Markdown"], {
"coc.preferences.formatOnSaveFiletypes": ["css", "Markdown"]
}
``` ```
[coc-prettier](https://github.com/neoclide/coc-prettier) have same configurations of [prettier-vscode](https://github.com/prettier/prettier-vscode), open `coc-settings.json` by `:CocConfig` to get autocompletion support. [coc-prettier](https://github.com/neoclide/coc-prettier) have same configurations of [prettier-vscode](https://github.com/prettier/prettier-vscode), open `coc-settings.json` by `:CocConfig` to get autocompletion support.
@@ -124,7 +126,7 @@ Update your `coc-settings.json` for languages that you want format on save.
If you want something really bare-bones, you can create a custom key binding. In this example, `gp` (mnemonic: "get pretty") is used to run prettier (with options) in the currently active buffer: If you want something really bare-bones, you can create a custom key binding. In this example, `gp` (mnemonic: "get pretty") is used to run prettier (with options) in the currently active buffer:
``` ```vim
nnoremap gp :silent %!prettier --stdin-filepath % --trailing-comma all --single-quote<CR> nnoremap gp :silent %!prettier --stdin-filepath % --trailing-comma all --single-quote<CR>
``` ```
+4 -2
View File
@@ -5,14 +5,16 @@ title: Watching For Changes
If you prefer to have prettier watch for changes from the command line you can use a package like [onchange](https://www.npmjs.com/package/onchange). For example: If you prefer to have prettier watch for changes from the command line you can use a package like [onchange](https://www.npmjs.com/package/onchange). For example:
``` ```bash
npx onchange '**/*.js' -- npx prettier --write {{changed}} npx onchange '**/*.js' -- npx prettier --write {{changed}}
``` ```
or add the following to your `package.json` or add the following to your `package.json`
```json ```json
{
"scripts": { "scripts": {
"prettier-watch": "onchange '**/*.js' -- prettier --write {{changed}}" "prettier-watch": "onchange '**/*.js' -- prettier --write {{changed}}"
}, }
}
``` ```