@ggdna/dna-gg 0.1.0

package/dna/scripts/rename-class.js

@@ -0,0 +1,147 @@
+#!/bin/node
+
+import fs from 'fs';
+import path from 'path';
+import { blue, gray, green, red, yellow } from './functions/colors.js';
+
+// .............................................................................
+const excludedFiles = ['create-new-repo.md', 'rename-class.js'];
+
+// .............................................................................
+
+const isExcluded = (fileName) => {
+  return excludedFiles.includes(fileName);
+};
+
+const shouldProcessFile = (file) => !isExcluded(file);
+
+// Binary files must not be rewritten as UTF-8, that would corrupt them.
+const readTextFile = (fullPath) => {
+  const buffer = fs.readFileSync(fullPath);
+  if (buffer.includes(0)) return null;
+  return buffer.toString('utf8');
+};
+
+const writeTextFile = (fullPath, oldContent, newContent) => {
+  if (newContent === oldContent) return;
+  fs.writeFileSync(fullPath, newContent, 'utf8');
+};
+
+if (process.argv.length < 4) {
+  const usage = red('Usage:');
+  const script = yellow(path.basename(process.argv[1]));
+  const classA = green('ClassA');
+  const classB = blue('ClassB');
+  console.error([usage, script, classA, classB].join(' '));
+  process.exit(1);
+}
+
+const classA = process.argv[2];
+const classB = process.argv[3];
+
+const toSnakeCase = (str) => {
+  return str.replace(/(?<=[a-z0-9])([A-Z])/g, '-$1').toLowerCase();
+};
+
+const toLowerCamelCase = (str) => {
+  return str.replace(/([-_]\w)/g, (matches) => matches[1].toUpperCase());
+};
+
+const toUpperCamelCase = (str) => {
+  return str.replace(/(?:^|[-_])(\w)/g, (_, c) => (c ? c.toUpperCase() : ''));
+};
+
+const classALower = toLowerCamelCase(classA);
+const classBLower = toLowerCamelCase(classB);
+const classAUpper = toUpperCamelCase(classA);
+const classBUpper = toUpperCamelCase(classB);
+const classASnake = toSnakeCase(classA);
+const classBSnake = toSnakeCase(classB);
+const classASnakeUnderscore = classASnake.replace(/-/g, '_');
+const classBSnakeUnderscore = classBSnake.replace(/-/g, '_');
+
+const replaceIncludesFirst = (directory) => {
+  const files = fs.readdirSync(directory, { withFileTypes: true });
+
+  for (const file of files) {
+    const fullPath = path.join(directory, file.name);
+
+    if (file.isDirectory()) {
+      if (file.name.startsWith('.') || file.name === 'node_modules') continue;
+      replaceIncludesFirst(fullPath);
+    } else if (shouldProcessFile(file.name)) {
+      const original = readTextFile(fullPath);
+      if (original === null) continue;
+      const content = original
+        .replace(
+          new RegExp(`(\\/)${classASnake}(\\.ts)?([\\.\\/\\'\\\"\\\\])`, 'g'),
+          `$1${classBSnake}$2$3`,
+        )
+        .replace(
+          new RegExp(
+            `(\\/)${classASnakeUnderscore}(\\.ts)?([\\.\\/\\'\\\"\\\\])`,
+            'g',
+          ),
+          `$1${classBSnakeUnderscore}$2$3`,
+        );
+      writeTextFile(fullPath, original, content);
+    }
+  }
+};
+
+const replaceInFiles = (directory) => {
+  const files = fs.readdirSync(directory, { withFileTypes: true });
+
+  for (const file of files) {
+    const fullPath = path.join(directory, file.name);
+
+    if (file.isDirectory()) {
+      if (file.name.startsWith('.') || file.name === 'node_modules') continue;
+      replaceInFiles(fullPath);
+    } else if (shouldProcessFile(file.name)) {
+      const original = readTextFile(fullPath);
+      if (original === null) continue;
+      const content = original
+        .replace(new RegExp(classAUpper, 'g'), classBUpper)
+        .replace(new RegExp(classALower, 'g'), classBLower)
+        .replace(new RegExp(classASnake, 'g'), classBSnake)
+        .replace(
+          new RegExp(classASnakeUnderscore, 'g'),
+          classBSnakeUnderscore,
+        );
+      writeTextFile(fullPath, original, content);
+    }
+  }
+};
+
+const renameFiles = (directory) => {
+  const files = fs.readdirSync(directory, { withFileTypes: true });
+
+  for (const file of files) {
+    const fullPath = path.join(directory, file.name);
+
+    if (file.isDirectory()) {
+      if (file.name.startsWith('.') || file.name === 'node_modules') continue;
+      renameFiles(fullPath);
+    } else if (
+      file.name.includes(classASnake) ||
+      file.name.includes(classASnakeUnderscore)
+    ) {
+      const newFileName = file.name
+        .replace(classASnake, classBSnake)
+        .replace(classASnakeUnderscore, classBSnakeUnderscore);
+      fs.renameSync(fullPath, path.join(directory, newFileName));
+    }
+  }
+};
+
+console.log(gray('Replacing includes first...'));
+replaceIncludesFirst('.');
+
+console.log(gray('Renaming files...'));
+renameFiles('.');
+
+console.log(gray('Replacing occurrences in files...'));
+replaceInFiles('.');
+
+console.log(green('Done.'));

