react-redux-typescript-scripts

react-redux-typescript-scripts 🛠

Shared dev-tools configuration files based on react-redux-typescript-guide

For now you can find tslint and tsconfig configurations, but I'm willing to add more tools and scripts in the future e.g. jest, babel, eslint, npm scripts etc.

Table of Contents

• Installation
• Usage
  • tsconfig.json
  • TSLint
    • tslint.json
  • ESLint
    • create-react-app
• LICENSE

Installation

This module is distributed via npm package and should be installed as one of your project's devDependencies:

npm i -D react-redux-typescript-scripts

Usage

You can find usage instructions for each tool in it's onw section below.

tsconfig.json

{
  "include": ["./src"],
  "extends": "./node_modules/react-redux-typescript-scripts/tsconfig.json",
  "compilerOptions": {
    // you can further customize options here
  }
}

TSLint

Following configs are available to extend (you can use one or all by declaring an array in extends config property):

• react-redux-typescript-scripts/tslint-recommended.json - best default config - based on recommended tslint built-in config.
• react-redux-typescript-scripts/tslint-react.json- for react projects - based on tslint-react.

tslint.json

{
  "extends": [
    "react-redux-typescript-scripts/tslint-recommended.json", 
    "react-redux-typescript-scripts/tslint-react.json"
  ],
  "rules": {
    // you can further customize options here
  }
}

ESLint

create-react-app

This will fully integrate @typescript-eslint config to your create-react-app:

{
  "eslintConfig": {
    "extends": [
      "react-app",
      "react-redux-typescript-scripts/eslint.js"
    ],
    "rules": {
      // you can further customize options here
    }
  }
}

LICENSE

MIT