@sapphire-sh/utils 2.9.0 → 2.11.0

package/bin/sapphire-bootstrap.js

@@ -1,20 +1,20 @@
 #!/usr/bin/env node
 
-import { copyFileSync, existsSync, mkdirSync, readFileSync, readdirSync, writeFileSync } from 'node:fs';
-import { dirname, join } from 'node:path';
+import { copyFileSync, existsSync, mkdirSync, readFileSync, readdirSync, rmSync, writeFileSync } from 'node:fs';
+import { basename, dirname, join } from 'node:path';
 import { fileURLToPath } from 'node:url';
 
 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')]);
 
-// Templates a consuming repo edits with its own values, so bootstrap only seeds them once.
-const preserved = new Set([
-	join('.github', 'workflows', 'utils-update.yml'),
-	join('.github', 'workflows', 'npm-audit-fix.yml'),
-]);
+const workflowsDir = join('.github', 'workflows');
+const workflowValuesPath = join('.github', 'sapphire-workflows.json');
+const withLinePattern = /^\s*with:\s*$/m;
+const requiredFiles = new Map([[join(workflowsDir, 'docker-publish.yml'), 'Dockerfile']]);
 
 const sectioned = new Set(['.gitignore', '.prettierignore']);
 const renameMap = new Map([
@@ -41,7 +41,18 @@ const readPackageName = () => {
 	}
 };
 
+const readWorkflowValues = () => {
+	const filepath = join(cwd, workflowValuesPath);
+
+	if (existsSync(filepath) === false) {
+		return {};
+	}
+
+	return JSON.parse(readFileSync(filepath, 'utf-8'));
+};
+
 const isSelf = readPackageName() === selfPackageName;
+const workflowValues = readWorkflowValues();
 
 const writeSectioned = (outputName, content) => {
 	const filepath = join(cwd, outputName);
@@ -68,6 +79,30 @@ const writeSectioned = (outputName, content) => {
 	console.log(`wrote ${outputName}`);
 };
 
+const writeWorkflow = (outputName, template) => {
+	const filepath = join(cwd, outputName);
+	const values = workflowValues[basename(outputName, '.yml')];
+	let content = template;
+
+	if (values === undefined) {
+		if (existsSync(filepath) && withLinePattern.test(readFileSync(filepath, 'utf-8'))) {
+			console.log(`warning: ${outputName} had with: values that are not in ${workflowValuesPath}`);
+		}
+	} else {
+		if (withLinePattern.test(template) === false) {
+			content += '    with:\n';
+		}
+
+		for (const [key, value] of Object.entries(values)) {
+			content += `      ${key}: ${JSON.stringify(value)}\n`;
+		}
+	}
+
+	mkdirSync(dirname(filepath), { recursive: true });
+	writeFileSync(filepath, content);
+	console.log(`wrote ${outputName}`);
+};
+
 const collectTemplates = (directory, prefix) => {
 	const relativePaths = [];
 
@@ -93,12 +128,14 @@ for (const relativePath of collectTemplates(templatesDir, '')) {
 		continue;
 	}
 
-	if (preserved.has(outputName) && existsSync(outputPath)) {
+	if (requiredFiles.has(outputName) && existsSync(join(cwd, requiredFiles.get(outputName))) === false) {
 		console.log(`skipped ${outputName}`);
 		continue;
 	}
 
-	if (sectioned.has(outputName)) {
+	if (dirname(outputName) === workflowsDir) {
+		writeWorkflow(outputName, readFileSync(join(templatesDir, relativePath), 'utf-8'));
+	} else if (sectioned.has(outputName)) {
 		const content = readFileSync(join(templatesDir, relativePath), 'utf-8');
 		writeSectioned(outputName, content);
 	} else {
@@ -107,3 +144,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.9.0",
+	"version": "2.11.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/docker-publish.yml

@@ -0,0 +1,17 @@
+name: Build and Push Docker Image
+
+on:
+  push:
+    branches:
+      - main
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  call-shared-ci:
+    uses: sapphire-sh/github-actions/.github/workflows/docker-ci-template.yml@main
+    secrets: inherit
+    with:
+      image_name: ${{ github.event.repository.name }}

package/templates/.github/workflows/npm-audit-fix.yml

@@ -10,4 +10,5 @@ jobs:
     uses: sapphire-sh/github-actions/.github/workflows/npm-audit-fix-template.yml@main
     permissions:
       contents: write
+      issues: write
       pull-requests: write

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,13 +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
-      pull-requests: write