feat(support-info): add `options` field #3433

ikatyang · 2017-12-07T10:16:41Z

This will unblock #3352. cc @duailibe

And I'm going to refactor options.js/cli-constant.js using getSupportInfo() in another PR to address #3350 (comment), #3340 (comment), and #3352 (comment).

* add `showDeprecated` option * add `showUnreleased` option

duailibe · 2017-12-07T11:35:42Z

Thank you for doing this!

Looks good to me, but I'd wait for another review :)

lydell · 2017-12-07T12:04:29Z

src/cli-constant.js

@@ -386,17 +387,12 @@ const minimistOptions = {
    )
 };

-const usageSummary = `
-Usage: prettier [options] [file/glob ...]
+const usageSummary = dedent(`


Isn’t dedent supposed to be used as a template tag?

duailibe · 2017-12-07T14:16:23Z

If we can get it in 1.9.2, we wouldn't have to wait another release to do #3352 (since the site's playground only uses the released version)

duailibe · 2017-12-07T18:45:19Z

src/support.js

+    description: "Which parser to use.",
+    choices: [
+      { value: "flow", description: "Flow" },
+      { value: "babylon", description: "JavaScript" },


Can you reorder flow and babylon? Just to keep the same order from the docs and the playground?

(not that it makes that much difference but still...)

duailibe · 2017-12-08T02:39:48Z

I've started working on the playground rewrite and it's looking pretty good, I have it almost done with preact, with no build steps :-)

One of the problems I faced now is when in a PR preview, which version should I pass to getSupportInfo to get the unreleased opts? It would be nice if it was always getSupportInfo() so I don't have to special case PR previews or the official playground, but we don't bump the package.json until we release a new version...

