rulebookguard 0.1.0 → 0.1.1

package/README.md

@@ -36,9 +36,12 @@ testGlobs: # required: files scanned for @rule tags
   - 'src/**/*.test.ts'
   - 'tests/**/test_*.py'
 contextBudget: 30 # default: 30; lint warns when a context holds more rules
+language: es # default: en; language of the text that rulebookguard generates
 ```
 
-`schema` and `testGlobs` are required (`testGlobs: []` is valid but finds no tags). Unknown fields are rejected. The JSON Schemas ship with the package under `rulebookguard/schemas/v1/`.
+`schema` and `testGlobs` are required (`testGlobs: []` is valid but finds no tags). Unknown fields are rejected.
+
+`language` (`en` or `es`) sets the language of the text rulebookguard writes for you, such as the template of `new`. Rule content is free text and is never checked for language, so rules can be written in any language whatever this setting says. `language` needs rulebookguard 0.1.1 or later; older versions reject it as an unknown field. The JSON Schemas ship with the package under `rulebookguard/schemas/v1/`.
 
 Inside a git work tree, files are listed with `git ls-files --cached --others --exclude-standard`, so anything in `.gitignore` (`dist/`, `coverage/`, caches) is never matched by anchors or test globs; files inside submodules are listed too. A submodule path that is a symlink, or that resolves outside the rulebook root, is skipped. A test file that is a symlink is scanned for `@rule` tags only when its target lies inside the rulebook root. If one submodule cannot be listed, commands print `warning: could not list files of submodule "<path>" (<reason>); skipping it.` and keep the rest of the git listing. Outside git, or when the rulebook root itself is git-ignored, the whole tree is walked, skipping only `.git` and `node_modules`. If git fails (for example, git is missing from `PATH` or the repository has dubious ownership), commands print one warning on stderr and walk the tree instead.
 
@@ -224,7 +227,7 @@ Exits 1 for an unknown id.
 
 ### `new <context>`
 
-Scaffolds the next free id of a context as a `proposed` rule and prints its path. Ids are never reused, and an existing file is never overwritten.
+Scaffolds the next free id of a context as a `proposed` rule and prints its path. Ids are never reused, and an existing file is never overwritten. The placeholder text of the new rule follows `language` in the config.
 
 ```sh
 $ rulebookguard new clients

package/dist/cli.mjs

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
-import { M as FormatError, N as formatIssue, _ as expandGlobs, a as CliError, c as openCatalog, d as scanTestTags, h as rulesForPath, l as writeJson, o as findRule, r as lintCommand, s as gitFallbackWarning, u as writeLines, y as toRepoPath } from "./lint-V-Uw5ueZ.mjs";
+import { M as FormatError, N as formatIssue, _ as expandGlobs, a as CliError, c as openCatalog, d as scanTestTags, h as rulesForPath, l as writeJson, o as findRule, r as lintCommand, s as gitFallbackWarning, u as writeLines, y as toRepoPath } from "./lint-DtD_Ekei.mjs";
 import { readdir, writeFile } from "node:fs/promises";
 import { isAbsolute, join, relative, resolve } from "node:path";
 import { parseArgs } from "node:util";
@@ -17,32 +17,51 @@ async function newCommand(catalog, io, name) {
 	const id = `R-${context.prefix}-${String(last + 1).padStart(3, "0")}`;
 	const file = `${directory}/${id}.md`;
 	try {
-		await writeFile(join(catalog.root, file), template(id, context.context), { flag: "wx" });
+		await writeFile(join(catalog.root, file), template(id, context.context, catalog.config.language ?? "en"), { flag: "wx" });
 	} catch (error) {
 		if (error.code === "EEXIST") throw new CliError(`${file} already exists; nothing was written.`);
 		throw error;
 	}
 	writeLines(io, [file]);
 }
