utilium 2.5.2 → 2.5.4

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "utilium",
-	"version": "2.5.2",
+	"version": "2.5.4",
 	"description": "Typescript utilities",
 	"funding": {
 		"type": "individual",
@@ -41,7 +41,7 @@
 	"homepage": "https://github.com/james-pre/utilium#readme",
 	"devDependencies": {
 		"@eslint/js": "^9.12.0",
-		"@types/node": "^20.12.7",
+		"@types/node": "^22.18.0",
 		"eslint": "^9.12.0",
 		"globals": "^15.10.0",
 		"prettier": "^3.2.5",
@@ -55,5 +55,8 @@
 	},
 	"optionalDependencies": {
 		"@xterm/xterm": "^5.5.0"
+	},
+	"engines": {
+		"node": ">=22.0.0"
 	}
 }

package/scripts/lice.js

@@ -2,37 +2,78 @@
 // SPDX-License-Identifier: LGPL-3.0-or-later
 // Copyright (c) 2025 James Prevett
 
-import { readdirSync } from 'node:fs';
+import { existsSync, globSync, readdirSync, readFileSync, statSync } from 'node:fs';
 import { readFile, writeFile } from 'node:fs/promises';
-import { join, matchesGlob, relative } from 'node:path';
+import { dirname, join, matchesGlob, relative } from 'node:path';
 import { parseArgs, styleText } from 'node:util';
 
