load-oxfmt-config 0.3.1 → 0.4.0

package/README.md

@@ -287,6 +287,7 @@ The loader reads the nearest `.editorconfig` file and maps the subset of fields
 - `indent_size` / `tab_width` → `tabWidth`
 - `max_line_length` → `printWidth`
 - `insert_final_newline` → `insertFinalNewline`
+- `quote_type` → `singleQuote`
 
 Glob sections such as `[*.ts]` are converted into returned `overrides` entries.
 

package/dist/index.mjs

@@ -1,7 +1,7 @@
 import { readFile, stat } from "node:fs/promises";
 import { dirname, isAbsolute, join, relative } from "node:path";
 import process from "node:process";
-import { interopDefault } from "@ntnyq/utils";
+import { interopDefault, isBoolean, isNumber, isObject } from "@ntnyq/utils";
 import { parse } from "jsonc-parser";
 import { parseBuffer } from "editorconfig";
 //#region src/constants.ts
@@ -24,23 +24,57 @@ const EDITORCONFIG_FILE = ".editorconfig";
 const EDITORCONFIG_GLOBAL_SECTION_NAMES = ["*", "**"];
 //#endregion
 //#region src/editorconfig.ts
+/**
+* Builds the cache key used for resolved EditorConfig lookups.
+*
+* @param resolveKey - The base resolution key for the current lookup.
+* @returns The namespaced cache key for EditorConfig resolution.
+*/
 function getEditorconfigResolveCacheKey(resolveKey) {
 	return `editorconfig::${resolveKey}`;
 }
+/**
+* Determines the directory that should be used to search for a nearby .editorconfig file.
+*
+* @param cwd - The current working directory for the lookup.
+* @param configPath - An optional config path used to anchor the search.
+* @returns The directory where EditorConfig discovery should begin.
+*/
 function getEditorconfigSearchDir(cwd, configPath) {
 	if (!configPath) return cwd;
 	return dirname(isAbsolute(configPath) ? configPath : join(cwd, configPath));
 }
+/**
+* Merges root-level EditorConfig options with oxfmt config options.
+*
+* @param oxfmtConfig - The explicit oxfmt options.
+* @param editorconfigRootOptions - Root options derived from .editorconfig.
+* @returns A single root options object where oxfmt takes precedence.
+*/
 function mergeRootOptions(oxfmtConfig, editorconfigRootOptions) {
 	return {
 		...editorconfigRootOptions,
 		...oxfmtConfig
 	};
 }
+/**
+* Merges EditorConfig-derived overrides with explicit oxfmt overrides.
+*
+* @param oxfmtOverrides - Overrides declared in the oxfmt config.
+* @param editorconfigOverrides - Overrides derived from .editorconfig sections.
+* @returns The merged overrides array, or undefined when no overrides exist.
+*/
 function mergeOverrides(oxfmtOverrides, editorconfigOverrides) {
 	const mergedOverrides = [...editorconfigOverrides, ...oxfmtOverrides || []];
 	return mergedOverrides.length > 0 ? mergedOverrides : void 0;
 }
