Skip to content

Add build & yalc files to the delete script #71

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
imnasnainaec wants to merge 5 commits into
base: main
Choose a base branch
from
Draft

Add build & yalc files to the delete script #71

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
39ade83
Add yalc-files to the delete script
imnasnainaec May 14, 2026
4e993a2
Update script
imnasnainaec May 15, 2026
96d337e
Add more core node_modules folders
imnasnainaec May 15, 2026
f2fffc3
Delete temp build paths
imnasnainaec May 15, 2026
0f21254
Prevent node_modules diving
imnasnainaec May 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +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-files.cjs --core --ext",
"core:reinstall": "npm run core:reset && node ./scripts/delete-temp-files.cjs --npm && npm run core:update && npm i",
"core:reinstall": "npm run core:stop && node ./scripts/delete-temp-files.cjs --all && npm run core:update && npm i",
Comment thread
imnasnainaec marked this conversation as resolved.
"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"
Expand Down
149 changes: 120 additions & 29 deletions scripts/delete-temp-files.cjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,30 +5,77 @@ const path = require('path');
* Cross-platform script to delete temporary and cache paths. Run this if Platform.Bible is holding
* on to outdated resources, such as localization strings, project data, or WebView ids.
*
* Warning: The `--build` flag deletes:
*
* - All core extension builds, which makes the next core:start last minutes longer
*
* Warning: The `--core` flag deletes:
*
* - The `Electron` cache folder, which affect any other Electron apps
* - `paranext-core/dev-appdata/`, which includes `installed-extensions/`
*
* Warning: The `--yalc` flag deletion includes:
*
* - `paranext-core/dev-packages/`, which makes the next core:install last minutes longer
*/

// Check command-line arguments

const hasCoreFlag = process.argv.includes('--core');
const hasExtFlag = process.argv.includes('--ext');
const hasNpmFlag = process.argv.includes('--npm');
const allFlag = process.argv.includes('--all');
const buildFlag = process.argv.includes('--build');
const coreFlag = process.argv.includes('--core');
const extFlag = process.argv.includes('--ext');
const npmFlag = process.argv.includes('--npm');
const testFlag = process.argv.includes('--test');
const yalcFlag = process.argv.includes('--yalc');

function printUsageAndExit(code = 0) {
console.info(
'Usage: node delete-temp-files.cjs [--all] [--build] [--core] [--ext] [--npm] [--test] [--yalc]',
);
console.info(' --build Delete core build files');
console.info(' --core Delete Electron and core caches (Electron, dev-appdata)');
console.info(' --ext Delete extension builds (dist, src/temp-build)');
console.info(' --npm Delete extension package-lock.json and all node_modules');
console.info(' --test Delete extension test/lint-related files');
console.info(' --yalc Delete core yalc-related files');
console.info(' --all Delete all of the above');
process.exit(code);
}

