Configs OG

Eslint, Prettier configurations for JavaScript Frontend environment

Getting Started

• Installation:

  npx configs-og
  

• Updating:

  npm install configs-og@latest
  

• Parser:

  for JavaScript files:

  npm install babel-eslint
  

  for TypeScript files:

  npm install typescript
  

Manual configuration

• Eslint

  Create .eslintrc.js in root directory with this config:

  module.exports = {
      extends: ['./node_modules/configs-og/.eslintrc.js'],
      // configuration
  };
  

  (optional) Create .eslintignore in root directory with this content

• Prettier

  Create prettier.config.js in root directory with this config:

  module.exports = {
      ...require('./node_modules/configs-og/prettier.config.js'),
      // configuration
  };
  

• (optional) .gitignore

  Create .gitignore in root directory with this content

• (optional) Scripts

  Add this to your package.json:

  {
      "scripts": {
          "lint": "eslint --quiet .",
          "lint:fix": "eslint --quiet --fix .",
          "prettier:fix": "prettier --write ." 
      }
  }