@sheplu/editorconfig 0.12.2 → 0.14.0

package/README.md

@@ -1,5 +1,10 @@
 # editorconfig
 
+[![npm version](https://img.shields.io/npm/v/@sheplu/editorconfig.svg)](https://www.npmjs.com/package/@sheplu/editorconfig)
+[![Quality gates](https://github.com/sheplu/editorconfig/actions/workflows/quality-gates.yaml/badge.svg)](https://github.com/sheplu/editorconfig/actions/workflows/quality-gates.yaml)
+[![Node.js](https://img.shields.io/node/v/@sheplu/editorconfig.svg)](https://nodejs.org)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
+
 A small CLI to manage a **consistent `.editorconfig`** across your projects.
 
 - ✅ Generate a sane default `.editorconfig` in seconds
@@ -178,6 +183,39 @@ The custom template must follow the same semantics as the built-ins:
 
 URL fetching is constrained for safety: `https://` only (`http://` is rejected before any network call), redirects must stay on https (max 5 hops), 10-second timeout, 1 MB response cap. Templates are fetched on every invocation — there is no local cache.
 
+### `--json` (machine-readable check output)
+
+`check` accepts a `--json` flag that swaps the human-readable report for a structured JSON document on stdout. The exit code is unchanged (`0` pass, `1` fail), so it stays drop-in for CI while letting dashboards and scripts parse the result.
+
+```bash
+npx @sheplu/editorconfig --mode=check --json
+npx @sheplu/editorconfig --mode=check --recursive --json
+```
+
+Single-file shape:
+
+```json
+{
+  "mode": "check",
+  "path": ".editorconfig",
+  "ok": true,
+  "summary": { "total": 1, "matched": 1, "failed": 0, "unknown": 0 },
+  "sections": [
+    { "header": "[*]", "status": "match", "detail": "" }
+  ]
+}
+```
+
+In `--recursive` mode the payload instead carries `recursive: true`, a `files` array (each with its `role`, `summary`, and `sections`) and a `crossFileIssues` array describing `child-root` / `redundant` / `contradiction` findings. When no JSON output is requested, the human-readable report is printed exactly as before.
+
+### `--version`
+
+```bash
+npx @sheplu/editorconfig --version
+```
+
+Prints the installed package version (also available as `-v`).
+
 ### `--help`
 
 ```bash

package/index.js

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
 import { compareEditorConfig } from './src/check.js';
-import { parseCliArgs, printHelp } from './src/cli/options.js';
+import { parseCliArgs, printHelp, printVersion } from './src/cli/options.js';
 import { dispatchValues } from './src/cli/dispatch.js';
 import { createEditorConfig } from './src/cli/write-flow.js';
 
@@ -16,6 +16,10 @@ async function main() {
 		printHelp();
 		return;
 	}
+	if (parsed.values.version) {
+		printVersion();
+		return;
+	}
 	await dispatchValues(parsed.values);
 };
 

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@sheplu/editorconfig",
-	"version": "0.12.2",
+	"version": "0.14.0",
 	"description": "CLI to generate and validate a consistent .editorconfig across your projects",
 	"main": "index.js",
 	"files": [

package/src/check-recursive.js

@@ -4,9 +4,11 @@ import { discoverEditorConfigs } from './discover.js';
 import { classify, crossFileIssues } from './cascade.js';
 import {
 	compareEditorConfigForRole,
+	identityReplacer,
 	NO_LANGUAGE_FILTER,
 	printReport,
 	reportIsFailing,
+	reportToSections,
 	summarizeReport,
 } from './check.js';
 import { logger } from './utils/logger.js';
@@ -162,21 +164,23 @@ function formatGlobalSummary({ entries, crossIssues, strict }) {
 	return { line: `${summaryHead(passed)} — ${parts.join('; ')}`, failed: !passed };
 }
 
-function processTree({ tree, parsedLanguages, overrides, startDir }) {
+function processTree({ tree, parsedLanguages, overrides, startDir, json }) {
 	const entries = buildFileEntries(tree, parsedLanguages, overrides);
 	const [rootEntry, ...childEntries] = entries;
 	const crossIssues = collectCrossIssues(rootEntry, childEntries);
-	for (const entry of entries) {
-		printFileBlock(entry, startDir);
+	if (!json) {
+		for (const entry of entries) {
+			printFileBlock(entry, startDir);
+		}
 	}
 	return { entries, crossIssues };
 }
 
-function gatherAll({ trees, parsedLanguages, overrides, startDir }) {
+function gatherAll({ trees, parsedLanguages, overrides, startDir, json }) {
 	const allEntries = [];
 	const allCrossIssues = [];
 	for (const tree of trees) {
-		const { entries, crossIssues } = processTree({ tree, parsedLanguages, overrides, startDir });
+		const { entries, crossIssues } = processTree({ tree, parsedLanguages, overrides, startDir, json });
 		allEntries.push(...entries);
 		allCrossIssues.push(...crossIssues);
 	}
@@ -192,18 +196,82 @@ function reportAndExit({ allEntries, allCrossIssues, strict, startDir }) {
 	}
 }
 
-export function runCheckRecursive({ startDir: rawStart, parsedLanguages, strict, overrides }) {
-	const startDir = resolveStartDir(rawStart);
-	const paths = discoverEditorConfigs(startDir);
-	if (paths.length === 0) {
-		logger.log(`No .editorconfig files found under ${startDir}`);
+function jsonFileEntry(entry, startDir, strict) {
+	return {
+		path: displayPath(entry.path, startDir),
+		role: entry.role,
+		failed: reportIsFailing(entry.report, strict),
+		summary: summarizeReport(entry.report),
+		sections: reportToSections(entry.report),
+	};
+}
+
+function jsonCrossIssue(issue, startDir) {
+	const copy = {};
+	for (const [key, value] of Object.entries(issue)) {
+		copy[key] = value;
+	}
+	copy.file = displayPath(issue.file, startDir);
+	return copy;
+}
+
+function buildRecursiveJson({ allEntries, allCrossIssues, strict, startDir }) {
+	const summary = formatGlobalSummary({ entries: allEntries, crossIssues: allCrossIssues, strict });
+	return {
+		mode: 'check',
+		recursive: true,
+		startDir,
+		ok: !summary.failed,
+		files: allEntries.map((entry) => jsonFileEntry(entry, startDir, strict)),
+		crossFileIssues: allCrossIssues.map((issue) => jsonCrossIssue(issue, startDir)),
+	};
+}
+
+function emitJson(payload) {
+	logger.log(JSON.stringify(payload, identityReplacer, 2));
+}
+
+function reportRecursiveJson(payload) {
+	const json = buildRecursiveJson(payload);
+	emitJson(json);
+	if (!json.ok) {
+		process.exitCode = 1;
+	}
+}
+
+function emitEmptyRecursiveJson(startDir) {
+	emitJson({ mode: 'check', recursive: true, startDir, ok: true, files: [], crossFileIssues: [] });
+}
+
+function reportEmpty(startDir, json) {
+	if (json) {
+		emitEmptyRecursiveJson(startDir);
 		return;
 	}
+	logger.log(`No .editorconfig files found under ${startDir}`);
+}
+
+function runWalk({ startDir, paths, parsedLanguages, strict, overrides, json }) {
 	const { allEntries, allCrossIssues } = gatherAll({
 		trees: classify(paths),
 		parsedLanguages,
 		overrides,
 		startDir,
+		json,
 	});
+	if (json) {
+		reportRecursiveJson({ allEntries, allCrossIssues, strict, startDir });
+		return;
+	}
 	reportAndExit({ allEntries, allCrossIssues, strict, startDir });
 }
+
+export function runCheckRecursive({ startDir: rawStart, parsedLanguages, strict, overrides, json }) {
+	const startDir = resolveStartDir(rawStart);
+	const paths = discoverEditorConfigs(startDir);
+	if (paths.length === 0) {
+		reportEmpty(startDir, json);
+		return;
+	}
+	runWalk({ startDir, paths, parsedLanguages, strict, overrides, json });
+}

package/src/check.js

@@ -143,7 +143,7 @@ function formatLine({ header, status }) {
 export function reportIsFailing({ baseIssues, results }, strict) {
 	const failing = [...baseIssues, ...results].some((entry) => FAILING_STATUSES.has(entry.status));
 	const hasUnknown = results.some((entry) => entry.status === 'unknown');
-	return failing || (strict && hasUnknown);
+	return failing || Boolean(strict && hasUnknown);
 }
 
 function buildHeading(displayPath, label) {
@@ -208,11 +208,38 @@ function formatSummary(report, isFailure) {
 	return formatPassSummary(counts);
 }
 
-export function runCheck({ path, parsedLanguages, strict, overrides }) {
+export function identityReplacer(_key, value) {
+	return value;
+}
+
+export function reportToSections(report) {
+	return [...report.baseIssues, ...report.results].map(({ header, status }) => ({
+		header,
+		status,
+		detail: STATUS_DETAIL[status],
+	}));
+}
+
+export function buildCheckJson({ path, report, failed }) {
+	return {
+		mode: 'check',
+		path,
+		ok: !failed,
+		summary: summarizeReport(report),
+		sections: reportToSections(report),
+	};
+}
+
+export function runCheck({ path, parsedLanguages, strict, overrides, json }) {
 	const report = compareEditorConfig(path, parsedLanguages, overrides);
-	printReport(path, report);
 	const failed = reportIsFailing(report, strict);
-	logger.log(formatSummary(report, failed));
+	if (json) {
+		logger.log(JSON.stringify(buildCheckJson({ path, report, failed }), identityReplacer, 2));
+	}
+	else {
+		printReport(path, report);
+		logger.log(formatSummary(report, failed));
+	}
 	if (failed) {
 		process.exitCode = 1;
 	}

package/src/cli/dispatch.js

@@ -32,17 +32,17 @@ function resolveCheckPath(values) {
 	return '.editorconfig';
 }
 
-function dispatchCheck({ path, languages, strict, overrides, recursive }) {
+function dispatchCheck({ path, languages, strict, overrides, recursive, json }) {
 	let filter = languages;
 	if (filter === NOT_PROVIDED) {
 		filter = NO_LANGUAGE_FILTER;
 	}
 	try {
 		if (recursive) {
-			runCheckRecursive({ startDir: path, parsedLanguages: filter, strict, overrides });
+			runCheckRecursive({ startDir: path, parsedLanguages: filter, strict, overrides, json });
 			return;
 		}
-		runCheck({ path, parsedLanguages: filter, strict, overrides });
+		runCheck({ path, parsedLanguages: filter, strict, overrides, json });
 	}
 	catch (error) {
 		logger.error(error.message);
@@ -69,13 +69,13 @@ async function handleWrite({ path, overwrite, languages, overrides, recursive })
 	await dispatchWrite({ path, overwrite, languages, overrides });
 }
 
-async function runCommand({ mode, path, overwrite, languages, strict, overrides, recursive }) {
+async function runCommand({ mode, path, overwrite, languages, strict, overrides, recursive, json }) {
 	if (mode === 'write') {
 		await handleWrite({ path, overwrite, languages, overrides, recursive });
 		return;
 	}
 	if (mode === 'check') {
-		dispatchCheck({ path, languages, strict, overrides, recursive });
+		dispatchCheck({ path, languages, strict, overrides, recursive, json });
 		return;
 	}
 	logger.error('invalid command');
@@ -95,5 +95,6 @@ export async function dispatchValues(values) {
 		strict: values.strict,
 		overrides,
 		recursive: Boolean(values.recursive),
+		json: Boolean(values.json),
 	});
 }

package/src/cli/options.js

@@ -1,3 +1,4 @@
+import { readFileSync } from 'node:fs';
 import { parseArgs } from 'node:util';
 import {
 	ALIASES,
@@ -10,10 +11,18 @@ export const options = {
 	path: { type: 'string', short: 'p' },
 	languages: { type: 'string', short: 'l' },
 	help: { type: 'boolean', short: 'h' },
+	version: { type: 'boolean', short: 'v' },
 	overwrite: { type: 'boolean', short: 'o' },
 	strict: { type: 'boolean', short: 's' },
 	template: { type: 'string', short: 't' },
 	recursive: { type: 'boolean', short: 'r' },
+	json: { type: 'boolean' },
+};
+
+export function printVersion() {
+	const pkgUrl = new URL('../../package.json', import.meta.url);
+	const { version } = JSON.parse(readFileSync(pkgUrl, 'utf8'));
+	logger.log(version);
 };
 
 export const NOT_PROVIDED = Symbol('languages-not-provided');
@@ -41,7 +50,7 @@ function formatAliasList() {
 }
 
 export function printHelp() {
-	logger.log(`Usage: editorconfig --mode=<command> [--path=<path>] [--languages=<list>] [--template=<path|url>] [--recursive]
+	logger.log(`Usage: editorconfig --mode=<command> [--path=<path>] [--languages=<list>] [--template=<path|url>] [--recursive] [--json]
 
 Commands:
   write    Create a .editorconfig file with the selected language sections
@@ -55,6 +64,8 @@ Options:
   -s, --strict     Treat unknown section headers as failures (check only)
   -t, --template   Path or https URL to a custom .editorconfig-syntax file whose sections override the built-in ones
   -r, --recursive  Check only. Walk the start directory and validate every .editorconfig (root + children) with cascade checks
+      --json       Emit check results as JSON instead of human-readable text (check only)
+  -v, --version    Show the installed version
   -h, --help       Show this help message
 
 Languages: ${AVAILABLE_LANGUAGES.join(', ')}