if (!hasCoreFlag && !hasExtFlag && !hasNpmFlag) {
console.error('Usage: node delete-temp-files.cjs [--core] [--ext] [--npm]');
console.error(' --core Delete Electron and core caches (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);
if (process.argv.length <= 2 || process.argv.includes('--help') || process.argv.includes('-h')) {
printUsageAndExit();
}

if (!allFlag && !buildFlag && !coreFlag && !extFlag && !npmFlag && !testFlag && !yalcFlag) {
printUsageAndExit(1);
}

const shouldDeleteBuild = allFlag || buildFlag;
const shouldDeleteCore = allFlag || coreFlag;
const shouldDeleteExt = allFlag || extFlag;
const shouldDeleteNpm = allFlag || npmFlag;
const shouldDeleteTest = allFlag || testFlag;
const shouldDeleteYalc = allFlag || yalcFlag;

// Define directory lists

let electronParent = '';
if (hasCoreFlag) {
const EXT_DIR_PATH = path.join(__dirname, '..');
const CORE_DIR_PATH = path.join(EXT_DIR_PATH, '..', 'paranext-core');
const SKIP_DIRS = new Set(['.yalc', 'dev-appdata', 'dev-packages', 'lib', 'node_modules']);

const BUILD_PATHS = [];
if (shouldDeleteBuild) {
// Add core build output subdirectories to `BUILD_PATHS`
BUILD_PATHS.push(...findNamed(CORE_DIR_PATH, 'dist', SKIP_DIRS));
BUILD_PATHS.push(...findNamed(CORE_DIR_PATH, 'temp-build', SKIP_DIRS));
}
Comment thread
imnasnainaec marked this conversation as resolved.

const CORE_PATHS = [path.join(CORE_DIR_PATH, 'dev-appdata')];
if (shouldDeleteCore) {
// Determine Electron cache directory based on platform and add to `CORE_PATHS`
let electronParent = '';

/* eslint-disable no-nested-ternary */
electronParent =
process.platform === 'win32'
Expand All @@ -45,25 +92,54 @@ if (hasCoreFlag) {
: '';
}
/* eslint-enable no-nested-ternary */

if (electronParent) {
CORE_PATHS.push(path.join(electronParent, 'Electron Cache'));
}
}

const CORE_DIRS = [
electronParent ? path.join(electronParent, 'Electron') : '',
path.join(__dirname, '..', '..', 'paranext-core', 'dev-appdata'),
];
const EXT_PATHS = [path.join(EXT_DIR_PATH, 'dist'), path.join(EXT_DIR_PATH, 'src', 'temp-build')];

const EXT_DIRS = [
path.join(__dirname, '..', 'coverage'),
path.join(__dirname, '..', 'dist'),
path.join(__dirname, '..', 'src', 'temp-build'),
const NPM_PATHS = [
path.join(EXT_DIR_PATH, 'node_modules'),
path.join(EXT_DIR_PATH, 'package-lock.json'),
];
if (shouldDeleteNpm) {
// Find core `node_modules` subdirectories and add them to `NPM_PATHS`
NPM_PATHS.push(...findNamed(CORE_DIR_PATH, 'node_modules', SKIP_DIRS));
}

const NPM_PATHS = [
path.join(__dirname, '..', '..', 'paranext-core', 'node_modules'),
path.join(__dirname, '..', 'node_modules'),
path.join(__dirname, '..', 'package-lock.json'),
const TEST_PATHS = [path.join(EXT_DIR_PATH, 'coverage'), path.join(EXT_DIR_PATH, '.eslintcache')];

const YALC_PATHS = [
path.join(CORE_DIR_PATH, '.yalc'),
path.join(CORE_DIR_PATH, 'dev-packages'),
path.join(CORE_DIR_PATH, 'yalc.lock'),
];

/**
* Recursively find all subdirectories named `targetDir` inside `corePath`, skipping `skipDirs`.
*
* @param {string} corePath - Root directory to search
* @param {string} targetDir - Directory name to collect
* @param {Set<string>} skipDirs - Directory names to skip entirely
* @returns {string[]} Absolute paths of every matching directory found
*/
function findNamed(corePath, target, skipDirs) {
let entries;
try {
entries = fs.readdirSync(corePath, { withFileTypes: true });
} catch {
return [];
}
return entries
.filter((entry) => entry.name === target || (entry.isDirectory() && !skipDirs.has(entry.name)))
.flatMap((entry) => {
const fullPath = path.join(corePath, entry.name);
return entry.name === target ? [fullPath] : findNamed(fullPath, target, skipDirs);
});
}

/**
* Delete a path if it exists
*
Expand All @@ -78,7 +154,7 @@ function deletePath(pathToDelete) {
try {
if (fs.existsSync(pathToDelete)) {
fs.rmSync(pathToDelete, { recursive: true, force: true });
console.log(`✓ Deleted ${pathToDelete}`);
console.log(`✓ ${pathToDelete} deleted`);
} else {
console.log(`⊘ ${pathToDelete} does not exist`);
}
Expand All @@ -90,21 +166,36 @@ function deletePath(pathToDelete) {
// Delete paths based on command-line flags

try {
if (hasCoreFlag) {
if (shouldDeleteBuild) {
console.log('Deleting core build directories...');
BUILD_PATHS.forEach(deletePath);
}

if (shouldDeleteCore) {
console.log('Deleting core cache directories...');
CORE_DIRS.forEach(deletePath);
CORE_PATHS.forEach(deletePath);
}

if (hasExtFlag) {
if (shouldDeleteExt) {
console.log('Deleting extension directories...');
EXT_DIRS.forEach(deletePath);
EXT_PATHS.forEach(deletePath);
}

if (hasNpmFlag) {
if (shouldDeleteNpm) {
console.log('Deleting node_modules and package-lock.json...');
NPM_PATHS.forEach(deletePath);
}

if (shouldDeleteTest) {
console.log('Deleting extension test- and lint-related files...');
TEST_PATHS.forEach(deletePath);
}

if (shouldDeleteYalc) {
console.log('Deleting core yalc-related files...');
YALC_PATHS.forEach(deletePath);
}

console.log('Complete!');
process.exit(0);
} catch (error) {
Expand Down
Loading