@sheplu/editorconfig 0.9.0 → 0.10.1

package/README.md

@@ -178,6 +178,7 @@ Run them with:
 npm test                  # everything
 npm run test:unit         # unit only — runs in ~50ms
 npm run test:integration  # integration only — spawns the CLI
+npm run test:coverage.    # coverage with 95% threshold
 npm run lint              # oxlint
 ```
 

package/index.js

@@ -11,6 +11,7 @@ import {
 } from './src/templates/index.js';
 import { loadCustomTemplate } from './src/templates/custom-template.js';
 import { compareEditorConfig, NO_LANGUAGE_FILTER, runCheck } from './src/check.js';
+import { logger } from './src/utils/logger.js';
 
 export { compareEditorConfig };
 
@@ -74,7 +75,7 @@ function formatAliasList() {
 }
 
 export function printHelp() {
-	console.log(`Usage: editorconfig --mode=<command> [--path=<path>] [--languages=<list>] [--template=<path|url>]
+	logger.log(`Usage: editorconfig --mode=<command> [--path=<path>] [--languages=<list>] [--template=<path|url>]
 
 Commands:
   write    Create a .editorconfig file with the selected language sections
@@ -124,7 +125,7 @@ function promptLanguages() {
 		const numbered = AVAILABLE_LANGUAGES
 			.map((name, index) => `  ${index + 1}. ${name}`)
 			.join('\n');
-		console.log(`Available language sections:\n${numbered}`);
+		logger.log(`Available language sections:\n${numbered}`);
 		rl.question('Languages? [comma-separated names or indices, blank=base only] ', (answer) => {
 			rl.close();
 			resolve(resolvePromptAnswer(answer));
@@ -154,7 +155,7 @@ function confirmOverwrite(path) {
 
 async function handleExistingTarget(path, languages, overrides) {
 	if (!process.stdin.isTTY) {
-		console.error(`\`${path}\` already exists. Use --overwrite to replace it.`);
+		logger.error(`\`${path}\` already exists. Use --overwrite to replace it.`);
 		process.exitCode = 1;
 		return;
 	}
@@ -163,7 +164,7 @@ async function handleExistingTarget(path, languages, overrides) {
 		createEditorConfig(path, languages, overrides);
 	}
 	else {
-		console.log(`Skipped: \`${path}\` was not modified.`);
+		logger.log(`Skipped: \`${path}\` was not modified.`);
 	}
 }
 
@@ -185,7 +186,7 @@ function dispatchCheck({ path, languages, strict, overrides }) {
 		runCheck({ path, parsedLanguages: filter, strict, overrides });
 	}
 	catch (error) {
-		console.error(error.message);
+		logger.error(error.message);
 		process.exitCode = 1;
 	}
 }
@@ -195,7 +196,7 @@ async function dispatchWrite({ path, overwrite, languages, overrides }) {
 		await runWrite({ path, overwrite, parsedLanguages: languages, overrides });
 	}
 	catch (error) {
-		console.error(error.message);
+		logger.error(error.message);
 		process.exitCode = 1;
 	}
 }
@@ -209,7 +210,7 @@ async function runCommand({ mode, path, overwrite, languages, strict, overrides
 		dispatchCheck({ path, languages, strict, overrides });
 		return;
 	}
-	console.error('invalid command');
+	logger.error('invalid command');
 	process.exitCode = 1;
 }
 
@@ -225,7 +226,7 @@ function parseCliArgs(args) {
 		return parseArgs({ args, options });
 	}
 	catch (error) {
-		console.error(formatCliError(error));
+		logger.error(formatCliError(error));
 		process.exitCode = 1;
 		return false;
 	}
@@ -241,7 +242,7 @@ async function resolveOverrides(templateValue) {
 		return await loadCustomTemplate(templateValue);
 	}
 	catch (error) {
-		console.error(error.message);
+		logger.error(error.message);
 		process.exitCode = 1;
 		return OVERRIDES_FAILED;
 	}
