@adamhl8/configs 0.27.3 → 0.28.0

package/README.md

@@ -6,6 +6,26 @@ Configs (`tsconfig`, `oxfmt`, `oxlint`, etc.) I use across my projects.
 nub add -D @adamhl8/configs
 ```
 
+### just
+
+Scripts live in a shared [`just`](https://github.com/casey/just) base justfile instead of being copied into every project's `package.json`. Your `justfile`:
+
+```just
+import "node_modules/@adamhl8/configs/dist/configs/justfile.base.just"
+```
+
+It provides `lint`, `build`, `test`, `bump-deps`, `release`, `release-run`, and `prepare`. Run `just` to list them. `build` only runs `tsdown` if the project has a `tsdown.config.ts`, so projects without a build step can use it as-is.
+
+The only script left in `package.json` is `prepare`, which hands off to just:
+
+```json
+"scripts": {
+  "prepare": "just prepare"
+}
+```
+
+The base justfile puts `node_modules/.bin` on `PATH`, so recipes can call package bins directly, just like `package.json` scripts.
+
 ### tsconfig
 
 ```json
@@ -98,7 +118,7 @@ adamhl8-cliff --bumped-version
 
 ### lefthook
 
-`lefthook.base.yaml` runs `lint` on pre-commit and `commitlint` on commit-msg. Extend it from your `lefthook.yaml`:
+`lefthook.base.yaml` runs `just lint` on pre-commit and `commitlint` on commit-msg. Extend it from your `lefthook.yaml`:
 
 ```yaml
 # lefthook.yaml
@@ -106,13 +126,13 @@ extends:
   - node_modules/@adamhl8/configs/dist/configs/lefthook.base.yaml
 ```
 
