feat: move `eslint --init` to @eslint/create-config #15150

aladdin-add · 2021-10-11T06:31:37Z

TODOs:

Update: rm eslint auto config. rfc step 1
Update: mv eslint --init to another package. step 2
move to esm.
fix failing tests
move to the eslint/create-config repo
docs update

Prerequisites checklist

I have read the contributing guidelines.

What is the purpose of this pull request? (put an "X" next to an item)

[ ] Documentation update
[ ] Bug fix (template)
[ ] New rule (template)
[ ] Changes an existing rule (template)
[ ] Add autofixing to a rule
[ ] Add a CLI option
[ ] Add something to the core
[ ] Other, please explain:

What changes did you make? (Give an overview)

fixes #14768

Is there anything you'd like reviewers to focus on?

bin/eslint.js

mdjermanovic · 2021-10-13T12:23:36Z

I think the files should be copied to the new repo https://github.com/eslint/create-config, as we decided not to go in the monorepo direction for this.

aladdin-add · 2021-10-13T12:43:06Z

absolutely right -- that's why the PR is a draft, will do later. 😄

aladdin-add · 2021-10-19T02:44:06Z

update: I was planning to move proxyrequire to testdouble in eslint/create-config, as proxyrequire does not support esm mocking.

nzakas · 2021-11-04T01:01:48Z

What’s the status on this? We are getting a bunch of issues/PRs related to —init and we need to make some progress.

aladdin-add · 2021-11-05T08:04:37Z

Now I'm using the native Node.js esm as sindresorhus' blog (not pushed yet):

Add "type": "module", to package.json (below the author field)
Add "exports": "./index.js", to package.json (below the type field)
Update engines field in package.json to Node.js 12.
~~Update index.d.ts to use ESM imports/exports.~~
~~Update code examples in readme and index.d.ts to use ESM and also top-level await.~~
Remove 'use strict';.
Convert '.' to './index.js'.
~~Use the node: protocol for imports.~~

additionally, I replaced proxyquire to testdouble(as proxyquire does not support esm mocking).

does it make sense? Do we want to add the cjs export in the new package, too?

mdjermanovic · 2021-11-05T11:41:24Z

Add "exports": "./index.js", to package.json (below the type field)
Do we want to add the cjs export in the new package, too?

Do we want to export anything from this package? If it's meant to be only a CLI app, I think we can publish ESM-only package, without exports.

nzakas · 2021-11-06T00:24:50Z

I agree. I don’t think we need to export anything.

nzakas · 2021-11-25T01:24:53Z

Where are we on this? Is there a reason all the work is being done here instead of on the new repo?

aladdin-add · 2021-12-06T05:39:57Z

this is ready for review, but set to a draft to make sure we don't merge it before @eslint/create-config is released.

btmills

I was able to test this manually locally with this setup:

In my eslint/create-config checkout, npm link.
In my eslint/eslint checkout on this branch, npm link @eslint/create-config.
In my eslint/eslint checkout on this branch, npx eslint --init.

bin/eslint.js

btmills

LGTM, thanks! Leaving as comment instead of approval pending release of @eslint/create-config.

eslint-github-bot · 2021-12-20T02:50:21Z

Hi @aladdin-add!, thanks for the Pull Request

The first commit message isn't properly formatted. We ask that you update the message to match this format, as we use it to generate changelogs and automate releases.

The commit message tag wasn't recognized. Did you mean "docs", "fix", or "feat"?
There should be a space following the initial tag and colon, for example 'feat: Message'.

To Fix: You can fix this problem by running git commit --amend, editing your commit message, and then running git push -f to update this pull request.

Read more about contributing to ESLint here

nzakas · 2022-01-07T00:35:06Z

Where are we on this? What’s needed now?

aladdin-add · 2022-01-07T00:49:42Z

The only thing is: eslint/create-config#10.

Given npx will always use latest, seems this one can even be merged first.

docs/user-guide/getting-started.md

nzakas · 2022-01-07T23:59:17Z

Okay, just releases v0.1.2. See my note on the issue about the version number.

mdjermanovic · 2022-01-08T11:07:39Z

