feat: check for valid rule names in the config file. Closes #12

src/constants.ts

@@ -19,3 +19,24 @@ export const keyNamingConventions = {
 };
 
 export const validKeyNamingConventions = Object.values(keyNamingConventions);
+
+/**
+ * Export a list of the rule names that are configurable
+ */
+export const configurableRuleNames: string[] = [
+	"no-empty-messages",
+	"no-untranslated-messages",
+	"no-invalid-variables",
+	"no-html-messages",
+	"no-missing-keys",
+	"no-malformed-keys",
+	"no-extra-whitespace",
+];
+
+/**
+ * Export a list of the rule names that are NOT configurable
+ */
+export const unConfigurableRuleNames: string[] = [
+	"no-invalid-configuration",
+	"no-invalid-severity",
+];

src/rules/no-empty-messages/no-empty-messages.ts

@@ -17,6 +17,7 @@ const ruleMeta: RuleMeta = {
 	url: "TBD",
 	type: "validation",
 	defaultSeverity: "error",
+	configurable: true,
 };
 
 const noEmptyMessages: Rule = {

src/rules/no-extra-whitespace/no-extra-whitespace.ts

@@ -19,6 +19,7 @@ const ruleMeta: RuleMeta = {
 	url: "TBD",
 	type: "validation",
 	defaultSeverity: "error",
+	configurable: true,
 };
 
 const noExtraWhitespace: Rule = {

src/rules/no-html-messages/no-html-messages.ts

@@ -16,6 +16,7 @@ const ruleMeta: RuleMeta = {
 	url: "TBD",
 	type: "validation",
 	defaultSeverity: "error",
+	configurable: true,
 };
 
 const noHtmlMessages: Rule = {

src/rules/no-invalid-configuration/README.md

@@ -15,8 +15,9 @@ This rule makes the following checks that your configuration is ready to go.
    2. A valid `sourceFile`
    3. Valid `translationFiles` object
    4. A valid `pathToTranslatedFiles` string
+   5. Only known rules can be passed into the `rules` section
 
-✅ Examples of a **correct** setup for this rule (all messages are non-empty):
+✅ Examples of a **correct** setup for this rule (all messages are non-empty, and valid rules are used):
 
 ```json
 {
@@ -25,7 +26,10 @@ This rule makes the following checks that your configuration is ready to go.
 	"translationFiles": {
 		"locale": "filename-of-this-locales-messages"
 	},
-	"pathToTranslatedFiles": "path/to/translation/files/directory"
+	"pathToTranslatedFiles": "path/to/translation/files/directory",
+	"rules": {
+		"no-html-messages": "warn"
+	}
 }
 ```
 

src/rules/no-invalid-configuration/no-invalid-configuration.spec.ts

@@ -11,6 +11,8 @@ import {
 	getInvalidTranslationFilesProblem,
 	getMissingDefaultLocaleProblem,
 	getMissingSourceFileProblem,
+	getUnConfigurableRuleFoundInConfigProblem,
+	getUnknownRuleConfigurationProblem,
 } from "./problems.ts";
 
 const ruleMeta = noInvalidConfiguration.meta;
@@ -257,4 +259,56 @@ describe(`${rule.meta.name}`, () => {
 		expect(problemStore.report).toHaveBeenCalledWith(expectedProblem);
 		expect(problemStore.report).toHaveBeenCalledTimes(1);
 	});
+
+	it(`should report unknown rules in configuration file`, () => {
+		const problemStore = createMockProblemReporter();
+
+		const { severity } = context;
+
+		const config: Config = {
+			...baseConfig,
+			rules: {
+				"this-is-an-unknown-rule": "error",
+			},
+		};
+
+		rule.run(translationFiles, config, problemStore, context);
+
+		const expectedProblem = getUnknownRuleConfigurationProblem(
+			{
+				severity: severity as RuleSeverity,
+				ruleMeta,
+			},
+			"this-is-an-unknown-rule"
+		);
+
+		expect(problemStore.report).toHaveBeenCalledWith(expectedProblem);
+		expect(problemStore.report).toHaveBeenCalledTimes(1);
+	});
+
+	it(`should report when un-configurable rules find configuration in the config file`, () => {
+		const problemStore = createMockProblemReporter();
+
+		const { severity } = context;
+
+		const config: Config = {
+			...baseConfig,
+			rules: {
+				"no-invalid-configuration": "off",
+			},
+		};
+
+		rule.run(translationFiles, config, problemStore, context);
+
+		const expectedProblem = getUnConfigurableRuleFoundInConfigProblem(
+			{
+				severity: severity as RuleSeverity,
+				ruleMeta,
+			},
+			"no-invalid-configuration"
+		);
+
+		expect(problemStore.report).toHaveBeenCalledWith(expectedProblem);
+		expect(problemStore.report).toHaveBeenCalledTimes(1);
+	});
 });

src/rules/no-invalid-configuration/no-invalid-configuration.ts

@@ -6,11 +6,17 @@ import {
 	TranslationFiles,
 } from "../../types.ts";
 import { isEmptyString } from "../../utils/string-helpers.ts";
+import {
+	configurableRuleNames,
+	unConfigurableRuleNames,
+} from "../../constants";
 import {
 	getInvalidTranslationFilesProblem,
 	getMissingSourceFileProblem,
 	getMissingDefaultLocaleProblem,
 	getInvalidPathToTranslatedFilesProblem,
+	getUnknownRuleConfigurationProblem,
+	getUnConfigurableRuleFoundInConfigProblem,
 } from "./problems.ts";
 
 const ruleMeta: RuleMeta = {
@@ -19,6 +25,7 @@ const ruleMeta: RuleMeta = {
 	url: "TBD",
 	type: "configuration",
 	defaultSeverity: "error",
+	configurable: false,
 };
 
 const noInvalidConfiguration: Rule = {
@@ -30,7 +37,7 @@ const noInvalidConfiguration: Rule = {
 		context: RuleContext
 	) => {
 		const { defaultLocale, sourceFile, pathToTranslatedFiles } = config;
-		const { severity } = context;
+		const severity = ruleMeta.defaultSeverity;
 
 		// Look for missing or invalid 'defaultLocale' in the configuration
 		if (!defaultLocale || isEmptyString(defaultLocale)) {
@@ -74,6 +81,31 @@ const noInvalidConfiguration: Rule = {
 				getInvalidPathToTranslatedFilesProblem({ ruleMeta, severity })
 			);
 		}
+
+		// Look for unexpected rule names in the configuration
+		Object.keys(config?.rules).forEach((ruleName) => {
+			if (
+				!configurableRuleNames.includes(ruleName) &&
+				!unConfigurableRuleNames.includes(ruleName)
+			) {
+				const problem = getUnknownRuleConfigurationProblem(
+					{ ruleMeta, severity },
+					ruleName
+				);
+				problemStore.report(problem);
+			}
+		});
+
+		// Look for un-configurable rule names in the configuration
+		Object.keys(config?.rules).forEach((ruleName) => {
+			if (unConfigurableRuleNames.includes(ruleName)) {
+				const problem = getUnConfigurableRuleFoundInConfigProblem(
+					{ ruleMeta, severity },
+					ruleName
+				);
+				problemStore.report(problem);
+			}
+		});
 	},
 };
 

src/rules/no-invalid-configuration/problems.ts

@@ -57,3 +57,33 @@ export function getInvalidPathToTranslatedFilesProblem(
 		)
 		.build();
 }
+
+export function getUnknownRuleConfigurationProblem(
+	problemContext: ProblemContext,
+	unknownRuleName: string
+): Problem {
+	const { severity, ruleMeta } = problemContext;
+
+	return Problem.Builder.withRuleMeta(ruleMeta)
+		.withRuleMeta(ruleMeta)
+		.withSeverity(severity)
+		.withMessage(
+			`Unknown rule '${unknownRuleName}' found in configuration. Remove or update the rule entry.`
+		)
+		.build();
+}
+
+export function getUnConfigurableRuleFoundInConfigProblem(
+	problemContext: ProblemContext,
+	ruleName: string
+): Problem {
+	const { severity, ruleMeta } = problemContext;
+
+	return Problem.Builder.withRuleMeta(ruleMeta)
+		.withRuleMeta(ruleMeta)
+		.withSeverity(severity)
+		.withMessage(
+			`The rule '${ruleName}' is not configurable. Remove it from your config's "rules" section.`
+		)
+		.build();
+}

src/rules/no-invalid-severity/no-invalid-severity.ts

@@ -16,6 +16,7 @@ const ruleMeta: RuleMeta = {
 	url: "TBD",
 	type: "configuration",
 	defaultSeverity: "error",
+	configurable: false,
 };
 
 const noInvalidSeverity: Rule = {
@@ -26,7 +27,7 @@ const noInvalidSeverity: Rule = {
 		problemStore,
 		context: RuleContext
 	) => {
-		const { severity } = context;
+		const severity = ruleMeta.defaultSeverity;
 
 		// Look for invalid rule severity in the configuration file
 		Object.entries(config.rules).forEach(([rule, ruleValue]) => {

src/rules/no-invalid-variables/no-invalid-variables.ts

@@ -24,6 +24,7 @@ const ruleMeta: RuleMeta = {
 	url: "TBD",
 	type: "validation",
 	defaultSeverity: "error",
+	configurable: true,
 };
 
 const noInvalidVariables: Rule = {

src/rules/no-malformed-keys/no-malformed-keys.ts

@@ -21,6 +21,7 @@ const ruleMeta: RuleMeta = {
 	url: "TBD",
 	type: "validation",
 	defaultSeverity: "error",
+	configurable: true,
 };
 
 const noMalformedKeys: Rule = {

src/rules/no-missing-keys/no-missing-keys.ts

@@ -17,6 +17,7 @@ const ruleMeta: RuleMeta = {
 	url: "TBD",
 	type: "validation",
 	defaultSeverity: "error",
+	configurable: true,
 };
 
 const noMissingKeys: Rule = {

src/rules/no-untranslated-messages/no-untranslated-messages.ts

@@ -14,6 +14,7 @@ const ruleMeta: RuleMeta = {
 	url: "TBD",
 	type: "validation",
 	defaultSeverity: "error",
+	configurable: true,
 };
 
 const noUntranslatedMessages: Rule = {

src/types.ts

@@ -43,6 +43,7 @@ export type RuleMeta = {
 	description: string;
 	type: keyof typeof RULE_TYPE;
 	url: string;
+	configurable: boolean;
 };
 
 export type RuleContext = {

src/utils/rules-helpers.spec.ts

@@ -13,6 +13,7 @@ describe("getRuleSeverity", () => {
 			url: "",
 			defaultSeverity: "warn",
 			name: "example-rule",
+			configurable: true,
 		};
 
 		const rule: Partial<Rule> = {
@@ -37,6 +38,7 @@ describe("getRuleSeverity", () => {
 			url: "",
 			defaultSeverity: "error",
 			name,
+			configurable: true,
 		};
 
 		const rule: Partial<Rule> = {
@@ -63,6 +65,7 @@ describe("getRuleSeverity", () => {
 			url: "",
 			defaultSeverity: "error",
 			name,
+			configurable: true,
 		};
 
 		const rule: Partial<Rule> = {
@@ -93,6 +96,7 @@ describe("getRuleIgnoreKeys", () => {
 			url: "",
 			defaultSeverity: "error",
 			name,
+			configurable: true,
 		};
 
 		const rule: Partial<Rule> = {
@@ -121,6 +125,7 @@ describe("getRuleIgnoreKeys", () => {
 			url: "",
 			defaultSeverity: "error",
 			name,
+			configurable: true,
 		};
 
 		const rule: Partial<Rule> = {
@@ -145,6 +150,7 @@ describe("getRuleIgnoreKeys", () => {
 			url: "",
 			defaultSeverity: "error",
 			name,
+			configurable: true,
 		};
 
 		const rule: Partial<Rule> = {

src/utils/rules-helpers.ts

@@ -8,8 +8,14 @@ import type { Config, Rule, RuleSeverity } from "../types";
  * @returns string
  */
 export function getRuleSeverity(config: Config, rule: Rule): RuleSeverity {
+	const isConfigurable = rule.meta.configurable;
+
 	const ruleConfig = config.rules[rule.meta.name];
 
+	if (!isConfigurable) {
+		return rule.meta.defaultSeverity;
+	}
+
 	if (typeof ruleConfig === "string" && validSeverities.includes(ruleConfig)) {
 		return ruleConfig;
 	}