Stanley Imagem
ODG linter Plugin

My Custom rules for eslint-plugin!

codecov Stargazers Made by ODGodinho Forks Repository size GitHub last commit License StyleCI

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 AutoReview Comment example
  • ๐Ÿงช Automatic Test when opening pull-request/merge
  • ๐Ÿ“ˆ Automatic Code Coverage when opening pull-request/merge Code Coverage example
  • ๐Ÿ“ฆ Automatic Package and release generate on merge
  • ๐Ÿช Run Lint/Test command pre-commit execute

๐Ÿ“— Libraries

๐Ÿ“ Dependencies

โฉ 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 and yarn start again

yarn build && yarn start
# or
yarn dev

๐Ÿงช Teste Code

To Test execute this command

yarn test
# or
yarn test:watch