akveo / styleguide

Akveo style guides

• Angular
• React
• React Native
• Java
• TypeScript
• RxJs

ESLint configs

• akveo/typescript:recommended
• akveo/angular:recommended
• akveo/react:recommended
• akveo/react-native:recommended

Typescript

• follow the installation instructions for typescript-eslint
• install eslint-config-akveo:

npm i -D eslint-config-akveo

• add akveo confing to the extends array in eslint config for your project.

eslintrc.json example:

"extends": [
  "akveo/typescript:recommended"
]

Angular

• follow the installation instructions for eslint-angular
• install eslint-config-akveo and needed dependencies:

npm i -D eslint-config-akveo eslint-plugin-rxjs eslint-plugin-rxjs-angular

• add akveo confing to the extends array in eslint config for your project.

eslintrc.json example:

"extends": [
  "akveo/angular:recommended"
]

React

• follow installation instructions for eslint
• install eslint-config-akveo and needed dependencies:

npm i -D eslint-config-akveo eslint-plugin-react

• add akveo confing to the extends array in eslint config for your project.

eslintrc.json example:

"extends": [
  "akveo/react:recommended"
]

React Native

• follow installation instructions for eslint
• install eslint-config-akveo and needed dependencies:

npm i -D eslint-config-akveo eslint-plugin-react-native

• add akveo confing to the extends array in eslint config for your project.

.eslintrc.js example:

overrides: [
  {
    extends: [
      'akveo/react-native:recommended',
    ],
    parserOptions: {
      project: ['./tsconfig.json'], // Specify it only for TypeScript files
    },
  },
],