@sapphire-sh/utils 2.15.0 → 3.1.0

package/bin/sapphire-bootstrap.js

@@ -8,8 +8,12 @@ const START_MARKER = '# @sapphire-sh/utils:start';
 const END_MARKER = '# @sapphire-sh/utils:end';
 
 const selfPackageName = '@sapphire-sh/utils';
-const selfSkipped = new Set([join('.github', 'workflows', 'shared-config-update.yml')]);
-const obsoleteFiles = new Set([join('.github', 'workflows', 'utils-update.yml')]);
+const selfSkipped = new Set([join('.github', 'workflows', 'node-shared-config-update.yml')]);
+const obsoleteFiles = new Set([
+	join('.github', 'workflows', 'utils-update.yml'),
+	join('.github', 'workflows', 'npm-audit-fix.yml'),
+	join('.github', 'workflows', 'shared-config-update.yml'),
+]);
 
 const workflowsDir = join('.github', 'workflows');
 const workflowValuesPath = join('.github', 'sapphire-workflows.json');
@@ -17,7 +21,10 @@ const withLinePattern = /^\s*with:\s*$/m;
 const pathsIgnoreLinePattern = /^\s*paths-ignore:\s*$/m;
 const pushBlockPattern = /^on:\n(?:[ \t].*\n|\n)*? {2}push:\n((?: {4}.*\n|\n)*)/m;
 const branchesListPattern = /^ {2}push:\n {4}branches:\n(?: {6}- .*\n)*/m;
+const entryKeys = new Set(['push', 'with']);
+const pushKeys = new Set(['paths', 'paths-ignore']);
 const requiredFiles = new Map([[join(workflowsDir, 'docker-publish.yml'), 'Dockerfile']]);
