yamllint-js 0.2.0 → 0.2.2

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # Changelog
 
+## [0.2.2](https://github.com/kimzuni-labs/yamllint-js/compare/v0.2.1...v0.2.2) (2026-02-19)
+
+
+### 🐛 Bug Fixes
+
+* detection yamllint field in package.json ([#37](https://github.com/kimzuni-labs/yamllint-js/issues/37)) ([5fe02d7](https://github.com/kimzuni-labs/yamllint-js/commit/5fe02d73c299bba7a53edb90a56aa16fad4fc845))
+
+## [0.2.1](https://github.com/kimzuni-labs/yamllint-js/compare/v0.2.0...v0.2.1) (2026-02-14)
+
+
+### ✨ Features
+
+* export detectUserGlobalConfig function ([#33](https://github.com/kimzuni-labs/yamllint-js/issues/33)) ([7dd1643](https://github.com/kimzuni-labs/yamllint-js/commit/7dd1643a09cb5c131d13decca0945beebd219b9d))
+* export loadYamlLintConfig function ([#35](https://github.com/kimzuni-labs/yamllint-js/issues/35)) ([e0b0738](https://github.com/kimzuni-labs/yamllint-js/commit/e0b073858adb2a2b43af297584cd709628bbd7f9))
+
 ## [0.2.0](https://github.com/kimzuni-labs/yamllint-js/compare/v0.1.0...v0.2.0) (2026-02-14)
 
 

package/README.md

@@ -130,14 +130,15 @@ In addition to the yamllint configuration format,
 JavaScript and TypeScript configuration files are also supported:
 
 - [yamllint configuration files and environment variables](https://yamllint.readthedocs.io/en/stable/configuration.html):
-- [Cosmiconfig default search places](https://github.com/cosmiconfig/cosmiconfig/blob/a5a842547c13392ebb89a485b9e56d9f37e3cbd3/src/defaults.ts#L12-L32):
-  + `package.json` (`"yamllint-js"` field),  `yamllint-js.config.ts`, etc. (Not support `rc` files)
-  + `package.json` (`"yamllint"` field),  `.yamllintrc.json`,  `yamllint.config.ts`, etc.
+- `package.json` or js/ts config files
+  + `package.json` (`"yamllint-js"`, `"yamllint"` fields)
+  + `yamllint-js.config.js`, `.ts`, `.cjs`, `.mjs`
+  + `yamllint.config.js`, `.ts`, `.cjs`, `.mjs`
 
 Configuration can be easily defined with type hints, like:
 
 ```typescript
-/** @type {import("yamllint-js").UserConfig")} */
+/** @type {import("yamllint-js").UserConfig} */
 
 const config = {/* ... */};
 
@@ -220,3 +221,4 @@ rules:
 ## License
 
 [GPL version 3](./LICENSE)
+(port of [yamllint](https://github.com/adrienverge/yamllint))

package/dist/cli.mjs

@@ -1,7 +1,6 @@
 import { APP, LEVELS, PROBLEM_LEVELS } from "./constants.mjs";
-import { getHomedir } from "./utils.mjs";
 import { run as run$1 } from "./linter.mjs";
-import { YamlLintConfig, loadConfigFile } from "./config.mjs";
+import { YamlLintConfig, loadYamlLintConfig } from "./config.mjs";
 import fs from "node:fs/promises";
 import path from "node:path";
 import os from "node:os";
@@ -168,10 +167,6 @@ async function run(argv = hideBin(process.argv), stdin = process.stdin) {
 		process.exitCode = -1;
 		return;
 	}
-	let userGlobalConfig;
-	if (process.env.YAMLLINT_CONFIG_FILE !== void 0) userGlobalConfig = process.env.YAMLLINT_CONFIG_FILE;
-	else if (process.env.XDG_CONFIG_HOME !== void 0) userGlobalConfig = path.join(process.env.XDG_CONFIG_HOME, "yamllint", "config");
-	else userGlobalConfig = path.join(getHomedir(), ".config", "yamllint", "config");
 	function getValue(value, type = "string") {
 		if (type === "boolean") return !!value;
 		const values = Array.isArray(value) ? value : [value];
@@ -187,12 +182,7 @@ async function run(argv = hideBin(process.argv), stdin = process.stdin) {
 			if (configData !== "" && !configData.includes(":")) configData = `extends: ${configData}`;
 			conf = await YamlLintConfig.init({ content: configData });
 		} else if (configFile !== void 0) conf = await YamlLintConfig.init({ file: configFile });
-		else {
-			const load = await loadConfigFile();
-			if (load !== null) conf = await YamlLintConfig.init({ _data: load.config });
-			else if (await fs.stat(userGlobalConfig).then((x) => x.isFile()).catch(() => false)) conf = await YamlLintConfig.init({ file: userGlobalConfig });
-			else conf = await YamlLintConfig.init({ content: "extends: default" });
-		}
+		else conf = await loadYamlLintConfig();
 	} catch (e) {
 		console.error(String(e));
 		process.exitCode = -1;

package/dist/config.d.mts

@@ -2,7 +2,6 @@ import { Level } from "./constants.mjs";
 import { Rule, RuleConf } from "./rules/types.mjs";
 import { RuleId } from "./rules/index.mjs";
 import { AllLevel, BuiltInExtendName, MaybeCamelCaseKeys, Prettify, ToCamelCaseKeys } from "./types.mjs";
-import * as cosmiconfig0 from "cosmiconfig";
 import { Ignore } from "ignore";
 
 //#region src/config.d.ts
@@ -70,6 +69,10 @@ declare class YamlLintConfig {
   enabledRules(filepath?: string): Rule[];
   extend(baseConfig: unknown): void;
 }
+interface LoadConfigFileOptions {
+  startDir?: string;
+  stopDir?: string;
+}
 /**
  * Load YAML lint configuration from a file.
  *
@@ -80,7 +83,21 @@ declare class YamlLintConfig {
  * const specified = await loadConfigFile("path/to/yamllint.yaml");
  * ```
  */
-declare const loadConfigFile: (filepath?: string) => Promise<cosmiconfig0.CosmiconfigResult>;
+declare const loadConfigFile: (filepath?: string | LoadConfigFileOptions) => Promise<unknown>;
+/**
+ * Detect user global config file path.
+ *
+ * @example
+ *
+ * ```typescript
+ * await detectUserGlobalConfig(); // "/home/user/.config/yamllint/config"
+ * ```
+ */
+declare function detectUserGlobalConfig(): Promise<string | undefined>;
+/**
+ * Load and return a fully resolved YamlLint configuration instance.
+ */
+declare function loadYamlLintConfig(): Promise<YamlLintConfig>;
 /**
  * if value is {@link AllLevel} or undefined
  * then convert to {@link Level} (undefined -> "error"),
@@ -103,4 +120,4 @@ declare const loadConfigFile: (filepath?: string) => Promise<cosmiconfig0.Cosmic
  */
 declare function validateLevel(value: unknown): Level | undefined;
 //#endregion
-export { CamelCaseConfigData, KebabCaseConfigData, MaybeCamelCaseConfigData, YamlLintConfig, YamlLintConfigError, YamlLintConfigProps, loadConfigFile, validateLevel };
+export { CamelCaseConfigData, KebabCaseConfigData, MaybeCamelCaseConfigData, YamlLintConfig, YamlLintConfigError, YamlLintConfigProps, detectUserGlobalConfig, loadConfigFile, loadYamlLintConfig, validateLevel };

package/dist/config.mjs

@@ -1,14 +1,14 @@
-import { ALIASES, APP, CONFIG_SEARCH_PLACES, LEVELS, YAML_OPTIONS } from "./constants.mjs";
-import { formatErrorMessage, getHomedir, splitlines, toKebabCaseKeys } from "./utils.mjs";
+import { ALIASES, COMMAND_NAMES, LEVELS, PY_YAMLLINT_CONFIG_FILES, YAML_OPTIONS } from "./constants.mjs";
+import { formatErrorMessage, getHomedir, getNodeSearchPlaces, splitlines, toKebabCaseKeys } from "./utils.mjs";
 import { autoDecode, linesInFiles } from "./decoder.mjs";
 import { get } from "./rules/index.mjs";
 import fs from "node:fs/promises";
 import path from "node:path";
-import { cosmiconfig, defaultLoaders } from "cosmiconfig";
 import assert from "node:assert";
 import yaml from "yaml";
 import z from "zod";
 import ignore$1 from "ignore";
+import { createJiti } from "jiti";
 /*!
 * Copyright (C) 2016 Adrien Vergé
 * Copyright (C) 2025 kimzuni
@@ -79,7 +79,7 @@ var YamlLintConfig = class YamlLintConfig {
 		if (props._data !== void 0 || props.data !== void 0) this.#data = props._data ?? props.data;
 		else try {
 			if (props.content !== void 0) this.#data = yaml.parse(props.content, YAML_OPTIONS);
-			else this.#data = await loadConfigFile(props.file).then((x) => x?.config);
+			else this.#data = await loadConfigFile(props.file);
 		} catch (e) {
 			throw new YamlLintConfigError(formatErrorMessage("invalid config: ", e));
 		}
@@ -165,26 +165,72 @@ async function validateRuleConf(rule, config) {
 	return conf;
 }
 const loadConfigFile = (() => {
-	const loadYAML = async function loadYAML(filepath) {
-		const content = autoDecode(await fs.readFile(filepath));
-		return yaml.parse(content, YAML_OPTIONS);
-	};
-	const explorer = cosmiconfig(APP.NAME, {
-		cache: false,
-		stopDir: getHomedir(),
-		searchPlaces: CONFIG_SEARCH_PLACES,
-		loaders: {
-			...defaultLoaders,
-			".json": loadYAML,
-			".yaml": loadYAML,
-			".yml": loadYAML,
-			noExt: loadYAML
+	const jsReg = /\.[cm]?js$/;
+	const homeDir = getHomedir();
+	const filenames = [
+		"package.json",
+		...getNodeSearchPlaces(COMMAND_NAMES),
+		...PY_YAMLLINT_CONFIG_FILES
+	];
+	const loadFile = async (filepath, throwOnFailure = false) => {
+		try {
+			filepath = path.resolve(filepath);
+			const filename = path.basename(filepath);
+			if (jsReg.test(filepath) || filepath.endsWith(".ts")) {
+				const jiti = createJiti(import.meta.url);
+				if (await fs.stat(filepath).then((x) => x.size).catch(() => 0) < 1) throw new Error();
+				const mod = await jiti.import(filepath, { default: true });
+				const value = mod.default ?? mod;
+				if (typeof value === "object" && value !== null) return value;
+			} else if (filename === "package.json") {
+				const content = autoDecode(await fs.readFile(filepath));
+				const pkg = JSON.parse(content);
+				if (typeof pkg !== "object" || pkg === null) return;
+				for (const name of COMMAND_NAMES) {
+					const value = pkg[name];
+					if (value) return value;
+				}
+			} else {
+				const content = autoDecode(await fs.readFile(filepath));
+				return yaml.parse(content, YAML_OPTIONS);
+			}
+		} catch {
+			if (throwOnFailure) throw new YamlLintConfigError(`failed to load config file "${filepath}"`);
+			return;
 		}
-	});
-	return function loadConfigFile(filepath) {
-		return filepath === void 0 ? explorer.search() : explorer.load(filepath);
+	};
+	return async function loadConfigFile(filepath) {
+		if (typeof filepath === "string") return loadFile(filepath, true);
+		const { startDir = process.cwd(), stopDir } = filepath ?? {};
+		let currDir = path.resolve(startDir);
+		do {
+			for (const filename of filenames) {
+				const curr = path.join(currDir, filename);
+				if (await fs.stat(curr).then((x) => x.isFile() || x.isSymbolicLink()).catch(() => false)) {
+					const content = await loadFile(curr);
+					if (content) return content;
+				}
+			}
+			currDir = path.dirname(currDir);
+		} while (currDir !== stopDir && currDir !== homeDir && currDir !== path.dirname(currDir));
 	};
 })();
+async function detectUserGlobalConfig() {
+	let userGlobalConfig;
+	if (process.env.YAMLLINT_CONFIG_FILE !== void 0) userGlobalConfig = process.env.YAMLLINT_CONFIG_FILE;
+	else if (process.env.XDG_CONFIG_HOME !== void 0) userGlobalConfig = path.join(process.env.XDG_CONFIG_HOME, "yamllint", "config");
+	else userGlobalConfig = path.join(getHomedir(), ".config", "yamllint", "config");
+	return await fs.stat(userGlobalConfig).then((x) => x.isFile()).catch(() => false) ? userGlobalConfig : void 0;
+}
+async function loadYamlLintConfig() {
+	let userGlobalConfig;
+	let load;
+	let conf;
+	if (load = await loadConfigFile()) conf = await YamlLintConfig.init({ _data: load });
+	else if (userGlobalConfig = await detectUserGlobalConfig()) conf = await YamlLintConfig.init({ file: userGlobalConfig });
+	else conf = await YamlLintConfig.init({ content: "extends: default" });
+	return conf;
+}
 async function getExtendedConfigFile(name) {
 	if (!name.includes("/")) {
 		const stdConf = path.join(import.meta.dirname, "conf", `${name}.yaml`);
@@ -225,4 +271,4 @@ function zodIssueDetect(issue) {
 	if (issue.code === "invalid_type") return ["should be ", issue.expected];
 	return ["unknown error"];
 }
-export { YamlLintConfig, YamlLintConfigError, loadConfigFile, validateLevel };
+export { YamlLintConfig, YamlLintConfigError, detectUserGlobalConfig, loadConfigFile, loadYamlLintConfig, validateLevel };

package/dist/constants.mjs

@@ -1,5 +1,5 @@
-import { description, name, version } from "./package.mjs";
-import { getDefaultSearchPlaces } from "cosmiconfig";
+import { bin, description, name, version } from "./package.mjs";
+const COMMAND_NAMES = Object.keys(bin);
 const APP = {
 	NAME: name,
 	VERSION: version,
@@ -10,17 +10,15 @@ const APP = {
 		"such as lines length, trailing spaces, indentation, etc."
 	].join(" ")
 };
-const YAML_OPTIONS = {
-	version: "1.1",
-	uniqueKeys: false
-};
-const CONFIG_SEARCH_PLACES = [
-	...getDefaultSearchPlaces(APP.NAME).filter((x) => !x.includes(`${APP.NAME}rc`)),
-	...getDefaultSearchPlaces("yamllint").filter((x) => !x.includes("yamllintrc")),
+const PY_YAMLLINT_CONFIG_FILES = [
 	".yamllint",
 	".yamllint.yaml",
 	".yamllint.yml"
 ];
+const YAML_OPTIONS = {
+	version: "1.1",
+	uniqueKeys: false
+};
 const LEVELS = [
 	null,
 	"warning",
@@ -40,4 +38,4 @@ const PROBLEM_LEVELS = {
 };
 const PY_EOL = /\r\n|\r|\n|\v|\f|\x1c|\x1d|\x1e|\x85|\u2028|\u2029/;
 const PY_EOL_END = new RegExp(`(${PY_EOL.source})$`);
-export { ALIASES, APP, CONFIG_SEARCH_PLACES, LEVELS, PROBLEM_LEVELS, PY_EOL, PY_EOL_END, YAML_OPTIONS };
+export { ALIASES, APP, COMMAND_NAMES, LEVELS, PROBLEM_LEVELS, PY_EOL, PY_EOL_END, PY_YAMLLINT_CONFIG_FILES, YAML_OPTIONS };

package/dist/internal.d.mts

@@ -1,6 +1,6 @@
 import { ALIASES, Alias, LEVELS, Level } from "./constants.mjs";
 import { LintProblem, run } from "./linter.mjs";
 import { RuleId } from "./rules/index.mjs";
-import { CamelCaseConfigData, KebabCaseConfigData, MaybeCamelCaseConfigData, YamlLintConfig, YamlLintConfigError, YamlLintConfigProps, loadConfigFile, validateLevel } from "./config.mjs";
+import { CamelCaseConfigData, KebabCaseConfigData, MaybeCamelCaseConfigData, YamlLintConfig, YamlLintConfigError, YamlLintConfigProps, detectUserGlobalConfig, loadConfigFile, loadYamlLintConfig, validateLevel } from "./config.mjs";
 import { AllLevel, BuiltInExtendName, Prettify } from "./types.mjs";
-export { ALIASES, type Alias, type AllLevel, type BuiltInExtendName, type CamelCaseConfigData, type KebabCaseConfigData, LEVELS, type Level, LintProblem, type MaybeCamelCaseConfigData, type Prettify, type RuleId, YamlLintConfig, YamlLintConfigError, type YamlLintConfigProps, run as linter, loadConfigFile, validateLevel };
+export { ALIASES, type Alias, type AllLevel, type BuiltInExtendName, type CamelCaseConfigData, type KebabCaseConfigData, LEVELS, type Level, LintProblem, type MaybeCamelCaseConfigData, type Prettify, type RuleId, YamlLintConfig, YamlLintConfigError, type YamlLintConfigProps, detectUserGlobalConfig, run as linter, loadConfigFile, loadYamlLintConfig, validateLevel };

package/dist/internal.mjs

@@ -1,4 +1,4 @@
 import { ALIASES, LEVELS } from "./constants.mjs";
 import { LintProblem, run } from "./linter.mjs";
-import { YamlLintConfig, YamlLintConfigError, loadConfigFile, validateLevel } from "./config.mjs";
-export { ALIASES, LEVELS, LintProblem, YamlLintConfig, YamlLintConfigError, run as linter, loadConfigFile, validateLevel };
+import { YamlLintConfig, YamlLintConfigError, detectUserGlobalConfig, loadConfigFile, loadYamlLintConfig, validateLevel } from "./config.mjs";
+export { ALIASES, LEVELS, LintProblem, YamlLintConfig, YamlLintConfigError, detectUserGlobalConfig, run as linter, loadConfigFile, loadYamlLintConfig, validateLevel };

package/dist/package.mjs

@@ -1,4 +1,8 @@
 var name = "yamllint-js";
 var description = "A linter for YAML files — an unofficial native Node.js port of Python yamllint.";
-var version = "0.2.0";
-export { description, name, version };
+var version = "0.2.2";
+var bin = {
+	"yamllint-js": "dist/main.mjs",
+	"yamllint": "dist/main.mjs"
+};
+export { bin, description, name, version };

package/dist/utils.mjs

@@ -49,4 +49,14 @@ const toKebabCaseKeys = (data) => {
 	for (const key in data) newData[toKebabCase(key)] = data[key];
 	return newData;
 };
-export { B, bufferStartsWith, formatErrorMessage, getHomedir, once, splitlines, toKebabCaseKeys };
+const getNodeSearchPlaces = (name, set = /* @__PURE__ */ new Set()) => {
+	const names = Array.isArray(name) ? name : [name];
+	for (const n of names) {
+		set.add(`${n}.config.js`);
+		set.add(`${n}.config.ts`);
+		set.add(`${n}.config.cjs`);
+		set.add(`${n}.config.mjs`);
+	}
+	return set;
+};
+export { B, bufferStartsWith, formatErrorMessage, getHomedir, getNodeSearchPlaces, once, splitlines, toKebabCaseKeys };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "yamllint-js",
   "description": "A linter for YAML files — an unofficial native Node.js port of Python yamllint.",
-  "version": "0.2.0",
+  "version": "0.2.2",
   "license": "GPL-3.0-or-later",
   "type": "module",
   "author": {
@@ -23,8 +23,10 @@
     "lint:eslint": "eslint .",
     "lint:types": "tsc --noEmit",
     "lint:markdown": "markdownlint-cli2",
-    "lint:yaml": "node dist/main.mjs -c yamllint.self.config.js . 2> /dev/null || tsx src/main.ts -c yamllint.self.config.js .",
-    "build": "tsdown"
+    "lint:yaml": "node dist/main.mjs -c yamllint.self.config.js .",
+    "prelint:yaml": "npm run build:nodts",
+    "build": "tsdown",
+    "build:nodts": "tsdown --no-dts"
   },
   "files": [
     "dist",
@@ -51,9 +53,9 @@
     "./internal": "./dist/internal.mjs"
   },
   "dependencies": {
-    "cosmiconfig": "^9.0.0",
     "iconv-lite": "^0.7.2",
     "ignore": "^7.0.5",
+    "jiti": "^2.6.1",
     "recheck": "^4.5.0",
     "yaml": "^2.8.2",
     "yargs": "^18.0.0",
@@ -67,11 +69,9 @@
     "@vitest/coverage-v8": "^4.0.18",
     "@vitest/ui": "^4.0.18",
     "eslint": "^9.39.2",
-    "jiti": "^2.6.1",
     "markdownlint-cli2": "^0.20.0",
     "standard-version": "^9.5.0",
     "tsdown": "^0.20.1",
-    "tsx": "^4.21.0",
     "typescript": "^5.9.3",
     "typescript-eslint": "^8.54.0",
     "vitest": "^4.0.18"