From 8e7350074ee44b48d30d7392ec81f38eddf23aaf Mon Sep 17 00:00:00 2001
From: Lev Chelyadinov <leva181777@gmail.com>
Date: Sun, 9 Jun 2024 19:35:47 +0200
Subject: [PATCH] Fix the formatting of file structures

---
 .../src/ambiguous-slice-names/README.md       | 54 ++++++-------
 .../src/excessive-slicing/README.md           | 80 +++++++++----------
 .../src/inconsistent-naming/README.md         | 28 +++----
 .../src/no-layer-public-api/README.md         | 52 ++++++------
 .../src/no-reserved-folder-names/README.md    | 48 +++++------
 .../src/no-segmentless-slices/README.md       | 46 +++++------
 .../src/public-api/README.md                  | 46 +++++------
 .../src/segments-by-purpose/README.md         | 24 +++---
 .../src/shared-lib-grouping/README.md         | 80 +++++++++----------
 9 files changed, 229 insertions(+), 229 deletions(-)

diff --git a/packages/steiger-plugin-fsd/src/ambiguous-slice-names/README.md b/packages/steiger-plugin-fsd/src/ambiguous-slice-names/README.md
index 75200fd..e9d767a 100644
--- a/packages/steiger-plugin-fsd/src/ambiguous-slice-names/README.md
+++ b/packages/steiger-plugin-fsd/src/ambiguous-slice-names/README.md
@@ -4,44 +4,44 @@ Forbid slice names that that match some segment’s name in the Shared layer. Fo
 
 Examples of project structures that pass this rule:
 
-```md
+```
 📂 shared
-📂 ui
-📄 index.ts
-📂 i18n
-📄 index.ts
+  📂 ui
+    📄 index.ts
+  📂 i18n
+    📄 index.ts
 📂 entities
-📂 user
-📂 ui
-📂 model
-📄 index.ts
+  📂 user
+    📂 ui
+    📂 model
+    📄 index.ts
 📂 pages
-📂 home
-📂 ui
-📄 index.ts
+  📂 home
+    📂 ui
+    📄 index.ts
 ```
 
 Examples of project structures that fail this rule:
 
-```md
+```
 📂 shared
-📂 ui
-📄 index.ts
-📂 i18n // ❗️
-📄 index.ts
+  📂 ui
+    📄 index.ts
+  📂 i18n // ❗️
+    📄 index.ts
 📂 entities
-📂 user
-📂 ui
-📂 model
-📄 index.ts
+  📂 user
+    📂 ui
+    📂 model
+    📄 index.ts
 📂 features
-📂 i18n // ❌
-📂 ui
-📄 index.ts
+  📂 i18n // ❌
+    📂 ui
+    📄 index.ts
 📂 pages
-📂 home
-📂 ui
-📄 index.ts
+  📂 home
+    📂 ui
+    📄 index.ts
 ```
 
 ## Rationale
diff --git a/packages/steiger-plugin-fsd/src/excessive-slicing/README.md b/packages/steiger-plugin-fsd/src/excessive-slicing/README.md
index bd2621c..a2c4fca 100644
--- a/packages/steiger-plugin-fsd/src/excessive-slicing/README.md
+++ b/packages/steiger-plugin-fsd/src/excessive-slicing/README.md
@@ -7,55 +7,55 @@ This rule forbids having too many ungrouped slices or too many slices in a group
 
 Example of a project structure that passes this rule:
 
-```md
+```
 📂 shared
-📂 ui
-📄 index.ts
-📂 i18n
-📄 index.ts
+  📂 ui
+    📄 index.ts
+  📂 i18n
+    📄 index.ts
 📂 entities
-📂 user
-📂 ui
-📂 model
-📄 index.ts
+  📂 user
+    📂 ui
+    📂 model
+    📄 index.ts
 📂 pages
