An ESLint plugin to disable to check that you didn't forget to add ApiEntityRef
decorator from @z-brain/api-entity-ref
to your classes with ApiPropertyRef
decorators.
Notice: If you have any propositions feel free to make an issue or create a pull request.
# Install with npm
npm install eslint eslint-plugin-api-entity-ref --save-dev
# Install with yarn
yarn add -D eslint eslint-plugin-api-entity-ref
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.
Add api-entity-ref
to the plugins section of your .eslintrc
configuration file. Then configure the rules you want to use under the rules section.
Or enable the ruleset via the extends
property of your .eslintrc
configuration file.
{
// ...
"extends": [
"plugin:api-entity-ref/recommended"
]
}
-
Install NVM
-
Use
.nvmrc
file one of the next ways:- Execute
nvm use
in the project root directory - Install NVM Loader and your .nvmrc will be loaded automatically when you open the terminal.
- Execute
yarn run build
- Just show problems
yarn run lint
- Fix problems if it is possible
yarn run lint:fix
-
All tests
yarn run test
yarn run test:watch
-
Specific tests
yarn run test -- src/my.spec.ts
yarn run test:watch -- src/my.spec.ts
NPM Token: 806f...5e2e
CI configuration details here: .github/workflows/npmpublish.yml
yarn run pre-push
&& npm version patch -m 'Update package version version to %s'
&& yarn run gen-public-package.json
&& cp README.md dist/
&& npm publish dist --access public
&& git push --no-verify && git push --tags --no-verify
Anton Korniychuk |
---|