Update development toolchain

Author: jdesrosiers

.eslintrc.json

@@ -0,0 +1,10 @@
+version: 2
+updates:
+- package-ecosystem: "npm"
+  directory: "/"
+  schedule:
+    interval: "weekly"
+- package-ecosystem: "github-actions"
+  directory: "/"
+  schedule:
+    interval: "weekly"

.github/dependabot.yml

@@ -0,0 +1,18 @@
+name: Node.js Automation
+
+on:
+  push:
+  pull_request:
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v4
+        with:
+          node-version: lts/*
+      - run: npm install
+      - run: npm test
+      - run: npm run lint
+      - run: npm run type-check

.github/workflows/nodejs.yml

@@ -1,3 +1,2 @@
-dist
 node_modules
 package-lock.json

.gitignore

@@ -1,4 +1,5 @@
-.eslintrc.json
-**/*.spec.ts
-lib/gherkin.ts
+.github/
+eslint.config.js
+**/*.test.js
+lib/gherkin.js
 tsconfig.json

.npmignore

@@ -0,0 +1,59 @@
+import tseslint from "typescript-eslint";
+import stylistic from "@stylistic/eslint-plugin";
+// @ts-expect-error No types available
+import importPlugin from "eslint-plugin-import";
+
+
+export default tseslint.config(
+  ...tseslint.configs.recommendedTypeChecked,
+  ...tseslint.configs.stylisticTypeChecked,
+  importPlugin.flatConfigs.recommended, // eslint-disable-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-unsafe-member-access
+  importPlugin.flatConfigs.typescript, // eslint-disable-line @typescript-eslint/no-unsafe-argument, @typescript-eslint/no-unsafe-member-access
+  stylistic.configs.customize({
+    arrowParens: true,
+    braceStyle: "1tbs",
+    commaDangle: "never",
+    jsx: false,
+    quotes: "double",
+    semi: true
+  }),
+  {
+    languageOptions: {
+      parserOptions: {
+        projectService: true,
+        tsconfigRootDir: import.meta.dirname
+      }
+    },
+    settings: {
+      "import/resolver": {
+        typescript: {}
+      }
+    },
+    rules: {
+      // TypeScript
+      "@typescript-eslint/no-unused-vars": ["error", {
+        argsIgnorePattern: "^_",
+        varsIgnorePattern: "^_",
+        caughtErrorsIgnorePattern: "^_"
+      }],
+      "@typescript-eslint/no-empty-function": "off",
+      "@typescript-eslint/consistent-type-definitions": ["error", "type"],
+      "no-console": "error",
+
+      // Imports
+      "import/extensions": ["error", "ignorePackages"],
+      // "import/newline-after-import": ["error", {
+      //   count: 2,
+      //   exactCount: false,
+      //   considerComments: true
+      // }], // Doesn't respect @import
+
+      // Stylistic
+      "@stylistic/yield-star-spacing": ["error", "after"],
+      "@stylistic/multiline-ternary": "off",
+      "@stylistic/no-mixed-operators": "off",
+      "@stylistic/no-multiple-empty-lines": ["error", { max: 2, maxEOF: 0, maxBOF: 0 }], // Allow max=2 for imports
+      "@stylistic/quote-props": ["error", "as-needed"]
+    }
+  }
+);

eslint.config.js

@@ -1,7 +1,10 @@
 import { beforeEach, describe, expect } from "vitest";
 import { Given, When, Then } from "./gherkin.js";
 import * as JsonPointer from "./index.js";
-import type { Json, JsonObject, Pointable } from "./index.js";
+
+/**
+ * @import { Json, JsonObject } from "./index.js"
+ */
 
 
 describe("JsonPointer.assign", () => {
@@ -13,7 +16,7 @@ describe("JsonPointer.assign", () => {
       JsonPointer.assign(pointer, subject, "foo");
 
       Then("the value is not changed", () => {
-        expect(subject).to.eql({ "foo": "bar" });
+        expect(subject).to.eql({ foo: "bar" });
       });
     });
   });