-📂 home
-📂 ui
-📄 index.ts
+  📂 home
+    📂 ui
+    📄 index.ts
 ```
 
 (Cartoonish) Example of a project structure that fails this rule:
 
-```md
+```
 📂 shared
-📂 ui
-📄 index.ts
-📂 i18n
-📄 index.ts
+  📂 ui
+    📄 index.ts
+  📂 i18n
+    📄 index.ts
 📂 features // ❌
-📂 comments
-📂 posts
-📂 users
-📂 cars
-📂 alligators
-📂 whales
-📂 giraffes
-📂 buses
-📂 trains
-📂 planes
-📂 boats
-📂 submarines
-📂 helicopters
-📂 rockets
-📂 satellites
-📂 space-stations
-📂 planets
-📂 galaxies
-📂 universes
-📂 multiverses
-📂 metaverses
-📂 ai
-📂 bitcoin
+  📂 comments
+  📂 posts
+  📂 users
+  📂 cars
+  📂 alligators
+  📂 whales
+  📂 giraffes
+  📂 buses
+  📂 trains
+  📂 planes
+  📂 boats
+  📂 submarines
+  📂 helicopters
+  📂 rockets
+  📂 satellites
+  📂 space-stations
+  📂 planets
+  📂 galaxies
+  📂 universes
+  📂 multiverses
+  📂 metaverses
+  📂 ai
+  📂 bitcoin
 ```
 
 ## Rationale
diff --git a/packages/steiger-plugin-fsd/src/inconsistent-naming/README.md b/packages/steiger-plugin-fsd/src/inconsistent-naming/README.md
index 6f64fcb..07ff735 100644
--- a/packages/steiger-plugin-fsd/src/inconsistent-naming/README.md
+++ b/packages/steiger-plugin-fsd/src/inconsistent-naming/README.md
@@ -7,26 +7,26 @@ This rule ensures that all entities are named consistently in terms of pluraliza
 
 Example of a project structure that passes this rule:
 
-```md
+```
 📂 entities
-📂 users
-📂 ui
-📄 index.ts
-📂 posts
-📂 ui
-📄 index.ts
+  📂 users
+    📂 ui
+    📄 index.ts
+  📂 posts
+    📂 ui
+    📄 index.ts
 ```
 
 Example of a project structure that fails this rule:
 
-```md
+```
 📂 entities
-📂 users // ❗️
-📂 ui
-📄 index.ts
-📂 post // ❌
-📂 ui
-📄 index.ts
+  📂 users // ❗️
+    📂 ui
+    📄 index.ts
+  📂 post // ❌
+    📂 ui
+    📄 index.ts
 ```
 
 ## Rationale
diff --git a/packages/steiger-plugin-fsd/src/no-layer-public-api/README.md b/packages/steiger-plugin-fsd/src/no-layer-public-api/README.md
index d0841f1..5873550 100644
--- a/packages/steiger-plugin-fsd/src/no-layer-public-api/README.md
+++ b/packages/steiger-plugin-fsd/src/no-layer-public-api/README.md
@@ -13,42 +13,42 @@ A corollary to this rule is that the layer itself should not have an index file.
 
 Examples of project structures that pass this rule:
 
-```md
+```
 📂 shared
-📂 ui
-📄 index.ts
-📂 lib
-📄 index.ts
+  📂 ui
+    📄 index.ts
+  📂 lib
+    📄 index.ts
 📂 entities
-📂 user
-📂 ui
-📂 model
-📄 index.ts
+  📂 user
+    📂 ui
+    📂 model
+    📄 index.ts
 📂 pages
-📂 home
-📂 ui
-📄 index.ts
+  📂 home
+    📂 ui
+    📄 index.ts
 ```
 
 Examples of project structures that fail this rule:
 
-```md
+```
 📂 shared
-📂 ui
-📄 index.ts
-📄 index.ts // ❌
+  📂 ui
+    📄 index.ts
+  📄 index.ts // ❌
 📂 entities
-📂 user
-📂 ui
-📄 index.ts
+  📂 user
+    📂 ui
+    📄 index.ts
 📂 pages
-📂 home
-📂 ui
-📄 index.ts
-📂 editor
-📂 ui
-📄 index.ts
-📄 index.ts // ❌
+  📂 home
+    📂 ui
+    📄 index.ts
+  📂 editor
+    📂 ui
+    📄 index.ts
+  📄 index.ts // ❌
 ```
 
 ## Rationale