package/dna/scripts/setup-github-repo.js

@@ -0,0 +1,221 @@
+/*
+ * @license
+ * Copyright (c) ggsuite
+ *
+ * Use of this source code is governed by terms that can be
+ * found in the LICENSE file in the root of this package.
+ */
+
+import { execSync } from 'child_process';
+import { writeFileSync } from 'fs';
+import { tmpdir } from 'os';
+import { join } from 'path';
+import {
+  blue,
+  cyan,
+  gray,
+  green,
+  red,
+  white,
+  yellow,
+} from './functions/colors.js';
+import { runCommand } from './functions/run-command.js';
+
+// The name of the branch ruleset managed by this script
+const rulesetName = 'Default';
+
+// The status check that must pass before merging. It is provided by the
+// GitHub Actions app, i.e. not by "Any source".
+const requiredStatusCheck = 'dnaGitQuickCheckPipelineName';
+const gitHubActionsAppId = 15368;
+
+// ...........................................................................
+// Make sure the GitHub CLI is available and authenticated
+function checkGhCli() {
+  console.log(gray('Check GitHub CLI'));
+
+  try {
+    runCommand('gh --version');
+  } catch {
+    throw new Error(
+      [
+        yellow('GitHub CLI is not installed. Please install it:'),
+        green('brew install gh'),
+      ].join('\n'),
+    );
+  }
+
+  try {
+    runCommand('gh auth status');
+  } catch {
+    throw new Error(
+      [yellow('Not yet logged in. Please run:'), green('gh auth login')].join(
+        '\n',
+      ),
+    );
+  }
+}
+
+// ...........................................................................
+// Get "org/repo" either from the first argument or from the current directory
+function repoSlug() {
+  const fromArgs = process.argv.slice(2).find((a) => !a.startsWith('--'));
+  if (fromArgs) {
+    if (!/^[^/]+\/[^/]+$/.test(fromArgs)) {
+      throw new Error(`Invalid repository '${fromArgs}'. Expected 'org/repo'.`);
+    }
+    return fromArgs;
+  }
+
+  console.log(gray('Get repository from current directory'));
+  try {
+    const json = runCommand('gh repo view --json nameWithOwner');
+    return JSON.parse(json).nameWithOwner;
+  } catch {
+    throw new Error(
+      [
+        yellow('Could not determine the repository.'),
+        yellow('Please call this script from a GitHub repository or run:'),
+        green('node dna/scripts/setup-github-repo.js org/repo'),
+      ].join('\n'),
+    );
+  }
+}
+
+// ...........................................................................
+// Call the GitHub API with a JSON body
+function ghApi(method, path, body) {
+  const file = join(tmpdir(), `setup-github-repo-${process.pid}.json`);
+  writeFileSync(file, JSON.stringify(body));
+  console.log(gray(`gh api --method ${method} ${path}`));
+  return execSync(`gh api --method ${method} ${path} --input ${file}`, {
+    encoding: 'utf-8',
+    stdio: ['pipe', 'pipe', 'pipe'],
+  }).trim();
+}
+
+// ...........................................................................
+// Only allow squash merges, auto merge and delete branches after merge
+function pullRequestSettings() {
+  return {
+    allow_merge_commit: false,
+    allow_squash_merge: true,
+    // Default commit message: "Pull request title"
+    squash_merge_commit_title: 'PR_TITLE',
+    squash_merge_commit_message: 'BLANK',
+    allow_rebase_merge: false,
+    allow_auto_merge: true,
+    allow_update_branch: true,
+    delete_branch_on_merge: true,
+  };
+}
+
+// ...........................................................................
+function setupPullRequestSettings(slug) {
+  console.log(gray('Setup pull request settings'));
+
+  ghApi('PATCH', `repos/${slug}`, pullRequestSettings());
+
+  console.log(green('✅ Pull request settings applied.'));
+}
+
+// ...........................................................................
+// The ruleset protecting the default branch
+function ruleset(requireReview) {
+  return {
+    name: rulesetName,
+    target: 'branch',
+    enforcement: 'active',
+    conditions: {
+      ref_name: { include: ['~DEFAULT_BRANCH'], exclude: [] },
+    },
+    rules: [
+      { type: 'deletion' },
+      { type: 'non_fast_forward' },
+      { type: 'required_linear_history' },
+      {
+        type: 'pull_request',
+        parameters: {
+          required_approving_review_count: requireReview ? 1 : 0,
+          dismiss_stale_reviews_on_push: false,
+          require_code_owner_review: false,
+          require_last_push_approval: requireReview,
+          required_review_thread_resolution: requireReview,
+          allowed_merge_methods: ['squash'],
+        },
+      },
+      {
+        type: 'required_status_checks',
+        parameters: {
+          strict_required_status_checks_policy: true,
+          required_status_checks: [
+            {
+              context: requiredStatusCheck,
+              integration_id: gitHubActionsAppId,
+            },
+          ],
+        },
+      },
+    ],
+  };
+}
+
+// ...........................................................................
+// Find the id of an already existing ruleset with the same name
+function existingRulesetId(slug) {
+  const json = runCommand(`gh api repos/${slug}/rulesets`);
+  const found = JSON.parse(json).find((r) => r.name === rulesetName);
+  return found ? found.id : undefined;
+}
+
+// ...........................................................................
+// Create the ruleset or update it when it already exists
+function setupBranchRules(slug, requireReview) {
+  console.log(gray('Setup branch rules'));
+
+  const id = existingRulesetId(slug);
+
+  if (id) {
+    ghApi('PUT', `repos/${slug}/rulesets/${id}`, ruleset(requireReview));
+    console.log(green(`✅ Ruleset '${rulesetName}' has been updated.`));
+  } else {
+    ghApi('POST', `repos/${slug}/rulesets`, ruleset(requireReview));
+    console.log(green(`✅ Ruleset '${rulesetName}' has been created.`));
+  }
+}
+
+// ...........................................................................
+// Print the repo and the settings without changing anything
+function dryRun(slug, requireReview) {
+  console.log(cyan(slug));
+  console.log(white(JSON.stringify(pullRequestSettings(), null, 2)));
+  console.log(white(JSON.stringify(ruleset(requireReview), null, 2)));
+}
+
+// ...........................................................................
+function main() {
+  const requireReview = process.argv.includes('--require-review');
+  const isDryRun = !process.argv.includes('--apply');
+
+  checkGhCli();
+  const slug = repoSlug();
+
+  if (isDryRun) {
+    dryRun(slug, requireReview);
+    return;
+  }
+
+  console.log(blue(`https://github.com/${slug}`));
+
+  setupPullRequestSettings(slug);
+  setupBranchRules(slug, requireReview);
+
+  console.log(green(`✅ Repository '${slug}' has been set up.`));
+}
+
+try {
+  main();
+} catch (error) {
+  console.error(red(`Error: ${error.message}`));
+  process.exit(1);
+}

