Add support for `prettierIgnore` key in `package.json` #12672

mataha · 2022-04-20T03:10:11Z

Description

Most of what I've wanted to write about had already been discussed in #3460; to keep it brief:

package.json is used more and more to store configuration for various development tools (including their gitignore-like files, if any) in lieu of dotfiles. Prettier provides a way to do that for its options, but not for the list of files to ignore itself.

This PR tries to amend that. Implementation is similar to ESLint - via prettierIgnore key.

Checklist

I’ve added tests to confirm my change works.
(If changing the API or CLI) I’ve documented the changes I’ve made (in the docs/ directory).
(If the change is user-facing) I’ve added my changes to changelog_unreleased/*/XXXX.md file following changelog_unreleased/TEMPLATE.md.
I’ve read the contributing guidelines.

✨Try the playground for this PR✨

mataha · 2022-06-11T00:05:55Z

Anyone?

trim21 · 2022-06-14T06:47:28Z

any progress 👀?

src/common/create-ignorer.js

src/common/get-key-content-or-null.js

fisker · 2022-07-18T07:54:32Z

src/cli/format.js

@@ -227,8 +227,13 @@ function format(context, input, opt) {
 }

 async function createIgnorerFromContextOrDie(context) {
+  const filepath = context.argv.filepath


Where is this filepath come from? There is no filepath flag in CLI at all.

There is - as --stdin-filepath - and it's used here as well.

filepath only exists when format stdin, when formatting files, it doesn't exist.

See formatFiles function, it calls createIgnorerFromContextOrDie on first line. I don't think it will work.

hendrikheil · 2022-08-23T08:01:02Z

I'd love to see this land. It would allow us to have pretterignore settings shared across projects. As we can already share settings, but not ignored files (https://prettier.io/docs/en/configuration.html#sharing-configurations)

Is there anything we could contribute to accelerate this?

kevinwolfcr · 2022-09-01T23:43:39Z

I would suggest adding this as an option within the configuration file (i.e. .prettierrc.json). That way, it can be included in shareable configs.

nickmccurdy · 2022-09-02T04:07:27Z

I don't think sharing ignored files would be a good practice, as ignored files tend to vary more based on a project's tooling usage than its style guide, and we wouldn't want to couple something unrelated to style to a config. ~~For reference, ESLint shareable configs also don't allow sharing ignores.~~ If you do have several projects with the same tooling, you can simply copy the .prettierignore (or with this, the package.json).

kevinwolfcr · 2022-09-02T04:09:50Z

For reference, ESLint shareable configs also don't allow sharing ignores.

Yes, they do.

mataha · 2022-09-07T19:25:54Z

I would suggest adding this as an option within the configuration file (i.e. .prettierrc.json). That way, it can be included in shareable configs.

That's a different feature for a different PR.

fisker · 2022-09-08T00:52:58Z

src/common/create-ignorer.js

-  const ignoreContent = !ignorePath
-    ? null
-    : getFileContentOrNull.sync(path.resolve(ignorePath));
+createIgnorer.sync = function (filePath, ignorePath, withNodeModules) {


Let's change base to next branch, so we don't need support sync version.

ivodolenc · 2022-09-24T11:32:14Z

It might not be a bad idea to implement this feature directly in the prettier.config file.

So when we want to share the settings we have all the options inside one file. This is exactly what eslint have.

For example, I can specify in package.json custom path for eslint.config.js and prettier.config.js and clean up the root as much as possible (no need for additional ignore files and custom ignore options inside package.json):

{
  "name": "package.json",
  "type": "module",

  "prettier": "./.config/prettier.config.cjs",
  "eslintConfig": {
    "extends": "./.config/eslint.config.cjs"
  }
}

and in one file I have all settings, including ignorePatterns like this:

// .config/eslint.config.js

module.exports = {
  root: true,

  extends: [],

  plugins: [],

  ignorePatterns: [
    '.DS_Store',
    'node_modules'
    // ...
  ]
}

This would be a huge win to put ignore directly inside prettier config:

// .config/prettier.config.js

module.exports = {
  singleQuote: true,
  trailingComma: 'none',
  
  plugins: [],

  ignorePatterns: [
    '.DS_Store',
    'node_modules'
    // ...
  ]
}

What do you think?

kachkaev · 2022-11-02T21:28:00Z

@mataha would you be interested to continue this PR? @ivodolenc's suggestion to use ignorePatterns makes sense – it' be great to see more alignment between ESLint and Prettier!

📖 Docs on ingorePatterns in ESLint config

aensley · 2022-11-03T12:47:56Z

I second @ivodolenc's suggestion: #12672 (comment)

It would be really great to be able to specify ignorePatterns in the prettier config.

Standard8 · 2023-01-23T09:57:57Z

Note, as this appears to have stalled out, I've started working on adding the options to the configuration. As a first step, I've added command line arguments to echo ESLint - as they were quite easy to do, and I've just posted that in #14223

wallpants · 2023-10-02T15:19:25Z

Is there anything I can do to help get this over the finish line? In a world where we already have a ton of config files in the root of our projects, I'm struggling to understand why we can't specify patterns to ignore in our prettier config file and we're forced to create a new file just for that.

Standard8 · 2023-10-02T15:26:11Z

Is there anything I can do to help get this over the finish line? In a world where we already have a ton of config files in the root of our projects, I'm struggling to understand why we can't specify patterns to ignore in our prettier config file and we're forced to create a new file just for that.

As discussed elsewhere, I think it would be much better to add an option in the .prettierrc.js file rather than package.json, this would also align it better with ESLint (which I believe was one of the aims).

I tried doing this previously but hit some issues, and despite asking never got any feedback from the developers, even when pinging the devs directly, so I gave up.

Feel free to take my work and try moving it forward though, maybe you'll have more success.

This is a rather dumb implementation (for now). Implements #3460 Signed-off-by: mataha <mataha@users.noreply.github.com>

With a sample `package.json`. Signed-off-by: mataha <mataha@users.noreply.github.com>

Not sure if more are necessary? Signed-off-by: mataha <mataha@users.noreply.github.com>

Signed-off-by: mataha <mataha@users.noreply.github.com>

mataha · 2023-10-02T18:58:15Z

I'm in a position in which I can commit some time to this again. I'd like to clarify some things beforehand though.

@mataha would you be interested to continue this PR? @ivodolenc's suggestion to use ignorePatterns makes sense – it' be great to see more alignment between ESLint and Prettier!

📖 Docs on ingorePatterns in ESLint config

Again, I believe that's a different feature for a different PR. The core tenet of this is that one can share prettier configuration between different projects or even monorepo packages, yet be able to selectively choose which files should be formatted at the project level, e.g. plumbing for package managers, test specifications, generated files... As someone here said, ignorable files tend to be influenced by a project's tooling more than anything - two entities sharing such config might not necessarily use the same package manager, among other things. ignorePatterns does not achieve this - it's applied on a configuration level, thus applicable to every package using said config.

That said, the main pain point of this PR continues to be how Prettier should behave upon encountering a package.json:

stop scanning
continue scanning until filesystem root, merge all sections
continue scanning if section is malformed or missing

I'll have to rewrite this as several things have changed since then (e.g. ignore facility has moved to src/utils).

mataha · 2023-10-03T02:16:41Z

Can't run tests at all due to jestjs/jest#7914.

mataha marked this pull request as ready for review April 21, 2022 02:37

fisker reviewed Jun 14, 2022

View reviewed changes

src/common/create-ignorer.js Outdated Show resolved Hide resolved

mataha mentioned this pull request Jul 18, 2022

feat: add support for prettierIgnore keithamus/sort-package-json#266

Closed

fisker reviewed Jul 18, 2022

View reviewed changes

src/common/get-key-content-or-null.js Outdated Show resolved Hide resolved

fisker reviewed Jul 18, 2022

View reviewed changes

fisker reviewed Sep 8, 2022

View reviewed changes

mataha changed the base branch from main to next September 9, 2022 10:32

kachkaev mentioned this pull request Oct 19, 2022

Configure ignore files, from the prettier config file #13088

Closed

kachkaev mentioned this pull request Nov 2, 2022

prettierIgnore key in package.json? #3460

Open

Standard8 mentioned this pull request Jan 23, 2023

Support --ignore-pattern as a command line option #14223

Closed

4 tasks

fisker changed the base branch from next to main April 23, 2023 01:08

mataha added 6 commits October 2, 2023 20:31

Add support for prettierIgnore key in package.json

3c6da29

This is a rather dumb implementation (for now). Implements #3460 Signed-off-by: mataha <mataha@users.noreply.github.com>

Update documentation regarding prettierIgnore

879091d

With a sample `package.json`. Signed-off-by: mataha <mataha@users.noreply.github.com>

Add package.json tests + snapshot

239a160

Not sure if more are necessary? Signed-off-by: mataha <mataha@users.noreply.github.com>

Add changes to changelog file

534710f

Signed-off-by: mataha <mataha@users.noreply.github.com>

Don't mix file and key ignores, just fallback

7ed1889

Signed-off-by: mataha <mataha@users.noreply.github.com>

Search for package.json from filepath, not cwd

c0b040e

Signed-off-by: mataha <mataha@users.noreply.github.com>

mataha added 2 commits October 2, 2023 20:31

Limit key content to string array only

95624bf

Signed-off-by: mataha <mataha@users.noreply.github.com>

Use cosmiconfig instead

27d9940

Signed-off-by: mataha <mataha@users.noreply.github.com>

Standard8 mentioned this pull request Oct 3, 2023

Support configuration defined ignore lists in a similar way as ESLint (loading ignore lists from multiple sources) #15481

Open

Use lilconfig instead

b0f5c0f

mataha closed this Oct 3, 2023

mataha deleted the feature/prettierignore-package-json branch October 3, 2023 17:11

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add support for `prettierIgnore` key in `package.json` #12672

Add support for `prettierIgnore` key in `package.json` #12672

mataha commented Apr 20, 2022 •

edited

mataha commented Jun 11, 2022

trim21 commented Jun 14, 2022

fisker Jul 18, 2022 •

edited

mataha Jul 29, 2022

fisker Sep 29, 2022

fisker Sep 29, 2022

hendrikheil commented Aug 23, 2022

kevinwolfcr commented Sep 1, 2022

nickmccurdy commented Sep 2, 2022 •

edited

kevinwolfcr commented Sep 2, 2022

mataha commented Sep 7, 2022

fisker Sep 8, 2022

mataha Sep 9, 2022

ivodolenc commented Sep 24, 2022

kachkaev commented Nov 2, 2022 •

edited

aensley commented Nov 3, 2022

Standard8 commented Jan 23, 2023

wallpants commented Oct 2, 2023

Standard8 commented Oct 2, 2023

mataha commented Oct 2, 2023

mataha commented Oct 3, 2023

Add support for prettierIgnore key in package.json #12672

Add support for prettierIgnore key in package.json #12672

Conversation

mataha commented Apr 20, 2022 • edited

Description

Checklist

mataha commented Jun 11, 2022

trim21 commented Jun 14, 2022

fisker Jul 18, 2022 • edited

Choose a reason for hiding this comment

mataha Jul 29, 2022

Choose a reason for hiding this comment

fisker Sep 29, 2022

Choose a reason for hiding this comment

fisker Sep 29, 2022

Choose a reason for hiding this comment

hendrikheil commented Aug 23, 2022

kevinwolfcr commented Sep 1, 2022

nickmccurdy commented Sep 2, 2022 • edited

kevinwolfcr commented Sep 2, 2022

mataha commented Sep 7, 2022

fisker Sep 8, 2022

Choose a reason for hiding this comment

mataha Sep 9, 2022

Choose a reason for hiding this comment

ivodolenc commented Sep 24, 2022

kachkaev commented Nov 2, 2022 • edited

aensley commented Nov 3, 2022

Standard8 commented Jan 23, 2023

wallpants commented Oct 2, 2023

Standard8 commented Oct 2, 2023

mataha commented Oct 2, 2023

mataha commented Oct 3, 2023

Add support for `prettierIgnore` key in `package.json` #12672

Add support for `prettierIgnore` key in `package.json` #12672

mataha commented Apr 20, 2022 •

edited

fisker Jul 18, 2022 •

edited

nickmccurdy commented Sep 2, 2022 •

edited

kachkaev commented Nov 2, 2022 •

edited