diff --git a/README.md b/README.md index 167b74e..84fd039 100644 --- a/README.md +++ b/README.md @@ -118,24 +118,23 @@ Currently, Steiger is not extendable with more rules, though that will change in - ambiguous-slice-names Forbid slice names that that match some segment’s name in the Shared layer. - excessive-slicing Forbid having too many ungrouped slices or too many slices in a group. - forbidden-imports Forbid imports from higher layers and cross-imports between slices on the same layer. - inconsistent-naming Ensure that all entities are named consistently in terms of pluralization. - insignificant-slice Detect slices that have just one reference or no references to them at all. - no-layer-public-api Forbid index files on the layer level. - no-public-api-sidestep Forbid going around the public API of a slice to import directly from an internal module in a slice. - no-reserved-folder-names Forbid subfolders in segments that have the same name as other conventional segments. - no-segmentless-slices Forbid slices that don't have any segments. - no-segments-on-sliced-layers Forbid segments (like ui, lib, api ...) that appear directly in sliced layer folders (entities, features, ...) - no-ui-in-app Forbid having the ui segment on the App layer. - public-api Require slices (and segments on sliceless layers like Shared) to have a public API definition. - repetitive-naming Ensure that all entities are named consistently in terms of pluralization. - segments-by-purpose Discourage the use of segment names that group code by its essence, and instead encourage grouping by purpose - shared-lib-grouping Forbid having too many ungrouped modules in shared/lib. - typo-in-layer-name Ensure that all layers are named without any typos. - no-processes Discourage the use of the deprecated Processes layer. - import-locality Require that imports from the same slice be relative and imports from one slice to another be absolute. + fsd/ambiguous-slice-names Forbid slice names that that match some segment’s name in the Shared layer. + fsd/excessive-slicing Forbid having too many ungrouped slices or too many slices in a group. + fsd/forbidden-imports Forbid imports from higher layers and cross-imports between slices on the same layer. + fsd/inconsistent-naming Ensure that all entities are named consistently in terms of pluralization. + fsd/insignificant-slice Detect slices that have just one reference or no references to them at all. + fsd/no-layer-public-api Forbid index files on the layer level. + fsd/no-public-api-sidestep Forbid going around the public API of a slice to import directly from an internal module in a slice. + fsd/no-reserved-folder-names Forbid subfolders in segments that have the same name as other conventional segments. + fsd/no-segmentless-slices Forbid slices that don't have any segments. + fsd/no-segments-on-sliced-layers Forbid segments (like ui, lib, api ...) that appear directly in sliced layer folders (entities, features, ...) + fsd/no-ui-in-app Forbid having the ui segment on the App layer. + fsd/public-api Require slices (and segments on sliceless layers like Shared) to have a public API definition. + fsd/repetitive-naming Ensure that all entities are named consistently in terms of pluralization. + fsd/segments-by-purpose Discourage the use of segment names that group code by its essence, and instead encourage grouping by purpose + fsd/shared-lib-grouping Forbid having too many ungrouped modules in shared/lib. + fsd/typo-in-layer-name Ensure that all layers are named without any typos. + fsd/no-processes Discourage the use of the deprecated Processes layer.