Skip to content

Commit

Permalink
Fix the formatting of file structures
Browse files Browse the repository at this point in the history
  • Loading branch information
illright committed Jun 9, 2024
1 parent 79b39cf commit 8e73500
Show file tree
Hide file tree
Showing 9 changed files with 229 additions and 229 deletions.
54 changes: 27 additions & 27 deletions packages/steiger-plugin-fsd/src/ambiguous-slice-names/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
80 changes: 40 additions & 40 deletions packages/steiger-plugin-fsd/src/excessive-slicing/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
28 changes: 14 additions & 14 deletions packages/steiger-plugin-fsd/src/inconsistent-naming/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
52 changes: 26 additions & 26 deletions packages/steiger-plugin-fsd/src/no-layer-public-api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
48 changes: 24 additions & 24 deletions packages/steiger-plugin-fsd/src/no-reserved-folder-names/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading

0 comments on commit 8e73500

Please sign in to comment.