Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(blog): 1.15 release #5296

Merged
merged 104 commits into from Nov 7, 2018
Merged
Show file tree
Hide file tree
Changes from 92 commits
Commits
Show all changes
104 commits
Select commit Hold shift + click to select a range
8fe4dff
docs(blog): 1.15 release draft
ikatyang Oct 25, 2018
34ae239
docs: add placeholder for #5290
ikatyang Oct 25, 2018
63a8ebd
docs: add placeholder for #5244
ikatyang Oct 25, 2018
49948c0
docs: add placeholder for #5251
ikatyang Oct 25, 2018
f3a3df9
docs: add placeholder for #5303
ikatyang Oct 26, 2018
d457ca3
Describe my PRs
j-f1 Oct 26, 2018
a33da78
Format!
j-f1 Oct 26, 2018
97f7c38
Case (#2)
lipis Oct 26, 2018
b944ad5
Group languages
lipis Oct 26, 2018
04577e0
docs: add placeholder for #5304
ikatyang Oct 27, 2018
635c802
docs: add description for HTML/Vue/Angular
ikatyang Oct 28, 2018
9ff013e
docs: update options
ikatyang Oct 30, 2018
777d853
style: fix linting
ikatyang Oct 30, 2018
866e963
docs: add TODOs
ikatyang Oct 30, 2018
ebc16d0
docs: add description for MDX
ikatyang Oct 30, 2018
e2a7def
docs: add description
ikatyang Oct 30, 2018
dbf03a5
docs: add description
ikatyang Oct 30, 2018
e7b7ff5
docs: add description
ikatyang Oct 30, 2018
911b43f
docs: add description
ikatyang Oct 30, 2018
7d5dc51
docs: add description
ikatyang Oct 30, 2018
5a5c91e
docs: add description
ikatyang Oct 30, 2018
e52dfb8
docs: add missing `<!-- prettier-ignore -->`
ikatyang Oct 30, 2018
5d8a951
docs: add description
ikatyang Oct 31, 2018
678ca36
docs: add description
ikatyang Oct 31, 2018
2524990
docs: add prettier-ignore
ikatyang Oct 31, 2018
b912bcc
docs: add description
ikatyang Oct 31, 2018
8dc7318
docs: add description
ikatyang Oct 31, 2018
145e1f7
docs: add description
ikatyang Oct 31, 2018
c3391ec
docs: add description
ikatyang Oct 31, 2018
1510a62
docs: add description
ikatyang Oct 31, 2018
8e5c22f
docs: add description
ikatyang Oct 31, 2018
8e559f1
docs: add description
ikatyang Oct 31, 2018
b3b57c8
docs: add description
ikatyang Oct 31, 2018
5fd1c6b
docs: add description
ikatyang Oct 31, 2018
6499621
docs: add descriptions
ikatyang Oct 31, 2018
b9ff12d
docs: add description
ikatyang Oct 31, 2018
99dce93
docs: colorful cli demo
ikatyang Oct 31, 2018
fe46ed5
docs: add description
ikatyang Oct 31, 2018
635e062
docs: add description
ikatyang Oct 31, 2018
a0c47b1
docs: consistent title
ikatyang Oct 31, 2018
b066fea
docs: merge items
ikatyang Oct 31, 2018
c7befd4
docs: add description
ikatyang Oct 31, 2018
4ebe4ce
docs: add description
ikatyang Oct 31, 2018
3541da9
docs: add description
ikatyang Oct 31, 2018
c1216a6
docs: add description
ikatyang Oct 31, 2018
6f955c4
docs: add description
ikatyang Oct 31, 2018
fafc916
docs: add description
ikatyang Oct 31, 2018
fd639de
docs: add description
ikatyang Oct 31, 2018
8dc930a
docs: add description
ikatyang Oct 31, 2018
fa22499
docs: add description
ikatyang Oct 31, 2018
deca40d
docs: add description
ikatyang Oct 31, 2018
41fea68
docs: add description
ikatyang Oct 31, 2018
b25ae8c
docs: add description
ikatyang Oct 31, 2018
da2c942
docs: add description
ikatyang Oct 31, 2018
16360b2
docs: add description
ikatyang Oct 31, 2018
9e23584
docs(ignore): add HTML
ikatyang Nov 1, 2018
5d525c3
docs: add description
ikatyang Nov 1, 2018
4201921
docs: add description
ikatyang Nov 1, 2018
a32a694
docs: add description
ikatyang Nov 1, 2018
1630c75
docs: add description
ikatyang Nov 1, 2018
996845d
docs: add description
ikatyang Nov 1, 2018
9aa630e
docs: add description
ikatyang Nov 1, 2018
aa4029d
docs: add description
ikatyang Nov 1, 2018
d5e454f
docs: add description
ikatyang Nov 1, 2018
244f6b3
docs: add description
ikatyang Nov 1, 2018
0c7d474
docs: add description
ikatyang Nov 1, 2018
95d2d06
Merge branch 'master' into docs/blog-1.15
ikatyang Nov 1, 2018
6b97643
docs: add description
ikatyang Nov 1, 2018
1a7a86f
docs: add description
ikatyang Nov 1, 2018
9af3e81
docs: add TODOs
ikatyang Nov 2, 2018
3f41901
docs: add description
ikatyang Nov 3, 2018
326504c
docs: add description
ikatyang Nov 3, 2018
3f4d5b3
docs: reorder
ikatyang Nov 3, 2018
088b0e6
docs: add description
ikatyang Nov 3, 2018
9a088f4
docs: add description
ikatyang Nov 3, 2018
5a1634a
Remove U+0008 BACKSPACE characters from 1.15 blog post
lydell Nov 3, 2018
96fd630
docs: add description
ikatyang Nov 3, 2018
25602f7
Merge branch 'docs/blog-1.15' of https://github.com/ikatyang/prettier…
ikatyang Nov 3, 2018
f75dcc8
docs: add missing prettier-ignore
ikatyang Nov 3, 2018
0e1401c
docs: add missing reference
ikatyang Nov 3, 2018
2a79f19
docs: add description for JSX splitting fix PR
lydell Nov 3, 2018
99548b9
docs: add summary
ikatyang Nov 3, 2018
951608c
Merge branch 'docs/blog-1.15' of https://github.com/ikatyang/prettier…
ikatyang Nov 3, 2018
3fbb849
docs: update item title
ikatyang Nov 3, 2018
d1ca6b5
docs: remove unnecessary newlines
ikatyang Nov 3, 2018
1f2d20d
docs: add references for regression fixes
ikatyang Nov 4, 2018
00506cc
docs: tweak wording
ikatyang Nov 4, 2018
c040bf3
Tweak wording and syntax highlighting
j-f1 Nov 4, 2018
c27fdfb
docs: fix linting
ikatyang Nov 4, 2018
da7216a
docs: add description for #4798
ikatyang Nov 4, 2018
3f35cda
docs: add thanks
ikatyang Nov 4, 2018
e8a134b
Final wording tweaks
j-f1 Nov 4, 2018
ce8d395
Proofread blog post and fix grammar issues
suchipi Nov 5, 2018
21ef4a1
Fix prettier issue
suchipi Nov 5, 2018
90beb63
docs: update thanks
ikatyang Nov 5, 2018
833268f
Merge branch 'master' into docs/blog-1.15
ikatyang Nov 5, 2018
652a1d3
chore(playground): remove temporary workaround for #5345
ikatyang Nov 5, 2018
6719f97
Merge branch 'master' into docs/blog-1.15
ikatyang Nov 6, 2018
444e9ea
docs: add description for #5327
ikatyang Nov 6, 2018
cb717ad
fix minor typos
existentialism Nov 6, 2018
60e8682
docs: update blog post date
ikatyang Nov 6, 2018
f74dc4c
docs: update for #5356
ikatyang Nov 6, 2018
d16895a
Merge branch 'master' into docs/blog-1.15
ikatyang Nov 6, 2018
7c2142d
docs: update thanks
ikatyang Nov 6, 2018
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions .pre-commit-hooks.yaml
Expand Up @@ -5,6 +5,7 @@
files: "\\.(\
css|less|scss\
|graphql|gql\
|html\
|js|jsx\
|json\
|md|markdown|mdown|mkdn\
Expand Down
40 changes: 27 additions & 13 deletions README.md
Expand Up @@ -4,19 +4,33 @@

<p align="center">
<em>
JavaScript
· Flow
· TypeScript
· CSS
· SCSS
· Less
· JSX
· Vue
· GraphQL
· JSON
· Markdown
· YAML
· <a href="https://prettier.io/docs/en/plugins.html">
JavaScript
· TypeScript
· Flow
· JSX
· JSON
</em>
<br />
<em>
CSS
· SCSS
· Less
</em>
<br />
<em>
HTML
· Vue
· Angular
</em>
<br />
<em>
GraphQL
· Markdown
· YAML
</em>
<br />
<em>
<a href="https://prettier.io/docs/en/plugins.html">
Your favorite language?
</a>
</em>
Expand Down
19 changes: 19 additions & 0 deletions docs/ignore.md
Expand Up @@ -53,6 +53,25 @@ matrix(
</div>
```

## HTML

```html
<!-- prettier-ignore -->
<div class="x" >hello world</div >

<!-- prettier-ignore-attribute -->
<div
(mousedown)=" onStart ( ) "
(mouseup)=" onEnd ( ) "
></div>

<!-- prettier-ignore-attribute (mouseup) -->
<div
(mousedown)="onStart()"
(mouseup)=" onEnd ( ) "
></div>
```

## CSS

```css
Expand Down
2 changes: 1 addition & 1 deletion docs/language-support.md
Expand Up @@ -7,6 +7,6 @@ Prettier attempts to support all JavaScript language features, including non-sta

All of JSX and Flow syntax is supported. In fact, the test suite in `tests/flow` _is_ the entire Flow test suite and they all pass.

Prettier also supports [TypeScript](https://www.typescriptlang.org/), CSS, [Less](http://lesscss.org/), [SCSS](http://sass-lang.com), [Vue](https://vuejs.org/), [JSON](http://json.org/), [GraphQL](http://graphql.org/), [Markdown](http://commonmark.org), and [YAML](http://yaml.org/).
Prettier also supports [TypeScript](https://www.typescriptlang.org/), CSS, [Less](http://lesscss.org/), [SCSS](http://sass-lang.com), HTML, [Vue](https://vuejs.org/), [Angular](https://angular.io/), [JSON](http://json.org/), [GraphQL](http://graphql.org/), [Markdown](http://commonmark.org), and [YAML](http://yaml.org/).

The minimum version of TypeScript supported is 2.1.3 as it introduces the ability to have leading `|` for type definitions which prettier outputs.
29 changes: 24 additions & 5 deletions docs/options.md
Expand Up @@ -183,13 +183,12 @@ Valid options:
- `"json-stringify"` (same parser as `"json"`, but outputs like `JSON.stringify`) _Since v1.13.0_
- `"graphql"` (via [graphql/language](https://github.com/graphql/graphql-js/tree/master/src/language)) _Since v1.5.0_
- `"markdown"` (via [remark-parse](https://github.com/wooorm/remark/tree/master/packages/remark-parse)) _Since v1.8.0_
- `"vue"` (uses several parsers) _Since 1.10.0_
- `"mdx"` (via [remark-parse](https://github.com/wooorm/remark/tree/master/packages/remark-parse) and [@mdx-js/mdx](https://github.com/mdx-js/mdx/tree/master/packages/mdx)) _Since v1.15.0_
- `"html"` (via [angular-html-parser](https://github.com/ikatyang/angular-html-parser/tree/master/packages/angular-html-parser)) _Since 1.15.0_
- `"vue"` (same parser as `"html"`, but also formats vue-specific syntax) _Since 1.10.0_
- `"angular"` (same parser as `"html"`, but also formats angular-specific syntax via [angular-estree-parser](https://github.com/ikatyang/angular-estree-parser)) _Since 1.15.0_
- `"yaml"` (via [yaml](https://github.com/eemeli/yaml) and [yaml-unist-parser](https://github.com/ikatyang/yaml-unist-parser)) _Since 1.14.0_

<!-- TODO: Uncomment and move below "markdown" above when 1.15.0 is released.
- `"mdx"` (same parser as `"markdown"`, with some custom overrides) _Since 1.15.0_
-->

[Custom parsers](api.md#custom-parser-api) are also supported. _Since v1.5.0_

| Default | CLI Override | API Override |
Expand Down Expand Up @@ -263,3 +262,23 @@ Valid options:
| Default | CLI Override | API Override |
| ------------ | ----------------------------------------------------------- | ----------------------------------------------------------- |
| `"preserve"` | <code>--prose-wrap <always&#124;never&#124;preserve></code> | <code>proseWrap: "<always&#124;never&#124;preserve>"</code> |

## HTML Whitespace Sensitivity

_available in v1.15.0+_
Copy link
Member

@j-f1 j-f1 Oct 26, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if these should be formatted differently (grammar-wise)? Perhaps:

First available in vX.X.X. Deprecated in vY.Y.Y

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since there's a +, I guess it should be fine?


Specify the global whitespace sensitivity for HTML files, see [whitespace-sensitive formatting] for more info.

TODO: update the blog post link

[whitespace-sensitive formatting]: https://prettier.io/blog/2018/10/00/1.15.0.html#whitespace-sensitive-formatting

Valid options:

- `"css"` - Respect the default value of CSS `display` property.
- `"strict"` - Whitespaces are considered sensitive.
- `"ignore"` - Whitespaces are considered insensitive.

| Default | CLI Override | API Override |
| ------- | ------------------------------------------------------------------------ | ----------------------------------------------------------------------- |
| `"css"` | <code>--html-whitespace-sensitivity <css&#124;strict&#124;ignore></code> | <code>htmlWhitespaceSensitivity: "<css&#124;strict&#124;ignore>"</code> |