@kcconfigs/textlint 0.1.0-beta.0 → 0.1.0

package/dist/preset-DI2qdO9E.d.ts

@@ -0,0 +1,37 @@
+// @generated by tsdown, DO NOT edit it manually
+//#region src/models/base.d.ts
+type Severity = "error" | "warning" | "info";
+type WithEnabled<T> = T | boolean;
+type ObjectType = "preset" | "rule" | "filter" | "plugin";
+type AnyObject = Record<string, any>;
+type EmptyObject = Record<never, never>;
+interface BaseObject<T extends ObjectType, N extends string> {
+  type: T;
+  name: N;
+}
+type AnyBaseObject = BaseObject<ObjectType, string>;
+interface ExtendSeverity {
+  severity?: Severity;
+}
+type UserBase<RS extends AnyBaseObject[], T extends ObjectType, K extends keyof RS[number]> = { [R in RS[number] as R extends BaseObject<T, infer N> ? N : never]: K extends keyof R ? R[K] : R };
+//#endregion
+//#region src/models/rule.d.ts
+type RuleModule = any;
+interface Rule<N extends string, C extends AnyObject> extends BaseObject<"rule", N> {
+  module: RuleModule;
+  config: WithEnabled<C>;
+}
+type AnyRule = Rule<string, AnyObject>;
+type UserRule<RS extends AnyRule[], K extends keyof AnyRule> = UserBase<RS, "rule", K>;
+//#endregion
+//#region src/models/preset.d.ts
+interface Preset<N extends string, RS extends AnyRule[]> extends BaseObject<"preset", N> {
+  rules: UserRule<RS, "module">;
+  rulesConfig: UserRule<RS, "config">;
+}
+type AnyPreset = Preset<string, AnyRule[]>;
+type UserPreset<RS extends AnyPreset[]> = RS[number]["rulesConfig"];
+//#endregion
+export { Rule as a, AnyBaseObject as c, EmptyObject as d, ExtendSeverity as f, WithEnabled as g, UserBase as h, AnyRule as i, AnyObject as l, Severity as m, Preset as n, RuleModule as o, ObjectType as p, UserPreset as r, UserRule as s, AnyPreset as t, BaseObject as u };
+// Generated by @kcconfigs/tsdown
+//# sourceMappingURL=preset-DI2qdO9E.d.ts.map

package/dist/preset-DI2qdO9E.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"preset-DI2qdO9E.d.ts","names":[],"sources":["../src/models/base.ts","../src/models/rule.ts","../src/models/preset.ts"],"mappings":";;KAAY,QAAA;AAAA,KAEA,WAAA,MAAiB,CAAA;AAAA,KAEjB,UAAA;AAAA,KAGA,SAAA,GAAY,MAAA;AAAA,KACZ,WAAA,GAAc,MAAA;AAAA,UAET,UAAA,WAAqB,UAAA;EACrC,IAAA,EAAM,CAAA;EACN,IAAA,EAAM,CAAA;AAAA;AAAA,KAEK,aAAA,GAAgB,UAAA,CAAW,UAAA;AAAA,UAEtB,cAAA;EAChB,QAAA,GAAW,QAAA;AAAA;AAAA,KAGA,QAAA,YACA,aAAA,cACD,UAAA,kBACM,EAAA,oBAEV,EAAA,YAAc,CAAA,SAAU,UAAA,CAAW,CAAA,aACtC,CAAA,WACQ,CAAA,eAAgB,CAAA,GAAI,CAAA,CAAE,CAAA,IAAK,CAAA;;;KCxB3B,UAAA;AAAA,UAEK,IAAA,6BAAiC,SAAA,UACzC,UAAA,SAAmB,CAAA;EAC3B,MAAA,EAAQ,UAAA;EACR,MAAA,EAAQ,WAAA,CAAY,CAAA;AAAA;AAAA,KAGT,OAAA,GAAU,IAAA,SAAa,SAAA;AAAA,KAEvB,QAAA,YAAoB,OAAA,oBAA2B,OAAA,IAAW,QAAA,CACrE,EAAA,UAEA,CAAA;;;UCbgB,MAAA,8BAAoC,OAAA,YAC5C,UAAA,WAAqB,CAAA;EAC7B,KAAA,EAAO,QAAA,CAAS,EAAA;EAChB,WAAA,EAAa,QAAA,CAAS,EAAA;AAAA;AAAA,KAEX,SAAA,GAAY,MAAA,SAAe,OAAA;AAAA,KAE3B,UAAA,YAAsB,SAAA,MAAe,EAAA"}

