https://github.com/learnwithfair/eslint-documentation

eslint-documentation with [learnwithfair, Learn with fair, Rahatul Rabbi, Md Rahatul Rabbi ,rahatulrabbi]
https://github.com/learnwithfair/eslint-documentation

eslint eslint-config eslint-plugin learn-with-fair learnwithfair rahatul-rabbi rahatulrabbi

Last synced: 6 days ago
JSON representation

eslint-documentation with [learnwithfair, Learn with fair, Rahatul Rabbi, Md Rahatul Rabbi ,rahatulrabbi]

• Host: GitHub
• URL: https://github.com/learnwithfair/eslint-documentation
• Owner: learnwithfair
• Created: 2024-04-29T18:50:51.000Z (7 months ago)
• Default Branch: main
• Last Pushed: 2024-04-29T19:10:16.000Z (7 months ago)
• Last Synced: 2024-10-12T17:21:36.971Z (about 1 month ago)
• Topics: eslint, eslint-config, eslint-plugin, learn-with-fair, learnwithfair, rahatul-rabbi, rahatulrabbi
• Homepage:
• Size: 6.84 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# ESLint

Thanks for visiting my GitHub account!

 **ESLint** is a static code analysis tool for identifying problematic patterns found in JavaScript code. It was created by Nicholas C. Zakas in 2013. Rules in ESLint are configurable, and customized rules can be defined and loaded. ESLint covers both code quality and coding style issues. 

- A linter - tool for identifying and reporting programmatic, stylistic errors.

- ESLint does static error checking before running the program

### 2. Example of Popular Linters

- [JSLint](https://www.jslint.com/)

- [ESLint](https://eslint.org/)

- [JSHint](https://jshint.com/)

### 3. Prerequisities for setting up ESLint

- install Node.js

- install VSCode (as we will use VSCode)

## Required Software (Download)

- VS Code, Download ->https://code.visualstudio.com/download

- Node-js, Download-> https://nodejs.org/en/download

### 4. Installing & using ESLint

1. Create package.json: `npm init`

2. Install and configure eslint as dev dependency: `npm init @eslint/config`

3. Initialize eslint: `eslint --init` and follow steps:

   - How would you like to use ESLint? To check syntax and find problems

   - How would you like to use ESLint? None of these

   - How would you like to use ESLint? None of these

   - Does your project use TypeScript? › No

   - Where does your code run? Browser

4. Go to `.eslintrc.json` file and make add your necessary adjustments

   Example

   ```json

   following codes will activate the recommended rules which can be changed inside the rules object.

     {

      "extends": "eslint:recommended"

     }

    

    Example of ESLint rules

    "rules": {

        "quotes": ["error", "double"]

    }

    More Examples of ESLint rules

   "rules": {

       "no-var": "error",

       "eqeqeq": "error",

       "no-unused-vars": "error",

       "default-case": "error",

       "no-console": "error",

       "camelcase": "error",

       "consistent-return": "error",

       "func-style": "error",

       "max-depth": ["error", 2],

       "max-lines": ["error", 25],

       "prefer-arrow-callback": "error",

       "prefer-const": "error",

       "no-useless-return": "error",

       "no-plusplus": "error",

       "quotes": ["error", "single"]

     }

   ```

5. add some codes in a js file for testing the eslint. I have created a file called app.js and added the following codes for testing purpose

   ```javascript

   var username = "anisul Islam";

   var password = "12345";

   var occupation = "full stack web developer";

   const user_presentaddress = "lala";

   var a = 6;

   a++;

   console.log(occupation);

   const validateUser = (pwd) => {

     if (password == pwd) {

       return true;

     }

   };

   console.log(validateUser(12345));

   switch (foo) {

     case 1:

       console.log(foo);

       break;

     case 2:

       console.log(foo);

       break;

   }

   const foo = true;

   if (foo) {

     if (foo) {

       if (foo) {

         console.log("hi");

       }

       console.log("hi");

     }

     console.log("hi");

   }

   setTimeout(function () {}, 1000);

   ```

6. make some changes in setting.json

   format on save and validate js codes: add the following codes in settings.json

   ```

    "editor.codeActionsOnSave": {

    "source.fixAll.eslint": true

    },

    "eslint.validate": ["javascript"]

   ```

7. Run the eslint: `eslint fileName.js` and check the erros

8. Fix automatically fixable errors: `eslint fileName.js --fix`

## Follow Me

 [Facebook](http://facebook.com/learnwithfair),     [Youtube](http://youtube.com/@learnwithfair),       [Instagram](http://instagram.com/learnwithfair)