1.0.2 โข Published 10 months ago
@odg/eslint-plugin v1.0.2
Table of Contents
๐ Benefits
- ๐ Speed start new project or package using typescript
- ๐จ Over 800 rules for pattern, possible errors and errors in Linter
- ๐ Code quality guaranteed
- ๐ข AutoReview when opening a pull-request/merge
- ๐งช Automatic Test when opening pull-request/merge
- ๐ Automatic Code Coverage when opening pull-request/merge
- ๐ฆ Automatic Package and release generate on merge
- ๐ช Run Lint/Test command pre-commit execute
๐ Libraries
๐ Dependencies
- Node.js 18 or later
- Yarn Optional/Recommended
- ODG TsConfig Last Version
โฉ Get Started
๐ป Rules
No Inconsistent Docblock
Validate Docblock with typescript types
๐ Examples of correct code
/**
* Valid Param
*
* @param {string} param
*/
function name(param: string) {
}
/**
* Valid return
*
* @returns {string}
*/
function name2(): string {
}
๐ Examples of incorrect code
/**
* Valid Param
*
* @param {number} param
*/
function name(param: string) {
}
/**
* Valid return
*
* @returns {number}
*/
function name2(): string {
}
๐ Start Project
First install dependencies with the following command
yarn install
# or
npm install
๐จ Build and Run
To build the project, you can use the following command
if you change files, you need to run
yarn build
andyarn start
again
yarn build && yarn start
# or
yarn dev
๐งช Teste Code
To Test execute this command
yarn test
# or
yarn test:watch