@enhance-eng/archangel 0.2.0 → 0.3.0

package/archangel.schema.json

@@ -695,9 +695,12 @@
                   },
                   {
                     "$ref": "#/definitions/namePattern"
+                  },
+                  {
+                    "$ref": "#/definitions/nameList"
                   }
                 ],
-                "description": "A style that the name, up to the first dot, must be in, or a name pattern that the full name, without the last extension, must match."
+                "description": "A style that the name, up to the first dot, must be in, or a name pattern that the full name, without the last extension, must match, or a list of them, of which one must match."
               }
             }
           },
@@ -753,9 +756,12 @@
                   },
                   {
                     "$ref": "#/definitions/namePattern"
+                  },
+                  {
+                    "$ref": "#/definitions/nameList"
                   }
                 ],
-                "description": "A style that each folder's name must be in, or a name pattern that it must match, which may use `{FolderName}` for the folder that holds it."
+                "description": "A style that each folder's name must be in, or a name pattern that it must match, which may use `{FolderName}` for the folder that holds it, or a list of them, of which one must match."
               }
             }
           },
@@ -1433,7 +1439,22 @@
     "namePattern": {
       "type": "string",
       "minLength": 1,
-      "description": "A name: text, `*` for any text, and `{FileName}`, `{fileName}`, `{file-name}`, `{file_name}` or `{FILE_NAME}` for the file's name in each style, or the same spellings of `{FolderName}` for the name of the folder that holds it."
+      "description": "A name: text, `*` for any text or no text, and `{FileName}`, `{fileName}`, `{file-name}`, `{file_name}` or `{FILE_NAME}` for the file's name in each style, or the same spellings of `{FolderName}` for the name of the folder that holds it."
+    },
+    "nameList": {
+      "type": "array",
+      "minItems": 1,
+      "items": {
+        "anyOf": [
+          {
+            "$ref": "#/definitions/style"
+          },
+          {
+            "$ref": "#/definitions/namePattern"
+          }
+        ]
+      },
+      "description": "The names that a `mustBeNamed` rule permits. One entry must match."
     }
   },
   "anyOf": [

package/index.d.ts

@@ -177,12 +177,15 @@ export interface ImportLimits {
 export type NameStyle = 'kebab-case' | 'camelCase' | 'PascalCase' | 'snake_case' | 'SCREAMING_SNAKE_CASE';
 
 /**
- * A name: text, `*` for any text, and `{FileName}`, `{fileName}`, `{file-name}`, `{file_name}` or
+ * A name: text, `*` for any text or no text, and `{FileName}`, `{fileName}`, `{file-name}`, `{file_name}` or
  * `{FILE_NAME}` for the file's name in each style, or the same spellings of `{FolderName}` for the
  * name of the folder that holds it.
  */
 export type NamePattern = string;
 
+/** One name that a `mustBeNamed` rule permits: a style or a name pattern. */
+export type NameEntry = NameStyle | (NamePattern & {});
+
 type Conditions<Other> = {
   /** The files may not import the other side. */
   readonly mayNotImport: Other;
@@ -192,9 +195,9 @@ type Conditions<Other> = {
   readonly mayOnlyBeImportedBy: Other;
   /**
    * The name, up to the first dot, is in a style, or the full name, without the last extension,
-   * matches a name pattern.
+   * matches a name pattern. In a list, one entry must match.
    */
-  readonly mustBeNamed: NameStyle | (NamePattern & {});
+  readonly mustBeNamed: NameEntry | readonly [NameEntry, ...NameEntry[]];
   /**
    * Each instance of `files`, an element with a capture, has a file that matches the pattern, or
    * one of the patterns.
@@ -311,6 +314,16 @@ export type ConditionName<P extends Plugins> = {
     : never;
 }[Extract<keyof P, string>];
 
+/** The conditions of the `fsd` preset, which a config that extends it can use with its own files. */
+export type FsdConditionName = `fsd/${
+  | 'typo-in-layer-name'
+  | 'ambiguous-slice-names'
+  | 'inconsistent-naming'
+  | 'insignificant-slice'
+  | 'repetitive-naming'
+  | 'excessive-slicing'
+  | 'shared-lib-grouping'}`;
+
 /** A rule that uses a plugin's condition, whose options the condition's schema checks. */
 export type PluginRule<E extends Elements, S extends Selectors, P extends Plugins> = Omit<
   CommonOptions,
@@ -320,7 +333,7 @@ export type PluginRule<E extends Elements, S extends Selectors, P extends Plugin
   /** The files whose records the condition sees. */
   readonly files: Files<E, S>;
   /** The condition, as `<plugin>/<condition>`. */
-  readonly plugin: NoInfer<ConditionName<P>>;
+  readonly plugin: NoInfer<ConditionName<P>> | FsdConditionName;
   /** The options, which the condition's JSON Schema checks when the config loads. */
   readonly options?: unknown;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@enhance-eng/archangel",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Make architecture verifiable. Architecture tests for TypeScript, checked in milliseconds: imports, cycles, names, folder structure and exports.",
   "keywords": [
     "architecture",
@@ -53,13 +53,13 @@
     "pluralize": "8.0.0"
   },
   "optionalDependencies": {
-    "@enhance-eng/archangel-darwin-arm64": "0.2.0",
-    "@enhance-eng/archangel-darwin-x64": "0.2.0",
-    "@enhance-eng/archangel-linux-arm64-gnu": "0.2.0",
-    "@enhance-eng/archangel-linux-arm64-musl": "0.2.0",
-    "@enhance-eng/archangel-linux-x64-gnu": "0.2.0",
-    "@enhance-eng/archangel-linux-x64-musl": "0.2.0",
-    "@enhance-eng/archangel-win32-x64": "0.2.0"
+    "@enhance-eng/archangel-darwin-arm64": "0.3.0",
+    "@enhance-eng/archangel-darwin-x64": "0.3.0",
+    "@enhance-eng/archangel-linux-arm64-gnu": "0.3.0",
+    "@enhance-eng/archangel-linux-arm64-musl": "0.3.0",
+    "@enhance-eng/archangel-linux-x64-gnu": "0.3.0",
+    "@enhance-eng/archangel-linux-x64-musl": "0.3.0",
+    "@enhance-eng/archangel-win32-x64": "0.3.0"
   },
   "tsd": {
     "compilerOptions": {