Add option to skip loading prettierrc #83
Conversation
|
Thanks for the PR. I'm fine with adding something like this, but I think it could be confusing to include it in the same object as the other prettier options, since this isn't an option that gets passed to prettier. Can you make this a second argument instead? For example, it could get configured as |
|
@not-an-aardvark absolutely, I like that route waaay better! Will revise. |
eliperelman
force-pushed
the
use-prettierrc
branch
from
897508d
to
90f3750
Compare
|
@not-an-aardvark updated! |
|
For posterity, this option was inspired by ESLint CLIEngine's https://eslint.org/docs/developer-guide/nodejs-api#cliengine |
README.md
Outdated
| }] | ||
| ``` | ||
|
|
||
| - `usePrettierRc`: Enables loading of the Prettier configuration file, set to `false` to disable. May be useful if you are using multiple tools that conflict with each other, or do not wish to mix your ESLint settings with your Prettier configuration. |
There was a problem hiding this comment.
Minor nitpick: Can we rename the option to usePrettierrc (lowercase r)? That would also be consistent with the useEslintrc option that this is based on.
README.md
Outdated
| }] | ||
| ``` | ||
|
|
||
| - `usePrettierRc`: Enables loading of the Prettier configuration file, set to `false` to disable. May be useful if you are using multiple tools that conflict with each other, or do not wish to mix your ESLint settings with your Prettier configuration. |
There was a problem hiding this comment.
set to
falseto disable
Nitpick: Can you replace this text with "(default: true)"? The double negative in "set to false to disable" makes it a bit confusing to read.
eslint-plugin-prettier.js
Outdated
| type: 'object', | ||
| properties: { | ||
| pragma: { type: 'string', pattern: '^@\\w+$' }, | ||
| usePrettierRc: { type: 'boolean' } |
There was a problem hiding this comment.
Can you add a test for the new option? (It would probably be similar to the existing prettierrc tests, except that the test would be asserting that the options in the file do not get applied.)
|
@not-an-aardvark ok, I think all your requests have been made! I also added a test to ensure you could still use |
|
If this is a breaking change (moving Perhaps a more ergonomic API would be to do: "prettier/prettier": ["error"], // use config file
"prettier/prettier": ["error", {}], // do not use config file
"prettier/prettier": ["error", { "singleQuote": true }], // do not use config file |
|
I think this is backwards-compatible -- |
|
This is not a breaking change, it's a minor bump. Using a string pragma is still supported in the second slot. |
|
Yeah I misinterpreted the change, ignore the first part of my comment. |
|
If I'm understanding correctly, the second part of the comment would be a breaking change, right? Maybe we should merge this as-is and then implement the second part of the comment in a major release (at some indefinite point in the future if a major release is necessary). |
There was a problem hiding this comment.
lgtm. I do think #83 (comment) is worth doing in a future release.
|
Thanks for contributing! |
|
My pleasure, thank you for accepting! |
Hello! This PR adds an option to allow you to skip loading the prettierrc file. I have a use case for this in some external tooling and it would really come in handy.