@nextcapital/eslint-config-typescript

A series of ESLint configs to enforce Nextcapial's code standards.

Installation

npx install-peerdeps --dev @nextcapital/eslint-config-typescript

Usage

We export multiple ESLint configurations for your usage.

Base Config (@nextcapital/eslint-config-typescript)

This config contains all rules for base TypeScript development - no jest, jsdoc, react, etc. This config extends the base JavaScript config.

// eslint.config.cjs
const nextcapitalBase = require('@nextcapital/eslint-config-typescript');

module.exports = [
  ...nextcapitalBase,
  // ......
];

// eslint.config.mjs
import nextcapitalBase from '@nextcapital/eslint-config-typescript';

export default [
  ...nextcapitalBase,
  // ......
];

Jest

This config contains all rules for testing with jest and TypeScript. This config does not extend the base config and can be used as a standalone ruleset.

// eslint.config.cjs
const jestConfig = require('@nextcapital/eslint-config-typescript/jest');

module.exports = [
  ...jestConfig,
  // ......
];

// eslint.config.mjs
import jestConfig from '@nextcapital/eslint-config-typescript/jest';

export default [
  ...jestConfig,
  // ......
];

JSDoc

This config contains all rules for testing with jsdoc and TypeScript. This config does not extend the base config and can be used as a standalone ruleset.

// eslint.config.cjs
const jsdocConfig = require('@nextcapital/eslint-config-typescript/jsdoc');

module.exports = [
  ...jsdocConfig,
  // ......
];

// eslint.config.mjs
import jsdocConfig from '@nextcapital/eslint-config-typescript/jsdoc';

export default [
  ...jsdocConfig,
  // ......
];

React

This config contains all rules for developing with React/jsx and TypeScript. This config does not extend the base config and can be used as a standalone ruleset.

// eslint.config.cjs
const reactConfig = require('@nextcapital/eslint-config-typescript/react');

module.exports = [
  ...reactConfig,
  // ......
];

// eslint.config.mjs
import reactConfig from '@nextcapital/eslint-config-typescript/react';

export default [
  ...reactConfig,
  // ......
];

Contributing

See CONTRIBUTING.md

Publishing

IMPORTANT: Versioning is handled by GitHub Actions through the publish.yml workflow configuration. DO NOT ATTEMPT TO PUBLISH PACKAGES YOURSELF. Publishing yourself should fail anyways because you need the auth token for an npm user in the @nextcapital organization on npm. This section simply documents how the CI workflow works.

Maintainers

Mike Kreiser (@nc-kreiserm)