[eslint] Adding metadata to Plugin/Processor/ParserModule

[matwilko]

• Use a meaningful title for the pull request. Include the name of the package modified.
• Test the change in your own code. (Compile and run.)
• Add or edit tests to reflect the change.
• Follow the advice from the readme.
• Avoid common mistakes.
• Run npm test <package to test>.

Select one of these and delete the others:

If changing an existing definition:

• Provide a URL to documentation or source code which provides context for the suggested changes: <>
• If this PR brings the type definitions up to date with a new version of the JS library, update the version number in the header.

The custom plugin documentation lists meta.name and meta.version (and legacy name/version properties) that can be specified on a plugin. While not necessarily documented, ESLint also accepts/expects the same metadata on processors and parsers in some cases (caching mostly).

[typescript-bot]

@matwilko Thank you for submitting this PR!

This is a live comment which I will keep updated.

1 package in this PR

• eslint — on npm, on unpkg
  • owner-approval: @JounQin

Code Reviews

Because this is a widely-used package, a DT maintainer will need to review it before it can be merged.

You can test the changes of this PR in the Playground.

Status

• ✅ No merge conflicts
• ✅ Continuous integration tests have passed
• ✅ Most recent commit is approved by a DT maintainer

All of the items on the list are green. To merge, you need to post a comment including the string "Ready to merge" to bring in your changes.

---

Diagnostic Information: What the bot saw about this PR

{
  "type": "info",
  "now": "-",
  "pr_number": 65826,
  "author": "matwilko",
  "headCommitOid": "f1642102693be9d878bf2a1958649b553577f742",
  "mergeBaseOid": "1293dd7b03f25ddc72c07f89314f3814bef35f09",
  "lastPushDate": "2023-06-19T14:04:56.000Z",
  "lastActivityDate": "2023-08-04T18:28:08.000Z",
  "mergeOfferDate": "2023-08-04T17:35:52.000Z",
  "mergeRequestDate": "2023-08-04T18:28:08.000Z",
  "mergeRequestUser": "matwilko",
  "hasMergeConflict": false,
  "isFirstContribution": false,
  "tooManyFiles": false,
  "hugeChange": false,
  "popularityLevel": "Critical",
  "pkgInfo": [
    {
      "name": "eslint",
      "kind": "edit",
      "files": [
        {
          "path": "types/eslint/eslint-tests.ts",
          "kind": "test"
        },
        {
          "path": "types/eslint/index.d.ts",
          "kind": "definition"
        }
      ],
      "owners": [
        "pmdartus",
        "j-f1",
        "saadq",
        "JasonHK",
        "bradzacher",
        "JounQin"
      ],
      "addedOwners": [],
      "deletedOwners": [],
      "popularityLevel": "Critical"
    }
  ],
  "reviews": [
    {
      "type": "approved",
      "reviewer": "jakebailey",
      "date": "2023-08-04T17:35:06.000Z",
      "isMaintainer": true
    },
    {
      "type": "approved",
      "reviewer": "JounQin",
      "date": "2023-08-03T18:48:09.000Z",
      "isMaintainer": false
    },
    {
      "type": "stale",
      "reviewer": "bradzacher",
      "date": "2023-07-11T12:20:42.000Z",
      "abbrOid": "c1a9f47"
    }
  ],
  "mainBotCommentID": 1597254406,
  "ciResult": "pass"
}

[typescript-bot]

🔔 @pmdartus @j-f1 @saadq @JasonHK @bradzacher @JounQin — please review this PR in the next few days. Be sure to explicitly select Approve or Request Changes in the GitHub UI so I know what's going on.

[typescript-bot]

@matwilko The CI build failed! Please review the logs for more information.

Once you've pushed the fixes, the build will automatically re-run. Thanks!

Note: builds which are failing do not end up on the list of PRs for the DT maintainers to review.

[bradzacher]

I wouldn't even bother adding the deprecated properties tbh

[typescript-bot]

@matwilko One or more reviewers has requested changes. Please address their comments. I'll be back once they sign off or you've pushed new commits. Thank you!

[matwilko]

I wouldn't even bother adding the deprecated properties tbh

Sure, I included them because the documentation says the meta.xxx properties are preferred, but it doesn't say the old style properties are being dropped, and I don't think there's any plan to do so.

I was trying to be faithful to what could appear in the wild (if consuming a plugin from elsewhere), and what the documentation permits (if authoring a plugin). :)

I'm happy to take them out if you think there's no real value there.

[matwilko]

Gentle poke @bradzacher 😄

[typescript-bot]

It has been more than two weeks and this PR still has no reviews.

I'll bump it to the DT maintainer queue. Thank you for your patience, @matwilko.

(Ping @pmdartus, @j-f1, @saadq, @JasonHK, @bradzacher.)

[JounQin]

Considering they're added mainly for flat configs which is not stable yet, and they're not included previously, so I also think we should not include the deprecated options.

[matwilko]

@JounQin - the change doesn't relate to flat configs - flat configs don't change anything about the structure of plugins outside of the format of their various config entries, the ability to add name/version to plugins predates flat config afaik 😄

[typescript-bot]

@matwilko One or more reviewers has requested changes. Please address their comments. I'll be back once they sign off or you've pushed new commits. Thank you!

[typescript-bot]

@matwilko The CI build failed! Please review the logs for more information.

Once you've pushed the fixes, the build will automatically re-run. Thanks!

Note: builds which are failing do not end up on the list of PRs for the DT maintainers to review.

[typescript-bot]

@matwilko The CI build failed! Please review the logs for more information.

Once you've pushed the fixes, the build will automatically re-run. Thanks!

Note: builds which are failing do not end up on the list of PRs for the DT maintainers to review.

[typescript-bot]

@bradzacher Thank you for reviewing this PR! The author has pushed new commits since your last review. Could you take another look and submit a fresh review?

[jakebailey]

Are there any more concerns here?

[JounQin]

Are there any more concerns here?

I don't think so~ Good to merge now.

[typescript-bot]

@matwilko: Everything looks good here. I am ready to merge this PR (at f164210) on your behalf whenever you think it's ready.

If you'd like that to happen, please post a comment saying:

Ready to merge

and I'll merge this PR almost instantly. Thanks for helping out! ❤️

(@pmdartus, @j-f1, @saadq, @JasonHK, @bradzacher, @JounQin: you can do this too.)

[matwilko]

Ready to merge