-const {
-	positionals: dirs,
-	values: { license: expectedLicense, write, verbose, force, exclude },
-} = parseArgs({
+const { positionals: inputs, values: opts } = parseArgs({
 	allowPositionals: true,
 	options: {
-		license: { type: 'string', short: 'L' },
-		write: { type: 'boolean', short: 'w', default: false },
-		verbose: { type: 'boolean', short: 'v', default: false },
+		auto: { type: 'boolean', short: 'a', default: false },
+		exclude: { type: 'string', short: 'x', default: [], multiple: true },
 		force: { type: 'boolean', short: 'f', default: false },
-		exclude: { type: 'string', short: 'x', default: '' },
+		help: { type: 'boolean', short: 'h', default: false },
+		license: { type: 'string', short: 'l' },
+		verbose: { type: 'boolean', short: 'v', default: false },
+		write: { type: 'boolean', short: 'w', default: false },
 	},
 });
 
-if (write && !expectedLicense) {
-	console.error(styleText('red', 'You must specify a license to write with --license/-L'));
+if (opts.help) {
+	console.error(`Usage: lice [options] <inputs...>
+
+Options:
+    -f, --force         Force overwrite of existing license headers
+    -h, --help          Show this help message
+    -a, --auto          Detect the SPDX identifier in package.json
+    -l, --license       Specify the SPDX license identifier to check for.
+    -v, --verbose       Enable verbose output
+    -w, --write         Write the license header if missing
+    -x, --exclude       Glob pattern to exclude files
+`);
+	process.exit(0);
+}
+
+/**
+ *
+ * @returns {string|null}
+ */
+function get_license() {
+	for (let dir = process.cwd(); dir != '/'; dir = dirname(dir)) {
+		const pkgPath = join(dir, 'package.json');
+		if (!existsSync(pkgPath)) continue;
+
+		const pkg = JSON.parse(readFileSync(pkgPath, 'utf-8'));
+		if (pkg.spdx) return pkg.spdx;
+		if (pkg.spdxLicense) return pkg.spdxLicense;
+		if (pkg.license) return pkg.license;
+	}
+
+	return null;
+}
+
+const expectedLicense = opts.license || (opts.auto && get_license());
+
+if (opts.write && !expectedLicense) {
+	console.error(styleText('red', 'You must specify a license to write.'));
 	process.exit(1);
 }
 
+function should_exclude(path, display) {
+	for (const pattern of opts.exclude) {
+		if (!matchesGlob(path, pattern)) continue;
+		console.log(styleText('whiteBright', 'Skipped:'), display);
+		return true;
+	}
+
+	return false;
+}
+
 const licenseSpec = /^\s*\/(?:\/|\*) SPDX-License-Identifier: (.+)/;
 
 async function check_file(path, display) {
-	if (matchesGlob(path, exclude)) {
-		console.log(styleText('whiteBright', 'Skipped:'), display);
-		return 'skipped';
-	}
+	if (should_exclude(path, display)) return 'skipped';
 
 	const content = await readFile(path, 'utf-8');
 
@@ -44,14 +85,14 @@ async function check_file(path, display) {
 	}
 
 	if (!expectedLicense) {
-		if (verbose) console.log(styleText(['dim'], 'Found:'), display);
+		if (opts.verbose) console.log(styleText(['dim'], 'Found:'), display);
 		return 'with license';
 	}
 
 	const [, license] = match;
 
 	if (license == expectedLicense) {
-		if (verbose) console.log(styleText(['green', 'dim'], 'Correct:'), display);
+		if (opts.verbose) console.log(styleText(['green', 'dim'], 'Correct:'), display);
 		return 'correct';
 	}
 
@@ -60,10 +101,7 @@ async function check_file(path, display) {
 }
 
 async function write_file(path, display) {
-	if (matchesGlob(path, exclude)) {
-		console.log(styleText('whiteBright', 'Skipped:'), display);
-		return 'skipped';
-	}
+	if (should_exclude(path, display)) return 'skipped';
 
 	const content = await readFile(path, 'utf-8');
 
@@ -79,13 +117,13 @@ async function write_file(path, display) {
 	const [, license] = match;
 
 	if (license == expectedLicense) {
-		if (verbose) console.log(styleText(['green', 'dim'], 'Correct:'), display);
+		if (opts.verbose) console.log(styleText(['green', 'dim'], 'Correct:'), display);
 		return 'correct';
 	}
 
 	process.stdout.write(styleText('yellow', 'Mismatch: ') + display);
 
-	if (!force) {
+	if (!opts.force) {
 		console.log(styleText('whiteBright', ' (skipped)'));
 		return 'skipped';
 	}
@@ -95,38 +133,50 @@ async function write_file(path, display) {
 	return 'overwritten';
 }
 
-function check_dir(dir, display) {
-	const entries = readdirSync(dir, { withFileTypes: true });
+function* check_dir(dir, display) {
+	if (should_exclude(dir, display)) return 'skipped';
 
-	const results = [];
+	const entries = readdirSync(dir, { withFileTypes: true });
 
 	for (const entry of entries) {
 		if (entry.isDirectory()) {
-			results.push(...check_dir(join(dir, entry.name), join(display, entry.name)));
+			yield* check_dir(join(dir, entry.name), join(display, entry.name));
 			continue;
 		}
 
 		if (!entry.isFile()) continue;
 
-		const op = write ? write_file : check_file;
-		results.push(op(join(dir, entry.name), join(display, entry.name)));
+		const op = opts.write ? write_file : check_file;
+		yield op(join(dir, entry.name), join(display, entry.name));
 	}
-
-	return results;
 }
 
-if (!dirs.length) {
-	console.error(styleText('red', 'No directories specified'));
+if (!inputs.length) {
+	console.error(styleText('red', 'No inputs specified'));
 	process.exit(1);
 }
 
-if (verbose) console.log('Checking:', dirs.join(', '));
+const globbed = globSync(inputs);
+
+if (opts.verbose) console.log('Checking:', globbed.join(', '));
 
 const promises = [];
 
-for (const dir of dirs) {
-	const rel = relative(process.cwd(), dir);
-	promises.push(...check_dir(dir, rel.startsWith('..') ? dir : rel));
+for (const input of globbed) {
+	const rel = relative(process.cwd(), input);
+	if (should_exclude(input, rel)) {
+		promises.push(Promise.resolve('skipped'));
+		continue;
+	}
+
+	const stat = statSync(input);
+
+	if (stat.isDirectory()) {
+		for (const result of check_dir(input, rel)) promises.push(result);
+	} else {
+		const op = opts.write ? write_file : check_file;
+		promises.push(op(input, rel));
+	}
 }
 
 const styles = Object.assign(Object.create(null), {
@@ -147,7 +197,7 @@ try {
 		results[result]++;
 	}
 	console.log(
-		write ? 'Wrote' : 'Checked',
+		opts.write ? 'Wrote' : 'Checked',
 		styleText('blueBright', raw_results.length.toString()),
 		'files:',
 		Object.entries(results)

package/scripts/tsconfig.json

@@ -0,0 +1,10 @@
+{
+	"compilerOptions": {
+		"checkJs": true,
+		"noEmit": true,
+		"lib": ["ESNext"],
+		"module": "NodeNext",
+		"moduleResolution": "NodeNext"
+	},
+	"include": ["*.js"]
+}