@@ -279,7 +280,7 @@ if (process.argv[1] === import.meta.filename) {
 		await main();
 	}
 	catch (error) {
-		console.error(error.message);
+		logger.error(error.message);
 		process.exitCode = 1;
 	}
 }

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@sheplu/editorconfig",
-	"version": "0.9.0",
-	"description": "",
+	"version": "0.10.1",
+	"description": "CLI to generate and validate a consistent .editorconfig across your projects",
 	"main": "index.js",
 	"files": [
 		"index.js",
@@ -10,6 +10,7 @@
 	"scripts": {
 		"lint": "oxlint",
 		"test": "node --test",
+		"test:coverage": "node --test --experimental-test-coverage --test-coverage-lines=95 --test-coverage-branches=95 --test-coverage-functions=95",
 		"test:unit": "node --test 'test/unit/*.test.js'",
 		"test:integration": "node --test 'test/integration/*.test.js'"
 	},
@@ -40,6 +41,6 @@
 	"homepage": "https://github.com/sheplu/editorconfig#readme",
 	"devDependencies": {
 		"node-pty": "1.0.0",
-		"oxlint": "^1.64.0"
+		"oxlint": "^1.65.0"
 	}
 }

package/src/check.js

@@ -9,6 +9,7 @@ import {
 	parseSections,
 	resolveLanguageNames,
 } from './templates/index.js';
+import { logger } from './utils/logger.js';
 
 export const NO_LANGUAGE_FILTER = Symbol('check-no-language-filter');
 
@@ -108,15 +109,15 @@ export function reportIsFailing({ baseIssues, results }, strict) {
 }
 
 function printReport(path, report) {
-	console.log(`Checking ${path}`);
-	console.log('');
+	logger.log(`Checking ${path}`);
+	logger.log('');
 	for (const issue of report.baseIssues) {
-		console.log(formatLine(issue));
+		logger.log(formatLine(issue));
 	}
 	for (const entry of report.results) {
-		console.log(formatLine(entry));
+		logger.log(formatLine(entry));
 	}
-	console.log('');
+	logger.log('');
 }
 
 function summarize(report) {
@@ -168,7 +169,7 @@ export function runCheck({ path, parsedLanguages, strict, overrides }) {
 	const report = compareEditorConfig(path, parsedLanguages, overrides);
 	printReport(path, report);
 	const failed = reportIsFailing(report, strict);
-	console.log(formatSummary(report, failed));
+	logger.log(formatSummary(report, failed));
 	if (failed) {
 		process.exitCode = 1;
 	}

package/src/utils/fetch.js

@@ -1,15 +1,18 @@
 import { parseRedirectLocation } from './url.js';
 
 const TIMEOUT_MS = 10_000;
+const MS_PER_SECOND = 1000;
 const MAX_BYTES = 1_048_576;
 const MAX_REDIRECTS = 5;
+const HTTP_REDIRECT_MIN = 300;
+const HTTP_REDIRECT_MAX = 400;
 
 function ignoreCancelError() {
 	return false;
 }
 
 export function isRedirect(status) {
-	return status >= 300 && status < 400;
+	return status >= HTTP_REDIRECT_MIN && status < HTTP_REDIRECT_MAX;
 }
 
 export function rejectOversized(url) {
@@ -81,7 +84,7 @@ export async function performFetch(initialUrl, signal) {
 
 export function describeFetchError(url, error) {
 	if (error.name === 'AbortError') {
-		return new Error(`failed to fetch '${url}': request timed out after ${TIMEOUT_MS / 1000}s`);
+		return new Error(`failed to fetch '${url}': request timed out after ${TIMEOUT_MS / MS_PER_SECOND}s`);
 	}
 	if (/^failed to fetch |^template body /u.test(error.message)) {
 		return error;

package/src/utils/logger.js

@@ -0,0 +1,8 @@
+/* eslint-disable no-console */
+export const logger = {
+	log: (...args) => console.log(...args),
+	info: (...args) => console.info(...args),
+	warn: (...args) => console.warn(...args),
+	error: (...args) => console.error(...args),
+	debug: (...args) => console.debug(...args),
+};