diff --git a/packages/steiger-plugin-fsd/src/no-reserved-folder-names/README.md b/packages/steiger-plugin-fsd/src/no-reserved-folder-names/README.md
index 03f3f27..eafc3ac 100644
--- a/packages/steiger-plugin-fsd/src/no-reserved-folder-names/README.md
+++ b/packages/steiger-plugin-fsd/src/no-reserved-folder-names/README.md
@@ -12,40 +12,40 @@ This rule forbids the following names:
 
 Examples of project structures that pass this rule:
 
-```md
+```
 📂 shared
-📂 ui
-📄 index.ts
-📂 lib
-📄 index.ts
+  📂 ui
+    📄 index.ts
+  📂 lib
+    📄 index.ts
 📂 entities
-📂 user
-📂 ui
-📂 model
-📄 index.ts
+  📂 user
+    📂 ui
+    📂 model
+    📄 index.ts
 📂 pages
-📂 home
-📂 ui
-📄 index.ts
+  📂 home
+    📂 ui
+    📄 index.ts
 ```
 
 Examples of project structures that fail this rule:
 
-```md
+```
 📂 shared
-📂 ui
-📄 index.ts
-📂 lib // ❌
-📄 someUiFunction.ts
+  📂 ui
+    📄 index.ts
+    📂 lib // ❌
+      📄 someUiFunction.ts
 📂 entities
-📂 user
-📂 ui
-📂 model
-📄 index.ts
+  📂 user
+    📂 ui
+    📂 model
+    📄 index.ts
 📂 pages
-📂 home
-📂 ui
-📄 index.ts
+  📂 home
+    📂 ui
+    📄 index.ts
 ```
 
 ## Rationale
diff --git a/packages/steiger-plugin-fsd/src/no-segmentless-slices/README.md b/packages/steiger-plugin-fsd/src/no-segmentless-slices/README.md
index 7f8cf46..1e02828 100644
--- a/packages/steiger-plugin-fsd/src/no-segmentless-slices/README.md
+++ b/packages/steiger-plugin-fsd/src/no-segmentless-slices/README.md
@@ -4,39 +4,39 @@ Forbid slices that don't have any segments.
 
 Examples of project structures that pass this rule:
 
-```md
+```
 📂 shared
-📂 ui
-📄 index.ts
-📂 lib
-📄 index.ts
+  📂 ui
+    📄 index.ts
+  📂 lib
+    📄 index.ts
 📂 entities
-📂 user
-📂 ui
-📂 model
-📄 index.ts
+  📂 user
+    📂 ui
+    📂 model
+    📄 index.ts
 📂 pages
-📂 home
-📂 ui
-📄 index.ts
+  📂 home
+    📂 ui
+    📄 index.ts
 ```
 
 Examples of project structures that fail this rule:
 
-```md
+```
 📂 shared
-📂 ui
-📄 index.ts
-📂 lib
-📄 index.ts
+  📂 ui
+    📄 index.ts
+  📂 lib
+    📄 index.ts
 📂 entities
-📂 user
-📂 ui
-📂 model
-📄 index.ts
+  📂 user
+    📂 ui
+    📂 model
+    📄 index.ts
 📂 pages
-📂 home // ❌
-📄 HomePage.tsx
+  📂 home  // ❌
+    📄 HomePage.tsx
 ```
 
 ## Rationale
diff --git a/packages/steiger-plugin-fsd/src/public-api/README.md b/packages/steiger-plugin-fsd/src/public-api/README.md
index 89a6c9d..fa0659b 100644
--- a/packages/steiger-plugin-fsd/src/public-api/README.md
+++ b/packages/steiger-plugin-fsd/src/public-api/README.md
@@ -11,39 +11,39 @@ According to the _public API rule on slices_:
 
 Examples of project structures that pass this rule:
 
-```md
+```
 📂 shared
-📂 ui
-📄 index.ts
-📂 lib
-📄 index.ts
+  📂 ui
+    📄 index.ts
+  📂 lib
+    📄 index.ts
 📂 entities
-📂 user
-📂 ui
-📂 model
-📄 index.ts
+  📂 user
+    📂 ui
+    📂 model
+    📄 index.ts
 📂 pages
