feat: languageOptions.parser must be an object. by nzakas · Pull Request #16985 · eslint/eslint

nzakas · 2023-03-14T19:09:55Z

Prerequisites checklist

I have read the contributing guidelines.

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

[x] 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)

Changes languageOptions.parser to disallow string values. Now parsers must always be an object.

Fixes #16930

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

Do the test and documentation updates make sense?

Changes languageOptions.parser to disallow string values. Fixes #16930

netlify · 2023-03-14T19:10:01Z

✅ Deploy Preview for docs-eslint canceled.

Name	Link
🔨 Latest commit	`1a360e6`
🔍 Latest deploy log	https://app.netlify.com/sites/docs-eslint/deploys/64111cddd94a5300071b4b3c

fasttime

Thanks for working on this! I left a comment in lib/config/flat-config-schema.js. And do we still need this?

eslint/lib/config/flat-config-array.js

Lines 195 to 204 in f5f5e11

    
           if (typeof parser === "string") { 
        
               const { pluginName, objectName: localParserName } = splitPluginIdentifier(parser); 
        
               parserName = parser; 
        
               if (!plugins || !plugins[pluginName] || !plugins[pluginName].parsers || !plugins[pluginName].parsers[localParserName]) { 
        
                   throw new TypeError(`Key "parser": Could not find "${localParserName}" in plugin "${pluginName}".`); 
        
               } 
        
               languageOptions.parser = plugins[pluginName].parsers[localParserName];

fasttime · 2023-03-14T20:28:46Z

+            typeof value !== "object" ||
+            (typeof value.parse !== "function" && typeof value.parseForESLint !== "function")
+        ) {
+            throw new TypeError("Expected object with parse() or parseForESLint() method.");


Could we make sure that this error is also thrown when the parser (value) is null? I'm currently getting Cannot read properties of null (reading 'parse').

Ooh, nice catch! Absolutely.

nzakas · 2023-03-15T01:19:40Z

        if (languageOptions && languageOptions.parser) {
            const { parser } = languageOptions;

-            if (typeof parser === "string") {


@fasttime another nice catch. 👍 This was never being called because the schema errors before it ever gets here.

mdjermanovic · 2023-03-15T09:27:34Z

I'll close-reopen to include 69bc0e2

snitin315 · 2023-03-15T11:34:03Z

I believe we will need to rebase.

mdjermanovic · 2023-03-15T11:48:22Z

I believe we will need to rebase.

It looks fine now, the tests run on Node 19.7.0?

mdjermanovic

LGTM, thanks! Leaving open for @fasttime to verify.

fasttime

LGTM. Will merge this tomorrow if there are no other comments. Thanks again @nzakas.

snitin315

LGTM

* feat: languageOptions.parser must be an object. Changes languageOptions.parser to disallow string values. Fixes #16930 * Add parser:null check * Remove unnecessary check

This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [eslint](https://eslint.org) ([source](https://github.com/eslint/eslint)) | devDependencies | minor | [`8.36.0` -> `8.37.0`](https://renovatebot.com/diffs/npm/eslint/8.36.0/8.37.0) | --- ### Release Notes <details> <summary>eslint/eslint</summary> ### [`v8.37.0`](https://github.com/eslint/eslint/releases/tag/v8.37.0) [Compare Source](eslint/eslint@v8.36.0...v8.37.0) #### Features - [`b6ab8b2`](eslint/eslint@b6ab8b2) feat: `require-unicode-regexp` add suggestions ([#17007](eslint/eslint#17007)) (Josh Goldberg) - [`10022b1`](eslint/eslint@10022b1) feat: Copy getScope() to SourceCode ([#17004](eslint/eslint#17004)) (Nicholas C. Zakas) - [`1665c02`](eslint/eslint@1665c02) feat: Use plugin metadata for flat config serialization ([#16992](eslint/eslint#16992)) (Nicholas C. Zakas) - [`b3634f6`](eslint/eslint@b3634f6) feat: docs license ([#17010](eslint/eslint#17010)) (Samuel Roldan) - [`892e6e5`](eslint/eslint@892e6e5) feat: languageOptions.parser must be an object. ([#16985](eslint/eslint#16985)) (Nicholas C. Zakas) #### Bug Fixes - [`619f3fd`](eslint/eslint@619f3fd) fix: correctly handle `null` default config in `RuleTester` ([#17023](eslint/eslint#17023)) (Brad Zacher) - [`1fbf118`](eslint/eslint@1fbf118) fix: `getFirstToken`/`getLastToken` on comment-only node ([#16889](eslint/eslint#16889)) (Francesco Trotta) - [`129e252`](eslint/eslint@129e252) fix: Fix typo in `logical-assignment-operators` rule description ([#17000](eslint/eslint#17000)) (Francesco Trotta) #### Documentation - [`75339df`](eslint/eslint@75339df) docs: fix typos and missing info in id-match docs ([#17029](eslint/eslint#17029)) (Ed Lucas) - [`ec2d830`](eslint/eslint@ec2d830) docs: Fix typos in the `semi` rule docs ([#17012](eslint/eslint#17012)) (Andrii Lundiak) - [`e39f28d`](eslint/eslint@e39f28d) docs: add back to top button ([#16979](eslint/eslint#16979)) (Tanuj Kanti) - [`721c717`](eslint/eslint@721c717) docs: Custom Processors cleanup and expansion ([#16838](eslint/eslint#16838)) (Ben Perlmutter) - [`d049f97`](eslint/eslint@d049f97) docs: 'How ESLint is Maintained' page ([#16961](eslint/eslint#16961)) (Ben Perlmutter) - [`5251a92`](eslint/eslint@5251a92) docs: Describe guard options for guard-for-in ([#16986](eslint/eslint#16986)) (alope107) - [`6157d81`](eslint/eslint@6157d81) docs: Add example to guard-for-in docs. ([#16983](eslint/eslint#16983)) (alope107) - [`fd47998`](eslint/eslint@fd47998) docs: update `Array.prototype.toSorted` specification link ([#16982](eslint/eslint#16982)) (Milos Djermanovic) - [`3e1cf6b`](eslint/eslint@3e1cf6b) docs: Copy edits on Maintain ESLint docs ([#16939](eslint/eslint#16939)) (Ben Perlmutter) #### Chores - [`c67f299`](eslint/eslint@c67f299) chore: upgrade [@eslint/js](https://github.com/eslint/js)[@8](https://github.com/8).37.0 ([#17033](eslint/eslint#17033)) (Milos Djermanovic) - [`ee9ddbd`](eslint/eslint@ee9ddbd) chore: package.json update for [@eslint/js](https://github.com/eslint/js) release (ESLint Jenkins) - [`dddb475`](eslint/eslint@dddb475) chore: upgrade [@eslint/eslintrc](https://github.com/eslint/eslintrc)[@2](https://github.com/2).0.2 ([#17032](eslint/eslint#17032)) (Milos Djermanovic) - [`522431e`](eslint/eslint@522431e) chore: upgrade [email protected] ([#17031](eslint/eslint#17031)) (Milos Djermanovic) - [`f5f9a88`](eslint/eslint@f5f9a88) chore: upgrade [email protected] ([#17030](eslint/eslint#17030)) (Milos Djermanovic) - [`4dd8d52`](eslint/eslint@4dd8d52) ci: bump actions/stale from 7 to 8 ([#17026](eslint/eslint#17026)) (dependabot\[bot]) - [`ad9dd6a`](eslint/eslint@ad9dd6a) chore: remove duplicate scss, ([#17005](eslint/eslint#17005)) (Strek) - [`ada6a3e`](eslint/eslint@ada6a3e) ci: unpin Node 19 ([#16993](eslint/eslint#16993)) (Milos Djermanovic) - [`c3da975`](eslint/eslint@c3da975) chore: Remove triage label from template ([#16990](eslint/eslint#16990)) (Nicholas C. Zakas) - [`69bc0e2`](eslint/eslint@69bc0e2) ci: pin Node 19 to 19.7.0 ([#16987](eslint/eslint#16987)) (Milos Djermanovic) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - 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, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate).  Co-authored-by: cabr2-bot <[email protected]> Reviewed-on: https://codeberg.org/Calciumdibromid/CaBr2/pulls/1834 Reviewed-by: Epsilon_02 <[email protected]> Co-authored-by: Calciumdibromid Bot <[email protected]> Co-committed-by: Calciumdibromid Bot <[email protected]>

feat: languageOptions.parser must be an object.

a05b08e

Changes languageOptions.parser to disallow string values. Fixes #16930

nzakas requested a review from a team as a code owner March 14, 2023 19:09

eslint-github-bot Bot added triage An ESLint team member will look at this issue soon feature This change adds a new feature to ESLint labels Mar 14, 2023

fasttime reviewed Mar 14, 2023

View reviewed changes

nzakas added 2 commits March 14, 2023 14:34

Add parser:null check

2a30da4

Remove unnecessary check

1a360e6

nzakas commented Mar 15, 2023

View reviewed changes

mdjermanovic closed this Mar 15, 2023

mdjermanovic reopened this Mar 15, 2023

mdjermanovic approved these changes Mar 15, 2023

View reviewed changes

fasttime approved these changes Mar 15, 2023

View reviewed changes

snitin315 approved these changes Mar 16, 2023

View reviewed changes

snitin315 merged commit 892e6e5 into main Mar 16, 2023

snitin315 deleted the issue16930 branch March 16, 2023 01:06

fasttime mentioned this pull request Mar 29, 2023

[eslint] Flat config parser must be an object DefinitelyTyped/DefinitelyTyped#64931

Merged

8 tasks

NotEvenANeko mentioned this pull request Aug 2, 2023

fix: languageOptions.parser should be an object eslint-types/eslint-define-config#220

Merged

eslint-github-bot Bot locked and limited conversation to collaborators Sep 13, 2023

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 Sep 13, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: languageOptions.parser must be an object.#16985

feat: languageOptions.parser must be an object.#16985
snitin315 merged 3 commits intomainfrom
issue16930

nzakas commented Mar 14, 2023

Uh oh!

netlify Bot commented Mar 14, 2023 •

edited

Loading

Uh oh!

fasttime left a comment

Uh oh!

fasttime Mar 14, 2023

Uh oh!

nzakas Mar 14, 2023

Uh oh!

nzakas Mar 15, 2023

Uh oh!

mdjermanovic commented Mar 15, 2023

Uh oh!

snitin315 commented Mar 15, 2023

Uh oh!

mdjermanovic commented Mar 15, 2023

Uh oh!

mdjermanovic left a comment

Uh oh!

fasttime left a comment

Uh oh!

snitin315 left a comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

	if (typeof parser === "string") {
	const { pluginName, objectName: localParserName } = splitPluginIdentifier(parser);

	parserName = parser;

	if (!plugins \|\| !plugins[pluginName] \|\| !plugins[pluginName].parsers \|\| !plugins[pluginName].parsers[localParserName]) {
	throw new TypeError(`Key "parser": Could not find "${localParserName}" in plugin "${pluginName}".`);
	}

	languageOptions.parser = plugins[pluginName].parsers[localParserName];

Uh oh!

Conversation

nzakas commented Mar 14, 2023

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?

Uh oh!

netlify Bot commented Mar 14, 2023 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for docs-eslint canceled.

Uh oh!

fasttime left a comment

Choose a reason for hiding this comment

Uh oh!

fasttime Mar 14, 2023

Choose a reason for hiding this comment

Uh oh!

nzakas Mar 14, 2023

Choose a reason for hiding this comment

Uh oh!

nzakas Mar 15, 2023

Choose a reason for hiding this comment

Uh oh!

mdjermanovic commented Mar 15, 2023

Uh oh!

snitin315 commented Mar 15, 2023

Uh oh!

mdjermanovic commented Mar 15, 2023

Uh oh!

mdjermanovic left a comment

Choose a reason for hiding this comment

Uh oh!

fasttime left a comment

Choose a reason for hiding this comment

Uh oh!

snitin315 left a comment

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

netlify Bot commented Mar 14, 2023 •

edited

Loading