@oxiul/configs 0.3.2 → 0.4.0

package/README.md

@@ -8,6 +8,57 @@ A shared config for oxlint
 
 A shared config for oxfmt
 
+## GitHub Actions
+
+Configure generation in `oxiul.config.ts`:
+
+```ts
+import type { Config } from "@oxiul/configs";
+
+export default {
+	workflows: {
+		workflows: [], // Optional { name, workflow } objects for project workflows.
+		jobs: {}, // Optional { jobName: <job> } object with CI jobs descriptions.
+	},
+} satisfies Config;
+```
+
+## Package.json verification
+
+Run `oxiul verify` to require a pinned Bun version of at least 1.4.4,
+a Node.js engine range starting at 26 or higher, and these exact scripts:
+
+```json
+{
+	"lint": "oxlint",
+	"lint:fix": "oxlint --fix",
+	"format": "oxfmt --write",
+	"format:verify": "oxfmt --check",
+	"workflows": "oxiul workflows --verify",
+	"workflows:generate": "oxiul workflows --generate",
+	"typecheck": "bun check",
+	"deps": "knip",
+	"oxiul:verify": "oxiul verify"
+}
+```
+
+Add requirements or override commands in `oxiul.config.ts`:
+
+```ts
+export default {
+	verify: {
+		scripts: {
+			build: "bun build src/index.ts",
+			test: "*", // Required script, any command.
+			lint: "oxlint --deny-warnings",
+		},
+	},
+} satisfies Config;
+```
+
+Other scripts are allowed and left unchecked. Verification reads `package.json`
+from the current directory and never modifies it.
+
 ## Development
 
 ### Prerequisites

package/dist/bin.d.mts

@@ -0,0 +1 @@
+export {}

package/dist/bin.mjs

@@ -0,0 +1,99 @@
+#!/usr/bin/env bun
+import { t as parse } from "./parse-DnOcFJT0.mjs";
+import { a as getDepsJob, c as getPackageJsonVerifyJob, d as getWorkflowsVerifyJob, i as getDefaultWorkflow, l as getSetupAction, o as getFormatVerifyJob, s as getLintJob, t as generateWorkflows, u as getTypecheckJob } from "./generate-BGCgStVl.mjs";
+import { gte, subset, valid, validRange } from "semver";
+import { z } from "zod";
+import { Crust, defineCommand } from "@crustjs/core";
+import { help } from "@crustjs/extensions";
+import { readFile } from "node:fs/promises";
+//#region src/schemas.ts
+const packageJsonSchema = z.object({
+	engines: z.object({ node: z.string() }),
+	packageManager: z.string(),
+	scripts: z.record(z.string(), z.string())
+}).partial();
+//#endregion
+//#region src/verify/package-json.ts
+const defaultScripts = {
+	deps: "knip",
+	format: "oxfmt --write",
+	"format:verify": "oxfmt --check",
+	lint: "oxlint",
+	"lint:fix": "oxlint --fix",
+	"oxiul:verify": "oxiul verify",
+	typecheck: "bun check",
+	workflows: "oxiul workflows --verify",
+	"workflows:generate": "oxiul workflows --generate"
+};
+const verifyPackageJson = (packageJson, { scripts: extraScripts, minBunVersion, minNodeVersion }) => {
+	const { scripts = {}, packageManager = "", engines: { node: nodeVersionRaw = "" } = { node: "" } } = packageJson;
+	const errors = [];
+	const bunVersion = /^bun@(?<version>[^+]+)(?:\+sha\d+\.[a-f\d]+)?$/u.exec(packageManager)?.groups?.version;
+	if (!bunVersion || !valid(bunVersion) || !gte(bunVersion, minBunVersion)) errors.push(`packageManager must pin bun@${minBunVersion} or higher`);
+	const nodeRange = validRange(nodeVersionRaw);
+	if (!nodeRange || !subset(nodeRange, `>=${minNodeVersion}`)) errors.push(`engines.node must require Node.js ${minNodeVersion} or higher`);
+	for (const [name, command] of Object.entries({
+		...defaultScripts,
+		...extraScripts
+	})) if (!scripts[name]) errors.push(`Missing script: ${name}`);
+	else if (command !== "*" && scripts[name] !== command) errors.push(`scripts[${name}] must be ${JSON.stringify(command)}`);
+	if (errors.length !== 0) throw new Error(`Package.json verification failed:\n${errors.join("\n")}`);
+};
+//#endregion
+//#region src/verify/bin.ts
+const command$1 = defineCommand("verify", { description: "Verify package.json" }, (def) => def.action(async ({ stdout }) => {
+	stdout("Verifying package.json...");
+	const config = await parse();
+	const parseResult = packageJsonSchema.safeParse(JSON.parse(await readFile("package.json", "utf8")));
+	if (!parseResult.success) throw new Error(`Invalid package.json: ${parseResult.error.message}`);
+	verifyPackageJson(parseResult.data, config.verify);
+	stdout("package.json verified successfully!");
+}));
+//#endregion
+//#region src/workflows/bin.ts
+const command = defineCommand("workflows", { description: "Workflows" }, (def) => def.flags({
+	name: "verify",
+	short: "r",
+	type: "boolean"
+}).flags({
+	name: "generate",
+	short: "g",
+	type: "boolean"
+}).action(async ({ flags, stdout }) => {
+	const config = await parse();
+	const options = {
+		actions: { "setup-env": getSetupAction() },
+		workflows: [getDefaultWorkflow({
+			jobs: {
+				deps: getDepsJob(),
+				format: getFormatVerifyJob(),
+				lint: getLintJob(),
+				typecheck: getTypecheckJob(),
+				verify: getPackageJsonVerifyJob(),
+				workflows: getWorkflowsVerifyJob(),
+				...config.workflows?.jobs
+			},
+			name: "CI"
+		}), ...config.workflows?.workflows ?? []]
+	};
+	if (flags.generate) {
+		stdout(`Generating the workflows..`);
+		await generateWorkflows({
+			...options,
+			check: false
+		});
+		stdout(`Workflows generated successfully!`);
+	} else {
+		stdout(`Verifying the workflows..`);
+		await generateWorkflows({
+			...options,
+			check: true
+		});
+		stdout(`Workflows verified successfully!`);
+	}
+}));
+//#endregion
+//#region src/bin.ts
+await new Crust("oxiul", { description: "Oxiul runner" }).add(command$1).add(command).extend(help()).execute();
+//#endregion
+export {};

