diff --git a/.eslint-doc-generatorrc.json b/.eslint-doc-generatorrc.json new file mode 100644 index 0000000..0718574 --- /dev/null +++ b/.eslint-doc-generatorrc.json @@ -0,0 +1,6 @@ +{ + "configEmoji": [ + ["recommended-flat", "βœ…"], + ["all-flat", "🌐"] + ] +} \ No newline at end of file diff --git a/README.md b/README.md index 2ea5932..c83f719 100644 --- 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. | βœ… βœ… | 🌐 🌐 | | diff --git a/docs/rules/never-export-initialized-store.md b/docs/rules/never-export-initialized-store.md index 2c8e13e..ec4aebc 100644 --- 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`. diff --git a/docs/rules/no-duplicate-store-ids.md b/docs/rules/no-duplicate-store-ids.md index 31dbb5f..db75535 100644 --- 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`. diff --git a/docs/rules/no-return-global-properties.md b/docs/rules/no-return-global-properties.md index 87bca1d..fd542f8 100644 --- 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`. diff --git a/docs/rules/no-store-to-refs-in-store.md b/docs/rules/no-store-to-refs-in-store.md index baa2b5a..c816676 100644 --- 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`. diff --git a/docs/rules/prefer-single-store-per-file.md b/docs/rules/prefer-single-store-per-file.md index e770cb5..ab31017 100644 --- 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`. diff --git a/docs/rules/prefer-use-store-naming-convention.md b/docs/rules/prefer-use-store-naming-convention.md index 15293e8..c7ecb61 100644 --- 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`. diff --git a/docs/rules/require-setup-store-properties-export.md b/docs/rules/require-setup-store-properties-export.md index db1d3c1..2c2568c 100644 --- 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`.