Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Igorkowalski94 committed Aug 15, 2024
1 parent 255acd9 commit 0bd7f1a
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,9 @@ Enforce complex naming rules.
#### Features:

✅ Naming validation. <br>
Support for classes, types, interfaces, enums, variables, functions, arrow function.<br>
Supported name types: Classes, types, interfaces, enums, variables, functions, arrow function.<br>
✅ Naming rules only for name types located in the root of the file (not nested).<br>
✅ Naming rules only for exported name types (export, export default).<br>
✅ Naming rules only for exported name types.<br>
✅ Inheriting the file name as the name. Option of adding your own prefixes/suffixes, changing the case or deleting parts of a file name.<br>
✅ Enforcing a maximum of one main function/class per file.<br>
✅ Different name rules for different files.<br>
Expand Down
4 changes: 2 additions & 2 deletions documentation/migration-to-2.1.0.md
Original file line number Diff line number Diff line change
Expand Up @@ -202,9 +202,9 @@ Enforce complex naming rules.
#### Features:

✅ Naming validation. <br>
Support for classes, types, interfaces, enums, variables, functions, arrow function.<br>
Supported name types: Classes, types, interfaces, enums, variables, functions, arrow function.<br>
✅ Naming rules only for name types located in the root of the file (not nested).<br>
✅ Naming rules only for exported name types (export, export default).<br>
✅ Naming rules only for exported name types.<br>
✅ Inheriting the file name as the name. Option of adding your own prefixes/suffixes, changing the case or deleting parts of a file name.<br>
✅ Enforcing a maximum of one main function/class per file.<br>
✅ Different name rules for different files.<br>
Expand Down
6 changes: 3 additions & 3 deletions documentation/project-structure-naming-rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@ Enforce complex naming rules.
#### Features:

✅ Naming validation. <br>
Support for classes, types, interfaces, enums, variables, functions, arrow function.<br>
Supported name types: Classes, types, interfaces, enums, variables, functions, arrow function.<br>
✅ Naming rules only for name types located in the root of the file (not nested).<br>
✅ Naming rules only for exported name types (export, export default).<br>
✅ Naming rules only for exported name types.<br>
✅ Inheriting the file name as the name. Option of adding your own prefixes/suffixes, changing the case or deleting parts of a file name.<br>
✅ Enforcing a maximum of one main function/class per file.<br>
✅ Different name rules for different files.<br>
Expand Down Expand Up @@ -107,7 +107,7 @@ import { createNamingRules } from "eslint-plugin-project-structure";

export const namingRulesConfig = createNamingRules([
{
filePattern: "**/*consts.ts", // Name rules for all files ending with .const.ts.
filePattern: "**/*.consts.ts", // Name rules for all files ending with .const.ts.
rules: [
{
// nameTypes we are interested in.
Expand Down

0 comments on commit 0bd7f1a

Please sign in to comment.