Filter out uncountable nouns in inconsistent-naming (#195)

Author: illright

.changeset/clever-ways-rescue.md

@@ -0,0 +1,5 @@
+---
+'@feature-sliced/steiger-plugin': patch
+---
+
+Filter out uncountable nouns in `inconsistent-naming`

integration-tests/tests/__snapshots__/smoke-stderr-posix.txt

@@ -4,9 +4,8 @@
 │
 └ fsd/forbidden-imports: https://github.com/feature-sliced/steiger/tree/master/packages/steiger-plugin-fsd/src/forbidden-imports
 
-┌ src/entities
-✘ Inconsistent pluralization of slice names. Prefer all plural names
-✔ Auto-fixable
+┌ src/entities/user
+✘ Avoid having both "user" and "users" entities.
 │
 └ fsd/inconsistent-naming: https://github.com/feature-sliced/steiger/tree/master/packages/steiger-plugin-fsd/src/inconsistent-naming
 
@@ -40,6 +39,6 @@
 │
 └ fsd/no-processes: https://github.com/feature-sliced/steiger/tree/master/packages/steiger-plugin-fsd/src/no-processes
 
-────────────────────────────────────────────────────────
- Found 8 errors (1 can be fixed automatically with --fix)
-
+────────────────────────────────────────────────
+ Found 8 errors (none can be fixed automatically)
+ 

integration-tests/tests/__snapshots__/smoke-stderr-windows.txt

@@ -4,9 +4,8 @@
 │
 └ fsd/forbidden-imports: https://github.com/feature-sliced/steiger/tree/master/packages/steiger-plugin-fsd/src/forbidden-imports
 
-┌ src\entities
-× Inconsistent pluralization of slice names. Prefer all plural names
-√ Auto-fixable
+┌ src\entities\user
+× Avoid having both "user" and "users" entities.
 │
 └ fsd/inconsistent-naming: https://github.com/feature-sliced/steiger/tree/master/packages/steiger-plugin-fsd/src/inconsistent-naming
 
@@ -40,6 +39,6 @@
 │
 └ fsd/no-processes: https://github.com/feature-sliced/steiger/tree/master/packages/steiger-plugin-fsd/src/no-processes
 
-────────────────────────────────────────────────────────
- Found 8 errors (1 can be fixed automatically with --fix)
-
+────────────────────────────────────────────────
+ Found 8 errors (none can be fixed automatically)
+ 

packages/pretty-reporter/package.json

@@ -37,7 +37,8 @@
     "eslint": "^9.18.0",
     "prettier": "^3.4.2",
     "tsx": "^4.19.2",
-    "typescript": "^5.7.3"
+    "typescript": "^5.7.3",
+    "vitest": "^3.0.2"
   },
   "dependencies": {
     "figures": "^6.1.0",

packages/steiger-plugin-fsd/src/inconsistent-naming/README.md

@@ -2,8 +2,13 @@
 
 This rule ensures that all entities are named consistently in terms of pluralization.
 
-> [!WARNING]
-> This rule is in early development. It currently assumes that the slice name is a single English word. In the future it will be able to understand more complex names like `images-of-cats`.
+For names that consist of multiple words, the pluralization of the main subject is considered. For example:
+
+- in `a book with pages`, the main subject is `book`, singular
+- in `admin-users`, the main subject is `users`, plural
+- in `receiptsByOrder`, the main subject is `receipts`, plural
+
+Uncountable nouns like "firmware" are not counted as either singular or plural.
 
 Example of a project structure that passes this rule:
 

packages/steiger-plugin-fsd/src/inconsistent-naming/index.spec.ts

@@ -157,3 +157,24 @@ it('allows inconsistency between different slice groups', () => {
   const diagnostics = inconsistentNaming.check(root).diagnostics
   expect(diagnostics).toEqual([])
 })
+
+it('does not consider uncountable words as plural', () => {
+  const root = parseIntoFsdRoot(
+    `
+    📂 entities
+      📂 user
+        📂 ui
+        📄 index.ts
+      📂 firmware
+        📂 ui
+        📄 index.ts
+      📂 hardware
+        📂 ui
+        📄 index.ts
+  `,
+    joinFromRoot('users', 'user', 'project', 'src'),
+  )
+
+  const diagnostics = inconsistentNaming.check(root).diagnostics
+  expect(diagnostics).toEqual([])
+})

packages/steiger-plugin-fsd/src/inconsistent-naming/index.ts

@@ -24,7 +24,9 @@ const inconsistentNaming = {
     const sliceNames = groupSlices(Object.keys(slices))
     for (const [groupPrefix, group] of Object.entries(sliceNames)) {
       const [pluralNames, singularNames] = partition(
-        group.map((name) => [name, getMainSubject(name)] as const),
+        group
+          .map((name) => [name, getMainSubject(name)] as const)
+          .filter(([, mainSubject]) => !isUncountable(mainSubject)),
         ([, mainSubject]) => isPlural(mainSubject),
       )
 
@@ -81,4 +83,8 @@ const inconsistentNaming = {
   },
 } satisfies Rule
 
+function isUncountable(word: string) {
+  return singular(word) === plural(word)
+}
+
 export default inconsistentNaming