Add script to update package-lock.json

Author: imnasnainaec

README.md

@@ -253,6 +253,12 @@ git merge template/main --allow-unrelated-histories
 
 For more information, read [the instructions on the wiki](https://github.com/paranext/paranext-extension-template/wiki/Merging-Template-Changes-into-Your-Extension).
 
+After updating this extension from the template, clear all temp/cache files and regenerate the extension's `package-lock.json` with this command:
+
+```bash
+npm run core:reinstall
+```
+
 **Note:** The merge/squash commits created when updating this repo from the template are important; Git uses them to compare the files for future updates. If you edit this repo's Git history, please preserve these commits (do not squash them, for example) to avoid duplicated merge conflicts in the future.
 
 ## Special features in this project

package.json

@@ -32,6 +32,7 @@
     "core:start": "npm --prefix ../paranext-core start",
     "core:stop": "npm --prefix ../paranext-core stop",
     "core:reset": "npm run core:stop && node ./scripts/delete-temp-dirs.cjs --core --ext",
+    "core:reinstall": "npm run core:reset && node ./scripts/delete-temp-dirs.cjs --npm && npm run core:update && npm i",
     "core:install": "npm --prefix ../paranext-core install",
     "core:pull": "git -C ../paranext-core pull --ff-only",
     "core:update": "npm run core:pull && npm run core:install"

scripts/delete-temp-dirs.cjs

@@ -11,24 +11,41 @@ const path = require('path');
  * - `paranext-core/dev-appdata/`, which includes `installed-extensions/`
  */
 
+// Check command-line arguments
+
+const hasCoreFlag = process.argv.includes('--core');
+const hasExtFlag = process.argv.includes('--ext');
+const hasNpmFlag = process.argv.includes('--npm');
+
+if (!hasCoreFlag && !hasExtFlag && !hasNpmFlag) {
+  console.error('Usage: node delete-temp-dirs.cjs [--core] [--ext] [--npm]');
+  console.error('  --core          Delete Electron and core cache (Electron, dev-appdata)');
+  console.error('  --ext           Delete extension directories (coverage, dist, src/temp-build)');
+  console.error('  --npm           Delete both node_modules and extension package-lock.json');
+  process.exit(1);
+}
+
 // Define directory lists
 
-/* eslint-disable no-nested-ternary */
-let electronParent =
-  process.platform === 'win32'
-    ? process.env.APPDATA
-    : process.platform === 'linux'
-      ? process.env.XDG_CONFIG_HOME
-      : '';
-if (!electronParent && process.env.HOME) {
+let electronParent = '';
+if (hasCoreFlag) {
+  /* eslint-disable no-nested-ternary */
   electronParent =
-    process.platform === 'linux'
-      ? path.join(process.env.HOME, '.config')
-      : process.platform === 'darwin'
-        ? path.join(process.env.HOME, 'Library', 'Application Support')
+    process.platform === 'win32'
+      ? process.env.APPDATA
+      : process.platform === 'linux'
+        ? process.env.XDG_CONFIG_HOME
         : '';
+  if (!electronParent && process.env.HOME) {
+    electronParent =
+      process.platform === 'linux'
+        ? path.join(process.env.HOME, '.config')
+        : process.platform === 'darwin'
+          ? path.join(process.env.HOME, 'Library', 'Application Support')
+          : '';
+  }
+  /* eslint-enable no-nested-ternary */
 }
-/* eslint-enable no-nested-ternary */
 
 const CORE_DIRS = [
   electronParent ? path.join(electronParent, 'Electron') : '',
@@ -41,6 +58,12 @@ const EXT_DIRS = [
   path.join(__dirname, '..', 'src', 'temp-build'),
 ];
 
+const NPM_PATHS = [
+  path.join(__dirname, '..', '..', 'paranext-core', 'node_modules'),
+  path.join(__dirname, '..', 'node_modules'),
+  path.join(__dirname, '..', 'package-lock.json'),
+];
+
 /**
  * Delete a directory if it exists
  *
@@ -67,16 +90,6 @@ function deleteDirectory(dirPath) {
 // Delete directories based on command-line flags
 
 try {
-  const hasCoreFlag = process.argv.includes('--core');
-  const hasExtFlag = process.argv.includes('--ext');
-
-  if (!hasCoreFlag && !hasExtFlag) {
-    console.error('Usage: node delete-temp-dirs.cjs [--core] [--ext]');
-    console.error('  --core  Delete AppData and core cache directories (Electron, dev-appdata)');
-    console.error('  --ext   Delete extension directories (coverage, dist, src/temp-build)');
-    process.exit(1);
-  }
-
   if (hasCoreFlag) {
     console.log('Deleting core cache directories...');
     CORE_DIRS.forEach(deleteDirectory);
@@ -87,6 +100,11 @@ try {
     EXT_DIRS.forEach(deleteDirectory);
   }
 
+  if (hasNpmFlag) {
+    console.log('Deleting node_modules and package-lock.json...');
+    NPM_PATHS.forEach(deleteDirectory);
+  }
+
   console.log('Complete!');
   process.exit(0);
 } catch (error) {