@grailwind/eslint-plugin 0.1.0-beta.1 → 0.1.0-beta.3

package/README.md

@@ -13,7 +13,7 @@ npm install --save-dev @grailwind/eslint-plugin@beta
 ```
 
 It reads the tinctures, ordinaries and charges from your installed `grailwind`, so it needs
-`grailwind` 0.5.x. For typos and other class errors, see
+`grailwind` 0.7.x. For typos and other class errors, see
 [Linting](https://github.com/pafirmin/grailwind#linting) in the Grailwind README.
 
 ## Setup
@@ -57,8 +57,8 @@ export default [
 No metal (`or`, `argent`) on metal, and no colour on colour.
 
 - An ordinary, chief or bordure is checked against the field on the same element:
-  `escutcheon or fess-argent` is metal on metal. So are engrailed and invected ones
-  (`fess-engrailed-argent`).
+  `escutcheon or fess-argent` is metal on metal. So are engrailed, invected and voided ones
+  (`fess-engrailed-argent`, `cross-voided-argent`).
 - A fimbriated ordinary is checked against its fimbriation, and the fimbriation against the
   field: `or chevron-sable fimbriated-argent` is metal on metal (Argent on Or).
 - Charges in a `charges` container are checked against the field.
@@ -104,7 +104,7 @@ one, other than a chief, they have nowhere to go.
 An element draws one ordinary plus, optionally, a chief. With two, such as
 `fess-azure chevron-gules`, only one shows. Two chiefs are flagged too. A `charges` container
 takes one arrangement: `between`, `on`, `in-pale`, `in-fess`, `in-bend` or `in-bend-sinister`.
-Counterchanged, engrailed, invected and fur ordinaries count as ordinaries.
+Counterchanged, engrailed, invected, voided and fur ordinaries count as ordinaries.
 
 A charge at a named point (`in-dexter-chief` and so on) is a separate group in the blazon, so it
 goes in its own `charges` container. Among other charges, it still counts towards their number
@@ -119,8 +119,8 @@ Modifiers that would otherwise do nothing:
   element, e.g. `per-pale-argent-gules`.
 - `counterchanged` on `charges`, or on a charge, needs a divided field on the shield that holds
   the container.
-- `fimbriated-*` needs a plain tinctured ordinary. A chief, and an engrailed, invected, fur or
-  counterchanged ordinary, aren't fimbriated.
+- `fimbriated-*` needs a plain tinctured ordinary. A chief, and an engrailed, invected, voided,
+  fur or counterchanged ordinary, aren't fimbriated.
 - `counterchanged` doesn't work on a charge with a transform (`rotate-*`, `scale-*`, `skew-*`,
   `translate-*`): the charge shows its own small copy of the field instead.
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grailwind/eslint-plugin",
-  "version": "0.1.0-beta.1",
+  "version": "0.1.0-beta.3",
   "description": "ESLint rules for Grailwind heraldry markup: the rule of tincture and charge structure",
   "type": "module",
   "main": "./src/index.js",
@@ -26,7 +26,7 @@
   "peerDependencies": {
     "@html-eslint/parser": "*",
     "eslint": "^9.0.0 || ^10.0.0",
-    "grailwind": "^0.5.0"
+    "grailwind": "^0.7.0"
   },
   "peerDependenciesMeta": {
     "@html-eslint/parser": {

package/src/blazon.js

@@ -15,6 +15,7 @@ import {
   POINTS,
   ROUNDELS,
   TINCTURES,
+  VOIDABLE,
 } from "grailwind/data";
 
 const METAL = new Set(METALS);
@@ -47,6 +48,23 @@ for (const ordinary of ORDINARIES) {
     counterchanged: true,
   });
 }
+for (const ordinary of VOIDABLE) {
+  for (const tincture of PAINT) {
+    const fur = FUR.has(tincture);
+    ORDINARY_CLASSES.set(`${ordinary}-voided-${tincture}`, {
+      ordinary,
+      tincture,
+      fur,
+      voided: true,
+    });
+  }
+  ORDINARY_CLASSES.set(`${ordinary}-voided-counterchanged`, {
+    ordinary,
+    tincture: null,
+    counterchanged: true,
+    voided: true,
+  });
+}
 for (const tincture of [...TINCTURES, OF_THE_FIRST]) {
   ORDINARY_CLASSES.set(`bordure-${tincture}`, { ordinary: "bordure", tincture });
 }
@@ -64,7 +82,7 @@ for (const division of DIVISIONS) {
 }
 
 // Only a plain, tinctured ordinary is fimbriated (see ordinaries.js).
-export const isFimbriable = (o) => !o.counterchanged && !o.line && !o.fur;
+export const isFimbriable = (o) => !o.counterchanged && !o.line && !o.fur && !o.voided;
 
 export const isFur = (tincture) => FUR.has(tincture);
 

package/src/rules/rule-of-tincture.js

@@ -23,7 +23,8 @@ const article = (thing) => (/^[aeiou]/.test(thing) ? `an ${thing}` : `a ${thing}
 const KINDS = ["metal", "colour", "exempt"];
 
 // e.g. "fess engrailed", as blazoned.
-const name = ({ ordinary, line }) => describe(line ? `${ordinary} ${line}` : ordinary);
+const name = ({ ordinary, line, voided }) =>
+  describe([ordinary, line, voided && "voided"].filter(Boolean).join(" "));
 
 // e.g. " (ermine counts as a metal)", or " (ermine and erminois count as metals)".
 const furNote = (tinctures, kind) => {