load-oxfmt-config 0.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025-PRESENT ntnyq <https://github.com/ntnyq>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,44 @@
+# load-oxfmt-config
+
+[![CI](https://github.com/ntnyq/load-oxfmt-config/workflows/CI/badge.svg)](https://github.com/ntnyq/load-oxfmt-config/actions)
+[![NPM VERSION](https://img.shields.io/npm/v/load-oxfmt-config.svg)](https://www.npmjs.com/package/load-oxfmt-config)
+[![NPM DOWNLOADS](https://img.shields.io/npm/dy/load-oxfmt-config.svg)](https://www.npmjs.com/package/load-oxfmt-config)
+[![LICENSE](https://img.shields.io/github/license/ntnyq/load-oxfmt-config.svg)](https://github.com/ntnyq/load-oxfmt-config/blob/main/LICENSE)
+
+Load .oxfmtrc.json(c) for oxfmt.
+
+## Install
+
+```shell
+npm install load-oxfmt-config
+```
+
+```shell
+yarn add load-oxfmt-config
+```
+
+```shell
+pnpm add load-oxfmt-config
+```
+
+## Usage
+
+```ts
+import { loadOxfmtConfig } from 'load-oxfmt-config'
+
+const config = loadOxfmtConfig({
+  cwd: '/configs',
+})
+
+console.log({ config })
+```
+
+## Options
+
+- `configPath?: string` Path to the oxfmt config file, resolved relative to `cwd`.
+- `cwd?: string` Current working directory used when searching for config files. Defaults to `process.cwd()`.
+- `useCache?: boolean` Enable in-memory caching for path resolution and parsed config contents. Defaults to `true`.
+
+## License
+
+[MIT](./LICENSE) License © 2025-PRESENT [ntnyq](https://github.com/ntnyq)

package/dist/index.d.mts

@@ -0,0 +1,166 @@
+//#region src/types.d.ts
+interface Options {
+  /**
+   * Path to the configuration file
+   */
+  configPath?: string;
+  /**
+   * Current working directory
+   */
+  cwd?: string;
+  /**
+   * Whether to use cache
+   */
+  useCache?: boolean;
+}
+/**
+ * Oxfmt configuration interface
+ */
+interface OxfmtConfig {
+  /**
+   * Include parentheses around a sole arrow function parameter.
+   * @default `always`
+   */
+  arrowParens?: 'always' | 'avoid';
+  /**
+   * Put the `>` of a multi-line JSX element at the end of the last line\ninstead of being alone on the next line.
+   * @default false
+   */
+  bracketSameLine?: boolean;
+  /**
+   * Print spaces between brackets in object literals.
+   * @default true
+   */
+  bracketSpacing?: boolean;
+  /**
+   * Control whether to format embedded parts in the file.
+   * @default `off`
+   */
+  embeddedLanguageFormatting?: 'auto' | 'off';
+  /**
+   * Which end of line characters to apply.
+   * @default `lf`
+   */
+  endOfLine?: 'cr' | 'crlf' | 'lf';
+  /**
+   * Experimental: Sort `package.json` keys.
+   * @default true
+   */
+  experimentalSortPackageJson?: boolean;
+  /**
+   * Ignore files matching these glob patterns. Current working directory is used as the root.
+   */
+  ignorePatterns?: string[];
+  /**
+   * Whether to insert a final newline at the end of the file.
+   * @default true
+   */
+  insertFinalNewline?: boolean;
+  /**
+   * Use single quotes instead of double quotes in JSX.
+   * @default false
+   */
+  jsxSingleQuote?: boolean;
+  /**
+   * How to wrap object literals when they could fit on one line or span multiple lines.
+   * @default `preserve`
+   * NOTE: In addition to Prettier's `preserve` and `collapse`, we also support `always`
+   */
+  objectWrap?: 'always' | 'never' | 'preserve';
+  /**
+   * The line length that the printer will wrap on.
+   * @default 100
+   */
+  printWidth?: number;
+  /**
+   * Change when properties in objects are quoted.
+   * @default `as-needed`
+   */
+  quoteProps?: 'as-needed' | 'consistent' | 'preserve';
+  /**
+   * Print semicolons at the ends of statements.
+   * @default true
+   */
+  semi?: boolean;
+  /**
+   * Put each attribute on a new line in JSX.
+   * @default false
+   */
+  singleAttributePerLine?: boolean;
+  /**
+   * Use single quotes instead of double quotes.
+   * @default false
+   */
+  singleQuote?: boolean;
+  /**
+   * Number of spaces per indentation level.
+   * @default 2
+   */
+  tabWidth?: number;
+  /**
+   * Print trailing commas wherever possible.
+   * @default `all`
+   */
+  trailingComma?: 'all' | 'es5' | 'none';
+  /**
+   * Use tabs for indentation or spaces.
+   * @default false
+   */
+  useTabs?: boolean;
+  /**
+   * Experimental: Sort import statements. Disabled by default.
+   */
+  experimentalSortImports?: {
+    /**
+     * Custom groups configuration for organizing imports.\nEach array element represents a group, and multiple group names in the same array are treated as one.\nAccepts both `string` and `string[]` as group elements.
+     */
+    groups?: Array<string | string[]>;
+    /**
+     * Ignore case when sorting.
+     * @default true
+     */
+    ignoreCase?: boolean;
+    /**
+     * Glob patterns to identify internal imports.
+     */
+    internalPattern?: string[];
+    /**
+     * Add newlines between import groups.
+     * @default true
+     */
+    newlinesBetween?: boolean;
+    /**
+     * Sort order. (Default: `asc`)
+     * @default `asc`
+     */
+    order?: 'asc' | 'desc';
+    /**
+     * Partition imports by comments.
+     * @default false
+     */
+    partitionByComment?: boolean;
+    /**
+     * Partition imports by newlines.
+     * @default false
+     */
+    partitionByNewline?: boolean;
+    /**
+     * Sort side-effect imports.
+     * @default false
+     */
+    sortSideEffects?: boolean;
+  };
+}
+//#endregion
+//#region src/core.d.ts
+/**
+ * Load oxfmt configuration by resolving the config file path and parsing its contents.
+ * Uses in-memory caches by default; set `useCache` to false to force re-read.
+ */
+declare function loadOxfmtConfig(options?: Options): Promise<OxfmtConfig>;
+/**
+ * Resolve the oxfmt config file path, searching upward from the provided cwd when no explicit path is given.
+ */
+declare function resolveOxfmtrcPath(cwd: string, configPath?: string): Promise<string | undefined>;
+//#endregion
+export { Options, OxfmtConfig, loadOxfmtConfig, resolveOxfmtrcPath };

package/dist/index.mjs

@@ -0,0 +1,78 @@
+import { readFile } from "node:fs/promises";
+import { join } from "node:path";
+import process from "node:process";
+import { parse } from "jsonc-parser";
+
+//#region src/constants.ts
+/**
+* Supported configuration files for oxfmt.
+* @see https://oxc.rs/docs/guide/usage/formatter/config.html#oxfmtrc-json-c
+*/
+const OXFMT_CONFIG_FILES = [".oxfmtrc.json", ".oxfmtrc.jsonc"];
+
+//#endregion
+//#region src/core.ts
+const resolveCache = /* @__PURE__ */ new Map();
+const configCache = /* @__PURE__ */ new Map();
+/**
+* Load oxfmt configuration by resolving the config file path and parsing its contents.
+* Uses in-memory caches by default; set `useCache` to false to force re-read.
+*/
+async function loadOxfmtConfig(options = {}) {
+	const useCache = options.useCache !== false;
+	const cwd = options.cwd || process.cwd();
+	const resolveKey = getResolveCacheKey(cwd, options.configPath);
+	const resolvedPath = useCache ? await cachePromise(resolveCache, resolveKey, () => resolveOxfmtrcPath(cwd, options.configPath)) : await resolveOxfmtrcPath(cwd, options.configPath);
+	if (!resolvedPath) {
+		if (!useCache) return {};
+		return cachePromise(configCache, getConfigCacheKey(resolvedPath, resolveKey), () => Promise.resolve({}));
+	}
+	const loadTask = () => readConfigFromFile(resolvedPath).catch((err) => {
+		throw new Error(`Failed to parse oxfmt configuration file at ${resolvedPath}: ${err instanceof Error ? err.message : String(err)}`, { cause: err });
+	});
+	if (!useCache) return loadTask();
+	return cachePromise(configCache, getConfigCacheKey(resolvedPath, resolveKey), loadTask);
+}
+/**
+* Resolve the oxfmt config file path, searching upward from the provided cwd when no explicit path is given.
+*/
+async function resolveOxfmtrcPath(cwd, configPath) {
+	if (configPath) return join(cwd, configPath);
+	let currentDir = cwd;
+	while (true) {
+		for (const filename of OXFMT_CONFIG_FILES) {
+			const configFilePath = join(currentDir, filename);
+			try {
+				const { stat } = await import("node:fs/promises");
+				if ((await stat(configFilePath)).isFile()) return configFilePath;
+			} catch {}
+		}
+		const parentDir = join(currentDir, "..");
+		if (parentDir === currentDir) break;
+		currentDir = parentDir;
+	}
+}
+function cachePromise(cache, key, factory) {
+	const cached = cache.get(key);
+	if (cached) return cached;
+	const task = factory().catch((err) => {
+		cache.delete(key);
+		throw err;
+	});
+	cache.set(key, task);
+	return task;
+}
+function getConfigCacheKey(resolvedPath, resolveKey) {
+	return resolvedPath || `missing:${resolveKey}`;
+}
+function getResolveCacheKey(cwd, configPath) {
+	return `${cwd}::${configPath || ""}`;
+}
+async function readConfigFromFile(resolvedPath) {
+	const content = await readFile(resolvedPath, "utf-8");
+	if (resolvedPath.endsWith(".jsonc")) return parse(content);
+	return JSON.parse(content);
+}
+
+//#endregion
+export { loadOxfmtConfig, resolveOxfmtrcPath };

package/package.json

@@ -0,0 +1,75 @@
+{
+  "name": "load-oxfmt-config",
+  "type": "module",
+  "version": "0.0.0",
+  "packageManager": "pnpm@10.26.1",
+  "description": "Load .oxfmtrc.json(c) for oxfmt.",
+  "keywords": [
+    "jsonc-parser",
+    "load-config",
+    "load-oxfmt-config",
+    "load-oxfmtrc",
+    "oxfmt",
+    "oxfmtrc"
+  ],
+  "license": "MIT",
+  "author": {
+    "name": "ntnyq",
+    "email": "ntnyq13@gmail.com"
+  },
+  "homepage": "https://github.com/ntnyq/load-oxfmt-config#readme",
+  "repository": "ntnyq/load-oxfmt-config",
+  "bugs": {
+    "url": "https://github.com/ntnyq/load-oxfmt-config/issues"
+  },
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "sideEffects": false,
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "lint": "eslint",
+    "prepare": "husky",
+    "prepublishOnly": "pnpm run build",
+    "release": "run-s release:check release:version",
+    "release:check": "run-s lint typecheck test",
+    "release:version": "bumpp",
+    "test": "vitest",
+    "typecheck": "tsc --noEmit"
+  },
+  "dependencies": {
+    "jsonc-parser": "^3.3.1"
+  },
+  "devDependencies": {
+    "@ntnyq/eslint-config": "^5.8.0",
+    "@ntnyq/prettier-config": "^3.0.1",
+    "@ntnyq/tsconfig": "^3.0.0",
+    "@types/node": "^25.0.3",
+    "bumpp": "^10.3.2",
+    "eslint": "^9.39.2",
+    "husky": "^9.1.7",
+    "nano-staged": "^0.9.0",
+    "npm-run-all2": "^8.0.4",
+    "prettier": "^3.7.4",
+    "tsdown": "^0.18.2",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.16"
+  },
+  "nano-staged": {
+    "*.{js,ts,mjs,cjs,md,vue,yml,yaml,toml,json}": "eslint --fix",
+    "*.{css,scss,html}": "prettier -uw"
+  }
+}