+const entryRequiredFiles = new Set([join(workflowsDir, 'userscript-publish.yml')]);
 
 const sectioned = new Set(['.gitignore', '.prettierignore']);
 const renameMap = new Map([
@@ -95,27 +102,26 @@ const writeWorkflow = (outputName, template) => {
 			console.log(`warning: ${outputName} had with: values that are not in ${workflowValuesPath}`);
 		}
 	} else {
-		const { 'paths-ignore': pathsIgnore, ...withValues } = values;
-
-		if (pathsIgnore !== undefined) {
-			const pathsIgnoreLines = pathsIgnore.map((value) => `      - ${formatYamlValue(value)}\n`).join('');
-			content = content.replace(
-				branchesListPattern,
-				(branchesList) => `${branchesList}    paths-ignore:\n${pathsIgnoreLines}`,
-			);
-		}
+		const { push = {}, with: withValues } = values;
 
-		if (withLinePattern.test(template) === false) {
-			content += '    with:\n';
+		for (const [key, patterns] of Object.entries(push)) {
+			const patternLines = patterns.map((value) => `      - ${formatYamlValue(value)}\n`).join('');
+			content = content.replace(branchesListPattern, (branchesList) => `${branchesList}    ${key}:\n${patternLines}`);
 		}
 
-		for (const [key, value] of Object.entries(withValues)) {
-			content += `      ${key}: ${formatYamlValue(value)}\n`;
+		if (withValues !== undefined) {
+			if (withLinePattern.test(template) === false) {
+				content += '    with:\n';
+			}
+
+			for (const [key, value] of Object.entries(withValues)) {
+				content += `      ${key}: ${formatYamlValue(value)}\n`;
+			}
 		}
 	}
 
 	if (
-		(values === undefined || Object.hasOwn(values, 'paths-ignore') === false) &&
+		(values?.push === undefined || Object.hasOwn(values.push, 'paths-ignore') === false) &&
 		existsSync(filepath) &&
 		pathsIgnoreLinePattern.test(readFileSync(filepath, 'utf-8'))
 	) {
@@ -146,15 +152,49 @@ const collectTemplates = (directory, prefix) => {
 for (const [name, values] of Object.entries(workflowValues)) {
 	const callerPath = join(workflowsDir, `${name}.yml`);
 
-	if (Object.hasOwn(values, 'paths-ignore') === false) {
+	if (existsSync(join(templatesDir, callerPath)) === false) {
+		console.error(`error: ${workflowValuesPath} ${name} names no workflow template`);
+		process.exit(1);
+	}
+
+	for (const key of Object.keys(values)) {
+		if (entryKeys.has(key) === false) {
+			console.error(`error: ${workflowValuesPath} ${name} has unknown key ${key}`);
+			process.exit(1);
+		}
+	}
+
+	if (name === 'userscript-publish' && values.with?.assets === undefined) {
+		console.error(`error: ${workflowValuesPath} userscript-publish has no with.assets`);
+		process.exit(1);
+	}
+
+	if (values.push === undefined) {
 		continue;
 	}
 
+	for (const key of Object.keys(values.push)) {
+		if (pushKeys.has(key) === false) {
+			console.error(`error: ${workflowValuesPath} ${name}.push has unknown key ${key}`);
+			process.exit(1);
+		}
+	}
+
+	if (Object.hasOwn(values.push, 'paths') && Object.hasOwn(values.push, 'paths-ignore')) {
+		console.error(`error: ${workflowValuesPath} ${name}.push sets both paths and paths-ignore`);
+		process.exit(1);
+	}
+
+	if (Object.keys(values.push).length === 0) {
+		continue;
+	}
+
+	const [pushKey] = Object.keys(values.push);
 	const pushBlock = pushBlockPattern.exec(readFileSync(join(templatesDir, callerPath), 'utf-8'));
 
 	if (pushBlock === null || /^ {4}paths:/m.test(pushBlock[1])) {
 		console.error(
-			`error: ${workflowValuesPath} sets paths-ignore for ${callerPath}, whose template has no push trigger without paths`,
+			`error: ${workflowValuesPath} sets push.${pushKey} for ${callerPath}, whose template has no push trigger without paths`,
 		);
 		process.exit(1);
 	}
@@ -174,6 +214,11 @@ for (const relativePath of collectTemplates(templatesDir, '')) {
 		continue;
 	}
 
+	if (entryRequiredFiles.has(outputName) && Object.hasOwn(workflowValues, basename(outputName, '.yml')) === false) {
+		console.log(`skipped ${outputName}`);
+		continue;
+	}
+
 	if (dirname(outputName) === workflowsDir) {
 		writeWorkflow(outputName, readFileSync(join(templatesDir, relativePath), 'utf-8'));
 	} else if (sectioned.has(outputName)) {

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@sapphire-sh/utils",
-	"version": "2.15.0",
+	"version": "3.1.0",
 	"description": "@sapphire-sh/utils",
 	"type": "module",
 	"sideEffects": false,
@@ -137,5 +137,9 @@
 		"typescript": "npm:@typescript/typescript6@^6.0.2",
 		"typescript-eslint": "^8.29.1",
 		"vitest": "^5.0.1"
+	},
+	"allowScripts": {
+		"fsevents@2.3.3": true,
+		"unrs-resolver@1.12.2": true
 	}
 }

package/templates/.github/workflows/docker-publish.yml

@@ -12,7 +12,7 @@ concurrency:
 
 jobs:
   call-shared-ci:
-    uses: sapphire-sh/github-actions/.github/workflows/docker-ci-template.yml@main
+    uses: sapphire-sh/github-actions/.github/workflows/docker-publish-template.yml@main
     secrets: inherit
     with:
       image_name: ${{ github.event.repository.name }}

package/templates/.github/workflows/{npm-audit-fix.yml → node-audit-fix.yml}

@@ -1,4 +1,4 @@
-name: npm-audit-fix
+name: node-audit-fix
 
 on:
   schedule:
@@ -7,7 +7,7 @@ on:
 
 jobs:
   fix:
-    uses: sapphire-sh/github-actions/.github/workflows/npm-audit-fix-template.yml@main
+    uses: sapphire-sh/github-actions/.github/workflows/node-audit-fix-template.yml@main
     permissions:
       contents: write
       issues: write

package/templates/.github/workflows/{shared-config-update.yml → node-shared-config-update.yml}

@@ -1,4 +1,4 @@
-name: shared-config-update
+name: node-shared-config-update
 
 on:
   push:
@@ -10,7 +10,7 @@ on:
 
 jobs:
   update:
-    uses: sapphire-sh/github-actions/.github/workflows/shared-config-update-template.yml@main
+    uses: sapphire-sh/github-actions/.github/workflows/node-shared-config-update-template.yml@main
     permissions:
       contents: write
       issues: write

package/templates/.github/workflows/userscript-publish.yml

@@ -0,0 +1,18 @@
+name: Publish Userscript
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  call-shared-publish:
+    uses: sapphire-sh/github-actions/.github/workflows/userscript-publish-template.yml@main
+    permissions:
+      contents: write
+    secrets: inherit