kvalita 1.22.0 → 1.24.0

package/README.md

@@ -30,6 +30,26 @@ Create a `biome.json` file in your project root:
 }
 ```
 
+The config also runs GritQL plugins. Most of them target Bun tests:
+
+- `await` before `expect(...).rejects`, since Bun tracks that assertion on its own.
+- A callback written inline in `expect(() => fn()).toThrow()`, which reads better as `const throwing = () => fn()`.
+- `const expected = value`, where asserting against `value` says the input comes back unchanged.
+- `const expected = true` or `false`, where the boolean reads better inline in `toBe()`.
+- `toBe(undefined)` and `toEqual(undefined)`, where `toBeUndefined()` says it directly.
+- A test title that doesn't start with "should".
+- A table written inline in `it.each(...)`, which reads better as a typed const above the call.
+
+The rest apply to all code:
+
+- `as unknown as`, which skips the type check entirely.
+- An object literal cast with `as Type`, where an annotation checks every field. `as const` is fine.
+- `.catch()` chained on a promise, where try/catch around an `await` is the house style. A fire-and-forget call behind `void` keeps its `.catch()`.
+- Two or more `===` comparisons against literals in one condition, which read better as a named array and `.includes()`.
+- A regex constant whose name doesn't end with `Regex`.
+
+The plugins load from `node_modules/kvalita`, so the config expects kvalita installed at the project root.
+
 ### [Commitlint](https://github.com/conventional-changelog/commitlint) Configuration
 
 Create a `commitlint.json` file in your project root:
@@ -111,7 +131,34 @@ jobs:
     secrets: inherit
 ```
 
-`shared-release` takes `branch`, `build`, `config` and `bun-version`; `shared-test` takes `bun-version`. Every one has a default, so a repo on the common setup passes nothing.
+`shared-release` takes `branch`, `build`, `config` and `bun-version`; `shared-test` takes `bun-version` and `ref`. Every one has a default, so a repo on the common setup passes nothing. Start every release from `main` and pick the branch with `branch`: `shared-release` checks it out and tells semantic-release to release it. Pass the same branch as `ref` when a release job waits on `shared-test`, or the tests check `main` instead of the branch being released.
+
+`shared-package` checks the package the way a consumer gets it. It builds the package, installs it into an empty project with `npm install --install-links`, so only the published files land there, and loads every entry point in `exports`: through `import`, and through `require()` where a `require` condition exists. It does that on every even Node.js major from the floor in `engines.node`, or 18 when it isn't set, up to the latest release. On the latest one, it also turns off syntax detection and `require()` of ESM files, which older versions don't have. Optional peers get installed too, since an entry point built on one needs it.
+
+A second job checks the same entry points the way TypeScript and bundler users reach them. It type-checks them from an ESM and a CommonJS project under each module resolution (`node10`, `node16`, `nodenext` and `bundler`) with `strict` and `skipLibCheck: false`, and fails only on errors in the package's own types. It also bundles them with Vite as a server build. With `browser: true`, it bundles them for the browser as well. Every setup only imports what the package claims: CommonJS files only use entry points with a `require` condition, and `node10` only checks the root entry, when the package has a top-level `types`.
+
+It takes `ref`, `bun-version` and `browser`:
+
+```yaml
+# .github/workflows/package.yml
+name: Package
+on:
+  push:
+    branches: [main, alpha, beta, rc]
+  pull_request:
+  workflow_call:
+    inputs:
+      ref:
+        type: string
+        default: ''
+jobs:
+  package:
+    uses: macieklamberski/kvalita/.github/workflows/shared-package.yml@main
+    with:
+      ref: ${{ inputs.ref }}
+```
+
+The `workflow_call` trigger lets the release workflow run it as a gate with `ref: ${{ inputs.branch }}`, next to `shared-test`.
 
 ### Ignore File Templates
 

package/configs/biome/no-await-expect-rejects.grit

@@ -0,0 +1,5 @@
+language js
+
+`await expect($value).rejects.$matcher($args)` where {
+  register_diagnostic(span=$value, message="Drop the await: Bun tracks an expect(...).rejects assertion on its own. Name the call as `const throwing = () => fn()` and assert `expect(throwing()).rejects...`.")
+}

