chaffjs 0.22.0 → 0.23.0

package/src/style-parse.ts

@@ -1,5 +1,8 @@
 import { isLevel } from "./levels.ts";
 import type { Level, Localized } from "./plugin.ts";
+import { guideLayerOf, type GuideLayer } from "./genre-guide/layer.ts";
+import { guideProblemText } from "./genre-guide/problem-text.ts";
+import { knownGenres } from "./known-genres.ts";
 
 // A house style (styles/*.yaml): a well-known guideline a team picks with style: in chaff.yaml. It sets rule levels and
 // options, and says where they come from. Pure: the YAML comes in already parsed.
@@ -21,6 +24,8 @@ export type StyleDefinition = {
   readonly options: Readonly<Record<string, Readonly<Record<string, unknown>>>>;
   /** The numbers the guideline sets, by language. The rule needs a level under rules too, or the limit decides nothing. */
   readonly limits: StyleLimits;
+  /** Its changes to the genre guides (genre-guide/layer.ts), between a rule pack's and chaff.yaml's. */
+  readonly guide?: GuideLayer | undefined;
 };
 
 const isRecord = (value: unknown): value is Record<string, unknown> => typeof value === "object" && value !== null && !Array.isArray(value);
@@ -85,6 +90,15 @@ const limitsOf = (value: unknown, rules: Readonly<Record<string, Level>>, where:
   );
 };
 
+/** The style's guide: as a layer named after the style. undefined when it writes none. */
+const guideOf = (value: unknown, id: string, where: string): GuideLayer | undefined => {
+  if (value === undefined) return undefined;
+  const read = guideLayerOf(value, `style: ${id}`, knownGenres());
+  const [problem] = read.problems;
+  if (problem !== undefined) throw new Error(`${where}: ${guideProblemText(problem, "en")}`);
+  return read.layer;
+};
+
 /** One style file. Throws on anything it cannot read: the file ships with chaff, so a wrong entry is chaff's bug. */
 export const parseStyle = (raw: unknown, file: string): StyleDefinition => {
   const id = isRecord(raw) ? raw["id"] : undefined;
@@ -99,7 +113,10 @@ export const styleOf = (raw: unknown, where: string): StyleDefinition => {
   if (typeof id !== "string" || id === "") throw new Error(`${where}: a style needs an id`);
   const rules = levelsOf(raw["rules"], where);
   const options = optionsOf(raw["options"], where);
-  if (Object.keys(rules).length === 0 && Object.keys(options).length === 0) throw new Error(`${where}: a style must set rules or options`);
+  const guide = guideOf(raw["guide"], id, where);
+  if (Object.keys(rules).length === 0 && Object.keys(options).length === 0 && guide === undefined) {
+    throw new Error(`${where}: a style must set rules, options or guide`);
+  }
   return {
     id,
     name: localizedOf(raw["name"], "name", where),
@@ -108,5 +125,6 @@ export const styleOf = (raw: unknown, where: string): StyleDefinition => {
     rules,
     options,
     limits: limitsOf(raw["limits"], rules, where),
+    ...(guide === undefined ? {} : { guide }),
   };
 };