chore: use changesets (#201)

Author: ota-meshi

.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

.changeset/config.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config/schema.json",
+  "changelog": [
+    "@changesets/changelog-github",
+    {
+      "repo": "ota-meshi/eslint-plugin-json-schema-validator"
+    }
+  ],
+  "commit": false,
+  "linked": [],
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "bumpVersionsWithWorkspaceProtocolOnly": true,
+  "ignore": []
+}

.env-cmdrc

@@ -7,5 +7,8 @@
   },
   "version": {
     "IN_VERSION_SCRIPT": "true"
+  },
+  "version-ci": {
+    "IN_VERSION_CI_SCRIPT": "true"
   }
 }

.github/workflows/NpmPublish.yml

@@ -0,0 +1,41 @@
+name: Release
+
+on:
+  push:
+    branches:
+      - main
+
+jobs:
+  release:
+    name: Release
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@v3
+        with:
+          # This makes Actions fetch all Git history so that Changesets can generate changelogs with the correct commits
+          fetch-depth: 0
+
+      - name: Setup Node.js 16
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18
+
+      - name: Install Dependencies
+        run: npm install
+      - name: Build
+        run: npm run build
+
+      - name: Create Release Pull Request or Publish to npm
+        id: changesets
+        uses: changesets/action@v1
+        with:
+          # this expects you to have a npm script called version that runs some logic and then calls `changeset version`.
+          version: npm run version:ci
+          # This expects you to have a script called release which does a build for your packages and calls changeset publish
+          publish: npm run release
+          commit: "chore: release eslint-plugin-json-schema-validator"
+          title: "chore: release eslint-plugin-json-schema-validator"
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

.github/workflows/Release.yml

@@ -36,11 +36,14 @@
     "new": "yarn ts ./tools/new-rule",
     "prebuild": "yarn -s clean",
     "predocs:watch": "yarn build:ts",
+    "prerelease": "yarn test && yarn build",
     "preversion": "yarn test && git add .",
+    "release": "changeset publish",
     "test": "env-cmd -e test yarn mocha \"tests/src/**/*.ts\" --reporter dot --timeout 60000",
     "ts": "env-cmd -e base node -r esbuild-register",
     "update": "yarn ts ./tools/update && yarn lint-fix",
-    "version": "env-cmd -e version yarn update && git add ."
+    "version": "env-cmd -e version yarn update && git add .",
+    "version:ci": "env-cmd -e version-ci yarn update && changeset version"
   },
   "peerDependencies": {
     "eslint": ">=6.0.0"
@@ -59,6 +62,8 @@
   },
   "devDependencies": {
     "@actions/core": "^1.2.6",
+    "@changesets/changelog-github": "^0.4.6",
+    "@changesets/cli": "^2.24.2",
     "@ota-meshi/eslint-plugin": "^0.13.0",
     "@types/debug": "^4.1.5",
     "@types/eslint": "^8.0.0",
@@ -105,5 +110,8 @@
     "vue-eslint-parser": "^9.0.0",
     "vuepress": "^1.5.2",
     "yaml": "^2.1.1"
+  },
+  "publishConfig": {
+    "access": "public"
   }
 }

package.json

@@ -23,13 +23,14 @@ export interface RuleMetaData {
     url: string;
     ruleId: string;
     ruleName: string;
-    replacedBy?: string[];
     default?: "error" | "warn";
   };
   messages: { [messageId: string]: string };
   fixable?: "code" | "whitespace";
+  hasSuggestions?: boolean;
   schema: JSONSchema4 | JSONSchema4[];
   deprecated?: boolean;
+  replacedBy?: string[];
   type: "problem" | "suggestion" | "layout";
 }
 
@@ -45,13 +46,14 @@ export interface PartialRuleMetaData {
   docs: {
     description: string;
     categories: "recommended"[] | null;
-    replacedBy?: string[];
     default?: "error" | "warn";
   };
   messages: { [messageId: string]: string };
   fixable?: "code" | "whitespace";
+  hasSuggestions?: boolean;
   schema: JSONSchema4 | JSONSchema4[];
   deprecated?: boolean;
+  replacedBy?: string[];
   type: "problem" | "suggestion" | "layout";
 }
 

src/types.ts

@@ -0,0 +1,27 @@
+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 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
+  );
+
+  return releasePlan.releases.find(
+    ({ name }) => name === "eslint-plugin-json-schema-validator"
+  )!.newVersion;
+}