Should we keep unit tests for the config-rule.js module?

mdjermanovic · 2022-01-08T11:15:59Z

Can we delete tests/fixtures/autoconfig/*?

fixes eslint#14768, fixes eslint#15159 Update: rm eslint auto config refs: https://github.com/aladdin-add/rfcs/blob/bdc12aa062750d837e5a3bbbf2f6e5e3a98da388/designs/2021-init-command-eslint-cli/README.md#1-remove-eslint-auto-config Update: mv eslint --init to another package moved `lib/init/config-rule` to tools, as it is also used by some others refs: https://github.com/aladdin-add/rfcs/blob/bdc12aa062750d837e5a3bbbf2f6e5e3a98da388/designs/2021-init-command-eslint-cli/README.md#2-move-eslint---init-related-files-to-a-separate-repo chore: fix imports to make test passing todo: use the new eslint api fix: use the new eslint api (async) fix: remove espree from deps chore: fix a failing test fix: a failing test chore: cleanup TODOs fix: allow to use local-installed eslint wip: fix one-var chore: lib => esm chore: tests => esm todo: proxyquire => td chore: update deps to latest fix: should write a file through fs when a ${fileType} path is passed replaced proxyquire & sinon => td fix: should include a newline character at EOF chore: add testdouble --wip-- [skip ci] chore: remove package @eslint/create-eslint feat: update npm --init to run `npm init @eslint/config` docs: update getting-started Update README.md Update getting-started.md chore: rm init fixtures fix: `npm init @eslint/config` output chore: rm unused files chore: rm unused deps Update bin/eslint.js Co-authored-by: Brandon Mills <btmills@users.noreply.github.com> chore: fix typo

aladdin-add · 2022-01-08T12:08:58Z

@mdjermanovic should be addressed now. 😄

btmills

LGTM! Leaving open to allow others to follow up their reviews.

mdjermanovic

LGTM, thanks!

eslint-github-bot bot added the triage An ESLint team member will look at this issue soon label Oct 11, 2021

aladdin-add added accepted There is consensus among the team that this change meets the criteria for inclusion cli Relates to ESLint's command-line interface and removed triage An ESLint team member will look at this issue soon labels Oct 11, 2021

aladdin-add mentioned this pull request Oct 13, 2021

Bug: running eslint --init generates a .eslint.json file with parserOptions.ecmaversion set to 13 #15159

Closed

1 task

mdjermanovic reviewed Oct 13, 2021

View reviewed changes

bin/eslint.js Outdated Show resolved Hide resolved

mdjermanovic changed the title ~~Update: move eslint --init to @eslint/create-config~~ feat: move eslint --init to @eslint/create-config Oct 26, 2021

aladdin-add force-pushed the update/rm-eslint-init branch from c2744b3 to 7d5c492 Compare November 5, 2021 09:36

aladdin-add force-pushed the update/rm-eslint-init branch 2 times, most recently from 7f69c98 to a4ac601 Compare November 19, 2021 09:53

eslint-github-bot bot added the feature This change adds a new feature to ESLint label Dec 1, 2021

aladdin-add force-pushed the update/rm-eslint-init branch 4 times, most recently from 128c2e5 to f09f525 Compare December 6, 2021 05:36

aladdin-add requested review from mdjermanovic, nzakas, btmills and bmish December 6, 2021 05:40

mdjermanovic mentioned this pull request Dec 7, 2021

Change Request: file glob for eslint --init is hard to figure out #15127

Closed

1 task

btmills requested changes Dec 9, 2021

View reviewed changes

bin/eslint.js Outdated Show resolved Hide resolved

btmills reviewed Dec 9, 2021

View reviewed changes

aladdin-add marked this pull request as ready for review December 18, 2021 06:06

aladdin-add force-pushed the update/rm-eslint-init branch from 0515509 to 039eced Compare December 20, 2021 02:50

aladdin-add force-pushed the update/rm-eslint-init branch from 039eced to 45c23f9 Compare December 20, 2021 02:50

aladdin-add mentioned this pull request Dec 21, 2021

release v1.0.0 eslint/create-config#10

Closed

mdjermanovic reviewed Jan 7, 2022

View reviewed changes

docs/user-guide/getting-started.md Outdated Show resolved Hide resolved

aladdin-add requested review from btmills and mdjermanovic January 8, 2022 00:43

aladdin-add and others added 4 commits January 8, 2022 20:02

docs: rm mentioned --init

62f6010

chore: fixtures/autoconfig/*

420c108

chore: add config-rule unit tests

82baad0

aladdin-add force-pushed the update/rm-eslint-init branch from 7b932c4 to 82baad0 Compare January 8, 2022 12:04

docs: update some eslint --init usage

70ef222

btmills approved these changes Jan 9, 2022

View reviewed changes

mdjermanovic approved these changes Jan 9, 2022

View reviewed changes

mdjermanovic merged commit 0d2b9a6 into eslint:main Jan 9, 2022

aladdin-add deleted the update/rm-eslint-init branch January 9, 2022 10:49

cek333 mentioned this pull request Jan 12, 2022

Bug: (Error running eslint init) #15512

Closed

1 task

sync-by-unito bot mentioned this pull request Feb 1, 2022

build(deps-dev): bump eslint from 7.32.0 to 8.8.0 numbersprotocol/capture-lite#1232

Closed

mdjermanovic mentioned this pull request Apr 1, 2022

chore: remove lib/init from eslint config #15748

Merged

1 task

eslint-github-bot bot locked and limited conversation to collaborators Jul 9, 2022

eslint-github-bot bot added the archived due to age This issue has been archived; please open a new issue for any further discussion label Jul 9, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: move `eslint --init` to @eslint/create-config #15150

feat: move `eslint --init` to @eslint/create-config #15150

aladdin-add commented Oct 11, 2021 •

edited

mdjermanovic commented Oct 13, 2021

aladdin-add commented Oct 13, 2021

aladdin-add commented Oct 19, 2021

nzakas commented Nov 4, 2021

aladdin-add commented Nov 5, 2021 •

edited

mdjermanovic commented Nov 5, 2021

nzakas commented Nov 6, 2021

nzakas commented Nov 25, 2021

aladdin-add commented Dec 6, 2021

btmills left a comment

btmills left a comment

eslint-github-bot bot commented Dec 20, 2021

nzakas commented Jan 7, 2022

aladdin-add commented Jan 7, 2022

nzakas commented Jan 7, 2022

mdjermanovic commented Jan 8, 2022

mdjermanovic commented Jan 8, 2022

aladdin-add commented Jan 8, 2022

btmills left a comment

mdjermanovic left a comment

feat: move eslint --init to @eslint/create-config #15150

feat: move eslint --init to @eslint/create-config #15150

Conversation

aladdin-add commented Oct 11, 2021 • edited

Prerequisites checklist

What is the purpose of this pull request? (put an "X" next to an item)

What changes did you make? (Give an overview)

Is there anything you'd like reviewers to focus on?

mdjermanovic commented Oct 13, 2021

aladdin-add commented Oct 13, 2021

aladdin-add commented Oct 19, 2021

nzakas commented Nov 4, 2021

aladdin-add commented Nov 5, 2021 • edited

mdjermanovic commented Nov 5, 2021

nzakas commented Nov 6, 2021

nzakas commented Nov 25, 2021

aladdin-add commented Dec 6, 2021

btmills left a comment

Choose a reason for hiding this comment

btmills left a comment

Choose a reason for hiding this comment

eslint-github-bot bot commented Dec 20, 2021

nzakas commented Jan 7, 2022

aladdin-add commented Jan 7, 2022

nzakas commented Jan 7, 2022

mdjermanovic commented Jan 8, 2022

mdjermanovic commented Jan 8, 2022

aladdin-add commented Jan 8, 2022

btmills left a comment

Choose a reason for hiding this comment

mdjermanovic left a comment

Choose a reason for hiding this comment

feat: move `eslint --init` to @eslint/create-config #15150

feat: move `eslint --init` to @eslint/create-config #15150

aladdin-add commented Oct 11, 2021 •

edited

aladdin-add commented Nov 5, 2021 •

edited