feat: export meta object (#238)

* feat: export meta object

* Create loud-elephants-attend.md

* fix

.changeset/loud-elephants-attend.md

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

package.json

@@ -11,7 +11,8 @@
   },
   "scripts": {
     "prebuild": "npm run -s clean",
-    "build": "npm run build:ts",
+    "build": "npm run build:meta && npm run build:ts",
+    "build:meta": "npm run ts -- ./tools/update-meta.ts",
     "build:ts": "tsc --project ./tsconfig.build.json",
     "clean": "rimraf .nyc_output dist coverage",
     "lint": "eslint . --ext .js,.vue,.ts,.json,.md,.yml,.yaml",

src/index.ts

@@ -4,6 +4,7 @@ import base from "./configs/base";
 import recommended from "./configs/recommended";
 import standard from "./configs/standard";
 import prettier from "./configs/prettier";
+import * as meta from "./meta";
 
 const configs = {
   base,
@@ -18,6 +19,7 @@ const rules = ruleList.reduce((obj, r) => {
 }, {} as { [key: string]: RuleModule });
 
 export = {
+  meta,
   configs,
   rules,
 };

src/meta.ts

@@ -0,0 +1,5 @@
+// IMPORTANT!
+// This file has been automatically generated,
+// in order to update its content execute "yarn build:meta"
+export const name = "eslint-plugin-yml" as const;
+export const version = "1.6.0" as const;

tests/src/meta.ts

@@ -0,0 +1,23 @@
+import assert from "assert";
+import plugin from "../../src";
+import { version } from "../../package.json";
+const expectedMeta = {
+  name: "eslint-plugin-yml",
+  version,
+};
+
+describe("Test for meta object", () => {
+  it("A plugin should have a meta object.", () => {
+    assert.deepStrictEqual(plugin.meta, expectedMeta);
+  });
+
+  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.deepStrictEqual(processor.meta, expectedMeta);
+    });
+  }
+});

tools/lib/changesets-util.ts

@@ -1,25 +1,9 @@
-import assembleReleasePlan from "@changesets/assemble-release-plan";
-import readChangesets from "@changesets/read";
-import { read } from "@changesets/config";
-import { getPackages } from "@manypkg/get-packages";
-import { readPreState } from "@changesets/pre";
+import getReleasePlan from "@changesets/get-release-plan";
 import path from "path";
 
-const root = path.resolve(__dirname, "../..");
-
 /** Get new version string from changesets */
 export async function getNewVersion(): Promise<string> {
-  const packages = await getPackages(root);
-  const preState = await readPreState(root);
-  const config = await read(root, packages);
-  const changesets = await readChangesets(root);
-
-  const releasePlan = assembleReleasePlan(
-    changesets,
-    packages,
-    config,
-    preState
-  );
+  const releasePlan = await getReleasePlan(path.resolve(__dirname, "../.."));
 
   return releasePlan.releases.find(({ name }) => name === "eslint-plugin-yml")!
     .newVersion;

tools/update-meta.ts

@@ -0,0 +1,38 @@
+import fs from "fs";
+import path from "path";
+import { ESLint } from "eslint";
+import { name, version } from "../package.json";
+import { getNewVersion } from "./lib/changesets-util";
+
+const META_PATH = path.join(__dirname, "../src/meta.ts");
+
+void main();
+
+/** main */
+async function main() {
+  if (!fs.existsSync(META_PATH)) {
+    fs.writeFileSync(META_PATH, "", "utf8");
+  }
+  const eslint = new ESLint({ fix: true });
+  const [result] = await eslint.lintText(
+    `/*
+ * IMPORTANT!
+ * This file has been automatically generated,
+ * in order to update its content execute "npm run update"
+ */
+export const name = ${JSON.stringify(name)} as const;
+export const version = ${JSON.stringify(await getVersion())} as const;
+`,
+    { filePath: META_PATH }
+  );
+  fs.writeFileSync(META_PATH, result.output!);
+}
+
+/** Get version */
+function getVersion() {
+  // eslint-disable-next-line no-process-env -- ignore
+  if (process.env.IN_VERSION_CI_SCRIPT) {
+    return getNewVersion();
+  }
+  return version;
+}

tools/update-rules.ts

@@ -12,7 +12,11 @@ function camelCase(str: string) {
   return str.replace(/[-/_](\w)/gu, (_, c) => (c ? c.toUpperCase() : ""));
 }
 
-let content = `
+let content = `/*
+ * IMPORTANT!
+ * This file has been automatically generated,
+ * in order to update its content execute "npm run update"
+ */
 import type { RuleModule } from "../types"
 ${rules
   .map(

tools/update-rulesets.ts

@@ -45,7 +45,11 @@ const CONFIGS = {
 };
 
 for (const rec of ["recommended", "standard", "prettier"] as const) {
-  let content = `
+  let content = `/*
+ * 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 =

tools/update.ts

@@ -3,3 +3,4 @@ import "./update-rulesets";
 import "./update-docs";
 import "./update-readme";
 import "./update-docs-rules-index";
+import "./update-meta";

tsconfig.json

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