+/**
+* Resolves the nearest .editorconfig file starting from a directory and optionally walking upward.
+*
+* @param startDir - The directory where the search starts.
+* @param onlyCwd - When true, only checks the starting directory.
+* @returns The resolved .editorconfig path, or undefined when none is found.
+*/
 async function resolveEditorconfigPath(startDir, onlyCwd = false) {
 	let currentDir = startDir;
 	while (true) {
@@ -54,19 +88,59 @@ async function resolveEditorconfigPath(startDir, onlyCwd = false) {
 		currentDir = parentDir;
 	}
 }
+/**
+* Normalizes a file path to POSIX separators for glob compatibility.
+*
+* @param path - The path to normalize.
+* @returns The path with forward slashes.
+*/
 function toPosixPath(path) {
 	return path.replaceAll("\\", "/");
 }
+/**
+* Checks whether an EditorConfig section should be treated as a global section.
+*
+* @param sectionName - The section name parsed from .editorconfig.
+* @returns True when the section applies globally.
+*/
 function isEditorconfigGlobalSection(sectionName) {
 	return Boolean(sectionName && EDITORCONFIG_GLOBAL_SECTION_NAMES.includes(sectionName));
 }
+/**
+* Parses an EditorConfig boolean string.
+*
+* @param value - The raw EditorConfig value.
+* @returns The parsed boolean, or undefined when the value is unsupported.
+*/
 function parseEditorconfigBoolean(value) {
 	if (value === "true") return true;
 	if (value === "false") return false;
 }
+/**
+* Parses the end-of-line style supported by oxfmt.
+*
+* @param value - The raw EditorConfig end_of_line value.
+* @returns The normalized line ending value, or undefined when unsupported.
+*/
 function parseEditorconfigEndOfLine(value) {
 	if (value === "lf" || value === "crlf" || value === "cr") return value;
 }
+/**
+* Parses the single quote preference from an EditorConfig section.
+*
+* @param value - The raw EditorConfig value for single quote preference.
+* @returns True if single quotes are preferred, false if double quotes are preferred, or undefined when auto.
+*/
+function parseEditorconfigQuoteType(value) {
+	if (value === "single") return true;
+	if (value === "double") return false;
+}
+/**
+* Resolves the effective tab width from an EditorConfig section.
+*
+* @param section - The parsed EditorConfig section body.
+* @returns The resolved tab width, or undefined when no numeric value is available.
+*/
 function parseEditorconfigTabWidth(section) {
 	const indentSize = section["indent_size"];
 	const tabWidth = section["tab_width"];
@@ -79,27 +153,50 @@ function parseEditorconfigTabWidth(section) {
 		if (Number.isFinite(parsedTabWidth)) return parsedTabWidth;
 	}
 }
+/**
+* Maps a parsed EditorConfig section to the subset of oxfmt formatter options it supports.
+*
+* @param section - The parsed EditorConfig section body.
+* @returns Formatter options derived from the section.
+*/
 function mapEditorconfigSectionToOptions(section) {
 	const options = {};
 	const endOfLine = parseEditorconfigEndOfLine(section["end_of_line"]);
 	if (endOfLine) options.endOfLine = endOfLine;
 	if (section["indent_style"] === "tab") options.useTabs = true;
 	else if (section["indent_style"] === "space") options.useTabs = false;
+	const singleQuote = parseEditorconfigQuoteType(section["quote_type"]);
+	if (isBoolean(singleQuote)) options.singleQuote = singleQuote;
 	const tabWidth = parseEditorconfigTabWidth(section);
-	if (typeof tabWidth === "number") options.tabWidth = tabWidth;
+	if (isNumber(tabWidth)) options.tabWidth = tabWidth;
 	if (section["max_line_length"] && section["max_line_length"] !== "unset") {
 		const parsedPrintWidth = Number(section["max_line_length"]);
 		if (Number.isFinite(parsedPrintWidth)) options.printWidth = parsedPrintWidth;
 	}
 	const insertFinalNewline = parseEditorconfigBoolean(section["insert_final_newline"]);
-	if (typeof insertFinalNewline === "boolean") options.insertFinalNewline = insertFinalNewline;
+	if (isBoolean(insertFinalNewline)) options.insertFinalNewline = insertFinalNewline;
 	return options;
 }
+/**
+* Rebases an EditorConfig section pattern from the config directory to the target anchor directory.
+*
+* @param pattern - The original EditorConfig section pattern.
+* @param editorconfigDir - The directory containing the .editorconfig file.
+* @param anchorDir - The directory used as the override pattern base.
+* @returns The rebased glob pattern.
+*/
 function rebaseEditorconfigPattern(pattern, editorconfigDir, anchorDir) {
 	const relativePrefix = toPosixPath(relative(anchorDir, editorconfigDir));
 	if (!relativePrefix || relativePrefix === ".") return pattern;
 	return `${relativePrefix}/${pattern.replace(/^\//, "")}`;
 }
+/**
+* Reads a .editorconfig file and converts it into root options and override entries.
+*
+* @param editorconfigPath - The absolute path to the .editorconfig file.
+* @param anchorDir - The directory used to rebase section patterns.
+* @returns Parsed EditorConfig data ready to merge into oxfmt config.
+*/
 async function readEditorconfigFromFile(editorconfigPath, anchorDir) {
 	const parsedSections = parseBuffer(await readFile(editorconfigPath));
 	const editorconfigDir = dirname(editorconfigPath);
@@ -223,8 +320,8 @@ async function loadOxfmtConfig(options = {}) {
 	const cwd = options.cwd || process.cwd();
 	const editorconfig = options.editorconfig ?? true;
 	const useEditorconfig = editorconfig !== false;
-	const onlyCwd = useEditorconfig && typeof editorconfig === "object" ? editorconfig.onlyCwd ?? false : false;
-	const editorconfigCwd = useEditorconfig && typeof editorconfig === "object" ? editorconfig.cwd : void 0;
+	const onlyCwd = useEditorconfig && isObject(editorconfig) ? editorconfig.onlyCwd ?? false : false;
+	const editorconfigCwd = useEditorconfig && isObject(editorconfig) ? editorconfig.cwd : void 0;
 	const resolveKey = getResolveCacheKey(cwd, options.configPath);
 	const editorconfigSearchDir = editorconfigCwd || getEditorconfigSearchDir(cwd, options.configPath);
 	const editorconfigResolveKey = editorconfigCwd ? getEditorconfigResolveCacheKey(`${editorconfigCwd}::${options.configPath || ""}`) : getEditorconfigResolveCacheKey(resolveKey);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "load-oxfmt-config",
-  "version": "0.3.1",
+  "version": "0.4.0",
   "description": "Load oxfmt config files and merge supported .editorconfig options.",
   "keywords": [
     "editorconfig",
@@ -39,23 +39,23 @@
     "access": "public"
   },
   "dependencies": {
-    "@ntnyq/utils": "^0.11.2",
+    "@ntnyq/utils": "^0.12.0",
     "editorconfig": "^3.0.2",
     "jiti": "^2.6.1",
     "jsonc-parser": "^3.3.1"
   },
   "devDependencies": {
     "@ntnyq/tsconfig": "^3.1.0",
-    "@types/node": "^25.5.0",
-    "@typescript/native-preview": "^7.0.0-dev.20260328.1",
+    "@types/node": "^25.6.0",
+    "@typescript/native-preview": "^7.0.0-dev.20260413.1",
     "bumpp": "^11.0.1",
     "husky": "^9.1.7",
-    "nano-staged": "^0.9.0",
+    "nano-staged": "^1.0.2",
     "npm-run-all2": "^8.0.4",
-    "oxfmt": "^0.42.0",
-    "oxlint": "^1.57.0",
-    "tsdown": "^0.21.7",
-    "vitest": "^4.1.2"
+    "oxfmt": "^0.45.0",
+    "oxlint": "^1.60.0",
+    "tsdown": "^0.21.8",
+    "vitest": "^4.1.4"
   },
   "peerDependencies": {
     "oxfmt": ">=0.41.0"