Prettier Markdown files #3022

lipis · 2017-10-13T20:52:43Z

Some of the JS examples though must be ignored.

Let me know what would be the default print size and I'll edit the JS examples that needs to be reverted and not prettified.

azz · 2017-10-13T23:50:25Z

commands.md

 ### ifBreak

 Prints something if the current group breaks and something else if it doesn't.

 ```js
-ifBreak(";", " ")
+ifBreak(";", " ");


Hmm, these are kind of expressions. Not statements, which is probably why there wasn't a semicolon here. Not the end of the world, I guess.

azz · 2017-10-13T23:54:57Z

docs/usage.md


 #### Option 2. [pre-commit](https://github.com/pre-commit/pre-commit)

 Copy the following config into your `.pre-commit-config.yaml` file:

 ```yaml
-


Is this a bug, @ikatyang?

No, the leading/trailing new line does nothing there.

http://spec.commonmark.org/0.25/#example-96

azz · 2017-10-13T23:57:30Z

editors/vim/README.md

@@ -4,36 +4,41 @@
 <summary><strong>Table of Contents</strong></summary>

 - [Vim and Prettier integration](#vim-and-prettier-integration)
-  * [Neoformat](#neoformat)


This is autogenerated so should be ignored.

azz · 2017-10-13T23:58:48Z

editors/vim/README.md


 vim-prettier executable resolution:

 1. Tranverse parents and search for Prettier installation inside `node_modules`
-2. Look for a global prettier installation


I still think we should preserve this choice @ikatyang

~~Should we add an option for it?~~ or just print ordered numbers if the second number equals the first number +1?

EDIT: auto-detection should be better.

I'd say a good enough heuristic could be always use 1. iff items[1].number === "1.".

Opened #3024

azz · 2017-10-14T00:02:02Z

commands.md

-Include this anywhere to force all parent groups to break. See `group`
-for more info. Example:
+Include this anywhere to force all parent groups to break. See `group` for more
+info. Example:

 ```js


Ignore this block

fixed.. maybe you can delete this comment so it won't confuse us

azz · 2017-10-14T00:02:47Z

commands.md


 ```js
-concat(["{", lineSuffix(" // comment"), lineSuffixBoundary, "}", hardline])
+concat(["{", lineSuffix(" // comment"), lineSuffixBoundary, "}", hardline]);
 ```

 will output

 ```js


Ignore this block

azz · 2017-10-14T00:03:12Z

commands.md

 ```

 will output

 ```js
-{ // comment
+{
+  // comment
 }
 ```

 and **not**

 ```js


Ignore this block

azz · 2017-10-14T00:04:03Z

docs/usage.md


 ## Excluding code from formatting

-A JavaScript comment of `// prettier-ignore` will exclude the next node in the abstract syntax tree from formatting.
+A JavaScript comment of `// prettier-ignore` will exclude the next node in the
+abstract syntax tree from formatting.

 For example:

 ```js


Ignore this block

azz · 2017-10-14T00:06:45Z

CHANGELOG.md

@@ -2,748 +2,769 @@

 [link](https://github.com/prettier/prettier/compare/1.7.3...1.7.4)

-* Force template literals to break after \` for styled-components (#2926 by duailibe)


@ikatyang Should we pick * as unordered list instead?

I think we should do some research for this too, just like the decision we made for strong/emphasis.

Good idea. Done! #2943 (comment)

Opened #3025

azz

Looks good. As you mentioned there are a handful of places we want to ignore.

ikatyang · 2017-10-14T09:11:40Z

editors/webstorm/README.md

@@ -1,45 +1,59 @@
 ## Configure External Tool

-https://blog.jetbrains.com/webstorm/2016/08/using-external-tools/
+[https://blog.jetbrains.com/webstorm/2016/08/using-external-tools/](https://blog.jetbrains.com/webstorm/2016/08/using-external-tools/)


This is a bug, we should print it with shortcut-style, i.e. <https://...>, opened #3030.

…ettier/md * 'master' of https://github.com/prettier/prettier: feat(cli): add `--loglevel` option (prettier#2992)

lipis · 2017-10-14T10:07:20Z

also I'm not sure how to incorporate markdown with the precommit hook.. but maybe we can do that after the official release..

azz · 2017-10-22T08:59:38Z

@lipis there have been some changes to Markdown since you opened this PR. Did you want to re-run this with the current master?

lipis · 2017-10-22T10:20:53Z

yes I will do that once I'll get in front of my computer..

lipis · 2017-10-23T18:23:54Z

should I fix anything else?

lydell · 2017-10-23T18:43:45Z

Yes, we need to figure out how to fix the "TOC should be up-to-date" test (which currently causes Travis to fail).

azz · 2017-10-23T22:12:49Z

Would this work?

<!-- prettier-ignore -->
<details>
...

lipis · 2017-10-23T22:36:25Z

would be nice.. html support is coming soon as well as it looks like ;)

azz · 2017-10-24T10:46:12Z

README.md


 For example:

 ```js
-matrix(


This block need to be <-- prettier-ignore -->d.

azz · 2017-10-24T10:46:55Z

README.md

@@ -731,8 +878,8 @@ The options to the configuration file are the same the [API options](#options).
 JSON:

 ```json
-// .prettierrc


We don't want this comment to move. Perhaps  this too.

azz · 2017-10-24T10:48:27Z

editors/atom.md

@@ -1 +1,2 @@
-See https://github.com/prettier/prettier-atom
+See
+[https://github.com/prettier/prettier-atom](https://github.com/prettier/prettier-atom)


@ikatyang This one intentional? I thought it was fixed.

It seems @lipis is still using the old prettier? The list style in this PR is still -, and so does this link.

…ettier/md * 'master' of https://github.com/prettier/prettier: Fix util.getStringWidth for falsy input (prettier#3092)

lipis · 2017-10-24T11:11:21Z

Updated.. the following didn't work.. so I rerun the yarn toc afterwards..

<!-- prettier-ignore -->
<details>
...

azz · 2017-10-24T11:41:21Z

README.md

@@ -640,7 +640,12 @@ abstract syntax tree from formatting.
 For example:

 ```js
-matrix(1, 0, 0, 0, 1, 0, 0, 0, 1);


The ignore comment needs to be above the fence otherwise it will show up in the rendered version.

azz · 2017-10-24T11:42:37Z

README.md

@@ -878,9 +878,9 @@ The options to the configuration file are the same the [API options](#options).
 JSON:

 ```json
-{
 <!-- prettier-ignore -->
 // .prettierrc


Same here. Ignore needs to move above ```json

lipis · 2017-10-30T17:18:20Z

I think it's ready

ikatyang · 2017-10-31T03:30:19Z

I think it'd be better to wait for the 1.8 release (or use current bin/prettier.js temporarily) to setup prettier --list-different <markdown-files> on travis in this PR to ensure our markdowns are formatted correctly.

lipis · 2017-10-31T13:34:27Z

Makes sense!

lipis · 2017-11-08T12:33:05Z

I think I will close that.. but the issue still remains.. we need to format all the md files with Prettier.. and use hooks for the future ones..

Prettier Markdown files

212c74e

lipis mentioned this pull request Oct 13, 2017

feat: support markdown #2943

Merged

8 tasks

azz reviewed Oct 13, 2017

View reviewed changes

azz reviewed Oct 14, 2017

View reviewed changes

commands.md Outdated

```

will output

```js

{ // comment

{

// comment

}

```

and **not**

```js

Copy link

Member

azz Oct 14, 2017

Choose a reason for hiding this comment

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

Ignore this block

azz reviewed Oct 14, 2017

View reviewed changes

azz requested changes Oct 14, 2017

View reviewed changes

ikatyang mentioned this pull request Oct 14, 2017

Determine which number style of ordered list to use based on original source #3024

Closed

ikatyang reviewed Oct 14, 2017

View reviewed changes

Merge branch 'master' of https://github.com/prettier/prettier into pr…

ce4dff7

…ettier/md * 'master' of https://github.com/prettier/prettier: feat(cli): add `--loglevel` option (prettier#2992)

ikatyang mentioned this pull request Oct 14, 2017

Auto-link should be printed as-is #3030

Closed

lipis added 2 commits October 14, 2017 11:17

Code review

04d5382

Autogenerated toc

ac8c61e

lipis mentioned this pull request Oct 14, 2017

The autogenerated toc in the main README.md should comply with the new markdown parser #3031

Closed

azz added the status:awaiting response Issues that require answers to questions from maintainers before action can be taken label Oct 22, 2017

lipis added 3 commits October 23, 2017 13:47

Sync with master

bc71e45

vim

87405c6

Revert autogenerated

f68b730

azz removed the status:awaiting response Issues that require answers to questions from maintainers before action can be taken label Oct 23, 2017

Revert toc

0f4a601

azz reviewed Oct 24, 2017

View reviewed changes

README.md Outdated

For example:

```js

matrix(

Copy link

Member

azz Oct 24, 2017

Choose a reason for hiding this comment

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

This block need to be <-- prettier-ignore -->d.

azz reviewed Oct 24, 2017

View reviewed changes

lipis added 5 commits October 24, 2017 13:53

Merge branch 'master' of https://github.com/prettier/prettier into pr…

a2cc27d

…ettier/md * 'master' of https://github.com/prettier/prettier: Fix util.getStringWidth for falsy input (prettier#3092)

Review

5736692

atom.md

f8767f9

Review

b82a818

more ignore

f150437

azz reviewed Oct 24, 2017

View reviewed changes

Prettier ignore outside of the fence

95e5b60

SimenB mentioned this pull request Oct 28, 2017

Fix docs overlapping navigation jestjs/jest#4781

Merged

ikatyang mentioned this pull request Nov 7, 2017

chore(deps): update prettier to 1.8.0 #3167

Merged

lipis closed this Nov 8, 2017

lipis deleted the prettier/md branch November 8, 2017 12:33

ikatyang mentioned this pull request Nov 9, 2017

chore: setup markdown formatting #3224

Merged

lock bot added the locked-due-to-inactivity Please open a new issue and fill out the template instead of commenting. label Jan 19, 2019

lock bot locked as resolved and limited conversation to collaborators Jan 19, 2019

		@@ -2,748 +2,769 @@

		[link](https://github.com/prettier/prettier/compare/1.7.3...1.7.4)

		* Force template literals to break after \` for styled-components (#2926 by duailibe)

Prettier Markdown files #3022

Prettier Markdown files #3022

Conversation

lipis commented Oct 13, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

azz Oct 13, 2017 • edited

Choose a reason for hiding this comment

ikatyang Oct 14, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

azz left a comment

Choose a reason for hiding this comment

ikatyang Oct 14, 2017 • edited

Choose a reason for hiding this comment

lipis commented Oct 14, 2017

azz commented Oct 22, 2017

lipis commented Oct 22, 2017

lipis commented Oct 23, 2017

lydell commented Oct 23, 2017

azz commented Oct 23, 2017

lipis commented Oct 23, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

azz Oct 24, 2017 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lipis commented Oct 24, 2017

Choose a reason for hiding this comment

Choose a reason for hiding this comment

lipis commented Oct 30, 2017

ikatyang commented Oct 31, 2017

lipis commented Oct 31, 2017

lipis commented Nov 8, 2017

lipis commented Oct 13, 2017 •

edited

azz Oct 13, 2017 •

edited

ikatyang Oct 14, 2017 •

edited

ikatyang Oct 14, 2017 •

edited

azz Oct 24, 2017 •

edited