-function template(id, context) {
+const TEMPLATE_TEXT = {
+	en: {
+		summary: "TODO: one-line summary of the rule.",
+		title: "TODO: rule title",
+		intro: "TODO: state the rule in full, then add examples as Gherkin scenarios or tables.",
+		scenario: `Scenario: TODO
+  Given TODO
+  When TODO
+  Then TODO`
+	},
+	es: {
+		summary: "TODO: resumen de la regla en una línea.",
+		title: "TODO: título de la regla",
+		intro: "TODO: describe la regla completa y agrega ejemplos como escenarios Gherkin o tablas.",
+		scenario: `# language: es
+Escenario: TODO
+  Dado TODO
+  Cuando TODO
+  Entonces TODO`
+	}
+};
+function template(id, context, language) {
+	const text = TEMPLATE_TEXT[language];
 	return `---
 id: ${id}
 context: ${context}
 entities: []
 status: proposed
 anchors: []
-summary: 'TODO: one-line summary of the rule.'
+summary: '${text.summary}'
 ---
 
-# TODO: rule title
+# ${text.title}
 
-TODO: state the rule in full, then add examples as Gherkin scenarios or tables.
+${text.intro}
 
 \`\`\`gherkin
-Scenario: TODO
-  Given TODO
-  When TODO
-  Then TODO
+${text.scenario}
 \`\`\`
 `;
 }

package/dist/index.d.mts

@@ -1,9 +1,12 @@
 type RuleStatus = "proposed" | "active" | "deprecated";
+type RuleLanguage = "en" | "es";
 interface RulebookConfig {
   schema: 1;
   rulesDir: string;
   testGlobs: string[];
   contextBudget: number;
+  /** Language the generated rule text is written in; `en` when unset. */
+  language?: RuleLanguage;
 }
 interface ContextFrontmatter {
   context: string;
@@ -146,4 +149,4 @@ interface LintOptions {
 export declare function lintCatalog(catalog: Catalog, tags?: TagIndex, onGitFallback?: GitFallbackListener): Promise<LintFinding[]>;
 export declare function pendingImplementation(catalog: Catalog, tags: TagIndex, base: string, changed: string[]): LintFinding[];
 export declare function formatFinding(finding: LintFinding): string;
-export type { Catalog, CatalogIssue, CatalogIssueCode, ContextDoc, ContextFrontmatter, ContextsJson, ForJson, FormatIssue, Frontmatter, GitFallbackListener, ImpactJson, LintFinding, LintJson, LintOptions, LintSeverity, ListJson, RuleDoc, RuleFrontmatter, RuleStatus, RuleSummaryJson, RuleTag, RulebookConfig, ShowJson, TagIndex, TagLocation };
+export type { Catalog, CatalogIssue, CatalogIssueCode, ContextDoc, ContextFrontmatter, ContextsJson, ForJson, FormatIssue, Frontmatter, GitFallbackListener, ImpactJson, LintFinding, LintJson, LintOptions, LintSeverity, ListJson, RuleDoc, RuleFrontmatter, RuleLanguage, RuleStatus, RuleSummaryJson, RuleTag, RulebookConfig, ShowJson, TagIndex, TagLocation };

package/dist/index.mjs

@@ -1 +1 @@
-export { k as CONFIG_FILE_NAME, T as CONTEXT_FILE_NAME, M as FormatError, b as RULE_TAG_PATTERN, g as createGlobMatcher, _ as expandGlobs, x as findRuleTags, f as findRulebookRoot, t as formatFinding, N as formatIssue, S as isRuleId, n as lintCatalog, v as listRepoFiles, p as loadCatalog, A as loadConfig, E as loadContext, C as loadRule, j as parseConfig, D as parseContext, w as parseRule, i as pendingImplementation, m as relativeToRoot, h as rulesForPath, d as scanTestTags, O as splitFrontmatter, y as toRepoPath } from "./lint-V-Uw5ueZ.mjs";
+export { k as CONFIG_FILE_NAME, T as CONTEXT_FILE_NAME, M as FormatError, b as RULE_TAG_PATTERN, g as createGlobMatcher, _ as expandGlobs, x as findRuleTags, f as findRulebookRoot, t as formatFinding, N as formatIssue, S as isRuleId, n as lintCatalog, v as listRepoFiles, p as loadCatalog, A as loadConfig, E as loadContext, C as loadRule, j as parseConfig, D as parseContext, w as parseRule, i as pendingImplementation, m as relativeToRoot, h as rulesForPath, d as scanTestTags, O as splitFrontmatter, y as toRepoPath } from "./lint-DtD_Ekei.mjs";

package/dist/{lint-V-Uw5ueZ.mjs → lint-DtD_Ekei.mjs}

@@ -52,7 +52,8 @@ var config_schema_default = {
 			"type": "integer",
 			"minimum": 1,
 			"default": 30
-		}
+		},
+		"language": { "enum": ["en", "es"] }
 	},
 	required: ["schema", "testGlobs"],
 	additionalProperties: false

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "rulebookguard",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "Keep business rules as the single source of truth, bound to code and tests.",
   "homepage": "https://github.com/JuanCJR/rulebookguard#readme",
   "bugs": {

package/schemas/v1/config.schema.json

@@ -7,7 +7,8 @@
     "schema": { "const": 1 },
     "rulesDir": { "type": "string", "minLength": 1, "default": "docs/rules" },
     "testGlobs": { "type": "array", "items": { "type": "string", "minLength": 1 } },
-    "contextBudget": { "type": "integer", "minimum": 1, "default": 30 }
+    "contextBudget": { "type": "integer", "minimum": 1, "default": 30 },
+    "language": { "enum": ["en", "es"] }
   },
   "required": ["schema", "testGlobs"],
   "additionalProperties": false