Instabuy Package Config

This package provides a simple way to configure your Typescript application or library. This package comes with Eslint and Prettier configurations and denpendencies so you don't have to worry about it.

Installation

The installation is straightforward and already comes with Eslint and Prettier dependencies, ramaning to you only to install Typescript depedency. Just run the following command to install Prettier and Eslint configurations and dependencies.

npm install @instabuy/package-config --save-dev

Usage

1. Use the default Typescript configuration by adding the following line to your tsconfig.json file.

   {
     "extends":  "@instabuy/package-config/tsconfig.json"
   }

2. Configure Eslint configuration file.

   a) If you just want the basic Typescript configuration, add the following line to your .eslintrc.json file.

   {
     "extends": "@instabuy/eslint-config"
   }

   b) If you want to use the React configuration, add the following line to your .eslintrc.json file.

   {
     "extends": "@instabuy/eslint-config/react"
   }

3. Configure Prettier configuration file by making the following line your prettierrc.json file content.

   "@instabuy/prettier-config"

4. Configure your package.json scripts to use the configurations. Like:

   {
     "scripts": {
       "lint": "eslint src --ext .ts,.js,.tsx",
       "lint:fix": "yarn lint --fix"
     }
   }