@sapphire-sh/utils 2.10.0 → 2.12.0

package/bin/sapphire-bootstrap.js

@@ -1,6 +1,6 @@
 #!/usr/bin/env node
 
-import { copyFileSync, existsSync, mkdirSync, readFileSync, readdirSync, writeFileSync } from 'node:fs';
+import { copyFileSync, existsSync, mkdirSync, readFileSync, readdirSync, rmSync, writeFileSync } from 'node:fs';
 import { basename, dirname, join } from 'node:path';
 import { fileURLToPath } from 'node:url';
 
@@ -8,11 +8,15 @@ 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', 'utils-update.yml')]);
+const selfSkipped = new Set([join('.github', 'workflows', 'shared-config-update.yml')]);
+const obsoleteFiles = new Set([join('.github', 'workflows', 'utils-update.yml')]);
 
 const workflowsDir = join('.github', 'workflows');
 const workflowValuesPath = join('.github', 'sapphire-workflows.json');
 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 requiredFiles = new Map([[join(workflowsDir, 'docker-publish.yml'), 'Dockerfile']]);
 
 const sectioned = new Set(['.gitignore', '.prettierignore']);
@@ -88,15 +92,33 @@ 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) => `      - ${JSON.stringify(value)}\n`).join('');
+			content = content.replace(
+				branchesListPattern,
+				(branchesList) => `${branchesList}    paths-ignore:\n${pathsIgnoreLines}`,
+			);
+		}
+
 		if (withLinePattern.test(template) === false) {
 			content += '    with:\n';
 		}
 
-		for (const [key, value] of Object.entries(values)) {
+		for (const [key, value] of Object.entries(withValues)) {
 			content += `      ${key}: ${JSON.stringify(value)}\n`;
 		}
 	}
 
+	if (
+		(values === undefined || Object.hasOwn(values, 'paths-ignore') === false) &&
+		existsSync(filepath) &&
+		pathsIgnoreLinePattern.test(readFileSync(filepath, 'utf-8'))
+	) {
+		console.log(`warning: ${outputName} had paths-ignore values that are not in ${workflowValuesPath}`);
+	}
+
 	mkdirSync(dirname(filepath), { recursive: true });
 	writeFileSync(filepath, content);
 	console.log(`wrote ${outputName}`);
@@ -118,6 +140,23 @@ const collectTemplates = (directory, prefix) => {
 	return relativePaths;
 };
 
+for (const [name, values] of Object.entries(workflowValues)) {
+	const callerPath = join(workflowsDir, `${name}.yml`);
+
+	if (Object.hasOwn(values, 'paths-ignore') === false) {
+		continue;
+	}
+
+	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`,
+		);
+		process.exit(1);
+	}
+}
+
 for (const relativePath of collectTemplates(templatesDir, '')) {
 	const outputName = renameMap.get(relativePath) ?? relativePath;
 	const outputPath = join(cwd, outputName);
@@ -143,3 +182,12 @@ for (const relativePath of collectTemplates(templatesDir, '')) {
 		console.log(`wrote ${outputName}`);
 	}
 }
+
+for (const relativePath of obsoleteFiles) {
+	const filepath = join(cwd, relativePath);
+
+	if (existsSync(filepath)) {
+		rmSync(filepath);
+		console.log(`removed ${relativePath}`);
+	}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@sapphire-sh/utils",
-	"version": "2.10.0",
+	"version": "2.12.0",
 	"description": "@sapphire-sh/utils",
 	"type": "module",
 	"sideEffects": false,

package/templates/.github/dependabot.yml

@@ -0,0 +1,18 @@
+version: 2
+updates:
+  - package-ecosystem: npm
+    directory: /
+    schedule:
+      interval: cron
+      cronjob: '0 0 * * *'
+    groups:
+      dependencies:
+        patterns:
+          - '*'
+        exclude-patterns:
+          - '@sapphire-sh/utils'
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: cron
+      cronjob: '0 0 * * *'

package/templates/.github/workflows/shared-config-update.yml

@@ -0,0 +1,17 @@
+name: shared-config-update
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - package-lock.json
+  workflow_dispatch:
+
+jobs:
+  update:
+    uses: sapphire-sh/github-actions/.github/workflows/shared-config-update-template.yml@main
+    permissions:
+      contents: write
+      issues: write
+      pull-requests: write

package/templates/.github/workflows/utils-update.yml

@@ -1,14 +0,0 @@
-name: utils-update
-
-on:
-  schedule:
-    - cron: '0 0 * * *'
-  workflow_dispatch:
-
-jobs:
-  update:
-    uses: sapphire-sh/github-actions/.github/workflows/utils-update-template.yml@main
-    permissions:
-      contents: write
-      issues: write
-      pull-requests: write