{"id":15020752,"url":"https://github.com/unlight/eslint-plugin-ngxs-style-guide","last_synced_at":"2025-10-26T22:06:27.861Z","repository":{"id":57230013,"uuid":"206797945","full_name":"unlight/eslint-plugin-ngxs-style-guide","owner":"unlight","description":"ESLint rules for ngxs state manager","archived":false,"fork":false,"pushed_at":"2021-11-22T16:32:33.000Z","size":65,"stargazers_count":3,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-31T16:53:56.429Z","etag":null,"topics":["eslint","eslint-plugin","eslint-rules","eslintplugin","ngxs"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/unlight.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-09-06T13:18:19.000Z","updated_at":"2023-06-11T21:47:37.000Z","dependencies_parsed_at":"2022-09-14T14:52:08.592Z","dependency_job_id":null,"html_url":"https://github.com/unlight/eslint-plugin-ngxs-style-guide","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unlight%2Feslint-plugin-ngxs-style-guide","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unlight%2Feslint-plugin-ngxs-style-guide/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unlight%2Feslint-plugin-ngxs-style-guide/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/unlight%2Feslint-plugin-ngxs-style-guide/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/unlight","download_url":"https://codeload.github.com/unlight/eslint-plugin-ngxs-style-guide/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":238284910,"owners_count":19446752,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["eslint","eslint-plugin","eslint-rules","eslintplugin","ngxs"],"created_at":"2024-09-24T19:55:34.163Z","updated_at":"2025-10-26T22:06:22.796Z","avatar_url":"https://github.com/unlight.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# eslint-plugin-ngxs-style-guide\n\nESLint rules for [ngxs](https://www.ngxs.io) state manager.\n\n## Install\n\n```\nnpm install --save-dev eslint-plugin-ngxs-style-guide\n```\n\n## Usage\n\nConfigure it in [your configuration file](https://eslint.org/docs/user-guide/configuring):\n\n1. Add to `plugins` section:\n\n```\nngxs-style-guide\n```\n\n2. Add to `extends` section (optional):\n\n```\nplugin:ngxs-style-guide/recommended\n```\n\n3. [Configure rules](https://eslint.org/docs/user-guide/configuring#configuring-rules)\n\n## Rules\n\n### NGXS style guide - https://www.ngxs.io/recipes/style-guide\n\n-   `ngxs-style-guide/state-suffix` A state should always be suffixed with the word `State`. Right: `ZooState` Wrong: `Zoo`\n-   `ngxs-style-guide/state-filenames` States should have a `.state.ts` suffix for the filename\n-   `ngxs-style-guide/state-interfaces` State interfaces should be named the name of the state followed by the `Model` suffix\n-   `ngxs-style-guide/select-suffix` Selects should have a `$` suffix\n-   `ngxs-style-guide/action-suffixes` Actions should NOT have a suffix\n-   `ngxs-style-guide/plugin-suffix` Plugins should end with the `Plugin` suffix\n\n### Other rules\n\n-   `ngxs-style-guide/no-subscribe-in-actions` Possible error https://stackoverflow.com/questions/56122116/do-not-subscribe-to-actions-ngxs\n-   `ngxs-style-guide/no-pipe-dispatch` No pipe() after dispatch\n\n## Todo\n\n-   return observable from action\n-   selector inject it must be after\n    @State\u003cStateModel\u003e({\n    name: 'supplier',\n    defaults: defaultState,\n    })\n    @Injectable({ providedIn: 'root' })\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funlight%2Feslint-plugin-ngxs-style-guide","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Funlight%2Feslint-plugin-ngxs-style-guide","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Funlight%2Feslint-plugin-ngxs-style-guide/lists"}