feat: export meta object (#217)

* feat: export meta object

* Create hungry-geckos-dance.md

* fix

* fix

Author: ota-meshi

.changeset/hungry-geckos-dance.md

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

src/index.ts

@@ -2,6 +2,7 @@ import type { RuleModule } from "./types";
 import { rules as ruleList } from "./utils/rules";
 import base from "./configs/base";
 import recommended from "./configs/recommended";
+import * as meta from "./meta";
 
 const configs = {
   base,
@@ -14,6 +15,7 @@ const rules = ruleList.reduce((obj, r) => {
 }, {} as { [key: string]: RuleModule });
 
 export = {
+  meta,
   configs,
   rules,
 };

src/meta.ts

@@ -0,0 +1,3 @@
+// note - cannot migrate this to an import statement because it will make TSC copy the package.json to the dist folder
+// eslint-disable-next-line @typescript-eslint/no-require-imports, @typescript-eslint/no-var-requires -- Get meta data
+export const { name, version } = require("../package.json");

tests/src/meta.ts

@@ -0,0 +1,14 @@
+import assert from "assert";
+import plugin from "../../src";
+import { version } from "../../package.json";
+const expectedMeta = {
+  name: "eslint-plugin-json-schema-validator",
+  version,
+};
+
+describe("Test for meta object", () => {
+  it("A plugin should have a meta object.", () => {
+    assert.strictEqual(plugin.meta.name, expectedMeta.name);
+    assert.strictEqual(plugin.meta.version, expectedMeta.version);
+  });
+});

tsconfig.json

@@ -19,6 +19,7 @@
     // },
     "esModuleInterop": true,
     "outDir": "lib",
+    "resolveJsonModule": true,
     "skipLibCheck": true
   },
   "include": [