ODG linter Plugin

My Custom rules for eslint-plugin!

Table of Contents

• Benefits
• Libraries
• Dependencies
  • Rules
    • No Inconsistent Docblock
  • Start Project
  • Build and Run
  • Teste Code

---

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

• Node.js 18
• Typescript
• Eslint
• ODG-Linter-JS
• EditorConfig
• ReviewDog

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

yarn build && yarn start
# or
yarn dev

Teste Code

To Test execute this command

yarn test
# or
yarn test:watch