@cssdoc/providers 0.1.0 → 0.2.0

package/dist/index.d.mts

@@ -3,6 +3,27 @@ import { ClassUsage, CssDocIndex, Location, Location as Location$1, PropertyAssi
 //#region src/types.d.ts
 /** Diagnostic severity. */
 type Severity = "error" | "warning";
+/** A configurable per-rule severity — `off` suppresses the rule entirely. */
+type RuleSeverity = "off" | "warn" | "error";
+/**
+ * Every rule id an aspect can emit, author-side and consumer-side. A superset of `@cssdoc/lint-core`'s
+ * author-side `RuleName` (which omits the consumer-side `unknown-modifier`/`deprecated-modifier` and
+ * the opt-in `unknown-custom-property`).
+ */
+type RuleId = "missing-summary" | "undocumented-modifier" | "deprecated-requires-canonical" | "name-not-in-css" | "unknown-modifier" | "deprecated-modifier" | "undocumented-part" | "invalid-default-value" | "invalid-property-value" | "invalid-fallback-value" | "unknown-custom-property";
+/** A resolved severity for every rule. */
+type RuleSeverities = Record<RuleId, RuleSeverity>;
+/**
+ * The default rule severities. `unknown-modifier` defaults to `warn` — safe under the BEM default's
+ * strong `--` signal; lower it to `off` for weak-signal conventions (bare/OOCSS) where every chained
+ * class is a candidate. `unknown-custom-property` stays `off` (it needs an opt-in `propertyPrefix`).
+ */
+declare const DEFAULT_RULE_SEVERITIES: RuleSeverities;
+/**
+ * Merge per-rule overrides over {@link DEFAULT_RULE_SEVERITIES}. A `boolean` override is accepted for
+ * back-compat: `false` → `off`, `true` → the rule's default.
+ */
+declare function resolveRuleSeverities(overrides?: Partial<Record<RuleId, RuleSeverity | boolean>>): RuleSeverities;
 /** One diagnostic from an aspect. */
 interface Diagnostic {
   /** The aspect that produced it (e.g. `modifier`). */
@@ -98,13 +119,13 @@ declare const func: {
 /** The aspect names covered, in a stable order (the extension point for future aspects). */
 declare const ASPECTS: readonly ["record", "modifier", "part", "custom-property", "structure", "function", "state", "condition"];
 /** Author-side hygiene diagnostics over the whole model (missing summaries, undocumented members, drift, invalid defaults). */
-declare function lintModel(index: CssDocIndex): Diagnostic[];
+declare function lintModel(index: CssDocIndex, severities?: RuleSeverities): Diagnostic[];
 /** Consumer-side diagnostics for custom-property assignments (`--x: value` must match its `@property` syntax). */
-declare function checkPropertyAssignments(assignments: readonly PropertyAssignment[], index: CssDocIndex): Diagnostic[];
+declare function checkPropertyAssignments(assignments: readonly PropertyAssignment[], index: CssDocIndex, severities?: RuleSeverities): Diagnostic[];
 /** Consumer-side diagnostics for class-attribute usage (unknown or deprecated modifiers). */
-declare function checkClassUsage(usages: readonly ClassUsage[], index: CssDocIndex): Diagnostic[];
+declare function checkClassUsage(usages: readonly ClassUsage[], index: CssDocIndex, severities?: RuleSeverities): Diagnostic[];
 /** Consumer-side diagnostics for `var(--…)` references (unknown custom properties; opt-in via prefix). */
-declare function checkPropertyUsage(usages: readonly PropertyUsage[], index: CssDocIndex, options?: UsageOptions): Diagnostic[];
+declare function checkPropertyUsage(usages: readonly PropertyUsage[], index: CssDocIndex, options?: UsageOptions, severities?: RuleSeverities): Diagnostic[];
 /** Completions for a class attribute: modifiers of `base` when given, else the component classes. */
 declare function completeClasses(base: string | undefined, index: CssDocIndex): Completion[];
 /** Completions for `var(--…)`: the declared custom properties. */
@@ -124,4 +145,4 @@ declare function definitionForCustomProperty(name: string, index: CssDocIndex):
 /** Definition of a custom function (its `@function` rule). */
 declare function definitionForFunction(name: string, index: CssDocIndex): Location$1 | undefined;
 //#endregion
-export { ASPECTS, Completion, CompletionKind, Diagnostic, Hover, type Location, Severity, type SourceSpan, SyntaxMatch, UsageOptions, checkClassUsage, checkPropertyAssignments, checkPropertyUsage, completeClasses, completeCustomProperties, completeFunctions, customProperty, definitionForClass, definitionForCustomProperty, definitionForFunction, func, hoverForClass, hoverForCustomProperty, hoverForFunction, lintModel, matchesSyntax, modifier, part, record };
+export { ASPECTS, Completion, CompletionKind, DEFAULT_RULE_SEVERITIES, Diagnostic, Hover, type Location, RuleId, RuleSeverities, RuleSeverity, Severity, type SourceSpan, SyntaxMatch, UsageOptions, checkClassUsage, checkPropertyAssignments, checkPropertyUsage, completeClasses, completeCustomProperties, completeFunctions, customProperty, definitionForClass, definitionForCustomProperty, definitionForFunction, func, hoverForClass, hoverForCustomProperty, hoverForFunction, lintModel, matchesSyntax, modifier, part, record, resolveRuleSeverities };

package/dist/index.mjs

@@ -119,26 +119,27 @@ const modifier = {
 		for (const info of index.records) {
 			const name = info.entry.name;
 			for (const m of info.entry.modifiers) {
+				const sel = index.matcher.selectorFor(m.name);
 				const span = info.memberSpans.get(memberKey("modifier", m.name)) ?? info.span;
 				if (!m.description?.trim() && !m.deprecated) out.push(warn({
 					aspect: "modifier",
 					rule: "undocumented-modifier",
-					message: `Modifier ".${m.name}" of "${name}" has no @modifier description.`,
+					message: `Modifier "${sel}" of "${name}" has no @modifier description.`,
 					record: name,
 					span
 				}));
 				if (m.deprecated && !m.deprecated.canonical && !m.deprecated.note?.trim()) out.push(warn({
 					aspect: "modifier",
 					rule: "deprecated-requires-canonical",
-					message: `Deprecated modifier ".${m.name}" of "${name}" needs a canonical replacement ({@link -x}) or a note.`,
+					message: `Deprecated modifier "${sel}" of "${name}" needs a canonical replacement ({@link}) or a note.`,
 					record: name,
 					span
 				}));
 			}
-			for (const authored of info.authoredModifiers) if (!info.selectorText.includes(`.${authored}`)) out.push(warn({
+			for (const authored of info.authoredModifiers) if (!info.selectorText.includes(index.matcher.selectorFor(authored))) out.push(warn({
 				aspect: "modifier",
 				rule: "name-not-in-css",
-				message: `Documented modifier ".${authored}" of "${name}" is not defined by any selector.`,
+				message: `Documented modifier "${index.matcher.selectorFor(authored)}" of "${name}" is not defined by any selector.`,
 				record: name,
 				span: info.span
 			}));
@@ -146,23 +147,24 @@ const modifier = {
 		return out;
 	},
 	classUsage(usage, index) {
-		if (!usage.base || !usage.token.startsWith("-")) return [];
+		if (!usage.base || !index.matcher.looksLikeUsage(usage.token, usage.base)) return [];
 		const entry = index.componentForClass(usage.base);
 		if (!entry) return [];
+		const sel = index.matcher.selectorFor(index.matcher.normalizeMember(usage.token));
 		if (!index.isModifier(usage.base, usage.token)) return [warn({
 			aspect: "modifier",
 			rule: "unknown-modifier",
-			message: `".${usage.token}" is not a documented modifier of "${entry.name}".`,
+			message: `"${sel}" is not a documented modifier of "${entry.name}".`,
 			record: entry.name,
 			span: usage.loc
 		})];
 		const dep = index.deprecationOf(usage.base, usage.token);
 		if (dep) {
-			const advice = dep.canonical ? `use ".${dep.canonical}"` : dep.note ?? "no replacement given";
+			const advice = dep.canonical ? `use "${index.matcher.selectorFor(dep.canonical)}"` : dep.note ?? "no replacement given";
 			return [warn({
 				aspect: "modifier",
 				rule: "deprecated-modifier",
-				message: `Modifier ".${usage.token}" of "${entry.name}" is deprecated — ${advice}.`,
+				message: `Modifier "${sel}" of "${entry.name}" is deprecated — ${advice}.`,
 				record: entry.name,
 				span: usage.loc
 			})];
@@ -173,7 +175,7 @@ const modifier = {
 		const entry = index.componentForClass(base);
 		if (!entry) return [];
 		return entry.modifiers.map((m) => ({
-			label: `-${m.name.replace(/^-/u, "")}`,
+			label: m.name,
 			kind: "modifier",
 			detail: m.prop,
 			documentation: m.description,
@@ -182,19 +184,19 @@ const modifier = {
 	},
 	hover(base, token, index) {
 		const entry = index.componentForClass(base);
-		const m = entry?.modifiers.find((x) => x.name === stripDot(token));
+		const m = entry?.modifiers.find((x) => x.name === index.matcher.normalizeMember(token));
 		if (!m) return void 0;
-		const lines = [`\`.${m.name}\` — modifier of \`${entry.className}\``];
+		const lines = [`\`${index.matcher.selectorFor(m.name)}\` — modifier of \`${entry.className}\``];
 		if (m.description) lines.push("", m.description);
 		if (m.deprecated) {
-			const advice = m.deprecated.canonical ? `use \`.${m.deprecated.canonical}\`` : m.deprecated.note ?? "";
+			const advice = m.deprecated.canonical ? `use \`${index.matcher.selectorFor(m.deprecated.canonical)}\`` : m.deprecated.note ?? "";
 			lines.push("", `**Deprecated** — ${advice}`);
 		}
 		return { contents: lines.join("\n") };
 	},
 	definition(base, token, index) {
 		const entry = index.componentForClass(base);
-		return entry ? index.location(entry.name, memberKey("modifier", stripDot(token))) : void 0;
+		return entry ? index.location(entry.name, memberKey("modifier", index.matcher.normalizeMember(token))) : void 0;
 	}
 };
 const part = { model(index) {
@@ -328,7 +330,58 @@ const func = {
 	}
 };
 //#endregion
+//#region src/types.ts
+/**
+* The default rule severities. `unknown-modifier` defaults to `warn` — safe under the BEM default's
+* strong `--` signal; lower it to `off` for weak-signal conventions (bare/OOCSS) where every chained
+* class is a candidate. `unknown-custom-property` stays `off` (it needs an opt-in `propertyPrefix`).
+*/
+const DEFAULT_RULE_SEVERITIES = {
+	"missing-summary": "warn",
+	"undocumented-modifier": "warn",
+	"deprecated-requires-canonical": "warn",
+	"name-not-in-css": "warn",
+	"unknown-modifier": "warn",
+	"deprecated-modifier": "warn",
+	"undocumented-part": "warn",
+	"invalid-default-value": "warn",
+	"invalid-property-value": "warn",
+	"invalid-fallback-value": "warn",
+	"unknown-custom-property": "off"
+};
+/**
+* Merge per-rule overrides over {@link DEFAULT_RULE_SEVERITIES}. A `boolean` override is accepted for
+* back-compat: `false` → `off`, `true` → the rule's default.
+*/
+function resolveRuleSeverities(overrides) {
+	const resolved = { ...DEFAULT_RULE_SEVERITIES };
+	if (!overrides) return resolved;
+	for (const [rule, value] of Object.entries(overrides)) {
+		if (value === void 0) continue;
+		if (typeof value === "boolean") resolved[rule] = value ? DEFAULT_RULE_SEVERITIES[rule] : "off";
+		else resolved[rule] = value;
+	}
+	return resolved;
+}
+//#endregion
 //#region src/index.ts
+/**
+* Apply resolved rule severities to a batch of diagnostics: drop `off` rules, and stamp the configured
+* severity onto the rest. This is the single place severity/enablement is decided — every host inherits
+* it. Aspects emit a placeholder `warning`; this overrides it.
+*/
+function applySeverities(diagnostics, severities) {
+	const out = [];
+	for (const d of diagnostics) {
+		const severity = severities[d.rule] ?? "warn";
+		if (severity === "off") continue;
+		out.push({
+			...d,
+			severity: severity === "error" ? "error" : "warning"
+		});
+	}
+	return out;
+}
 /** The aspect names covered, in a stable order (the extension point for future aspects). */
 const ASPECTS = [
 	"record",
@@ -341,25 +394,25 @@ const ASPECTS = [
 	"condition"
 ];
 /** Author-side hygiene diagnostics over the whole model (missing summaries, undocumented members, drift, invalid defaults). */
-function lintModel(index) {
-	return [
+function lintModel(index, severities = DEFAULT_RULE_SEVERITIES) {
+	return applySeverities([
 		...record.model(index),
 		...modifier.model(index),
 		...part.model(index),
 		...customProperty.model(index)
-	];
+	], severities);
 }
 /** Consumer-side diagnostics for custom-property assignments (`--x: value` must match its `@property` syntax). */
-function checkPropertyAssignments(assignments, index) {
-	return assignments.flatMap((a) => customProperty.assignment(a, index));
+function checkPropertyAssignments(assignments, index, severities = DEFAULT_RULE_SEVERITIES) {
+	return applySeverities(assignments.flatMap((a) => customProperty.assignment(a, index)), severities);
 }
 /** Consumer-side diagnostics for class-attribute usage (unknown or deprecated modifiers). */
-function checkClassUsage(usages, index) {
-	return usages.flatMap((usage) => modifier.classUsage(usage, index));
+function checkClassUsage(usages, index, severities = DEFAULT_RULE_SEVERITIES) {
+	return applySeverities(usages.flatMap((usage) => modifier.classUsage(usage, index)), severities);
 }
 /** Consumer-side diagnostics for `var(--…)` references (unknown custom properties; opt-in via prefix). */
-function checkPropertyUsage(usages, index, options = {}) {
-	return usages.flatMap((usage) => customProperty.propertyUsage(usage, index, options));
+function checkPropertyUsage(usages, index, options = {}, severities = DEFAULT_RULE_SEVERITIES) {
+	return applySeverities(usages.flatMap((usage) => customProperty.propertyUsage(usage, index, options)), severities);
 }
 /** Completions for a class attribute: modifiers of `base` when given, else the component classes. */
 function completeClasses(base, index) {
@@ -398,4 +451,4 @@ function definitionForFunction(name, index) {
 	return func.definition(name, index);
 }
 //#endregion
-export { ASPECTS, checkClassUsage, checkPropertyAssignments, checkPropertyUsage, completeClasses, completeCustomProperties, completeFunctions, customProperty, definitionForClass, definitionForCustomProperty, definitionForFunction, func, hoverForClass, hoverForCustomProperty, hoverForFunction, lintModel, matchesSyntax, modifier, part, record };
+export { ASPECTS, DEFAULT_RULE_SEVERITIES, checkClassUsage, checkPropertyAssignments, checkPropertyUsage, completeClasses, completeCustomProperties, completeFunctions, customProperty, definitionForClass, definitionForCustomProperty, definitionForFunction, func, hoverForClass, hoverForCustomProperty, hoverForFunction, lintModel, matchesSyntax, modifier, part, record, resolveRuleSeverities };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cssdoc/providers",
-  "version": "0.1.0",
+  "version": "0.2.0",
   "description": "Host-agnostic aspect providers over the @cssdoc/index — diagnostics, completions, hover, and definitions for modifiers, custom properties, structure, functions, states, and conditions.",
   "keywords": [
     "css",
@@ -29,8 +29,8 @@
   },
   "dependencies": {
     "css-tree": "^3.2.1",
-    "@cssdoc/core": "0.1.0",
-    "@cssdoc/index": "0.1.0"
+    "@cssdoc/core": "0.2.0",
+    "@cssdoc/index": "0.2.0"
   },
   "devDependencies": {
     "@types/css-tree": "^2.3.11",