package/dist/presets/default.cjs

@@ -1,10 +1,11 @@
 // @generated by tsdown, DO NOT edit it manually
-const require_defineConfig = require('../defineConfig-BSVyAEFt.cjs');
+const require_terminology = require('../terminology-BJO_eqym.cjs');
+const require_definePreset = require('../definePreset-B6sruUgg.cjs');
 
 //#region src/presets/default.ts
-const config = require_defineConfig.defineConfig(require_defineConfig.comments(true), require_defineConfig.allowlist(), require_defineConfig.terminology());
-module.exports = config;
+const config = require_definePreset.definePreset("@kcconfigs/textlint/preset-default", require_terminology.terminology());
 
 //#endregion
+module.exports = config;
 // Generated by @kcconfigs/tsdown
 //# sourceMappingURL=default.cjs.map

package/dist/presets/default.cjs.map

@@ -1 +1 @@
-{"version":3,"file":"default.cjs","names":["config: UserConfig","defineConfig","comments","allowlist","terminology"],"sources":["../../src/presets/default.ts"],"sourcesContent":["import type { UserConfig } from \"../models/config\";\nimport { allowlist, comments, terminology } from \"../rules\";\nimport { defineConfig } from \"../utils/defineConfig\";\n\nconst config: UserConfig = defineConfig(\n\tcomments(true),\n\tallowlist(),\n\tterminology(),\n);\n\nexport = config;\n"],"mappings":";;;;AAIA,MAAMA,SAAqBC,kCAC1BC,8BAAS,KAAK,EACdC,gCAAW,EACXC,kCAAa,CACb;iBAEQ"}
+{"version":3,"file":"default.cjs","names":["definePreset","terminology"],"sources":["../../src/presets/default.ts"],"sourcesContent":["import type { Preset } from \"../models\";\nimport { type TerminologyRule, terminology } from \"../rules/terminology\";\nimport { definePreset } from \"../utils/definePreset\";\n\nconst name = \"@kcconfigs/textlint/preset-default\";\n\ntype DefaultPreset = Preset<typeof name, [TerminologyRule]>;\n\nconst config: DefaultPreset = definePreset(name, terminology());\n\nexport default config;\n"],"mappings":";;;;;AAQA,MAAM,SAAwBA,kCAJjB,sCAIoCC,iCAAa,CAAC"}

package/dist/presets/default.d.cts

@@ -1,8 +1,11 @@
 // @generated by tsdown, DO NOT edit it manually
-import { t as UserConfig } from "../config-CjR_suQD.cjs";
+import { n as Preset } from "../preset-DCOiMLaG.cjs";
+import { n as TerminologyRule } from "../terminology-BQqu0v3E.cjs";
 
 //#region src/presets/default.d.ts
-declare const config: UserConfig;
+declare const name = "@kcconfigs/textlint/preset-default";
+type DefaultPreset = Preset<typeof name, [TerminologyRule]>;
+declare const config: DefaultPreset;
 export = config;
 // Generated by @kcconfigs/tsdown
 //# sourceMappingURL=default.d.cts.map

package/dist/presets/default.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"default.d.cts","names":["config: UserConfig"],"sources":["../../src/presets/default.ts"],"sourcesContent":[],"mappings":";;;;cAIMA,QAAQ"}
+{"version":3,"file":"default.d.cts","names":[],"sources":["../../src/presets/default.ts"],"mappings":";;;;;cAIM,IAAA;AAAA,KAED,aAAA,GAAgB,MAAA,QAAc,IAAA,GAAO,eAAA;AAAA,cAEpC,MAAA,EAAQ,aAAA;AAAA"}

package/dist/presets/default.d.ts

@@ -1,8 +1,11 @@
 // @generated by tsdown, DO NOT edit it manually
-import { t as UserConfig } from "../config-KDNTBTCT.js";
+import { n as Preset } from "../preset-DI2qdO9E.js";
+import { n as TerminologyRule } from "../terminology-CPBVBYUJ.js";
 
 //#region src/presets/default.d.ts