package/configs/biome/no-double-cast.grit

@@ -0,0 +1,5 @@
+language js
+
+`$value as unknown as $type` where {
+  register_diagnostic(span=$value, message="Drop the `as unknown` step: try a single cast, a runtime check or a property of the base type first.")
+}

package/configs/biome/no-expected-alias.grit

@@ -0,0 +1,6 @@
+language js
+
+`const expected = $alias` where {
+  $alias <: `value`,
+  register_diagnostic(span=$alias, message="Assert against `value` itself: `const expected = value` names the same value twice.")
+}

package/configs/biome/no-expected-boolean.grit

@@ -0,0 +1,9 @@
+language js
+
+`const expected = $boolean` where {
+  $boolean <: or {
+    `true`,
+    `false`
+  },
+  register_diagnostic(span=$boolean, message="Inline the boolean in the matcher: `expect(...).toBe(true)`.")
+}

package/configs/biome/no-inline-each-table.grit

@@ -0,0 +1,11 @@
+language js
+
+`$test.each($rows)` where {
+  $test <: or {
+    `it`,
+    `test`,
+    `describe`
+  },
+  $rows <: array(),
+  register_diagnostic(span=$rows, message="Move the table into a typed const above the call.")
+}

package/configs/biome/no-literal-equality-chain.grit

@@ -0,0 +1,13 @@
+language js
+
+`$left === $first || $left === $second` where {
+  $first <: or {
+    string(),
+    number()
+  },
+  $second <: or {
+    string(),
+    number()
+  },
+  register_diagnostic(span=$left, message="Put the literals in a named array and check membership with `.includes()`.")
+}

package/configs/biome/no-object-cast.grit

@@ -0,0 +1,7 @@
+language js
+
+`$object as $type` where {
+  $object <: object(),
+  not $type <: r"^const$",
+  register_diagnostic(span=$object, message="Annotate instead of casting: `const value: Type = { ... }` checks every field.")
+}

package/configs/biome/no-promise-catch.grit

@@ -0,0 +1,6 @@
+language js
+
+`$promise.catch($handler)` where {
+  not $promise <: within `void $_` ,
+  register_diagnostic(span=$handler, message="Handle the rejection in try/catch around an await. A fire-and-forget call keeps `.catch()` behind `void`.")
+}

package/configs/{biome.json → biome/shared.json}

@@ -1,6 +1,20 @@
 {
   "$schema": "https://biomejs.dev/schemas/latest/schema.json",
   "root": false,
+  "plugins": [
+    "./node_modules/kvalita/configs/biome/no-await-expect-rejects.grit",
+    "./node_modules/kvalita/configs/biome/no-double-cast.grit",
+    "./node_modules/kvalita/configs/biome/no-expected-alias.grit",
+    "./node_modules/kvalita/configs/biome/no-expected-boolean.grit",
+    "./node_modules/kvalita/configs/biome/no-inline-each-table.grit",
+    "./node_modules/kvalita/configs/biome/no-literal-equality-chain.grit",
+    "./node_modules/kvalita/configs/biome/no-object-cast.grit",
+    "./node_modules/kvalita/configs/biome/no-promise-catch.grit",
+    "./node_modules/kvalita/configs/biome/use-throwing-const.grit",
+    "./node_modules/kvalita/configs/biome/use-regex-suffix.grit",
+    "./node_modules/kvalita/configs/biome/use-should-title.grit",
+    "./node_modules/kvalita/configs/biome/use-to-be-undefined.grit"
+  ],
   "vcs": {
     "enabled": true,
     "clientKind": "git",
@@ -45,7 +59,9 @@
         "noMultiAssign": "error",
         "noMultilineString": "error",
         "noNestedTernary": "error",
+        "noNonNullAssertion": "error",
         "noParameterAssign": "error",
+        "noProcessEnv": "error",
         "noSubstr": "error",
         "noUnusedTemplateLiteral": "error",
         "noUselessElse": "error",
@@ -78,6 +94,7 @@
         "useShorthandAssign": "error",
         "useSingleVarDeclarator": "error",
         "useSpreadOverApply": "error",
+        "useTemplate": "error",
         "useThrowNewError": "error",
         "useThrowOnlyError": "error",
         "useTrimStartEnd": "error"
@@ -101,10 +118,13 @@
       "suspicious": {
         "noDuplicatedSpreadProps": "error",
         "noEmptySource": "error",
+        "noFocusedTests": "error",
         "noForIn": "error",
+        "noMisplacedAssertion": "error",
         "noParametersOnlyUsedInRecursion": "error",
         "noProto": "error",
         "noReturnAssign": "error",
+        "noSkippedTests": "error",
         "noVar": "error",
         "useArraySortCompare": "error",
         "useAwait": "error",
@@ -117,6 +137,21 @@
       },
       "security": {
         "noScriptUrl": "error"
+      },
+      "nursery": {
+        "noConditionalExpect": "error",
+        "noFloatingPromises": "error",
+        "noIdenticalTestTitle": "error",
+        "useConsistentFunctionStyle": {
+          "level": "error",
+          "options": {
+            "style": "expression"
+          }
+        },
+        "useConsistentTestIt": "error",
+        "useNullishCoalescing": "error",
+        "useTestHooksOnTop": "error",
+        "useValidTestTitle": "error"
       }
     }
   }

