yamllint-js 0.2.1 → 0.2.3

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## [0.2.3](https://github.com/kimzuni-labs/yamllint-js/compare/v0.2.2...v0.2.3) (2026-02-19)
+
+
+### ✨ Features
+
+* support options on loadYamlLintConfig ([9f67bea](https://github.com/kimzuni-labs/yamllint-js/commit/9f67beab94698b64c1b09c332a246d4099ff0cbc))
+
+
+### 🐛 Bug Fixes
+
+* stopDir option on loadConfigFile ([9f67bea](https://github.com/kimzuni-labs/yamllint-js/commit/9f67beab94698b64c1b09c332a246d4099ff0cbc))
+* throw on failure in loadConfigFile ([9f67bea](https://github.com/kimzuni-labs/yamllint-js/commit/9f67beab94698b64c1b09c332a246d4099ff0cbc))
+
+## [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)
 
 

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/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,18 @@ declare class YamlLintConfig {
   enabledRules(filepath?: string): Rule[];
   extend(baseConfig: unknown): void;
 }
+interface LoadConfigFileOptions {
+  /**
+   * @default process.cwd()
+   */
+  startDir?: string;
+  /**
+   * @default getHomedir()
+   *
+   * @see {@link getHomedir}
+   */
+  stopDir?: string;
+}
 /**
  * Load YAML lint configuration from a file.
  *
@@ -78,9 +89,10 @@ declare class YamlLintConfig {
  * ```typescript
  * const autoDetected = await loadConfigFile();
  * const specified = await loadConfigFile("path/to/yamllint.yaml");
+ * const withOptions = await loadConfigFile({ startDir, stopDir });
  * ```
  */
-declare const loadConfigFile: (filepath?: string) => Promise<cosmiconfig0.CosmiconfigResult>;
+declare const loadConfigFile: (filepath?: string | LoadConfigFileOptions) => Promise<unknown>;
 /**
  * Detect user global config file path.
  *
@@ -93,8 +105,12 @@ declare const loadConfigFile: (filepath?: string) => Promise<cosmiconfig0.Cosmic
 declare function detectUserGlobalConfig(): Promise<string | undefined>;
 /**
  * Load and return a fully resolved YamlLint configuration instance.
+ *
+ * - First, try to load config file from the current directory to user home directory.
+ * - If not found, try to load from the user global config file.
+ * - If not found, try to load from the default config.
  */
-declare function loadYamlLintConfig(): Promise<YamlLintConfig>;
+declare function loadYamlLintConfig(options?: LoadConfigFileOptions): Promise<YamlLintConfig>;
 /**
  * if value is {@link AllLevel} or undefined
  * then convert to {@link Level} (undefined -> "error"),

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,24 +165,55 @@ 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 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) > 0) {
+					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);
+			}
+			throw new Error();
+		} catch {
+			if (throwOnFailure) throw new YamlLintConfigError(`failed to load config file "${filepath}"`);
 		}
-	});
-	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 = filepath?.startDir ?? process.cwd();
+		const stopDir = filepath?.stopDir === void 0 ? getHomedir() : path.resolve(filepath.stopDir);
+		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 !== path.dirname(currDir));
 	};
 })();
 async function detectUserGlobalConfig() {
@@ -192,11 +223,11 @@ async function detectUserGlobalConfig() {
 	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() {
+async function loadYamlLintConfig(options) {
 	let userGlobalConfig;
 	let load;
 	let conf;
-	if (load = await loadConfigFile()) conf = await YamlLintConfig.init({ _data: load.config });
+	if (load = await loadConfigFile(options)) 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;

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/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.1";
-export { description, name, version };
+var version = "0.2.3";
+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.1",
+  "version": "0.2.3",
   "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"