feat: export meta object (#234)

Author: ota-meshi

.changeset/brown-doors-crash.md

@@ -0,0 +1,5 @@
+---
+"eslint-plugin-jsonc": minor
+---
+
+feat: export meta object

lib/configs/prettier.ts

@@ -1,3 +1,6 @@
+// IMPORTANT!
+// This file has been automatically generated,
+// in order to update its content execute "npm run update"
 import path from "path";
 const base = require.resolve("./base");
 const baseExtend =

lib/configs/recommended-with-json.ts

@@ -1,3 +1,6 @@
+// IMPORTANT!
+// This file has been automatically generated,
+// in order to update its content execute "npm run update"
 import path from "path";
 const base = require.resolve("./base");
 const baseExtend =

lib/configs/recommended-with-json5.ts

@@ -1,3 +1,6 @@
+// IMPORTANT!
+// This file has been automatically generated,
+// in order to update its content execute "npm run update"
 import path from "path";
 const base = require.resolve("./base");
 const baseExtend =

lib/configs/recommended-with-jsonc.ts

@@ -1,3 +1,6 @@
+// IMPORTANT!
+// This file has been automatically generated,
+// in order to update its content execute "npm run update"
 import path from "path";
 const base = require.resolve("./base");
 const baseExtend =

lib/index.ts

@@ -7,6 +7,7 @@ import recommendedWithJsonc from "./configs/recommended-with-jsonc";
 import recommendedWithJson5 from "./configs/recommended-with-json5";
 import prettier from "./configs/prettier";
 import all from "./configs/all";
+import * as meta from "./meta";
 
 // backward compatibility
 import {
@@ -33,6 +34,7 @@ const rules = ruleList.reduce((obj, r) => {
 }, {} as { [key: string]: RuleModule });
 
 export default {
+  meta,
   configs,
   rules,
   // as parser
@@ -43,6 +45,7 @@ export default {
   getStaticJSONValue,
 };
 export {
+  meta,
   configs,
   rules,
   // as parser

lib/meta.ts

@@ -0,0 +1,5 @@
+// IMPORTANT!
+// This file has been automatically generated,
+// in order to update its content execute "npm run update"
+export const name = "eslint-plugin-jsonc" as const;
+export const version = "2.7.0" as const;

lib/utils/rules.ts

@@ -1,3 +1,6 @@
+// IMPORTANT!
+// This file has been automatically generated,
+// in order to update its content execute "npm run update"
 import type { RuleModule } from "../types";
 import arrayBracketNewline from "../rules/array-bracket-newline";
 import arrayBracketSpacing from "../rules/array-bracket-spacing";

package.json

@@ -17,7 +17,8 @@
   },
   "scripts": {
     "prebuild": "npm run -s clean",
-    "build": "npm run build:ts && npm run build:dts",
+    "build": "npm run build:meta && npm run build:ts && npm run build:dts",
+    "build:meta": "ts-node --transpile-only ./tools/update-meta.ts",
     "build:ts": "tsc --project ./tsconfig.build.json",
     "build:dts": "npm run build:dts-step1 && npm run build:dts-step2",
     "build:dts-step1": "tsc --declaration --outDir dist-ts --project ./tsconfig.build.json",

tests/lib/meta.ts

@@ -0,0 +1,26 @@
+import assert from "assert";
+import plugin from "../../lib";
+import { version } from "../../package.json";
+const expectedMeta = {
+  name: "eslint-plugin-jsonc",
+  version,
+};
+
+describe("Test for meta object", () => {
+  it("A plugin should have a meta object.", () => {
+    assert.strictEqual(plugin.meta.name, expectedMeta.name);
+    assert.strictEqual(typeof plugin.meta.version, "string");
+  });
+
+  for (const [name, processor] of Object.entries(
+    // @ts-expect-error -- missing processors
+    plugin.processors || {}
+  )) {
+    it(`"${name}" processor should have a meta object.`, () => {
+      // @ts-expect-error -- missing type
+      assert.strictEqual(processor.meta.name, expectedMeta.name);
+      // @ts-expect-error -- missing type
+      assert.strictEqual(typeof processor.meta.version, "string");
+    });
+  }
+});