-`lefthook install` (run it from `prepare`) sets up the hooks.
+`lefthook install` (the base justfile's `prepare` recipe runs it) sets up the hooks.
 
 ## GitHub Actions
 
-This repo hosts three reusable workflows you can call from other projects instead of copy/pasting them. The calling project must use `nub` and define `lint` / `bundle` / `bump-deps` / `release:run` scripts and a commitlint config (e.g. via these configs).
+This repo hosts three reusable workflows you can call from other projects instead of copy/pasting them. The calling project must use `nub`, have a `justfile` that imports the base justfile (see [just](#just)), and have a commitlint config (e.g. via these configs). The workflows install just themselves.
 
-- `ci.yml`: runs `bundle` (build + lint) on pushes/PRs and lints commit messages with commitlint
+- `ci.yml`: runs `build` (build + lint) on pushes/PRs and lints commit messages with commitlint
 - `update-deps.yml`: weekly `bump-deps` run that opens a dependency-update PR
 - `release.yml`: manually dispatched release where git-cliff sets the version, then publishes to npm and cuts a GitHub release (commit and tag signed)
 
@@ -151,9 +171,9 @@ jobs:
 
 ### Release
 
-Manually dispatched. git-cliff computes the next version from the commits, then `release-it` bumps `package.json`, regenerates the changelog, commits and tags (both SSH-signed), publishes to npm, and cuts a GitHub release. There is no automatic trigger, so run it when a release is ready (the `release` script just does `gh workflow run release.yml`). A dispatch with no releasable commits fails fast at release-it's `Version not changed`.
+Manually dispatched. git-cliff computes the next version from the commits, then `release-it` bumps `package.json`, regenerates the changelog, commits and tags (both SSH-signed), publishes to npm, and cuts a GitHub release. There is no automatic trigger, so run it when a release is ready (the `release` recipe just does `gh workflow run release.yml`). A dispatch with no releasable commits fails fast at release-it's `Version not changed`.
 
-Needs the `NPM_CI_TOKEN` and `CI_SIGNING_KEY` secrets (see [Secrets](#secrets)). The calling project must define `release` and `release:run` scripts, where `release:run` is `release-it --ci -i "$(adamhl8-cliff --bumped-version)"`.
+Needs the `NPM_CI_TOKEN` and `CI_SIGNING_KEY` secrets (see [Secrets](#secrets)). The workflow runs the base justfile's `release-run` recipe: `release-it --ci -i "$(adamhl8-cliff --bumped-version)"`.
 
 ```yaml
 # .github/workflows/release.yml
@@ -182,6 +202,6 @@ Configure these on each repo that uses the workflows (Settings -> Secrets and va
 
 ## Notes
 
-The `prepare` script looks like: `"prepare": "lefthook install && tsdown"`
+The `prepare` script is `"prepare": "just prepare"`, which runs the base justfile's `prepare` recipe (`lefthook install`).
 
-nub installs `package.json` bin executables into the local `node_modules/.bin`. This means that we can run something like `adamhl8-knip` directly instead of doing `src/adamhl8-knip/index.tx`. That's why we have `tsdown` in the prepare script. Those executables need to be available.
+nub installs `package.json` bin executables into the local `node_modules/.bin`. This means that we can run something like `adamhl8-cliff` directly instead of doing `src/adamhl8-cliff/index.ts`. That's why this repo overrides the `prepare` recipe to also run `tsdown`. Those executables need to be available.

package/dist/configs/justfile.base.just

@@ -0,0 +1,42 @@
+# user-defined functions are unstable as of just 1.52
+set unstable
+set default-list
+set allow-duplicate-recipes
+set lazy
+
+export PATH := justfile_directory() + "/node_modules/.bin:" + env("PATH")
+
+# runs cmd if the [ ] condition holds, echoing cmd only when it runs
+run-when(cmd, condition) := f"if [ {{condition}} ]; then echo {{style("command", cmd)}}; {{cmd}}; fi"
+
+current_repo := `basename -s .git $(git remote get-url origin)`
+
+prepare:
+    lefthook install
+    @{{ run-when("tsdown", f"{{current_repo}} = configs") }}
+
+bump-deps:
+    nub update -L
+    rm -f lock.yaml
+    nub i --no-frozen-lockfile
+    oxfmt lock.yaml
+
+lint:
+    markdown-toc -i --bullets '-' --maxdepth 3 ./README.md
+    oxlint --fix --fix-suggestions --fix-dangerously
+    oxfmt
+    knip
+    @{{ run-when("just test", "-f vitest.config.ts") }}
+
+build: lint
+    @{{ run-when("tsdown", "-f tsdown.config.ts") }}
+
+test:
+    vitest run
+
+release:
+    gh workflow run release.yml
+
+[private]
+release-run:
+    release-it --ci -i "$(adamhl8-cliff --bumped-version)"

package/dist/configs/knip.base.d.ts

@@ -5,8 +5,8 @@ import { KnipConfig } from "knip";
 declare const knipConfig: OptionalMergeConfigFn<KnipConfig, {
   readonly project: ["**/*"];
   readonly entry: ["./src/index.ts"];
-  readonly ignoreBinaries: ["lefthook", "gh"];
-  readonly ignoreDependencies: ["@adamhl8/eslint-plugin-clean-modules"];
+  readonly ignoreBinaries: ["just"];
+  readonly ignoreDependencies: ["@adamhl8/eslint-plugin-clean-modules", "release-it", "markdown-toc"];
 }>;
 //#endregion
 export { knipConfig };

package/dist/configs/knip.base.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"knip.base.d.ts","names":[],"sources":["../../src/configs/knip.base.ts"],"mappings":";;;;cAoBa,UAAA,EAAU,qBAAA,CAAA,UAAA;EAAA"}
+{"version":3,"file":"knip.base.d.ts","names":[],"sources":["../../src/configs/knip.base.ts"],"mappings":";;;;cA0Ba,UAAA,EAAU,qBAAA,CAAA,UAAA;EAAA"}

package/dist/configs/knip.base.js

@@ -1,11 +1,16 @@
 import { createMergeConfigFn } from "../utils.js";
 //#region src/configs/knip.base.ts
-const IGNORE_BINARIES = ["lefthook", "gh"];
+/** Knip sees `just` in the `prepare` script and the release-it hooks, but it isn't a package.json dependency */
+const IGNORE_BINARIES = ["just"];
 const knipConfig = createMergeConfigFn({
 	project: ["**/*"],
 	entry: ["./src/index.ts"],
 	ignoreBinaries: IGNORE_BINARIES,
-	ignoreDependencies: ["@adamhl8/eslint-plugin-clean-modules"]
+	ignoreDependencies: [
+		"@adamhl8/eslint-plugin-clean-modules",
+		"release-it",
+		"markdown-toc"
+	]
 });
 //#endregion
 export { IGNORE_BINARIES, knipConfig };

package/dist/configs/knip.base.js.map

@@ -1 +1 @@
-{"version":3,"file":"knip.base.js","names":[],"sources":["../../src/configs/knip.base.ts"],"sourcesContent":["import type { KnipConfig } from \"knip\"\n\nimport { createMergeConfigFn } from \"#/utils.ts\"\n\nexport const IGNORE_BINARIES = [\"lefthook\", \"gh\"] as const satisfies string[]\n\n/**\n * Consuming projects show these transitive dependencies as unlisted. e.g. knip resolves\n * `@adamhl8/eslint-plugin-clean-modules` via the oxlint config, but we don't need to install it directly in the\n * consuming project.\n */\nconst UNLISTED_DEPENDENCIES = [\"@adamhl8/eslint-plugin-clean-modules\"] as const satisfies string[]\n\nconst baseConfig = {\n  project: [\"**/*\"],\n  entry: [\"./src/index.ts\"],\n  ignoreBinaries: IGNORE_BINARIES,\n  ignoreDependencies: UNLISTED_DEPENDENCIES,\n} as const satisfies KnipConfig\n\nexport const knipConfig = createMergeConfigFn<KnipConfig, typeof baseConfig>(baseConfig)\n"],"mappings":";;AAIA,MAAa,kBAAkB,CAAC,YAAY,IAAI;AAgBhD,MAAa,aAAa,oBAAmD;CAN3E,SAAS,CAAC,MAAM;CAChB,OAAO,CAAC,gBAAgB;CACxB,gBAAgB;CAChB,oBAAoB,CANS,sCAMW;AAGmC,CAAU"}
+{"version":3,"file":"knip.base.js","names":[],"sources":["../../src/configs/knip.base.ts"],"sourcesContent":["import type { KnipConfig } from \"knip\"\n\nimport { createMergeConfigFn } from \"#/utils.ts\"\n\n/** Knip sees `just` in the `prepare` script and the release-it hooks, but it isn't a package.json dependency */\nexport const IGNORE_BINARIES = [\"just\"] as const satisfies string[]\n\n/**\n * - Knip resolves `@adamhl8/eslint-plugin-clean-modules` via the oxlint config, but we don't need to install it directly\n *   in the consuming project, so it shows as unlisted\n * - `release-it` and `markdown-toc` are only referenced from the base justfile, which knip doesn't parse, so they show as\n *   unused\n */\nconst IGNORE_DEPENDENCIES = [\n  \"@adamhl8/eslint-plugin-clean-modules\",\n  \"release-it\",\n  \"markdown-toc\",\n] as const satisfies string[]\n\nconst baseConfig = {\n  project: [\"**/*\"],\n  entry: [\"./src/index.ts\"],\n  ignoreBinaries: IGNORE_BINARIES,\n  ignoreDependencies: IGNORE_DEPENDENCIES,\n} as const satisfies KnipConfig\n\nexport const knipConfig = createMergeConfigFn<KnipConfig, typeof baseConfig>(baseConfig)\n"],"mappings":";;;AAKA,MAAa,kBAAkB,CAAC,MAAM;AAqBtC,MAAa,aAAa,oBAAmD;CAN3E,SAAS,CAAC,MAAM;CAChB,OAAO,CAAC,gBAAgB;CACxB,gBAAgB;CAChB,oBAAoB;EATpB;EACA;EACA;CAOsC;AAGqC,CAAU"}

package/dist/configs/lefthook.base.yaml

@@ -1,7 +1,7 @@
 pre-commit:
   commands:
     lint:
-      run: nub run lint
+      run: just lint
 
 commit-msg:
   commands:

package/dist/configs/release-it.base.d.ts

@@ -4,7 +4,7 @@ import { Config } from "release-it";
 //#region src/configs/release-it.base.d.ts
 declare const releaseItConfig: OptionalMergeConfigFn<Config, {
   readonly hooks: {
-    readonly "before:init": "nub run bundle";
+    readonly "before:init": "just build";
     readonly "after:bump": ["adamhl8-cliff --tag ${version} -o", "nubx oxfmt CHANGELOG.md"];
   };
   readonly git: {

package/dist/configs/release-it.base.js

@@ -1,7 +1,7 @@
 import { createMergeConfigFn } from "../utils.js";
 const releaseItConfig = createMergeConfigFn({
 	hooks: {
-		"before:init": "nub run bundle",
+		"before:init": "just build",
 		"after:bump": ["adamhl8-cliff --tag ${version} -o", "nubx oxfmt CHANGELOG.md"]
 	},
 	git: {

package/dist/configs/release-it.base.js.map

@@ -1 +1 @@
-{"version":3,"file":"release-it.base.js","names":[],"sources":["../../src/configs/release-it.base.ts"],"sourcesContent":["// oxlint-disable no-template-curly-in-string\nimport type { Config } from \"release-it\"\n\nimport { createMergeConfigFn } from \"#/utils.ts\"\n\nconst baseConfig = {\n  hooks: {\n    \"before:init\": \"nub run bundle\",\n    \"after:bump\": [\"adamhl8-cliff --tag ${version} -o\", \"nubx oxfmt CHANGELOG.md\"],\n  },\n  git: {\n    commitMessage: \"release: ${version}\",\n    tagName: \"${version}\",\n    tagAnnotation: \"release ${version}\",\n    addUntrackedFiles: true,\n  },\n  github: {\n    release: true,\n    releaseName: \"${version}\",\n    releaseNotes: \"adamhl8-cliff --unreleased --tag ${version}\",\n  },\n  npm: {\n    // oxlint-disable-next-line typescript/no-unsafe-type-assertion - release-it doesn't support nub directly yet\n    publishPackageManager: \"nub\" as \"bun\",\n    publishPath: \"\",\n    publishArgs: [\"--no-git-checks\"],\n  },\n} as const satisfies Config\n\nexport const releaseItConfig = createMergeConfigFn<Config, typeof baseConfig>(baseConfig)\n"],"mappings":";AA6BA,MAAa,kBAAkB,oBAA+C;CAvB5E,OAAO;EACL,eAAe;EACf,cAAc,CAAC,qCAAqC,yBAAyB;CAC/E;CACA,KAAK;EACH,eAAe;EACf,SAAS;EACT,eAAe;EACf,mBAAmB;CACrB;CACA,QAAQ;EACN,SAAS;EACT,aAAa;EACb,cAAc;CAChB;CACA,KAAK;EAEH,uBAAuB;EACvB,aAAa;EACb,aAAa,CAAC,iBAAiB;CACjC;AAG4E,CAAU"}
+{"version":3,"file":"release-it.base.js","names":[],"sources":["../../src/configs/release-it.base.ts"],"sourcesContent":["// oxlint-disable no-template-curly-in-string\nimport type { Config } from \"release-it\"\n\nimport { createMergeConfigFn } from \"#/utils.ts\"\n\nconst baseConfig = {\n  hooks: {\n    \"before:init\": \"just build\",\n    \"after:bump\": [\"adamhl8-cliff --tag ${version} -o\", \"nubx oxfmt CHANGELOG.md\"],\n  },\n  git: {\n    commitMessage: \"release: ${version}\",\n    tagName: \"${version}\",\n    tagAnnotation: \"release ${version}\",\n    addUntrackedFiles: true,\n  },\n  github: {\n    release: true,\n    releaseName: \"${version}\",\n    releaseNotes: \"adamhl8-cliff --unreleased --tag ${version}\",\n  },\n  npm: {\n    // oxlint-disable-next-line typescript/no-unsafe-type-assertion - release-it doesn't support nub directly yet\n    publishPackageManager: \"nub\" as \"bun\",\n    publishPath: \"\",\n    publishArgs: [\"--no-git-checks\"],\n  },\n} as const satisfies Config\n\nexport const releaseItConfig = createMergeConfigFn<Config, typeof baseConfig>(baseConfig)\n"],"mappings":";AA6BA,MAAa,kBAAkB,oBAA+C;CAvB5E,OAAO;EACL,eAAe;EACf,cAAc,CAAC,qCAAqC,yBAAyB;CAC/E;CACA,KAAK;EACH,eAAe;EACf,SAAS;EACT,eAAe;EACf,mBAAmB;CACrB;CACA,QAAQ;EACN,SAAS;EACT,aAAa;EACb,cAAc;CAChB;CACA,KAAK;EAEH,uBAAuB;EACvB,aAAa;EACb,aAAa,CAAC,iBAAiB;CACjC;AAG4E,CAAU"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@adamhl8/configs",
-  "version": "0.27.3",
+  "version": "0.28.0",
   "homepage": "https://github.com/adamhl8/configs",
   "bugs": {
     "url": "https://github.com/adamhl8/configs/issues"
@@ -40,12 +40,7 @@
     "access": "public"
   },
   "scripts": {
-    "lint": "markdown-toc -i --bullets '-' --maxdepth 3 ./README.md && oxfmt && oxlint --fix --fix-suggestions --fix-dangerously && knip",
-    "bump-deps": "nub update -L && rm -f lock.yaml && nub i --no-frozen-lockfile && oxfmt lock.yaml",
-    "bundle": "nub run lint && tsdown",
-    "release": "gh workflow run release.yml",
-    "release:run": "release-it --ci -i \"$(adamhl8-cliff --bumped-version)\"",
-    "prepare": "lefthook install && tsdown"
+    "prepare": "just prepare"
   },
   "dependencies": {
     "@adamhl8/eslint-plugin-clean-modules": "^0.1.3",
@@ -77,6 +72,7 @@
     "@commitlint/cli": ">=21",
     "@commitlint/config-conventional": ">=21",
     "knip": ">=6",
+    "markdown-toc": ">=1",
     "oxfmt": ">=0.50",
     "oxlint": ">=1",
     "oxlint-tsgolint": ">=0.24",
@@ -99,6 +95,9 @@
     "knip": {
       "optional": true
     },
+    "markdown-toc": {
+      "optional": true
+    },
     "oxfmt": {
       "optional": true
     },