package/dna/scripts/wait-for-pr.js

@@ -0,0 +1,90 @@
+/**
+ * @license
+ * Copyright (c) ggsuite
+ *
+ * Use of this source code is governed by terms that can be
+ * found in the LICENSE file in the root of this package.
+ */
+
+import { blue, green, red, yellow } from './functions/colors.js';
+import { runCommand } from './functions/run-command.js';
+
+function getPRUrl() {
+  try {
+    const json = runCommand('gh pr view --json url').trim();
+
+    const parsed = JSON.parse(json);
+    const url = parsed.url;
+    console.log(blue(url));
+  } catch (error) {
+    console.error(yellow('No PR available'));
+    process.exit(1);
+  }
+}
+
+function getPRStatus() {
+  try {
+    const jsonString = runCommand(
+      'gh pr view --json state',
+      true,
+      false,
+    ).trim();
+
+    const jsonParsed = JSON.parse(jsonString);
+    return jsonParsed.state;
+  } catch (error) {
+    console.error(red('Error fetching PR status'));
+    process.exit(1);
+  }
+}
+
+async function checkIfPipelineHasFailed() {
+  try {
+    const json = runCommand(
+      'gh run list --repo rljson/template-project --limit 1 --json status,conclusion',
+      true,
+      false,
+    ).trim();
+
+    const jsonParsed = JSON.parse(json);
+    if (jsonParsed.length) {
+      if (jsonParsed[0].conclusion === 'failure') {
+        console.error(red('Pipeline has failed. Please fix.'));
+        process.exit(1);
+      }
+    }
+  } catch (e) {
+    console.error(red('Error fetching pipeline status'));
+    process.exit(1);
+  }
+}
+
+async function waitForPRClosure() {
+  console.log(yellow('Wait for pipelines, code review and merge ...'));
+
+  while (true) {
+    const status = getPRStatus();
+
+    if (status === 'MERGED') {
+      console.log(green('PR has been merged.'));
+      break;
+    } else if (status === 'CLOSED') {
+      console.log(green('PR has been closed.'));
+      break;
+    } else if (status === 'FAILED') {
+      console.log(red('Error: PR has failed.'));
+      break;
+    }
+
+    await checkIfPipelineHasFailed();
+
+    await new Promise((resolve) => setTimeout(resolve, 2000));
+  }
+}
+
+async function main() {
+  getPRUrl();
+  await waitForPRClosure();
+}
+
+main();

package/package.json

@@ -0,0 +1,45 @@
+{
+  "name": "@ggdna/dna-gg",
+  "version": "0.1.0",
+  "description": "DNA layer: gg CLI workflow guides, repo setup scripts and CI check",
+  "keywords": [
+    "dna",
+    "helix",
+    "conventions",
+    "scaffolding"
+  ],
+  "homepage": "https://github.com/ggdna/dna_gg",
+  "bugs": "https://github.com/ggdna/dna_gg/issues",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ggdna/dna_gg.git"
+  },
+  "type": "module",
+  "files": [
+    "dna",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=22"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@ggdna/dna-index": "^0.1.0",
+    "@ggdna/dna-install": "^0.1.0"
+  },
+  "scripts": {
+    "test:dart": "dart test",
+    "test": "pnpm run test:dart",
+    "prepublishOnly": "pnpm run test",
+    "format": "prettier --write .",
+    "format:check": "prettier --check ."
+  },
+  "devDependencies": {
+    "@types/node": "^26.2.0",
+    "prettier": "^3.9.6"
+  }
+}