@theholocron/holocron-config 7.28.0 → 7.28.1

package/README.md

@@ -82,7 +82,7 @@ Pre-built `compose()` calls for the most common combinations. Import and spread
 
 ### `nodeDocs()`
 
-= `compose(node(), typecheck(), docs(), audit())`. For TypeScript library repos that publish a docs site.
+= `compose(node(), typecheck(), docs())` + `"audit / Conclusion"` required check. For TypeScript library repos that publish a docs site. The audit workflow is repo-specific — add it explicitly: `workflows: [...preset.workflows, "audit", ...]`.
 
 ```ts
 import { defineConfig } from "@theholocron/cli";

package/dist/configs/node-docs.d.ts

@@ -4,11 +4,16 @@ type NodeDocsPreset = ComposedPreset;
 type NodeDocsSitePreset = ComposedPreset;
 /**
  * Preset for theholocron repos that are TypeScript libraries AND publish a
- * documentation site (e.g. configs, utils, holocron). Includes typecheck and
- * audit in addition to the docs deploy.
+ * documentation site (e.g. configs, utils, holocron, clients).
  *
- * For repos that are docs-only sites without TypeScript source to check,
- * use nodeDocsSite() instead.
+ * Includes the "audit / Conclusion" required check so branch protection works
+ * for repos that add the audit workflow explicitly. The workflow itself is
+ * intentionally left repo-specific — add it with your own options:
+ *   workflows: [...preset.workflows, "audit", ...]
+ *   // or with overrides:
+ *   workflows: [...preset.workflows, { name: "audit", with: { "run-knip": true } }, ...]
+ *
+ * For docs-only sites without TypeScript source, use nodeDocsSite() instead.
  *
  * @example
  * const preset = nodeDocs();
@@ -24,8 +29,7 @@ type NodeDocsSitePreset = ComposedPreset;
 declare function nodeDocs(): NodeDocsPreset;
 /**
  * Preset for theholocron repos that are documentation-only sites with no
- * TypeScript source to check (e.g. skills, themes). Identical to nodeDocs()
- * except typecheck and audit are not included.
+ * TypeScript source to check (e.g. skills, themes). No typecheck, no audit.
  *
  * @example
  * const preset = nodeDocsSite();

package/dist/configs/node-docs.js

@@ -1,2 +1,2 @@
-import { n as nodeDocsSite, t as nodeDocs } from "../node-docs-ccjE0K8S.js";
+import { n as nodeDocsSite, t as nodeDocs } from "../node-docs-BW6pdsNO.js";
 export { nodeDocs, nodeDocsSite };

package/dist/index.js

@@ -1,11 +1,32 @@
 import { t as node } from "./node-3iHN9DIf.js";
 import { t as typecheck } from "./typecheck-epaimGtp.js";
-import { i as docs, n as nodeDocsSite, r as audit, t as nodeDocs } from "./node-docs-ccjE0K8S.js";
+import { n as nodeDocsSite, r as docs, t as nodeDocs } from "./node-docs-BW6pdsNO.js";
 import { t as react } from "./react-Pm9PjGpV.js";
 import { n as nextjs$1, t as nextjs } from "./nextjs-D1E4Gf4-.js";
 import { react as react$1 } from "./configs/react.js";
 import { monorepo } from "./configs/monorepo.js";
 import { compose } from "@theholocron/cli";
+//#region capabilities/audit.ts
+/**
+* Adds BundleWatch + optional Knip and Lighthouse auditing.
+* Requires: node
+*/
+function audit({ knip = false, performance = false, lighthouseConfig } = {}) {
+	const withBlock = {};
+	if (knip) withBlock["run-knip"] = true;
+	if (performance) withBlock["run-performance"] = true;
+	if (lighthouseConfig) withBlock["lighthouse-config"] = lighthouseConfig;
+	return {
+		id: "audit",
+		requires: ["node"],
+		workflows: [Object.keys(withBlock).length > 0 ? {
+			name: "audit",
+			with: withBlock
+		} : "audit"],
+		requiredChecks: ["audit / Conclusion"]
+	};
+}
+//#endregion
 //#region capabilities/monorepo.ts
 /**
 * Adjusts a repo to be a monorepo — sets uses_external_packages: true

package/dist/{node-docs-ccjE0K8S.js → node-docs-BW6pdsNO.js}

@@ -33,35 +33,19 @@ function docs() {
 	};
 }
 //#endregion
-//#region capabilities/audit.ts
-/**
-* Adds BundleWatch + optional Knip and Lighthouse auditing.
-* Requires: node
-*/
-function audit({ knip = false, performance = false, lighthouseConfig } = {}) {
-	const withBlock = {};
-	if (knip) withBlock["run-knip"] = true;
-	if (performance) withBlock["run-performance"] = true;
-	if (lighthouseConfig) withBlock["lighthouse-config"] = lighthouseConfig;
-	return {
-		id: "audit",
-		requires: ["node"],
-		workflows: [Object.keys(withBlock).length > 0 ? {
-			name: "audit",
-			with: withBlock
-		} : "audit"],
-		requiredChecks: ["audit / Conclusion"]
-	};
-}
-//#endregion
 //#region configs/node-docs.ts
 /**
 * Preset for theholocron repos that are TypeScript libraries AND publish a
-* documentation site (e.g. configs, utils, holocron). Includes typecheck and
-* audit in addition to the docs deploy.
+* documentation site (e.g. configs, utils, holocron, clients).
 *
-* For repos that are docs-only sites without TypeScript source to check,
-* use nodeDocsSite() instead.
+* Includes the "audit / Conclusion" required check so branch protection works
+* for repos that add the audit workflow explicitly. The workflow itself is
+* intentionally left repo-specific — add it with your own options:
+*   workflows: [...preset.workflows, "audit", ...]
+*   // or with overrides:
+*   workflows: [...preset.workflows, { name: "audit", with: { "run-knip": true } }, ...]
+*
+* For docs-only sites without TypeScript source, use nodeDocsSite() instead.
 *
 * @example
 * const preset = nodeDocs();
@@ -75,12 +59,15 @@ function audit({ knip = false, performance = false, lighthouseConfig } = {}) {
 * });
 */
 function nodeDocs() {
-	return compose(node(), typecheck(), docs(), audit());
+	return compose(node(), typecheck(), docs(), {
+		id: "audit-check",
+		requires: ["node"],
+		requiredChecks: ["audit / Conclusion"]
+	});
 }
 /**
 * Preset for theholocron repos that are documentation-only sites with no
-* TypeScript source to check (e.g. skills, themes). Identical to nodeDocs()
-* except typecheck and audit are not included.
+* TypeScript source to check (e.g. skills, themes). No typecheck, no audit.
 *
 * @example
 * const preset = nodeDocsSite();
@@ -96,4 +83,4 @@ function nodeDocsSite() {
 	return compose(node(), docs());
 }
 //#endregion
-export { docs as i, nodeDocsSite as n, audit as r, nodeDocs as t };
+export { nodeDocsSite as n, docs as r, nodeDocs as t };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theholocron/holocron-config",
-  "version": "7.28.0",
+  "version": "7.28.1",
   "description": "Shareable holocron configuration presets for theholocron repositories.",
   "homepage": "https://github.com/theholocron/configs/tree/main/packages/holocron-config#readme",
   "bugs": "https://github.com/theholocron/configs/issues",
@@ -23,8 +23,8 @@
     "typescript": "^5.9.3",
     "vitest": "^4.1.10",
     "@vitest/coverage-v8": "^4.1.10",
-    "@theholocron/tsconfig": "7.28.0",
-    "@theholocron/vitest-config": "7.28.0"
+    "@theholocron/vitest-config": "7.28.1",
+    "@theholocron/tsconfig": "7.28.1"
   },
   "peerDependencies": {
     "@theholocron/cli": ">=2.0.0-alpha.1"