(Actually the PR preview changes the package.json to pr+XXXX but that can be changed.. I don't know what we should change it to)

I can't simply append -beta in PR previews because new stuff is likely to be on 1.10 and then new options would not be enabled (1.9.1-beta < 1.10). So another option would be to always bump the minor when inside a PR preview, but that might be confusing to users because we may do a patch release before the next minor? I'm not sure what I should do...

Let me know if I wasn't clear!

ikatyang · 2017-12-08T03:41:00Z

getSupportInfo(null, { showUnreleased: !!isPR })?

duailibe · 2017-12-09T01:59:18Z

@ikatyang that would work. I hope that’s not too hackish though

ikatyang · 2017-12-12T13:58:41Z

Anyone wants to do another review? I'd like to merge it and send a followed up PR.

duailibe · 2017-12-15T02:41:10Z

@azz @lydell @suchipi anyone have any comments about this? Can we merge it?

azz · 2017-12-16T02:03:18Z

tests_integration/__tests__/support-info.js

+      const previousVersion = testVersions[index - 1];
+      const previousInfo = getCoreInfo(previousVersion);
+      test(`with version ${previousVersion} -> ${version}`, () => {
+        expect(snapshotDiff(previousInfo, info)).toMatchSnapshot();


Neat idea with snapshotDiff!

azz · 2017-12-16T02:09:42Z

Unless I'm reading this wrong we now have two copies of each option definition (cli-constant.js and support.js)?

ikatyang · 2017-12-16T02:18:21Z

I have a followed up PR for it, see ikatyang/prettier@feat/support-options...ikatyang:refactor/options, or should I add them in this PR?

duailibe · 2017-12-29T23:47:21Z

I fixed all the conflicts, @azz can you take a look?

I had to change the getSupportInfo.. I'm not sure how useful it is to load external plugins there since the information is about prettier's own functionality?

This unblocks #3573

azz · 2017-12-30T10:22:41Z

We need to split it into multiple files:

src/common/options.js
- --parser
- --print-width
- --tab-width
- --use-tabs
- --insert-pragma
- --require-pragma
laguage-js/options.js:
- --no-semi
- --single-quote
- --no-bracket-spacing
- --jsx-bracket-same-line
- --arrow-parens
- --trailing-comma
language-markdown/options.js
- --prose-wrap

And then expose them as options on the printer objects.

j-f1 · 2017-12-30T12:15:12Z

--single-quote is also used by Markdown and CSS.
--no-bracket-spacing is also used by GraphQL.

I’m wondering if it would be a good idea to enable --prose-wrap on JSDoc comments.

azz · 2017-12-30T12:42:25Z

That's fine, we should re-declare those flags in the printers that use them.

azz · 2017-12-30T13:59:34Z

src/language-js/index.js

@@ -132,6 +133,7 @@ const printers = {
 };

 module.exports = {
+  options,


options should probably be a property of a specific printer rather than a plugin, as a plugin can provide multiple languages/printers. In this case it should be printers.estree.options

duailibe · 2017-12-31T03:48:09Z

@ikatyang is there anything else to tackle on this PR?

ikatyang · 2017-12-31T04:31:24Z

@duailibe No, the CLI option generation will be in another PR. This one should be good to go.

ikatyang added 6 commits December 7, 2017 14:32

refactor: rename supportTable with supportLanguages

637cc3e

refactor: use dedent

976503a

test: reduce unnecessary data

644b733

feat(support-info): add options field

e099397

* add `showDeprecated` option * add `showUnreleased` option

test: snapshot diff

669db3b

fix(support): add missing since

f4efee0

duailibe approved these changes Dec 7, 2017

View reviewed changes

fix: add missing category

e883da3

lydell reviewed Dec 7, 2017

View reviewed changes

refactor: use template tag

259f463

duailibe added this to the 1.9.2 milestone Dec 7, 2017

fix: trailingComma:true should redirect to trailingComma:es5

ffd09e4

duailibe reviewed Dec 7, 2017

View reviewed changes

refactor: reorder parser

e32ac72

duailibe removed this from the 1.9.2 milestone Dec 11, 2017

duailibe mentioned this pull request Dec 11, 2017

1.9 Release #3333

Closed

5 tasks

ikatyang force-pushed the feat/support-options branch from 74b0503 to e32ac72 Compare December 12, 2017 13:57

azz reviewed Dec 16, 2017

View reviewed changes

Merge branch 'master' into feat/support-options

78b7ab9

azz approved these changes Dec 16, 2017

View reviewed changes

azz mentioned this pull request Dec 19, 2017

Use a monorepo and separate out Prettier’s components #3511

Closed

ikatyang and others added 2 commits December 19, 2017 20:34

Merge branch 'master' into feat/support-options

7a36c4d

Merge branch 'master' into feat/support-options

5f404a8

duailibe mentioned this pull request Dec 29, 2017

New playground #3573

Merged

refactor: fix linting

be3ae05

refactor: move options

9543207

azz requested changes Dec 30, 2017

View reviewed changes

ikatyang added 2 commits December 30, 2017 22:14

refactor: move options to printers

31673c1

Merge branch 'master' into feat/support-options

5297037

azz approved these changes Dec 30, 2017

View reviewed changes

ikatyang mentioned this pull request Dec 30, 2017

fix(playground): fix report version #3614

Merged

azz merged commit 6c0dd74 into prettier:master Dec 31, 2017

ikatyang deleted the feat/support-options branch December 31, 2017 04:38

This was referenced Dec 31, 2017

1.10 Release #3603

Closed

Support options in external plugins #3615

Closed

azz added this to the 1.10 milestone Jan 7, 2018

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

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat(support-info): add `options` field #3433

feat(support-info): add `options` field #3433

ikatyang commented Dec 7, 2017

duailibe commented Dec 7, 2017 •

edited

lydell Dec 7, 2017 •

edited

duailibe commented Dec 7, 2017

duailibe Dec 7, 2017

duailibe commented Dec 8, 2017 •

edited

ikatyang commented Dec 8, 2017

duailibe commented Dec 9, 2017

ikatyang commented Dec 12, 2017

duailibe commented Dec 15, 2017

azz Dec 16, 2017

azz commented Dec 16, 2017 •

edited

ikatyang commented Dec 16, 2017

duailibe commented Dec 29, 2017 •

edited

azz commented Dec 30, 2017

j-f1 commented Dec 30, 2017 •

edited

azz commented Dec 30, 2017

azz Dec 30, 2017

duailibe commented Dec 31, 2017

ikatyang commented Dec 31, 2017

feat(support-info): add options field #3433

feat(support-info): add options field #3433

Conversation

ikatyang commented Dec 7, 2017

duailibe commented Dec 7, 2017 • edited

lydell Dec 7, 2017 • edited

Choose a reason for hiding this comment

duailibe commented Dec 7, 2017

duailibe Dec 7, 2017

Choose a reason for hiding this comment

duailibe commented Dec 8, 2017 • edited

ikatyang commented Dec 8, 2017

duailibe commented Dec 9, 2017

ikatyang commented Dec 12, 2017

duailibe commented Dec 15, 2017

azz Dec 16, 2017

Choose a reason for hiding this comment

azz commented Dec 16, 2017 • edited

ikatyang commented Dec 16, 2017

duailibe commented Dec 29, 2017 • edited

azz commented Dec 30, 2017

j-f1 commented Dec 30, 2017 • edited

azz commented Dec 30, 2017

azz Dec 30, 2017

Choose a reason for hiding this comment

duailibe commented Dec 31, 2017

ikatyang commented Dec 31, 2017

feat(support-info): add `options` field #3433

feat(support-info): add `options` field #3433

duailibe commented Dec 7, 2017 •

edited

lydell Dec 7, 2017 •

edited

duailibe commented Dec 8, 2017 •

edited

azz commented Dec 16, 2017 •

edited

duailibe commented Dec 29, 2017 •

edited

j-f1 commented Dec 30, 2017 •

edited