-declare const config: UserConfig;
+declare const name = "@kcconfigs/textlint/preset-default";
+type DefaultPreset = Preset<typeof name, [TerminologyRule]>;
+declare const config: DefaultPreset;
 //#endregion
 export { config as default };
 // Generated by @kcconfigs/tsdown

package/dist/presets/default.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"default.d.ts","names":["config: UserConfig"],"sources":["../../src/presets/default.ts"],"sourcesContent":[],"mappings":";;;;cAIMA,QAAQ"}
+{"version":3,"file":"default.d.ts","names":[],"sources":["../../src/presets/default.ts"],"mappings":";;;;;cAIM,IAAA;AAAA,KAED,aAAA,GAAgB,MAAA,QAAc,IAAA,GAAO,eAAA;AAAA,cAEpC,MAAA,EAAQ,aAAA"}

package/dist/presets/default.js

@@ -1,16 +1,11 @@
 // @generated by tsdown, DO NOT edit it manually
-import { a as comments, i as terminology, n as init_defineConfig, o as allowlist, r as init_rules, s as __commonJSMin, t as defineConfig } from "../defineConfig-Rcs53KN7.js";
+import { t as terminology } from "../terminology-CTuwYZjs.js";
+import { t as definePreset } from "../definePreset-BufbSTvs.js";
 
 //#region src/presets/default.ts
-var require_default = /* @__PURE__ */ __commonJSMin(((exports, module) => {
-	init_rules();
-	init_defineConfig();
-	const config = defineConfig(comments(true), allowlist(), terminology());
-	module.exports = config;
-}));
+const config = definePreset("@kcconfigs/textlint/preset-default", terminology());
 
 //#endregion
-export default require_default();
-
+export { config as default };
 // Generated by @kcconfigs/tsdown
 //# sourceMappingURL=default.js.map

package/dist/presets/default.js.map

@@ -1 +1 @@
-{"version":3,"file":"default.js","names":["config: UserConfig"],"sources":["../../src/presets/default.ts"],"sourcesContent":["import type { UserConfig } from \"../models/config\";\nimport { allowlist, comments, terminology } from \"../rules\";\nimport { defineConfig } from \"../utils/defineConfig\";\n\nconst config: UserConfig = defineConfig(\n\tcomments(true),\n\tallowlist(),\n\tterminology(),\n);\n\nexport = config;\n"],"mappings":";;;;;aAC4D;oBACP;CAErD,MAAMA,SAAqB,aAC1B,SAAS,KAAK,EACd,WAAW,EACX,aAAa,CACb;kBAEQ"}
+{"version":3,"file":"default.js","names":[],"sources":["../../src/presets/default.ts"],"sourcesContent":["import type { Preset } from \"../models\";\nimport { type TerminologyRule, terminology } from \"../rules/terminology\";\nimport { definePreset } from \"../utils/definePreset\";\n\nconst name = \"@kcconfigs/textlint/preset-default\";\n\ntype DefaultPreset = Preset<typeof name, [TerminologyRule]>;\n\nconst config: DefaultPreset = definePreset(name, terminology());\n\nexport default config;\n"],"mappings":";;;;;AAQA,MAAM,SAAwB,aAJjB,sCAIoC,aAAa,CAAC"}

package/dist/{defineConfig-BSVyAEFt.cjs → terminology-BJO_eqym.cjs}

@@ -1,5 +1,5 @@
 // @generated by tsdown, DO NOT edit it manually
-//#region rolldown:runtime
+//#region \0rolldown/runtime.js
 var __create = Object.create;
 var __defProp = Object.defineProperty;
 var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
@@ -29,91 +29,29 @@ var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__ge
 let textlint_rule_terminology = require("textlint-rule-terminology");
 textlint_rule_terminology = __toESM(textlint_rule_terminology);
 
