Update: separate eslint --init #79
Conversation
aladdin-add
force-pushed
the
init-command-eslint-cli
branch
from
86b7924
to
a8643eb
Compare
nzakas
added
Initial Commenting
@eslint/eslintrc will not be removed.
aladdin-add
force-pushed
the
init-command-eslint-cli
branch
2 times, most recently
from
58193e4
to
2010343
Compare
aladdin-add
force-pushed
the
init-command-eslint-cli
branch
from
2010343
to
15f573d
Compare
Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com>
|
Moving to final commenting. |
nzakas
added
Final Commenting
| - the following dependencies can be removed in eslint repo: | ||
| - enquirer | ||
| - semver | ||
| - Whenever `--init` command is being used, show a warning(e.g. "You can also run this command directly using 'npm init @eslint/config'") and run `npm init @eslint/config` using `child_process` of the native node modules. |
There was a problem hiding this comment.
Can we just show the message and let the user run the command manually?
One of the obstacles for supporting yarn in eslint --init (eslint/eslint#13756) was a scenario where the config initialization reinstalls local eslint, and then yarn intentionally breaks the whole process.
There was a problem hiding this comment.
👍 good point! will update later.
There was a problem hiding this comment.
Doesn't that issue only apply when using yarn? If we run npm init @eslint/config, aren't we okay?
There was a problem hiding this comment.
It will be an issue when users are using some different package managers than npm(yarn/pnpm/...).
There was a problem hiding this comment.
that also works. though I think better to recommend yarn users run yarn create @eslint/config. :)
There was a problem hiding this comment.
@eslint/create-config will require() local ESLint to format the .eslintrc.js config file. Since yarn 2 doesn't create node_modules, I think that @eslint/create-config when run through npm init won't be able to require() any locally installed packages.
There was a problem hiding this comment.
To add to my previous comment, eslint --init doesn't officially support yarn yet, but yarn eslint --init currently works fine when provided answers don't require installing dependencies. I'd expect the formatting step to fail when user runs yarn eslint --init and then we run npm init @eslint/config as a child process.
There was a problem hiding this comment.
Given that we are in final commenting and there’s a lot of “I think” comments that are best answered by implementing the package and testing it, I move that we approve this RFC and hold further speculation until there is a prototype to play with.
There was a problem hiding this comment.
Agreed. We'll certainly publish the new package first, and then we can experiment.
Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
|
There is consensus on moving forward, so it’s time to merge! |
* Docs: separate eslint --init * chore: review suggestions * chore: review suggestions * chore: review suggestions * chore: review suggestions * Update README.md @eslint/eslintrc will not be removed. * chore: review suggestions * Update designs/2021-init-command-eslint-cli/README.md Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com> * Update README.md * Update designs/2021-init-command-eslint-cli/README.md Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com> * chore: rm unused deps Co-authored-by: Nicholas C. Zakas <nicholas@humanwhocodes.com> Co-authored-by: Milos Djermanovic <milos.djermanovic@gmail.com>
rendered: https://github.com/aladdin-add/rfcs/tree/init-command-eslint-cli/designs/2021-init-command-eslint-cli
Summary
initcommand from main repo (eslint) to a new repo named@eslint/create-config.Related Issues
this is following #58