Implement getSupportInfo() and use it for inference by azz · Pull Request #3033 · prettier/prettier

azz · 2017-10-14T14:21:24Z

TODO

CLI
Docs

This PR adds a new function to the prettier API: getSupportInfo().

It returns an object, currently with a languages property, which is an array of:

{
  name: "SCSS", // display name for the language
  since: "1.4.0", // version it was added to prettier
  parsers: ["scss"], // built-in parsers that support this language
  group: "CSS", // metadata used to group related languages
  tmScope: "source.scss", // TextMate scope, used by prettier-atom
  aceMode: "scss",
  codemirrorMode: "css",
  codemirrorMimeType: "text/x-scss",
  extensions: [".scss"], // extensions used in parser inference
  files: [], // filenames without extensions, also used in parser inference
  liguistLanguageId: 329, // GitHub linguist language ID
  vscodeLanguageIds: ["scss"] // used by prettier-vscode
},

getSupportInfo accepts an optional argument, version, e.g. prettier.getSupportInfo("1.4.0"), this will filter the list to only include languages that version 1.4.0 of prettier support. This includes changing less/scss/css parsers back to postcss.

In addition, this table is now used by Prettier internally to perform parser inference based on filename and extension.

Maybe we should also add a CLI version?

Closes #3023
Fixes #3058

ikatyang · 2017-10-14T15:20:54Z

Maybe we should also add a CLI version?

Yeah, the CLI seems necessary for non-JS editor, e.g. vim-prettier.

ikatyang · 2017-10-14T14:25:49Z

package.json

    "postcss-values-parser": "1.3.1",
    "remark-frontmatter": "1.1.0",
    "remark-parse": "4.0.0",
+    "semver": "^5.4.1",


It seems your yarn is always too lazy to pin them. 😂

Has save-prefix "" been removed from yarn?

No, it works for me (v1.2.1).

ikatyang · 2017-10-14T15:00:39Z

src/support.js

+
+  const languages = supportTable
+    .filter(language => {
+      return language.since && semver.gte(version, language.since);


Can be simplified to language => language...

ikatyang · 2017-10-14T15:06:32Z

tests_integration/__tests__/support-info.js

+
+  testVersions.forEach(version => {
+    test(`with version ${version}`, () => {
+      expect(prettier.getSupportInfo(version)).toMatchSnapshot();


Can we only snapshot the { [language]: parsers } information? It's hard to read its snapshot and other information seems unrelated here.

ikatyang · 2017-10-14T15:19:25Z

src/support.js

+// Based on:
+// https://github.com/github/linguist/blob/master/lib/linguist/languages.yml
+
+const supportTable = [


Maybe we should add a script to generate this table from linguist so that it'd be easy to update in the future.

Maybe. I ended up changing quite a few things though, added more extensions, filenames, added groups, etc.

suchipi · 2017-10-14T21:41:51Z

src/support.js

+  },
+  {
+    name: "HTML",
+    since: undefined, // unreleased


No plans to release this yet (in eg 1.8.0), right?

Probably not. Depends on #2976

mitermayer · 2017-10-19T04:21:19Z

Are there any plans on having this function exposed through the CLI ? I believe the info table supplied by the CLI does not need to be so verbose so would probably be a much simpler output than the one returned by getSupportInfo()

azz · 2017-10-19T07:09:39Z

What kind of output would you expect from the CLI version?

azz · 2017-10-29T01:21:55Z

Ping @mitermayer, would JSON output or a parseable table be good for CLI?

mitermayer · 2017-10-29T05:32:00Z

Hi @azz,

Vim has a function json_decode() however to better leverage that we need to make sure that the output of getSupportInfo() would be a plain json with nothing else, otherwise we would still need to use regex to extract the JSON node, and in that case a table would make more sense.

This is the documentation info on json_decode() function for vim 8:

json_decode({string})					*json_decode()*
		This parses a JSON formatted string and returns the equivalent
		in Vim values.  See |json_encode()| for the relation between
		JSON and Vim values.
		The decoding is permissive:
		- A trailing comma in an array and object is ignored.
		- More floating point numbers are recognized, e.g. "1." for
		  "1.0".
		However, a duplicate key in an object is not allowed. *E938*
		The result must be a valid Vim type:
		- An empty object member name is not allowed.
		- Duplicate object member names are not allowed.

mitermayer · 2017-10-29T05:36:01Z

I actually am not sure we can leverage from the json_decode to parse arbitrary json. So I would suggest printing as a table since it would also be nicer for CLI users, and on the vim side we can use regex to extract info output

azz · 2017-10-29T05:37:24Z

Let's just do

console.log(
  prettier.format(
    JSON.stringify(prettier.getSupportInfo()),
    { parser: "json" }
  )
);

?

mitermayer · 2017-10-29T05:40:48Z

We can always start with that, then i can try to to add that to vim-prettier and see how that goes. Can always submit another PR later to allow the getSupportInfo() cli command to accept other output formats other than JSON if required

azz · 2017-11-02T08:53:59Z

@mitermayer do you want to give this a try with json_decode before we merge?

mitermayer · 2017-11-02T16:45:54Z

I won't be able to test this today, so feel free to merge it as it is! Can always wait for next release in case this is not sufficient.

azz added 2 commits October 15, 2017 01:11

Implement getSupportInfo() and use it for inference

5f5997c

Add comment with source of languages.yml

2e1621e

ikatyang reviewed Oct 14, 2017

View reviewed changes

azz added 4 commits October 15, 2017 02:26

Fix build, pin semver

4899c4b

Simplify test snapshots

9d9aeb7

Remove stray 'type' property

f38b38a

Fix parser being overwritten

e829523

suchipi approved these changes Oct 14, 2017

View reviewed changes

azz mentioned this pull request Oct 18, 2017

JSDoc: Wrong indent for already incorrect indents #3054

Closed

azz self-assigned this Oct 18, 2017

This was referenced Oct 18, 2017

The experimental HTML support unexpectedly leaks through the CLI #3058

Closed

Expose list of supported parsers, etc. #3023

Closed

Don't infer unreleased parser from extension

afdca30

azz mentioned this pull request Oct 22, 2017

Add older versions of Prettier to the playground #3082

Closed

Add CLI and docs for support info

46e68aa

azz mentioned this pull request Oct 29, 2017

1.8 Release #3117

Closed

9 tasks

azz merged commit e436ada into prettier:master Nov 3, 2017

azz deleted the lang-support branch November 3, 2017 07:06

zimme mentioned this pull request Nov 7, 2017

Use getSupportInfo from prettier prettier/prettier-eslint#137

Closed

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

Uh oh!

Conversation

azz commented Oct 14, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

ikatyang commented Oct 14, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

mitermayer commented Oct 19, 2017

Uh oh!

azz commented Oct 19, 2017

Uh oh!

azz commented Oct 29, 2017

Uh oh!

mitermayer commented Oct 29, 2017

Uh oh!

mitermayer commented Oct 29, 2017

Uh oh!

azz commented Oct 29, 2017

Uh oh!

mitermayer commented Oct 29, 2017

Uh oh!

azz commented Nov 2, 2017

Uh oh!

mitermayer commented Nov 2, 2017

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

azz commented Oct 14, 2017 •

edited

Loading