From 0bd7f1a024016aaca8b881cb7710b0435a2d17c3 Mon Sep 17 00:00:00 2001 From: Igor Kowalski Date: Thu, 15 Aug 2024 11:08:55 +0200 Subject: [PATCH] Update documentation --- README.md | 4 ++-- documentation/migration-to-2.1.0.md | 4 ++-- documentation/project-structure-naming-rules.md | 6 +++--- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index b333839..9b3ffe2 100644 --- a/README.md +++ b/README.md @@ -60,9 +60,9 @@ Enforce complex naming rules. #### Features: ✅ Naming validation.
-✅ Support for classes, types, interfaces, enums, variables, functions, arrow function.
+✅ Supported name types: Classes, types, interfaces, enums, variables, functions, arrow function.
✅ Naming rules only for name types located in the root of the file (not nested).
-✅ Naming rules only for exported name types (export, export default).
+✅ Naming rules only for exported name types.
✅ Inheriting the file name as the name. Option of adding your own prefixes/suffixes, changing the case or deleting parts of a file name.
✅ Enforcing a maximum of one main function/class per file.
✅ Different name rules for different files.
diff --git a/documentation/migration-to-2.1.0.md b/documentation/migration-to-2.1.0.md index 752cc8d..ccf828b 100644 --- a/documentation/migration-to-2.1.0.md +++ b/documentation/migration-to-2.1.0.md @@ -202,9 +202,9 @@ Enforce complex naming rules. #### Features: ✅ Naming validation.
-✅ Support for classes, types, interfaces, enums, variables, functions, arrow function.
+✅ Supported name types: Classes, types, interfaces, enums, variables, functions, arrow function.
✅ Naming rules only for name types located in the root of the file (not nested).
-✅ Naming rules only for exported name types (export, export default).
+✅ Naming rules only for exported name types.
✅ Inheriting the file name as the name. Option of adding your own prefixes/suffixes, changing the case or deleting parts of a file name.
✅ Enforcing a maximum of one main function/class per file.
✅ Different name rules for different files.
diff --git a/documentation/project-structure-naming-rules.md b/documentation/project-structure-naming-rules.md index 020d8fd..8959d3c 100644 --- a/documentation/project-structure-naming-rules.md +++ b/documentation/project-structure-naming-rules.md @@ -5,9 +5,9 @@ Enforce complex naming rules. #### Features: ✅ Naming validation.
-✅ Support for classes, types, interfaces, enums, variables, functions, arrow function.
+✅ Supported name types: Classes, types, interfaces, enums, variables, functions, arrow function.
✅ Naming rules only for name types located in the root of the file (not nested).
-✅ Naming rules only for exported name types (export, export default).
+✅ Naming rules only for exported name types.
✅ Inheriting the file name as the name. Option of adding your own prefixes/suffixes, changing the case or deleting parts of a file name.
✅ Enforcing a maximum of one main function/class per file.
✅ Different name rules for different files.
@@ -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.