fix: update README.md

lisilinhart · Aug 25, 2024 · 5597cfe · 5597cfe
1 parent 46f7357
commit 5597cfe
Show file tree

Hide file tree

Showing 9 changed files with 26 additions and 18 deletions.
diff --git a/.eslint-doc-generatorrc.json b/.eslint-doc-generatorrc.json
@@ -0,0 +1,6 @@
+{
+  "configEmoji": [
+    ["recommended-flat", "✅"],
+    ["all-flat", "🌐"]
+  ]
+}
diff --git a/README.md b/README.md
@@ -122,17 +122,19 @@ export default [
 ⚠️ Configurations set to warn in.\
 🚫 Configurations disabled in.\
 🌐 Set in the `all` configuration.\
-✅ Set in the `recommended` configuration.
-
-| Name                                                                                         | Description                                                                                | 💼                            | ⚠️                                                   | 🚫                     |
-| :------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------- | :---------------------------- | :--------------------------------------------------- | :--------------------- |
-| [never-export-initialized-store](docs/rules/never-export-initialized-store.md)               | Never export an initialized named or default store.                                        | ✅ ![badge-recommended-flat][] | 🌐 ![badge-all-flat][]                               |                        |
-| [no-duplicate-store-ids](docs/rules/no-duplicate-store-ids.md)                               | Disallow duplicate store ids.                                                              | ✅ ![badge-recommended-flat][] | 🌐 ![badge-all-flat][]                               |                        |
-| [no-return-global-properties](docs/rules/no-return-global-properties.md)                     | Disallows returning globally provided properties from Pinia stores.                        | ✅ ![badge-recommended-flat][] | 🌐 ![badge-all-flat][]                               |                        |
-| [no-store-to-refs-in-store](docs/rules/no-store-to-refs-in-store.md)                         | Disallow use of storeToRefs inside defineStore                                             | ✅ ![badge-recommended-flat][] | 🌐 ![badge-all-flat][]                               |                        |
-| [prefer-single-store-per-file](docs/rules/prefer-single-store-per-file.md)                   | Encourages defining each store in a separate file.                                         |                               |                                                      | 🌐 ![badge-all-flat][] |
-| [prefer-use-store-naming-convention](docs/rules/prefer-use-store-naming-convention.md)       | Enforces the convention of naming stores with the prefix `use` followed by the store name. |                               | 🌐 ✅ ![badge-all-flat][] ![badge-recommended-flat][] |                        |
-| [require-setup-store-properties-export](docs/rules/require-setup-store-properties-export.md) | In setup stores all state properties must be exported.                                     | ✅ ![badge-recommended-flat][] | 🌐 ![badge-all-flat][]                               |                        |
+🌐 Set in the `all-flat` configuration.\
+✅ Set in the `recommended` configuration.\
+✅ Set in the `recommended-flat` configuration.
+
+| Name                                                                                         | Description                                                                                | 💼  | ⚠️        | 🚫    |
+| :------------------------------------------------------------------------------------------- | :----------------------------------------------------------------------------------------- | :-- | :-------- | :---- |
+| [never-export-initialized-store](docs/rules/never-export-initialized-store.md)               | Never export an initialized named or default store.                                        | ✅ ✅ | 🌐 🌐     |       |
+| [no-duplicate-store-ids](docs/rules/no-duplicate-store-ids.md)                               | Disallow duplicate store ids.                                                              | ✅ ✅ | 🌐 🌐     |       |
+| [no-return-global-properties](docs/rules/no-return-global-properties.md)                     | Disallows returning globally provided properties from Pinia stores.                        | ✅ ✅ | 🌐 🌐     |       |
+| [no-store-to-refs-in-store](docs/rules/no-store-to-refs-in-store.md)                         | Disallow use of storeToRefs inside defineStore                                             | ✅ ✅ | 🌐 🌐     |       |
+| [prefer-single-store-per-file](docs/rules/prefer-single-store-per-file.md)                   | Encourages defining each store in a separate file.                                         |     |           | 🌐 🌐 |
+| [prefer-use-store-naming-convention](docs/rules/prefer-use-store-naming-convention.md)       | Enforces the convention of naming stores with the prefix `use` followed by the store name. |     | 🌐 🌐 ✅ ✅ |       |
+| [require-setup-store-properties-export](docs/rules/require-setup-store-properties-export.md) | In setup stores all state properties must be exported.                                     | ✅ ✅ | 🌐 🌐     |       |
 
 <!-- end auto-generated rules list -->
 

diff --git a/docs/rules/never-export-initialized-store.md b/docs/rules/never-export-initialized-store.md
@@ -1,6 +1,6 @@
 # Never export an initialized named or default store (`pinia/never-export-initialized-store`)
 
-💼⚠️ This rule is enabled in the following configs: ✅ `recommended`, `recommended-flat`. This rule _warns_ in the following configs: 🌐 `all`, `all-flat`.
+💼⚠️ This rule is enabled in the following configs: ✅ `recommended`, ✅ `recommended-flat`. This rule _warns_ in the following configs: 🌐 `all`, 🌐 `all-flat`.
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/no-duplicate-store-ids.md b/docs/rules/no-duplicate-store-ids.md
@@ -1,6 +1,6 @@
 # Disallow duplicate store ids (`pinia/no-duplicate-store-ids`)
 
-💼⚠️ This rule is enabled in the following configs: ✅ `recommended`, `recommended-flat`. This rule _warns_ in the following configs: 🌐 `all`, `all-flat`.
+💼⚠️ This rule is enabled in the following configs: ✅ `recommended`, ✅ `recommended-flat`. This rule _warns_ in the following configs: 🌐 `all`, 🌐 `all-flat`.
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/no-return-global-properties.md b/docs/rules/no-return-global-properties.md
@@ -1,6 +1,6 @@
 # Disallows returning globally provided properties from Pinia stores (`pinia/no-return-global-properties`)
 
-💼⚠️ This rule is enabled in the following configs: ✅ `recommended`, `recommended-flat`. This rule _warns_ in the following configs: 🌐 `all`, `all-flat`.
+💼⚠️ This rule is enabled in the following configs: ✅ `recommended`, ✅ `recommended-flat`. This rule _warns_ in the following configs: 🌐 `all`, 🌐 `all-flat`.
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/no-store-to-refs-in-store.md b/docs/rules/no-store-to-refs-in-store.md
@@ -1,6 +1,6 @@
 # Disallow use of storeToRefs inside defineStore (`pinia/no-store-to-refs-in-store`)
 
-💼⚠️ This rule is enabled in the following configs: ✅ `recommended`, `recommended-flat`. This rule _warns_ in the following configs: 🌐 `all`, `all-flat`.
+💼⚠️ This rule is enabled in the following configs: ✅ `recommended`, ✅ `recommended-flat`. This rule _warns_ in the following configs: 🌐 `all`, 🌐 `all-flat`.
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/prefer-single-store-per-file.md b/docs/rules/prefer-single-store-per-file.md
@@ -1,6 +1,6 @@
 # Encourages defining each store in a separate file (`pinia/prefer-single-store-per-file`)
 
-🚫 This rule is _disabled_ in the following configs: 🌐 `all`, `all-flat`.
+🚫 This rule is _disabled_ in the following configs: 🌐 `all`, 🌐 `all-flat`.
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/prefer-use-store-naming-convention.md b/docs/rules/prefer-use-store-naming-convention.md
@@ -1,6 +1,6 @@
 # Enforces the convention of naming stores with the prefix `use` followed by the store name (`pinia/prefer-use-store-naming-convention`)
 
-⚠️ This rule _warns_ in the following configs: 🌐 `all`, `all-flat`, ✅ `recommended`, `recommended-flat`.
+⚠️ This rule _warns_ in the following configs: 🌐 `all`, 🌐 `all-flat`, ✅ `recommended`, ✅ `recommended-flat`.
 
 <!-- end auto-generated rule header -->
 

diff --git a/docs/rules/require-setup-store-properties-export.md b/docs/rules/require-setup-store-properties-export.md
@@ -1,6 +1,6 @@
 # In setup stores all state properties must be exported (`pinia/require-setup-store-properties-export`)
 
-💼⚠️ This rule is enabled in the following configs: ✅ `recommended`, `recommended-flat`. This rule _warns_ in the following configs: 🌐 `all`, `all-flat`.
+💼⚠️ This rule is enabled in the following configs: ✅ `recommended`, ✅ `recommended-flat`. This rule _warns_ in the following configs: 🌐 `all`, 🌐 `all-flat`.
 
 <!-- end auto-generated rule header -->