@@ -22,7 +25,7 @@ describe("JsonPointer.assign", () => {
     const pointer = "/aaa";
 
     When("mutating a property", () => {
-      const subject = { "aaa": 111, "bbb": [] };
+      const subject = { aaa: 111, bbb: [] };
       JsonPointer.assign(pointer, subject, "foo");
 
       Then("the new value should be set", () => {
@@ -48,7 +51,7 @@ describe("JsonPointer.assign", () => {
     const pointer = "/aaa/ccc";
 
     When("mutating a property", () => {
-      const subject = { "aaa": { "ccc": 333, "ddd": 444 }, "bbb": 222 };
+      const subject = { aaa: { ccc: 333, ddd: 444 }, bbb: 222 };
       JsonPointer.assign(pointer, subject, "foo");
 
       Then("the new value should be set", () => {
@@ -58,7 +61,8 @@ describe("JsonPointer.assign", () => {
   });
 
   Given("an object", () => {
-    let subject: JsonObject;
+    /** @type JsonObject */
+    let subject;
 
     beforeEach(() => {
       subject = { aaa: { bbb: {} } };
@@ -84,7 +88,8 @@ describe("JsonPointer.assign", () => {
   });
 
   Given("an array", () => {
-    let subject: Json[];
+    /** @type Json[] */
+    let subject;
 
     beforeEach(() => {
       subject = [];
@@ -112,7 +117,8 @@ describe("JsonPointer.assign", () => {
   });
 
   Given("a number", () => {
-    let subject: unknown;
+    /** @type number */
+    let subject;
 
     beforeEach(() => {
       subject = 42;
@@ -122,13 +128,14 @@ describe("JsonPointer.assign", () => {
       const assign = JsonPointer.assign("/0");
 
       Then("an error should be thrown", () => {
-        expect(() => assign(subject as Pointable, "foo")).to.throw(Error, "Value at '' is a number and does not have property '0'");
+        expect(() => assign(subject, "foo")).to.throw(Error, "Value at '' is a number and does not have property '0'");
       });
     });
   });
 
   Given("a string", () => {
-    let subject: unknown;
+    /** @type string */
+    let subject;
 
     beforeEach(() => {
       subject = "foo";
@@ -138,13 +145,14 @@ describe("JsonPointer.assign", () => {
       const assign = JsonPointer.assign("/0");
 
       Then("an error should be thrown", () => {
-        expect(() => assign(subject as Pointable, "foo")).to.throw(Error, "Value at '' is a string and does not have property '0'");
+        expect(() => assign(subject, "foo")).to.throw(Error, "Value at '' is a string and does not have property '0'");
       });
     });
   });
 
   Given("null", () => {
-    let subject: unknown;
+    /** @type null */
+    let subject;
 
     beforeEach(() => {
       subject = null;
@@ -154,7 +162,7 @@ describe("JsonPointer.assign", () => {
       const assign = JsonPointer.assign("/0");
 
       Then("an error should be thrown", () => {
-        expect(() => assign(subject as Pointable, "foo")).to.throw(Error, "Value at '' is null and does not have property '0'");
+        expect(() => assign(subject, "foo")).to.throw(Error, "Value at '' is null and does not have property '0'");
       });
     });
   });

lib/append.spec.ts lib/append.test.jslib/append.spec.ts renamed to lib/append.test.js

@@ -1,11 +1,14 @@
 import { beforeEach, describe, expect, test } from "vitest";
 import * as JsonPointer from "./index.js";
-import type { Getter } from "./index.js";
+
+/**
+ * @import { Getter } from "./index.js"
+ */
 
 
 describe("JsonPointer", () => {
   const subject = {
-    "foo": ["bar", "baz"],
+    foo: ["bar", "baz"],
     "": 0,
     "a/b": 1,
     "c%d": 2,
@@ -19,12 +22,13 @@ describe("JsonPointer", () => {
     "~1": 10,
     "/0": 11,
     "/1": 12,
-    "aaa": null,
-    "bbb": { "-": { "ccc": 13 } }
+    aaa: null,
+    bbb: { "-": { ccc: 13 } }
   };
 
   describe("get", () => {
-    const tests: [string, unknown][] = [
+    /** @type [string, unknown][] */
+    const tests = [
       ["", subject],
       ["/foo", ["bar", "baz"]],
       ["/foo/0", "bar"],
@@ -42,15 +46,16 @@ describe("JsonPointer", () => {
       ["/~10", 11],
       ["/~11", 12],
       ["/bbb/-/ccc", 13],
-      ["/bbb/-", { "ccc": 13 }],
+      ["/bbb/-", { ccc: 13 }],
       ["/bar", undefined],
       ["/foo/2", undefined],
       ["/foo/-", undefined],
       ["/0", undefined]
     ];
     tests.forEach(([pointer, expected]) => {
       describe(JSON.stringify(pointer), () => {
-        let ptr: Getter;
+        /** @type Getter */
+        let ptr;
 
         beforeEach(() => {
           ptr = JsonPointer.get(pointer);

lib/assign.spec.ts lib/assign.test.jslib/assign.spec.ts renamed to lib/assign.test.js

@@ -0,0 +1,20 @@
+import { describe, it } from "vitest";
+
+/**
+ * @import { SuiteCollector, SuiteFactory, TestFunction } from "vitest"
+ */
+
+
+/** @type (message: string, fn?: SuiteFactory) => SuiteCollector */
+export const Given = (message, fn) => describe("Given " + message, fn);
+
+/** @type (message: string, fn?: SuiteFactory) => SuiteCollector */
+export const When = (message, fn) => describe("When " + message, fn);
+
+/** @type (message: string, fn?: TestFunction) => void */
+export const Then = (message, fn) => {
+  it("Then " + message, fn);
+};
+
+/** @type (message: string, fn?: SuiteFactory) => SuiteCollector */
+export const And = (message, fn) => describe("And " + message, fn);