package/dist/generate-BGCgStVl.mjs

@@ -0,0 +1,103 @@
+import { mkdir, readFile, writeFile } from "node:fs/promises";
+import path from "node:path";
+import { stringify } from "yaml";
+//#region src/workflows/default.ts
+const DEFAULT_MACHINE = "ubuntu-26.04";
+const getSetupAction = () => ({
+	description: "Setup runtime",
+	name: "Runtime setup",
+	runs: {
+		steps: [
+			{
+				name: "Setup Node.js",
+				uses: "actions/setup-node@v7",
+				with: { "node-version-file": "package.json" }
+			},
+			{
+				name: "Setup Bun",
+				uses: "oven-sh/setup-bun@v2",
+				with: { "bun-version-file": "package.json" }
+			},
+			{
+				name: "Install dependencies",
+				run: "bun install --frozen-lockfile",
+				shell: "bash"
+			}
+		],
+		using: "composite"
+	}
+});
+const getDefaultWorkflow = ({ concurrency, on, name = "Default workflow", ...rest }) => ({
+	concurrency: {
+		"cancel-in-progress": true,
+		group: "${{ github.workflow }}-${{ github.ref }}",
+		...concurrency
+	},
+	name,
+	on: {
+		pull_request: {},
+		push: { branches: ["main"] },
+		workflow_dispatch: {},
+		...on
+	},
+	...rest
+});
+const getCheckJob = ({ "runs-on": runsOn = DEFAULT_MACHINE, steps, overrideSteps = false, ...rest }) => ({
+	"runs-on": runsOn,
+	steps: overrideSteps ? steps : [
+		{ uses: "actions/checkout@v7" },
+		{ uses: "./.github/actions/setup-env" },
+		...steps
+	],
+	...rest
+});
+const getFormatVerifyJob = () => getCheckJob({
+	name: "Format verification",
+	steps: [{ run: "bun run format:verify" }]
+});
+const getDepsJob = () => getCheckJob({
+	name: "Dependencies check",
+	steps: [{ run: "bun run deps" }]
+});
+const getTypecheckJob = () => getCheckJob({
+	name: "Typecheck",
+	steps: [{ run: "bun run typecheck" }]
+});
+const getLintJob = () => getCheckJob({
+	name: "Lint",
+	steps: [{ run: "bun run lint" }]
+});
+const getWorkflowsVerifyJob = () => getCheckJob({
+	name: "Workflows verification",
+	steps: [{ run: "bun run workflows" }]
+});
+const getPackageJsonVerifyJob = () => getCheckJob({
+	name: "Package.json verification",
+	steps: [{ run: "bun run oxiul:verify" }]
+});
+//#endregion
+//#region src/workflows/generate.ts
+const generateWorkflows = async ({ workflows = [], actions = {}, directory = ".", check = false }) => {
+	const files = /* @__PURE__ */ new Map();
+	const addFile = (name, filePath, value) => {
+		if (!name || !/^[\w-]+$/u.test(name)) throw new Error(`Invalid generated file name: ${name}`);
+		if (files.has(filePath)) throw new Error(`Duplicate generated file: ${filePath}`);
+		files.set(filePath, `# Generated by @oxiul/configs/workflows. Do not edit.\n${stringify(value, { lineWidth: 0 })}`);
+	};
+	for (const workflow of workflows) addFile(workflow.name, `.github/workflows/${workflow.name.toLowerCase()}.yml`, workflow);
+	for (const [name, action] of Object.entries(actions)) addFile(name, `.github/actions/${name}/action.yml`, action);
+	for (const [filePath, content] of files) {
+		const target = path.resolve(directory, filePath);
+		if (check) {
+			if (await readFile(target, "utf8").catch((error) => {
+				if (error instanceof Error && "code" in error && error.code === "ENOENT") return;
+				throw error;
+			}) !== content) throw new Error(`Generated file is out of date: ${filePath}`);
+		} else {
+			await mkdir(path.dirname(target), { recursive: true });
+			await writeFile(target, content);
+		}
+	}
+};
+//#endregion
+export { getDepsJob as a, getPackageJsonVerifyJob as c, getWorkflowsVerifyJob as d, getDefaultWorkflow as i, getSetupAction as l, DEFAULT_MACHINE as n, getFormatVerifyJob as o, getCheckJob as r, getLintJob as s, generateWorkflows as t, getTypecheckJob as u };