package/configs/biome/use-regex-suffix.grit

@@ -0,0 +1,11 @@
+language js
+
+`const $name = $value` where {
+  $value <: or {
+    r"^/.+/[dgimsuvy]*$",
+    `new RegExp($pattern)`,
+    `new RegExp($pattern, $flags)`
+  },
+  not $name <: r".*Regex$",
+  register_diagnostic(span=$name, message="End a regex constant's name with `Regex`.")
+}

package/configs/biome/use-should-title.grit

@@ -0,0 +1,17 @@
+language js
+
+`$test($title, $callback)` where {
+  $test <: or {
+    `it`,
+    `test`,
+    `it.todo`,
+    `it.skip`,
+    `it.only`,
+    `test.todo`,
+    `test.skip`,
+    `test.only`
+  },
+  $title <: r"^['\"`].*",
+  not $title <: r"^['\"`]should .*",
+  register_diagnostic(span=$title, message="Start the test title with \"should\".")
+}

package/configs/biome/use-throwing-const.grit

@@ -0,0 +1,13 @@
+language js
+
+`expect($callback).$matcher($args)` where {
+  $callback <: or {
+    `() => $body`,
+    `async () => $body`
+  },
+  $matcher <: or {
+    `toThrow`,
+    `toThrowError`
+  },
+  register_diagnostic(span=$callback, message="Name the throwing call: `const throwing = () => fn()`, then `expect(throwing).toThrow(...)`.")
+}

package/configs/biome/use-to-be-undefined.grit

@@ -0,0 +1,10 @@
+language js
+
+`expect($value).$matcher(undefined)` where {
+  $matcher <: or {
+    `toBe`,
+    `toEqual`,
+    `toStrictEqual`
+  },
+  register_diagnostic(span=$matcher, message="Assert a missing value with `toBeUndefined()`.")
+}

package/package.json

@@ -15,7 +15,7 @@
     "configs"
   ],
   "exports": {
-    "./biome": "./configs/biome.json",
+    "./biome": "./configs/biome/shared.json",
     "./commitlint": "./configs/commitlint.json",
     "./semantic-release": "./configs/semantic-release.json",
     "./semantic-release-dry-run": "./configs/semantic-release-dry-run.json"
@@ -37,9 +37,10 @@
     "@commitlint/cli": "^21.2.2",
     "@commitlint/config-conventional": "^21.2.2",
     "conventional-changelog-conventionalcommits": "^9.3.1",
+    "kvalita": "file:.",
     "lefthook": "^2.1.14",
     "semantic-release": "^25.0.9",
     "typescript": "^7.0.2"
   },
-  "version": "1.22.0"
+  "version": "1.24.0"
 }