Add script to remove temp/cache dirs (#58)

Author: imnasnainaec

.eslintrc.js

@@ -171,7 +171,7 @@ module.exports = {
       },
     },
     {
-      files: ['./lib/*', './webpack/*'],
+      files: ['./lib/*', './scripts/*', './webpack/*'],
       rules: {
         // These files are scripts not running in Platform.Bible, so they can't use the logger
         'no-console': 'off',

package.json

@@ -31,6 +31,7 @@
     "test:coverage": "jest --coverage",
     "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: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

@@ -0,0 +1,95 @@
+const fs = require('fs');
+const path = require('path');
+
+/**
+ * Cross-platform script to delete temporary and cache directories. Run this if Platform.Bible is
+ * holding on to outdated resources, such as localization strings, project data, or WebView ids.
+ *
+ * Warning: The `--core` flag deletes:
+ *
+ * - The `Electron` cache folder, which affect any other Electron apps
+ * - `paranext-core/dev-appdata/`, which includes `installed-extensions/`
+ */
+
+// 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) {
+  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 */
+
+const CORE_DIRS = [
+  electronParent ? path.join(electronParent, 'Electron') : '',
+  path.join(__dirname, '..', '..', 'paranext-core', 'dev-appdata'),
+];
+
+const EXT_DIRS = [
+  path.join(__dirname, '..', 'coverage'),
+  path.join(__dirname, '..', 'dist'),
+  path.join(__dirname, '..', 'src', 'temp-build'),
+];
+
+/**
+ * Delete a directory if it exists
+ *
+ * @param {string} dirPath - The directory path to delete
+ */
+function deleteDirectory(dirPath) {
+  if (!dirPath) {
+    console.log('⊘ Skipping empty path');
+    return;
+  }
+
+  try {
+    if (fs.existsSync(dirPath)) {
+      fs.rmSync(dirPath, { recursive: true, force: true });
+      console.log(`✓ Deleted ${dirPath}`);
+    } else {
+      console.log(`⊘ ${dirPath} does not exist`);
+    }
+  } catch (error) {
+    console.error(`✗ Failed to delete ${dirPath}:`, error.message);
+  }
+}
+
+// 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);
+  }
+
+  if (hasExtFlag) {
+    console.log('Deleting extension directories...');
+    EXT_DIRS.forEach(deleteDirectory);
+  }
+
+  console.log('Complete!');
+  process.exit(0);
+} catch (error) {
+  console.error('Error during cleanup:', error);
+  process.exit(1);
+}

tsconfig.lint.json

@@ -3,5 +3,5 @@
   "compilerOptions": {
     "allowJs": true
   },
-  "include": [".eslintrc.js", "*.ts", "*.js", "lib", "src", "webpack"]
+  "include": [".*.js", "*.js", "*.ts", "lib", "scripts", "src", "webpack"]
 }