{"id":24773038,"url":"https://github.com/re-quant/eslint-plugin-api-entity-ref","last_synced_at":"2025-03-23T21:14:46.622Z","repository":{"id":40783576,"uuid":"247196817","full_name":"Re-Quant/eslint-plugin-api-entity-ref","owner":"Re-Quant","description":"ESLint Rules for @z-brain/api-entity-ref","archived":false,"fork":false,"pushed_at":"2023-01-05T09:58:32.000Z","size":1884,"stargazers_count":0,"open_issues_count":14,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-03-25T01:22:27.758Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/Re-Quant.png","metadata":{"files":{"readme":"README.md","changelog":null,"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":"2020-03-14T02:19:42.000Z","updated_at":"2020-03-14T16:43:18.000Z","dependencies_parsed_at":"2023-02-04T00:02:16.559Z","dependency_job_id":null,"html_url":"https://github.com/Re-Quant/eslint-plugin-api-entity-ref","commit_stats":null,"previous_names":["z-brain/eslint-plugin-api-entity-ref"],"tags_count":4,"template":false,"template_full_name":"korniychuk/wallaby-ts-starter","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Re-Quant%2Feslint-plugin-api-entity-ref","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Re-Quant%2Feslint-plugin-api-entity-ref/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Re-Quant%2Feslint-plugin-api-entity-ref/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Re-Quant%2Feslint-plugin-api-entity-ref/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Re-Quant","download_url":"https://codeload.github.com/Re-Quant/eslint-plugin-api-entity-ref/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245168904,"owners_count":20571804,"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":[],"created_at":"2025-01-29T04:35:28.879Z","updated_at":"2025-03-23T21:14:46.598Z","avatar_url":"https://github.com/Re-Quant.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cdiv align=\"center\"\u003e\n\n![eslint-logo](docs/assets/eslint-logo.svg?sanitize=true)\n\n# @z-brain/eslint-plugin-api-entity-ref\n\n\u003cp\u003e\n  \u003ca target=\"_blank\" href=\"https://github.com/z-brain/eslint-plugin-api-entity-ref/actions?query=workflow%3A%22Build%22\"\u003e\n    \u003cimg alt=\"Build status\" src=\"https://github.com/z-brain/eslint-plugin-api-entity-ref/workflows/Build/badge.svg\"\u003e\n  \u003c/a\u003e\n  \u003ca target=\"_blank\" href=\"https://www.npmjs.com/package/@z-brain/eslint-plugin-api-entity-ref\"\u003e\n    \u003cimg alt=\"NPM version\" src=\"https://img.shields.io/npm/v/@z-brain/eslint-plugin-api-entity-ref.svg\"\u003e\n  \u003c/a\u003e\n  \u003ca target=\"_blank\" href=\"https://codecov.io/gh/z-brain/eslint-plugin-api-entity-ref\"\u003e\n    \u003cimg alt=\"Code Coverage\" src=\"https://codecov.io/gh/z-brain/eslint-plugin-api-entity-ref/branch/master/graph/badge.svg\"\u003e\n  \u003c/a\u003e\n  \u003ca target=\"_blank\" href=\"https://www.gnu.org/licenses/gpl-3.0\"\u003e\n    \u003cimg alt=\"License: GPL v3\" src=\"https://img.shields.io/badge/License-GPLv3-blue.svg\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\nAn [ESLint](http://eslint.org) plugin to disable to check that you didn't forget to add `ApiEntityRef` decorator from [`@z-brain/api-entity-ref`](https://github.com/z-brain/api-entity-ref) to your classes with `ApiPropertyRef` decorators.\n\n\u003c/div\u003e\n\n---\n\n*Notice: If you have any propositions feel free to make an issue or create a pull request.*\n\n## Installation\n\n\n```sh\n# Install with npm\nnpm install eslint eslint-plugin-api-entity-ref --save-dev\n\n# Install with yarn\nyarn add -D eslint eslint-plugin-api-entity-ref\n```\n\n**Note:** If you installed ESLint globally (using the `-g` flag with npm or `global` with yarn) then you must also install `eslint-plugin-api-entity-ref` globally.\n\n\n## Usage\n\nAdd `api-entity-ref` to the plugins section of your `.eslintrc` configuration file. Then configure the rules you want to use under the rules section.\n\n```jsonc\n{\n  \"plugins\": [\"api-entity-ref\"],\n  \"rules\": {\n    \"api-entity-ref/check-class-decorator\": \"error\"\n  }\n}\n```\n\nOr enable the ruleset via the `extends` property of your `.eslintrc` configuration file.  \n   \n```jsonc\n{\n // ...\n \"extends\": [\n   \"plugin:api-entity-ref/recommended\"\n ]\n}\n```\n\n\n## Development notes\n\n### How to use NodeJS version from the `.nvmrc`\n\n1. Install NVM\n2. Use `.nvmrc` file one of the next ways:\n\n    * Execute `nvm use` in the project root directory\n    * Install [NVM Loader](https://github.com/korniychuk/ankor-shell) and your .nvmrc will be loaded automatically when you open the terminal.\n      ![NVM Loader demo](docs/assets/readme.nvm-loader.png)\n\n### How to make a build\n\n`yarn run build`\n\n### How to run lint\n\n* Just show problems `yarn run lint`\n* Fix problems if it is possible `yarn run lint:fix`\n\n### How to run tests\n\n* All tests\n\n  `yarn run test`  \n  `yarn run test:watch`\n* Specific tests\n\n  `yarn run test -- src/my.spec.ts`  \n  `yarn run test:watch -- src/my.spec.ts`\n\n### How to build and publish NPM package\n\n*NPM Token:* `806f...5e2e`\n\nCI configuration details here: [.github/workflows/npmpublish.yml](.github/workflows/npmpublish.yml)\n\n```bash\nyarn run pre-push\n\u0026\u0026 npm version patch -m 'Update package version version to %s'\n\u0026\u0026 yarn run gen-public-package.json\n\u0026\u0026 cp README.md dist/\n\u0026\u0026 npm publish dist --access public\n\u0026\u0026 git push --no-verify \u0026\u0026 git push --tags --no-verify\n```\n\n## Author\n\n| [\u003cimg src=\"https://www.korniychuk.pro/avatar.jpg\" width=\"100px;\"/\u003e\u003cbr /\u003e\u003csub\u003eAnton Korniychuk\u003c/sub\u003e](https://korniychuk.pro) |\n| :---: |\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fre-quant%2Feslint-plugin-api-entity-ref","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fre-quant%2Feslint-plugin-api-entity-ref","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fre-quant%2Feslint-plugin-api-entity-ref/lists"}