feat: Implement FlatRuleTester #15519

nzakas · 2022-01-13T22:11:42Z

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 autofix to a rule
[ ] Add a CLI option
[x] Add something to the core
[ ] Other, please explain:

What changes did you make? (Give an overview)

I implemented FlatRuleTester to allow folks to test their rules using flat config instead of eslintrc.

I also implemented tests for FlatRuleTester.

This class is not currently exported but will be when we do a developer preview.

Note: I copied over most of the RuleTester tests, but I did delete a block that was testing ecmaVersion normalization because it was basically just duplicating all of the Linter tests that already did that.

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

Does it all look good?

lib/rule-tester/flat-rule-tester.js

nzakas · 2022-01-14T00:48:31Z

Looks like I need to incorporate https://github.com/eslint/eslint/pull/15507/files before merging.

Implements FlatRuleTester as a way to allow devs to test their rules against flat config. Refs #13481

nzakas · 2022-01-14T18:54:03Z

lib/config/flat-config-array.js

@@ -58,7 +58,11 @@ class FlatConfigArray extends ConfigArray {
            schema: flatConfigSchema
        });

-        this.unshift(...baseConfig);
+        if (baseConfig[Symbol.iterator]) {


Convenience.

nzakas · 2022-01-14T18:54:42Z

tests/lib/rule-tester/rule-tester.js

-        const assertionDescribe = assertEmitted(ruleTesterTestEmitter, "custom describe", "this-is-a-rule-name");
-        const assertionIt = assertEmitted(ruleTesterTestEmitter, "custom it", "valid(code);");
-        const assertionItOnly = assertEmitted(ruleTesterTestEmitter, "custom itOnly", "validOnly(code);");
+    describe("Subclassing", () => {


While copying over I noticed this wasn't inside of a describe block so I added one.

tests/lib/rule-tester/flat-rule-tester.js

aladdin-add

LGTM.

lib/rule-tester/flat-rule-tester.js

nzakas · 2022-01-21T16:51:18Z

Okay, I think I got everything. 👍

lib/rule-tester/flat-rule-tester.js

nzakas · 2022-01-24T16:17:40Z

Okay, I think I got everything. 👍

mdjermanovic

A few minor suggestions.

Examples (here) should be updated as they are using some properties that are now invalid (for example, string parser and top-level globals).
The same for typedefs (here).

tests/lib/rule-tester/flat-rule-tester.js

lib/rule-tester/flat-rule-tester.js

nzakas · 2022-01-27T17:25:12Z

I'm actually just going to remove the examples at the top of the file. They are already woefully out of date and I don't think they provide any real value since we have actual documentation.

nzakas · 2022-01-27T17:27:57Z

Updated the typedefs 👍

lib/rule-tester/flat-rule-tester.js

nzakas · 2022-02-01T19:40:25Z

Ensured that all parsers are wrapped and added tests to verify.

mdjermanovic

LGTM, thanks!

I managed to successfully run all rule tests we have (except for those with /*eslint-env*/ comments in the code) with FlatRuleTester, by automatically converting configurations to the new format: mdjermanovic@4746376

mdjermanovic · 2022-02-02T12:15:11Z

I removed the link to #13481 issue so that it doesn't get closed automatically after merging this PR.

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [eslint](https://eslint.org) ([source](https://github.com/eslint/eslint)) | devDependencies | minor | [`8.8.0` -> `8.9.0`](https://renovatebot.com/diffs/npm/eslint/8.8.0/8.9.0) | --- ### Release Notes <details> <summary>eslint/eslint</summary> ### [`v8.9.0`](https://github.com/eslint/eslint/releases/v8.9.0) [Compare Source](eslint/eslint@v8.8.0...v8.9.0) #### Features - [`68f64a9`](eslint/eslint@68f64a9) feat: update eslint-scope to ignore `"use strict"` directives in ES3 ([#15595](eslint/eslint#15595)) (Milos Djermanovic) - [`db57639`](eslint/eslint@db57639) feat: add `es2016`, `es2018`, `es2019`, and `es2022` environments ([#15587](eslint/eslint#15587)) (Milos Djermanovic) - [`2dc38aa`](eslint/eslint@2dc38aa) feat: fix bug with arrow function return types in function-paren-newline ([#15541](eslint/eslint#15541)) (Milos Djermanovic) - [`6f940c3`](eslint/eslint@6f940c3) feat: Implement FlatRuleTester ([#15519](eslint/eslint#15519)) (Nicholas C. Zakas) #### Documentation - [`570a036`](eslint/eslint@570a036) docs: add `one-var` example with `for-loop` initializer ([#15596](eslint/eslint#15596)) (Milos Djermanovic) - [`417191d`](eslint/eslint@417191d) docs: Remove the $ prefix in terminal commands ([#15565](eslint/eslint#15565)) (Andreas Lewis) - [`389ff34`](eslint/eslint@389ff34) docs: add missing `Variable#scope` property in the scope manager docs ([#15571](eslint/eslint#15571)) (Milos Djermanovic) - [`f63795d`](eslint/eslint@f63795d) docs: no-eval replace dead link with working one ([#15568](eslint/eslint#15568)) (rasenplanscher) - [`0383591`](eslint/eslint@0383591) docs: Remove old Markdown issue template ([#15556](eslint/eslint#15556)) (Brandon Mills) - [`a8dd5a2`](eslint/eslint@a8dd5a2) docs: add 'when not to use it' section in no-duplicate-case docs ([#15563](eslint/eslint#15563)) (Milos Djermanovic) - [`1ad439e`](eslint/eslint@1ad439e) docs: add missed verb in docs ([#15550](eslint/eslint#15550)) (Jeff Mosawy) #### Chores - [`586d45c`](eslint/eslint@586d45c) chore: Upgrade to espree@9.3.1 ([#15600](eslint/eslint#15600)) (Milos Djermanovic) - [`623e1e2`](eslint/eslint@623e1e2) chore: Upgrade to eslint-visitor-keys@3.3.0 ([#15599](eslint/eslint#15599)) (Milos Djermanovic) - [`355b23d`](eslint/eslint@355b23d) chore: fix outdated link to Code of Conduct in PR template ([#15578](eslint/eslint#15578)) (Rich Trott) - [`b10fef2`](eslint/eslint@b10fef2) ci: use Node 16 for browser test ([#15569](eslint/eslint#15569)) (Milos Djermanovic) - [`92f89fb`](eslint/eslint@92f89fb) chore: suggest demo link in bug report template ([#15557](eslint/eslint#15557)) (Brandon Mills) </details> --- ### Configuration 📅 **Schedule**: At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] If you want to rebase/retry this PR, click this checkbox. --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). Co-authored-by: cabr2-bot <cabr2.help@gmail.com> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1173 Reviewed-by: Epsilon_02 <epsilon_02@noreply.codeberg.org> Co-authored-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org> Co-committed-by: Calciumdibromid Bot <cabr2_bot@noreply.codeberg.org>

nzakas added the core Relates to ESLint's core APIs and features label Jan 13, 2022

eslint-github-bot bot added the feature This change adds a new feature to ESLint label Jan 13, 2022

nzakas linked an issue Jan 13, 2022 that may be closed by this pull request

Implement Flat Config #13481

Open

69 tasks

nzakas commented Jan 14, 2022

View reviewed changes

lib/rule-tester/flat-rule-tester.js Outdated Show resolved Hide resolved

nzakas commented Jan 14, 2022

View reviewed changes

lib/rule-tester/flat-rule-tester.js Outdated Show resolved Hide resolved

nzakas marked this pull request as draft January 14, 2022 00:48

nzakas added 5 commits January 14, 2022 10:42

feat: Implement FlatRuleTester

e509d9f

Implements FlatRuleTester as a way to allow devs to test their rules against flat config. Refs #13481

more test fixes

1d0a612

Finish tests

249ac9c

Remove TODO comments

ddc53e2

Added subclassing tests

da9d3f8

nzakas force-pushed the flat-config-rule-tester branch from 7d774f8 to da9d3f8 Compare January 14, 2022 18:49

nzakas marked this pull request as ready for review January 14, 2022 18:49

Add FlatConfigArray test

da7f9c0

nzakas commented Jan 14, 2022

View reviewed changes

aladdin-add reviewed Jan 19, 2022

View reviewed changes

tests/lib/rule-tester/flat-rule-tester.js Outdated Show resolved Hide resolved

aladdin-add approved these changes Jan 20, 2022

View reviewed changes

mdjermanovic reviewed Jan 20, 2022

View reviewed changes

lib/rule-tester/flat-rule-tester.js Outdated Show resolved Hide resolved

lib/rule-tester/flat-rule-tester.js Outdated Show resolved Hide resolved

lib/rule-tester/flat-rule-tester.js Outdated Show resolved Hide resolved

mdjermanovic added the accepted There is consensus among the team that this change meets the criteria for inclusion label Jan 20, 2022

mdjermanovic reviewed Jan 20, 2022

View reviewed changes

lib/rule-tester/flat-rule-tester.js Outdated Show resolved Hide resolved

lib/rule-tester/flat-rule-tester.js Outdated Show resolved Hide resolved

nzakas added 2 commits January 21, 2022 08:49

Incorporate feedback

02118e8

Fix comment

3ff18e7

nzakas force-pushed the flat-config-rule-tester branch from e80113e to 3ff18e7 Compare January 21, 2022 16:51

mdjermanovic reviewed Jan 21, 2022

View reviewed changes

lib/rule-tester/flat-rule-tester.js Outdated Show resolved Hide resolved

lib/rule-tester/flat-rule-tester.js Outdated Show resolved Hide resolved

lib/rule-tester/flat-rule-tester.js Outdated Show resolved Hide resolved

mdjermanovic reviewed Jan 21, 2022

View reviewed changes

lib/rule-tester/flat-rule-tester.js Outdated Show resolved Hide resolved

Incorporate feedback

48d3cce

mdjermanovic reviewed Jan 26, 2022

View reviewed changes

tests/lib/rule-tester/flat-rule-tester.js Outdated Show resolved Hide resolved

lib/rule-tester/flat-rule-tester.js Show resolved Hide resolved

Fix up typedefs

621813b

mdjermanovic reviewed Jan 28, 2022

View reviewed changes

lib/rule-tester/flat-rule-tester.js Outdated Show resolved Hide resolved

Fix parser wrapping in all scenarios

564bb31

mdjermanovic approved these changes Feb 2, 2022

View reviewed changes

mdjermanovic removed a link to an issue Feb 2, 2022

Implement Flat Config #13481

Open

69 tasks

mdjermanovic merged commit 6f940c3 into main Feb 2, 2022

mdjermanovic deleted the flat-config-rule-tester branch February 2, 2022 12:16

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

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

Closed

eslint-github-bot bot locked and limited conversation to collaborators Aug 2, 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 Aug 2, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Implement FlatRuleTester #15519

feat: Implement FlatRuleTester #15519

nzakas commented Jan 13, 2022

nzakas commented Jan 14, 2022

nzakas Jan 14, 2022

nzakas Jan 14, 2022

aladdin-add left a comment

nzakas commented Jan 21, 2022

nzakas commented Jan 24, 2022

mdjermanovic left a comment

nzakas commented Jan 27, 2022

nzakas commented Jan 27, 2022

nzakas commented Feb 1, 2022

mdjermanovic left a comment

mdjermanovic commented Feb 2, 2022

feat: Implement FlatRuleTester #15519

feat: Implement FlatRuleTester #15519

Conversation

nzakas commented Jan 13, 2022

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?

nzakas commented Jan 14, 2022

nzakas Jan 14, 2022

Choose a reason for hiding this comment

nzakas Jan 14, 2022

Choose a reason for hiding this comment

aladdin-add left a comment

Choose a reason for hiding this comment

nzakas commented Jan 21, 2022

nzakas commented Jan 24, 2022

mdjermanovic left a comment

Choose a reason for hiding this comment

nzakas commented Jan 27, 2022

nzakas commented Jan 27, 2022

nzakas commented Feb 1, 2022

mdjermanovic left a comment

Choose a reason for hiding this comment

mdjermanovic commented Feb 2, 2022