@alkafinance/eslint-config-typescript

Alka ESLint config for our Typescript codebases

Usage no npm install needed!

<script type="module">
  import alkafinanceEslintConfigTypescript from 'https://cdn.skypack.dev/@alkafinance/eslint-config-typescript';
</script>

README

@alkafinance/eslint-config-typescript

npm version CircleCI Status license: MIT dependencies Status devDependencies Status

Alka ESLint config for our Typescript codebases.

Usage

This config relies dangerously on npm@3/yarn flatter tree for its dependencies (because of eslint/issues/3458), so installation may be as simple as:

$ yarn add eslint prettier @alkafinance/eslint-config @alkafinance/eslint-config-typescript --dev
# or
$ npm install eslint prettier @alkafinance/eslint-config @alkafinance/eslint-config-typescript --save-dev

Then add the extends to your .eslintrc.js:

module.exports = {
  extends: ['@alkafinance/eslint-config', '@alkafinance/eslint-config-typescript' /* and maybe '@alkafinance/eslint-config-typescript/react' or '@alkafinance/eslint-config-typescript/react-native' */],
  rules: {
    // your overrides
  },
};

Additional configs include:

  • '@alkafinance/eslint-config-typescript/requiring-type-checking' for rules that require type information
  • '@alkafinance/eslint-config-typescript/react' for usage with React
  • '@alkafinance/eslint-config-typescript/react-native' for usage with React Native

License

MIT License © Alka, Inc