package/dist/hook/install.mjs

@@ -1,7 +1,7 @@
 import { i as packageName } from "../common-B9SE4GL9.mjs";
-import { exec } from "node:child_process";
 import fs from "node:fs/promises";
 import path from "node:path";
+import { exec } from "node:child_process";
 import { promisify } from "node:util";
 //#region src/hook/install.ts
 const promisifiedExec = promisify(exec);

package/dist/hook/pre-commit.mjs

@@ -1,8 +1,5 @@
-import { r as moduleName } from "../common-B9SE4GL9.mjs";
-import { t as configSchema } from "../schema-DM8wm8HH.mjs";
-import { z } from "zod";
+import { t as parse } from "../parse-DnOcFJT0.mjs";
 import { spawn } from "node:child_process";
-import { cosmiconfig } from "cosmiconfig";
 import { Listr } from "listr2";
 //#region src/hook/pre-commit.ts
 const failedOutputs = /* @__PURE__ */ new Map();
@@ -34,11 +31,8 @@ const run = (command, task) => new Promise((resolve, reject) => {
 		reject(/* @__PURE__ */ new Error(signal ? `killed by ${signal}` : `exited with code ${code}`));
 	});
 });
-const rawConfig = await cosmiconfig(moduleName).search();
-const parsedConfig = z.safeParse(configSchema, rawConfig?.config);
-if (!parsedConfig.success) throw new Error(`Validation error: ${parsedConfig.error.message}`);
 try {
-	const config = parsedConfig.data;
+	const config = await parse();
 	if (config.preCommitCommands && config.preCommitCommands.length !== 0) await new Listr(config.preCommitCommands.map((command) => ({
 		rendererOptions: {
 			outputBar: 5,

package/dist/index-DqMadVlO.d.mts

@@ -0,0 +1,44 @@
+import { GeneratedWorkflowTypes, GeneratedWorkflowTypes as GeneratedWorkflowTypes$1 } from "@github-actions-workflow-ts/lib";
+//#region src/workflows/types.d.ts
+type CompositeAction = {
+  name: string;
+  description: string;
+  runs: {
+    using: "composite";
+    steps: GeneratedWorkflowTypes.Step[];
+  };
+};
+type Workflow = GeneratedWorkflowTypes.Workflow;
+//#endregion
+//#region src/workflows/default.d.ts
+declare const DEFAULT_MACHINE = "ubuntu-26.04";
+declare const getSetupAction: () => CompositeAction;
+declare const getDefaultWorkflow: ({ concurrency, on, name, ...rest }: Omit<GeneratedWorkflowTypes.Workflow, "on" | "concurrency"> & {
+  on?: Exclude<GeneratedWorkflowTypes.Workflow["on"], GeneratedWorkflowTypes.Event | GeneratedWorkflowTypes.Event[]>;
+  concurrency?: Exclude<GeneratedWorkflowTypes.Workflow["concurrency"], string>;
+}) => Omit<GeneratedWorkflowTypes.Workflow, "name"> & {
+  name: string;
+};
+declare const getCheckJob: ({ "runs-on": runsOn, steps, overrideSteps, ...rest }: Omit<GeneratedWorkflowTypes.NormalJob, "runs-on"> & {
+  overrideSteps?: boolean;
+  "runs-on"?: GeneratedWorkflowTypes.NormalJob["runs-on"];
+  steps: Exclude<GeneratedWorkflowTypes.NormalJob["steps"], undefined>;
+}) => GeneratedWorkflowTypes.NormalJob;
+declare const getFormatVerifyJob: () => GeneratedWorkflowTypes.NormalJob;
+declare const getDepsJob: () => GeneratedWorkflowTypes.NormalJob;
+declare const getTypecheckJob: () => GeneratedWorkflowTypes.NormalJob;
+declare const getLintJob: () => GeneratedWorkflowTypes.NormalJob;
+declare const getWorkflowsVerifyJob: () => GeneratedWorkflowTypes.NormalJob;
+declare const getPackageJsonVerifyJob: () => GeneratedWorkflowTypes.NormalJob;
+//#endregion
+//#region src/workflows/generate.d.ts
+declare const generateWorkflows: ({ workflows, actions, directory, check }: {
+  workflows?: (Omit<GeneratedWorkflowTypes.Workflow, "name"> & {
+    name: string;
+  })[];
+  actions?: Record<string, CompositeAction>;
+  directory?: string;
+  check?: boolean;
+}) => Promise<void>;
+//#endregion
+export { getDefaultWorkflow as a, getLintJob as c, getTypecheckJob as d, getWorkflowsVerifyJob as f, getCheckJob as i, getPackageJsonVerifyJob as l, Workflow as m, generateWorkflows as n, getDepsJob as o, CompositeAction as p, DEFAULT_MACHINE as r, getFormatVerifyJob as s, GeneratedWorkflowTypes$1 as t, getSetupAction as u };

package/dist/index.d.mts

@@ -1,3 +1,4 @@
+import { t as GeneratedWorkflowTypes } from "./index-DqMadVlO.mjs";
 import { z } from "zod";
 import { OxlintConfig } from "oxlint";
 import { OxfmtConfig } from "oxfmt";
@@ -146,7 +147,22 @@ declare const getConfig$1: ({ options, ...overrides }?: ConfigOptions) => Promis
 //#region src/config/schema.d.ts
 export declare const configSchema: z.ZodObject<{
   preCommitCommands: z.ZodOptional<z.ZodArray<z.ZodString>>;
+  verify: z.ZodDefault<z.ZodObject<{
+    minBunVersion: z.ZodDefault<z.ZodString>;
+    minNodeVersion: z.ZodDefault<z.ZodString>;
+    scripts: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodString>>;
+  }, z.core.$strip>>;
+  workflows: z.ZodOptional<z.ZodObject<{
+    branch: z.ZodOptional<z.ZodString>;
+    jobs: z.ZodOptional<z.ZodRecord<z.ZodString, z.ZodCustom<GeneratedWorkflowTypes.NormalJob, GeneratedWorkflowTypes.NormalJob>>>;
+    workflows: z.ZodOptional<z.ZodArray<z.ZodCustom<Omit<GeneratedWorkflowTypes.Workflow, "name"> & {
+      name: string;
+    }, Omit<GeneratedWorkflowTypes.Workflow, "name"> & {
+      name: string;
+    }>>>;
+  }, z.core.$strip>>;
 }, z.core.$strip>;
-type Config = z.infer<typeof configSchema>;
+type ConfigInput = z.input<typeof configSchema>;
+type ConfigOutput = z.output<typeof configSchema>;
 //#endregion
-export { type Config, getConfig as getFormatConfig, getConfig$1 as getKnipConfig, getConfig$2 as getLintConfig };
+export { type ConfigInput as Config, type ConfigOutput, getConfig as getFormatConfig, getConfig$1 as getKnipConfig, getConfig$2 as getLintConfig };

package/dist/index.mjs

@@ -1,5 +1,5 @@
 import { n as baseIgnorePatterns, t as arraify } from "./common-B9SE4GL9.mjs";
-import { t as configSchema } from "./schema-DM8wm8HH.mjs";
+import { t as configSchema } from "./schema-BuCl21uv.mjs";
 import { isNonNullish, mapValues, omitBy } from "remeda";
 //#region src/oxlint.ts
 const disabledRules = {
@@ -330,17 +330,24 @@ const getBaseConfig$1 = () => ({
 		reportUnusedDisableDirectives: "error",
 		typeAware: true
 	},
-	overrides: [{
-		files: ["**/*.config.{j,t}s"],
-		rules: {
-			"import/no-default-export": "off",
-			"import/no-nodejs-modules": "off",
-			"node/no-top-level-await": "off"
+	overrides: [
+		{
+			files: ["**/*.config.{j,t}s"],
+			rules: {
+				"import/no-default-export": "off",
+				"import/no-nodejs-modules": "off",
+				"node/no-top-level-await": "off"
+			}
+		},
+		{
+			files: ["**/*.d.ts"],
+			rules: { "typescript/triple-slash-reference": "off" }
+		},
+		{
+			files: ["workflows.config.ts"],
+			rules: { "eslint/no-template-curly-in-string": "off" }
 		}
-	}, {
-		files: ["**/*.d.ts"],
-		rules: { "typescript/triple-slash-reference": "off" }
-	}],
+	],
 	plugins: {
 		eslint: true,
 		import: true,

package/dist/parse-DnOcFJT0.mjs

@@ -0,0 +1,14 @@
+import { r as moduleName } from "./common-B9SE4GL9.mjs";
+import { t as configSchema } from "./schema-BuCl21uv.mjs";
+import { z } from "zod";
+import { cosmiconfig } from "cosmiconfig";
+//#region src/config/parse.ts
+const explorer = cosmiconfig(moduleName);
+const parse = async () => {
+	const rawConfig = await explorer.search();
+	const parsedConfig = z.safeParse(configSchema, rawConfig?.config ?? {});
+	if (!parsedConfig.success) throw new Error(`Validation error: ${parsedConfig.error.message}`);
+	return parsedConfig.data;
+};
+//#endregion
+export { parse as t };

package/dist/schema-BuCl21uv.mjs

@@ -0,0 +1,23 @@
+import { valid } from "semver";
+import { z } from "zod";
+//#region src/config/schema.ts
+const MIN_NODE_VERSION = "26.0.0";
+const MIN_BUN_VERSION = "1.4.4";
+const configSchema = z.object({
+	preCommitCommands: z.string().array().optional(),
+	verify: z.object({
+		minBunVersion: z.string().refine((version) => valid(version)).default(() => MIN_BUN_VERSION),
+		minNodeVersion: z.string().refine((version) => valid(version)).default(() => MIN_NODE_VERSION),
+		scripts: z.record(z.string(), z.string()).optional()
+	}).default(() => ({
+		minBunVersion: MIN_BUN_VERSION,
+		minNodeVersion: MIN_NODE_VERSION
+	})),
+	workflows: z.object({
+		branch: z.string().optional(),
+		jobs: z.record(z.string(), z.custom()).optional(),
+		workflows: z.custom().array().optional()
+	}).optional()
+});
+//#endregion
+export { configSchema as t };

package/dist/workflows/index.d.mts

@@ -0,0 +1,2 @@
+import { a as getDefaultWorkflow, c as getLintJob, d as getTypecheckJob, f as getWorkflowsVerifyJob, i as getCheckJob, l as getPackageJsonVerifyJob, m as Workflow, n as generateWorkflows, o as getDepsJob, p as CompositeAction, r as DEFAULT_MACHINE, s as getFormatVerifyJob, t as GeneratedWorkflowTypes, u as getSetupAction } from "../index-DqMadVlO.mjs";
+export { type CompositeAction, DEFAULT_MACHINE, type GeneratedWorkflowTypes, type Workflow, generateWorkflows, getCheckJob, getDefaultWorkflow, getDepsJob, getFormatVerifyJob, getLintJob, getPackageJsonVerifyJob, getSetupAction, getTypecheckJob, getWorkflowsVerifyJob };

package/dist/workflows/index.mjs

@@ -0,0 +1 @@
+export { n as DEFAULT_MACHINE, t as generateWorkflows, r as getCheckJob, i as getDefaultWorkflow, a as getDepsJob, o as getFormatVerifyJob, s as getLintJob, c as getPackageJsonVerifyJob, l as getSetupAction, u as getTypecheckJob, d as getWorkflowsVerifyJob } from "../generate-BGCgStVl.mjs";

package/package.json

@@ -1,11 +1,14 @@
 {
 	"name": "@oxiul/configs",
-	"version": "0.3.2",
+	"version": "0.4.0",
 	"license": "MIT",
 	"repository": {
 		"type": "git",
 		"url": "git+https://github.com/oxiul/configs.git"
 	},
+	"bin": {
+		"oxiul": "./dist/bin.mjs"
+	},
 	"files": [
 		"dist/**",
 		"scripts/postinstall.mjs"
@@ -15,8 +18,14 @@
 	"main": "./dist/index.mjs",
 	"module": "./dist/index.mjs",
 	"exports": {
-		"types": "./dist/index.d.mts",
-		"default": "./dist/index.mjs"
+		".": {
+			"types": "./dist/index.d.mts",
+			"default": "./dist/index.mjs"
+		},
+		"./workflows": {
+			"types": "./dist/workflows/index.d.mts",
+			"default": "./dist/workflows/index.mjs"
+		}
 	},
 	"publishConfig": {
 		"access": "public"
@@ -29,13 +38,21 @@
 		"format:verify": "oxfmt --check",
 		"lint": "oxlint",
 		"lint:fix": "oxlint --fix",
+		"oxiul:verify": "bun src/bin.ts verify",
 		"postinstall": "node scripts/postinstall.mjs",
-		"typecheck": "bun check"
+		"typecheck": "bun check",
+		"workflows": "bun src/bin.ts workflows --verify",
+		"workflows:generate": "bun src/bin.ts workflows --generate"
 	},
 	"dependencies": {
+		"@crustjs/core": "^0.5.6",
+		"@crustjs/extensions": "^0.5.6",
+		"@github-actions-workflow-ts/lib": "^2.6.1",
 		"cosmiconfig": "^10.0.1",
 		"listr2": "^11.4.0",
 		"oxlint-plugin-eslint": "^1.88.0",
+		"semver": "^7.8.5",
+		"yaml": "^2.9.1",
 		"zod": "^4.6.7"
 	},
 	"devDependencies": {
@@ -44,6 +61,7 @@
 		"@changesets/cli": "^3.0.3",
 		"@tanstack/eslint-plugin-router": "^1.162.0",
 		"@types/bun": "1.4.3",
+		"@types/semver": "^7.8.0",
 		"eslint-plugin-better-tailwindcss": "^4.9.1",
 		"eslint-plugin-package-json": "^1.10.1",
 		"eslint-plugin-playwright": "^2.12.1",
@@ -63,5 +81,5 @@
 	"engines": {
 		"node": "26"
 	},
-	"packageManager": "bun@1.4.3"
+	"packageManager": "bun@1.4.4"
 }

package/dist/schema-DM8wm8HH.mjs

@@ -1,5 +0,0 @@
-import { z } from "zod";
-//#region src/config/schema.ts
-const configSchema = z.object({ preCommitCommands: z.string().array() }).partial();
-//#endregion
-export { configSchema as t };