Improvements to the update snippets script (#1276)

Author: matux

package.json

@@ -101,9 +101,9 @@
   },
   "scripts": {
     "build": "webpack --mode production",
-    "postbuild": "npm run update:snippets",
+    "postbuild": "npm run validate:es5 && npm run update:snippets:examples",
     "build:dev": "webpack --mode development",
-    "postbuild:dev": "npm run update:snippets",
+    "postbuild:dev": "npm run postbuild",
     "test": "./node_modules/.bin/grunt test",
     "test-browser": "./node_modules/.bin/grunt test-browser",
     "test-server": "mocha 'test/server.*.test.js' --reporter spec",
@@ -113,6 +113,6 @@
     "test-ci": "./node_modules/.bin/grunt test && npm run test-server",
     "lint": "./node_modules/.bin/eslint .",
     "validate:es5": "es-check es5 './dist/**/*.js' --verbose",
-    "update:snippets": "node scripts/update-example-snippets.js"
+    "update:snippets:examples": "node scripts/update-snippets.js examples"
   }
 }

scripts/update-example-snippets.js

@@ -0,0 +1,109 @@
+#!/usr/bin/env node
+
+/**
+ * Updates the Rollbar snippet in js and html files under a specified base
+ * directory from the project root.
+ *
+ * Usage:
+ *   update-snippets <baseDir>
+ *
+ * If <baseDir> is omitted, it defaults to '.' (current directory).
+ *
+ * Replaces content between "// Rollbar Snippet" and "// End Rollbar Snippet" markers.
+ */
+
+import { readFile, writeFile } from 'node:fs/promises';
+import { fileURLToPath } from 'node:url';
+import path from 'node:path';
+import glob from 'glob';
+
+import { findUp } from './util.js';
+
+const verbose = ['--verbose', '-v'].some((f) => process.argv.includes(f));
+const baseDir = process.argv.at(verbose ? 3 : 2);
+
+function replaceSnippet({ content, snippet, regex, file, root }) {
+  let didMatch = false;
+  let wasReplaced = false;
+
+  const updatedContent = content.replace(regex, (...args) => {
+    const { indent, start, currentSnippet, end } = args.at(-1); // groups
+    didMatch = true;
+    wasReplaced = currentSnippet.trim() !== snippet;
+    console.log(`  ${wasReplaced ? '✓' : '-'} ${path.relative(root, file)}`);
+    return `${indent}${start}${indent}${snippet}${end}`;
+  });
+
+  if (verbose && !didMatch) {
+    console.log(`  ✗ ${path.relative(root, file)}`);
+  }
+
+  return { updatedContent, wasReplaced };
+}
+
+async function updateSnippets({ dir }) {
+  if (!dir) {
+    throw new Error('baseDir is required.');
+  }
+
+  const cwd = path.dirname(fileURLToPath(import.meta.url));
+  const root = await findUp({ fileName: 'package.json', dir: cwd });
+
+  console.log(`Updating Rollbar snippets in ${path.relative(root, cwd)}...`);
+
+  if (verbose) {
+    console.log(`Found project root at ${root}`);
+  }
+
+  const snippetPath = path.join(root, 'dist/rollbar.snippet.js');
+  const snippet = await readFile(snippetPath, 'utf8');
+
+  const regex = new RegExp(
+    '^' +
+      '(?<indent>[ \t]*)' +
+      '(?<start>// Rollbar Snippet\n)' +
+      '(?<currentSnippet>.*?)' +
+      '(?<end>\n[ \t]*// End Rollbar Snippet)' +
+      '$',
+    'ms',
+  );
+
+  const files = glob.sync(`${dir}/**/*.{html,js}`, {
+    cwd: root,
+    absolute: true,
+    ignore: ['**/.git/**', '**/node_modules/**'],
+  });
+
+  if (files.length === 0) {
+    throw new Error(`No files found in ${path.relative(root, dir)} to update.`);
+  }
+
+  let snippetsUpdated = 0;
+
+  for (const file of files) {
+    const content = await readFile(file, 'utf8');
+
+    const { updatedContent, wasReplaced } = replaceSnippet({
+      content,
+      snippet,
+      regex,
+      file,
+      root,
+    });
+
+    if (wasReplaced) {
+      await writeFile(file, updatedContent);
+      snippetsUpdated++;
+    }
+  }
+
+  console.log(`${snippetsUpdated} snippets updated.`);
+}
+
+updateSnippets({ dir: baseDir }).catch((err) => {
+  console.error('Error updating snippets:', err);
+  console.error('\nUsage: update-snippets [--verbose|-v] <baseDir>');
+  console.error('Example:');
+  console.error('  update-snippets examples');
+  process.exit(1);
+});

scripts/update-snippets.js

@@ -0,0 +1,29 @@
+import { access } from 'node:fs/promises';
+import path from 'node:path';
+
+/**
+ * Walks up parent directories from the given start directory until it finds the specified file.
+ *
+ * @param {Object} options - The options object.
+ * @param {string} options.fileName - Name of the file to search for, eg. 'package.json'.
+ * @param {string} [options.dir=process.cwd()] - Directory to start from. Defaults to `process.cwd()`.
+ * @returns {Promise<string>} The directory containing the file.
+ * @throws {Error} If no such file is found in any ancestor.
+ */
+export async function findUp({ fileName, dir = process.cwd() }) {
+  const origin = dir;
+  let current = dir;
+
+  while (true) {
+    try {
+      await access(path.join(current, fileName));
+      return current;
+    } catch {
+      const parent = path.dirname(current);
+      if (parent === current) break;
+      current = parent;
+    }
+  }
+
+  throw new Error(`No ${fileName} found in or above ${origin}`);
+}