-//#region src/rules/allowlist.ts
-const allowlist = (config) => {
-	if (!config) return {
-		type: "filter",
-		name: "allowlist",
-		config: false
-	};
-	return {
-		type: "filter",
-		name: "allowlist",
-		config: {
-			allow: config.allow,
-			allowlistConfigPaths: config.allowlistConfigPaths
-		}
-	};
-};
-
-//#endregion
-//#region src/rules/comment.ts
-const comments = (enabled = true) => {
+//#region src/utils/defineRule.ts
+const defineRule = (rule) => {
 	return {
-		type: "filter",
-		name: "comments",
-		config: enabled
+		type: "rule",
+		...rule
 	};
 };
 
 //#endregion
 //#region src/rules/terminology.ts
 const terminology = (config) => {
-	return {
-		type: "rule",
+	return defineRule({
 		name: "terminology",
 		module: textlint_rule_terminology.default,
-		config: {
-			defaultTerms: true,
-			...config
-		}
-	};
-};
-
-//#endregion
-//#region src/utils/defineConfig.ts
-const defineConfig = (...inputs) => {
-	const filters = {};
-	const rules = {};
-	const rulesConfig = {};
-	for (const input of inputs) {
-		if (input.config === false) continue;
-		switch (input.type) {
-			case "filter":
-				filters[input.name] = input.config;
-				break;
-			case "rule": {
-				const rule = input;
-				rules[rule.name] = rule.module;
-				rulesConfig[rule.name] = rule.config;
-				break;
-			}
-		}
-	}
-	return {
-		filters,
-		rules,
-		rulesConfig
-	};
+		config: config ?? true
+	});
 };
 
 //#endregion
-Object.defineProperty(exports, 'allowlist', {
-  enumerable: true,
-  get: function () {
-    return allowlist;
-  }
-});
-Object.defineProperty(exports, 'comments', {
-  enumerable: true,
-  get: function () {
-    return comments;
-  }
-});
-Object.defineProperty(exports, 'defineConfig', {
+Object.defineProperty(exports, 'defineRule', {
   enumerable: true,
   get: function () {
-    return defineConfig;
+    return defineRule;
   }
 });
 Object.defineProperty(exports, 'terminology', {
@@ -123,4 +61,4 @@ Object.defineProperty(exports, 'terminology', {
   }
 });
 // Generated by @kcconfigs/tsdown
-//# sourceMappingURL=defineConfig-BSVyAEFt.cjs.map
+//# sourceMappingURL=terminology-BJO_eqym.cjs.map

package/dist/terminology-BJO_eqym.cjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"terminology-BJO_eqym.cjs","names":["terminologyModule"],"sources":["../src/utils/defineRule.ts","../src/rules/terminology.ts"],"sourcesContent":["import type { AnyRule } from \"../models\";\n\nexport const defineRule = <R extends AnyRule>(rule: Omit<R, \"type\">): R => {\n\treturn {\n\t\ttype: \"rule\",\n\t\t...rule,\n\t} as R;\n};\n","import terminologyModule from \"textlint-rule-terminology\";\nimport type { Rule } from \"../models\";\nimport { defineRule } from \"../utils/defineRule\";\n\nexport interface TerminologyConfig {\n\tdefaultTerms?: boolean;\n\tskip?: string[];\n\tterms?: string[];\n\texclude?: string[];\n}\n\nexport type TerminologyRule = Rule<\"terminology\", TerminologyConfig>;\n\nexport const terminology = (config?: TerminologyConfig): TerminologyRule => {\n\treturn defineRule({\n\t\tname: \"terminology\",\n\t\tmodule: terminologyModule,\n\t\tconfig: config ?? true,\n\t});\n};\n"],"mappings":";;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAEA,MAAa,cAAiC,SAA6B;AAC1E,QAAO;EACN,MAAM;EACN,GAAG;EACH;;;;;ACOF,MAAa,eAAe,WAAgD;AAC3E,QAAO,WAAW;EACjB,MAAM;EACN,QAAQA;EACR,QAAQ,UAAU;EAClB,CAAC"}

package/dist/terminology-BQqu0v3E.d.cts

@@ -0,0 +1,16 @@
+// @generated by tsdown, DO NOT edit it manually
+import { a as Rule } from "./preset-DCOiMLaG.cjs";
+
+//#region src/rules/terminology.d.ts
+interface TerminologyConfig {
+  defaultTerms?: boolean;
+  skip?: string[];
+  terms?: string[];
+  exclude?: string[];
+}
+type TerminologyRule = Rule<"terminology", TerminologyConfig>;
+declare const terminology: (config?: TerminologyConfig) => TerminologyRule;
+//#endregion
+export { TerminologyRule as n, terminology as r, TerminologyConfig as t };
+// Generated by @kcconfigs/tsdown
+//# sourceMappingURL=terminology-BQqu0v3E.d.cts.map

package/dist/terminology-BQqu0v3E.d.cts.map

@@ -0,0 +1 @@
+{"version":3,"file":"terminology-BQqu0v3E.d.cts","names":[],"sources":["../src/rules/terminology.ts"],"mappings":";;;;UAIiB,iBAAA;EAChB,YAAA;EACA,IAAA;EACA,KAAA;EACA,OAAA;AAAA;AAAA,KAGW,eAAA,GAAkB,IAAA,gBAAoB,iBAAA;AAAA,cAErC,WAAA,GAAe,MAAA,GAAS,iBAAA,KAAoB,eAAA"}

package/dist/terminology-CPBVBYUJ.d.ts

@@ -0,0 +1,16 @@
+// @generated by tsdown, DO NOT edit it manually
+import { a as Rule } from "./preset-DI2qdO9E.js";
+
+//#region src/rules/terminology.d.ts
+interface TerminologyConfig {
+  defaultTerms?: boolean;
+  skip?: string[];
+  terms?: string[];
+  exclude?: string[];
+}
+type TerminologyRule = Rule<"terminology", TerminologyConfig>;
+declare const terminology: (config?: TerminologyConfig) => TerminologyRule;
+//#endregion
+export { TerminologyRule as n, terminology as r, TerminologyConfig as t };
+// Generated by @kcconfigs/tsdown
+//# sourceMappingURL=terminology-CPBVBYUJ.d.ts.map

package/dist/terminology-CPBVBYUJ.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"terminology-CPBVBYUJ.d.ts","names":[],"sources":["../src/rules/terminology.ts"],"mappings":";;;;UAIiB,iBAAA;EAChB,YAAA;EACA,IAAA;EACA,KAAA;EACA,OAAA;AAAA;AAAA,KAGW,eAAA,GAAkB,IAAA,gBAAoB,iBAAA;AAAA,cAErC,WAAA,GAAe,MAAA,GAAS,iBAAA,KAAoB,eAAA"}

package/dist/terminology-CTuwYZjs.js

@@ -0,0 +1,25 @@
+// @generated by tsdown, DO NOT edit it manually
+import terminologyModule from "textlint-rule-terminology";
+
+//#region src/utils/defineRule.ts
+const defineRule = (rule) => {
+	return {
+		type: "rule",
+		...rule
+	};
+};
+
+//#endregion
+//#region src/rules/terminology.ts
+const terminology = (config) => {
+	return defineRule({
+		name: "terminology",
+		module: terminologyModule,
+		config: config ?? true
+	});
+};
+
+//#endregion
+export { defineRule as n, terminology as t };
+// Generated by @kcconfigs/tsdown
+//# sourceMappingURL=terminology-CTuwYZjs.js.map

package/dist/terminology-CTuwYZjs.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"terminology-CTuwYZjs.js","names":[],"sources":["../src/utils/defineRule.ts","../src/rules/terminology.ts"],"sourcesContent":["import type { AnyRule } from \"../models\";\n\nexport const defineRule = <R extends AnyRule>(rule: Omit<R, \"type\">): R => {\n\treturn {\n\t\ttype: \"rule\",\n\t\t...rule,\n\t} as R;\n};\n","import terminologyModule from \"textlint-rule-terminology\";\nimport type { Rule } from \"../models\";\nimport { defineRule } from \"../utils/defineRule\";\n\nexport interface TerminologyConfig {\n\tdefaultTerms?: boolean;\n\tskip?: string[];\n\tterms?: string[];\n\texclude?: string[];\n}\n\nexport type TerminologyRule = Rule<\"terminology\", TerminologyConfig>;\n\nexport const terminology = (config?: TerminologyConfig): TerminologyRule => {\n\treturn defineRule({\n\t\tname: \"terminology\",\n\t\tmodule: terminologyModule,\n\t\tconfig: config ?? true,\n\t});\n};\n"],"mappings":";;;;AAEA,MAAa,cAAiC,SAA6B;AAC1E,QAAO;EACN,MAAM;EACN,GAAG;EACH;;;;;ACOF,MAAa,eAAe,WAAgD;AAC3E,QAAO,WAAW;EACjB,MAAM;EACN,QAAQ;EACR,QAAQ,UAAU;EAClB,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kcconfigs/textlint",
-  "version": "0.1.0-beta.0",
+  "version": "0.1.0",
   "description": "Shared textlint rule configuration",
   "type": "module",
   "dependencies": {
@@ -9,14 +9,13 @@
     "textlint-rule-terminology": "5.2.16"
   },
   "devDependencies": {
-    "@biomejs/biome": "2.3.10",
-    "textlint": "15.5.0",
-    "tsdown": "0.18.4",
+    "@biomejs/biome": "2.4.6",
+    "tsdown": "0.20.3",
     "vitest": "4.0.15",
-    "@kcconfigs/biome": "0.2.1",
-    "@kcconfigs/tsdown": "0.1.0-beta.3",
-    "@kcconfigs/vitest": "0.1.0-beta.2",
-    "@kcconfigs/tsconfig": "0.1.0"
+    "@kcconfigs/biome": "0.2.2",
+    "@kcconfigs/tsconfig": "0.1.1",
+    "@kcconfigs/tsdown": "0.1.1-beta.3",
+    "@kcconfigs/vitest": "0.1.1-beta.2"
   },
   "peerDependencies": {
     "textlint": "^15.0.0"

package/src/configs/default.test.ts

@@ -0,0 +1,27 @@
+import { describe, expect, test } from "vitest";
+import defaultConfig from "./default";
+
+describe("default config", () => {
+	test("should compose the package default textlint config", () => {
+		expect(defaultConfig).toEqual({
+			plugins: [],
+			filters: [
+				{
+					type: "filter",
+					name: "comments",
+					config: true,
+				},
+				{
+					type: "filter",
+					name: "allowlist",
+					config: {
+						allow: [""],
+					},
+				},
+			],
+			rules: {
+				terminology: true,
+			},
+		});
+	});
+});

package/src/configs/default.ts

@@ -0,0 +1,14 @@
+import { allowlist } from "../filters/allowlist";
+import { comments } from "../filters/comment";
+import type { AnyUserConfig } from "../models";
+import { terminology } from "../rules/terminology";
+import { defineConfig } from "../utils/defineConfig";
+
+const config: AnyUserConfig = defineConfig({
+	presets: [],
+	rules: [terminology()],
+	filters: [comments(), allowlist({ allow: [""] })],
+	plugins: [],
+});
+
+export default config;

package/src/filters/allowlist.test.ts

@@ -0,0 +1,41 @@
+import { describe, expect, test } from "vitest";
+import { allowlist, DEFAULT_ALLOWLIST } from "./allowlist";
+
+describe(allowlist.name, () => {
+	test("should disable the filter when no config is provided", () => {
+		expect(allowlist()).toEqual({
+			type: "filter",
+			name: "allowlist",
+			config: false,
+		});
+	});
+
+	test("should apply the default allow list when allow is omitted", () => {
+		expect(
+			allowlist({
+				allowlistConfigPaths: ["./allowlist.txt"],
+			}),
+		).toEqual({
+			type: "filter",
+			name: "allowlist",
+			config: {
+				allow: DEFAULT_ALLOWLIST,
+				allowlistConfigPaths: ["./allowlist.txt"],
+			},
+		});
+	});
+
+	test("should preserve an explicit allow list", () => {
+		expect(
+			allowlist({
+				allow: ["bun", "pnpm"],
+			}),
+		).toEqual({
+			type: "filter",
+			name: "allowlist",
+			config: {
+				allow: ["bun", "pnpm"],
+			},
+		});
+	});
+});

package/src/filters/allowlist.ts

@@ -0,0 +1,36 @@
+import type { Filter } from "../models";
+import { defineFilter } from "../utils/defineFilter";
+
+export interface AllowListConfig {
+	allow?: string[];
+	allowlistConfigPaths?: string[];
+}
+
+export const DEFAULT_ALLOWLIST: string[] = [
+	"editorconfig",
+	"url",
+	"html",
+	"api",
+	"apis",
+	"github",
+	"typescript",
+	"json",
+];
+
+export type AllowListRule = Filter<"allowlist", AllowListConfig>;
+
+export const allowlist = (config?: AllowListConfig): AllowListRule => {
+	const name = "allowlist";
+	if (!config) {
+		return defineFilter({
+			name,
+			config: false,
+		});
+	}
+
+	if (!config.allow) config.allow = DEFAULT_ALLOWLIST;
+	return defineFilter({
+		name,
+		config,
+	});
+};

package/src/filters/comment.test.ts

@@ -0,0 +1,20 @@
+import { describe, expect, test } from "vitest";
+import { comments } from "./comment";
+
+describe(comments.name, () => {
+	test("should enable the filter by default", () => {
+		expect(comments()).toEqual({
+			type: "filter",
+			name: "comments",
+			config: true,
+		});
+	});
+
+	test("should allow disabling the filter", () => {
+		expect(comments(false)).toEqual({
+			type: "filter",
+			name: "comments",
+			config: false,
+		});
+	});
+});

package/src/filters/comment.ts

@@ -0,0 +1,11 @@
+import type { EmptyObject, Filter } from "../models";
+import { defineFilter } from "../utils/defineFilter";
+
+export type CommentRule = Filter<"comments", EmptyObject>;
+
+export const comments = (enabled = true): CommentRule => {
+	return defineFilter({
+		name: "comments",
+		config: enabled,
+	});
+};

package/src/index.test.ts

@@ -1,35 +1,25 @@
 import { describe, expect, test } from "vitest";
-import { multiply } from ".";
+import * as exports from "./index";
 
-describe(multiply.name, () => {
-	test("should multiply two numbers correctly", () => {
-		expect(multiply(3, 4)).toBe(12);
+describe("index exports", () => {
+	test("should export filter factories", () => {
+		expect(exports.allowlist).toBeDefined();
+		expect(typeof exports.allowlist).toBe("function");
+		expect(exports.comments).toBeDefined();
+		expect(typeof exports.comments).toBe("function");
 	});
 
-	test("should handle negative numbers", () => {
-		expect(multiply(-2, 5)).toBe(-10);
+	test("should export rule factories", () => {
+		expect(exports.terminology).toBeDefined();
+		expect(typeof exports.terminology).toBe("function");
 	});
 
-	test("should handle zero", () => {
-		expect(multiply(0, 5)).toBe(0);
-		expect(multiply(10, 0)).toBe(0);
-	});
-
-	test("should handle decimal numbers", () => {
-		expect(multiply(2.5, 4)).toBe(10);
-		expect(multiply(1.5, 2.5)).toBe(3.75);
-	});
-
-	test("should handle both negative numbers", () => {
-		expect(multiply(-3, -4)).toBe(12);
-	});
-
-	test("should handle multiplication by one", () => {
-		expect(multiply(7, 1)).toBe(7);
-		expect(multiply(1, 7)).toBe(7);
-	});
-
-	test("should handle large numbers", () => {
-		expect(multiply(1000, 1000)).toBe(1000000);
+	test("should export helper factories", () => {
+		expect(exports.defineFilter).toBeDefined();
+		expect(typeof exports.defineFilter).toBe("function");
+		expect(exports.definePreset).toBeDefined();
+		expect(typeof exports.definePreset).toBe("function");
+		expect(exports.defineRule).toBeDefined();
+		expect(typeof exports.defineRule).toBe("function");
 	});
 });

package/src/index.ts

@@ -1,6 +1,10 @@
-export type * from "./models/config";
-export type * from "./models/rule";
+export * from "./filters/allowlist";
+export * from "./filters/comment";
 
-export * from "./rules";
+export type * from "./models";
 
-export * from "./utils/defineConfig";
+export * from "./rules/terminology";
+
+export * from "./utils/defineFilter";
+export * from "./utils/definePreset";
+export * from "./utils/defineRule";

package/src/models/base.ts

@@ -0,0 +1,29 @@
+export type Severity = "error" | "warning" | "info";
+
+export type WithEnabled<T> = T | boolean;
+
+export type ObjectType = "preset" | "rule" | "filter" | "plugin";
+
+// biome-ignore lint/suspicious/noExplicitAny: Any object type
+export type AnyObject = Record<string, any>;
+export type EmptyObject = Record<never, never>;
+
+export interface BaseObject<T extends ObjectType, N extends string> {
+	type: T;
+	name: N;
+}
+export type AnyBaseObject = BaseObject<ObjectType, string>;
+
+export interface ExtendSeverity {
+	severity?: Severity;
+}
+
+export type UserBase<
+	RS extends AnyBaseObject[],
+	T extends ObjectType,
+	K extends keyof RS[number],
+> = {
+	[R in RS[number] as R extends BaseObject<T, infer N>
+		? N
+		: never]: K extends keyof R ? R[K] : R;
+};