Skip to content

Commit 3087c9e

Browse files
authoredNov 6, 2024··
feat: add meta object to @eslint/js plugin (#19095)
1 parent 298625e commit 3087c9e

File tree

4 files changed

+18
-1
lines changed

4 files changed

+18
-1
lines changed
 

‎packages/js/README.md

+3
Original file line numberDiff line numberDiff line change
@@ -28,12 +28,14 @@ export default [
2828

2929
// apply recommended rules to JS files
3030
{
31+
name: "your-project/recommended-rules",
3132
files: ["**/*.js"],
3233
rules: js.configs.recommended.rules
3334
},
3435

3536
// apply recommended rules to JS files with an override
3637
{
38+
name: "your-project/recommended-rules-with-override",
3739
files: ["**/*.js"],
3840
rules: {
3941
...js.configs.recommended.rules,
@@ -43,6 +45,7 @@ export default [
4345

4446
// apply all rules to JS files
4547
{
48+
name: "your-project/all-rules",
4649
files: ["**/*.js"],
4750
rules: {
4851
...js.configs.all.rules,

‎packages/js/src/index.js

+6
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,17 @@
55

66
"use strict";
77

8+
const { version } = require("../package.json");
9+
810
//------------------------------------------------------------------------------
911
// Public Interface
1012
//------------------------------------------------------------------------------
1113

1214
module.exports = {
15+
meta: {
16+
name: "@eslint/js",
17+
version
18+
},
1319
configs: {
1420
all: require("./configs/eslint-all"),
1521
recommended: require("./configs/eslint-recommended")

‎packages/js/tests/types/types.test.ts

+5-1
Original file line numberDiff line numberDiff line change
@@ -25,9 +25,13 @@
2525
* SOFTWARE
2626
*/
2727

28-
import type { Linter } from "eslint";
28+
import type { ESLint, Linter } from "eslint";
2929
import js from "../../";
3030

31+
js satisfies ESLint.Plugin;
32+
js.meta.name satisfies string;
33+
js.meta.version satisfies string;
34+
3135
let config: Linter.Config[];
3236

3337
config = [js.configs.recommended];

‎packages/js/types/index.d.ts

+4
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
import type { Linter } from "eslint";
22

33
declare const js: {
4+
readonly meta: {
5+
readonly name: string;
6+
readonly version: string;
7+
},
48
readonly configs: {
59
readonly recommended: { readonly rules: Readonly<Linter.RulesRecord> };
610
readonly all: { readonly rules: Readonly<Linter.RulesRecord> };

0 commit comments

Comments
 (0)
Please sign in to comment.