-📂 home
-📂 ui
-📄 index.ts
+  📂 home
+    📂 ui
+    📄 index.ts
 ```
 
 Examples of project structures that fail this rule:
 
-```md
+```
 📂 shared
-📂 ui // ❌
-📄 Button.tsx
-📂 lib
-📄 index.ts
+  📂 ui  // ❌
+    📄 Button.tsx
+  📂 lib
+    📄 index.ts
 📂 entities
-📂 user // ❌
-📂 ui
-📂 model
+  📂 user  // ❌
+    📂 ui
+    📂 model
 📂 pages
-📂 home
-📂 ui
-📄 index.ts
+  📂 home
+    📂 ui
+    📄 index.ts
 ```
 
 ## Rationale
diff --git a/packages/steiger-plugin-fsd/src/segments-by-purpose/README.md b/packages/steiger-plugin-fsd/src/segments-by-purpose/README.md
index 1adc103..14f9786 100644
--- a/packages/steiger-plugin-fsd/src/segments-by-purpose/README.md
+++ b/packages/steiger-plugin-fsd/src/segments-by-purpose/README.md
@@ -12,21 +12,21 @@ To pass this rule, avoid using the following segment names:
 
 Examples of project structures that pass this rule:
 
-```md
+```
 📂 shared
-📂 ui
-📄 index.ts
-📂 lib
-📄 index.ts
+  📂 ui
+    📄 index.ts
+  📂 lib
+    📄 index.ts
 📂 entities
-📂 user
-📂 ui
-📂 model
-📄 index.ts
+  📂 user
+    📂 ui
+    📂 model
+    📄 index.ts
 📂 pages
-📂 home
-📂 ui
-📄 index.ts
+  📂 home
+    📂 ui
+    📄 index.ts
 ```
 
 Examples of project structures that fail this rule:
diff --git a/packages/steiger-plugin-fsd/src/shared-lib-grouping/README.md b/packages/steiger-plugin-fsd/src/shared-lib-grouping/README.md
index bfac951..9f747a0 100644
--- a/packages/steiger-plugin-fsd/src/shared-lib-grouping/README.md
+++ b/packages/steiger-plugin-fsd/src/shared-lib-grouping/README.md
@@ -7,18 +7,18 @@ This rule forbids having too many ungrouped modules in `shared/lib`.
 
 Examples of project structures that pass this rule:
 
-```md
+```
 📂 entities
-📂 users
-📂 ui
-📄 index.ts
-📂 posts
-📂 ui
-📄 index.ts
+  📂 users
+    📂 ui
+    📄 index.ts
+  📂 posts
+    📂 ui
+    📄 index.ts
 📂 shared
-📂 ui
-📄 index.ts
-📄 Button.tsx
+  📂 ui
+    📄 index.ts
+    📄 Button.tsx
 ```
 
 ```
@@ -41,38 +41,38 @@ Examples of project structures that pass this rule:
 
 (Cartoonish) Example of a project structure that fails this rule:
 
-```md
+```
 📂 entities
-📂 users
-📂 ui
-📄 index.ts
-📂 posts
-📂 ui
-📄 index.ts
+  📂 users
+    📂 ui
+    📄 index.ts
+  📂 posts
+    📂 ui
+    📄 index.ts
 📂 shared
-📂 ui
-📄 index.ts
-📄 Button.tsx
-📂 lib // ❌
-📄 index.ts
-📄 dates.ts
-📄 collections.ts
-📄 utils.ts
-📄 helpers.ts
-📄 constants.ts
-📄 types.ts
-📄 api.ts
-📄 hooks.ts
-📄 selectors.ts
-📄 actions.ts
-📄 reducers.ts
-📄 sagas.ts
-📄 middleware.ts
-📄 components.ts
-📄 hell.ts
-📄 is.ts
-📄 other.ts
-📄 people.ts
+  📂 ui
+    📄 index.ts
+    📄 Button.tsx
+  📂 lib  // ❌
+    📄 index.ts
+    📄 dates.ts
+    📄 collections.ts
+    📄 utils.ts
+    📄 helpers.ts
+    📄 constants.ts
+    📄 types.ts
+    📄 api.ts
+    📄 hooks.ts
+    📄 selectors.ts
+    📄 actions.ts
+    📄 reducers.ts
+    📄 sagas.ts
+    📄 middleware.ts
+    📄 components.ts
+    📄 hell.ts
+    📄 is.ts
+    📄 other.ts
+    📄 people.ts
 ```
 
 ## Rationale