Nokkel Typescript Styling Guide

This styling guide provide configuration and rules for typescript, eslint and prettier that can be used in Nokkel projects to ensure they meet these recommended stylistic choices. It does not inform code quality, merely the look of how code should be written to ensure it is consistent and easy to interpret for developers.

Using this style guide in your project

In order to use this guide you should first install the following dependencies in your project

npm add -D @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint eslint-config-prettier eslint-plugin-cypress eslint-plugin-jest eslint-plugin-node eslint-plugin-prettier eslint-plugin-simple-import-sort prettier prettier-eslint typescript typescript-eslint

Then install this package to your project

npm add -D @nokkel/typescript

Then you can add the following files to your Typescript project

.eslintrc.json

{
  "extends": "./node_modules/@nokkel/typescript/.eslintrc.json"
  // Add any overrides/extensions here...
}

eslint.config.js

// eslint.config.js
import myconfig from '@nokkel/typescript/eslint.config.mjs';

export default [...myconfig];

To override: https://eslint.org/docs/latest/extend/shareable-configs#overriding-settings-from-shareable-configs

.prettierrc.js

module.exports = {
  ...require('@nokkel/typescript/.prettierrc.json')
  // And any overrides/extensions here...
};

We also recommend adding the following

.eslintignore

dist/

tsconfig.browser.json

This is an example of a typescript configuration you can put into your browser project that extends the typescript configuration of this library.

{
  "extends": "./node_modules/@nokkel/typescript/tsconfig.browser.json",
  "compilerOptions": {
    "baseUrl": "./",
    "outDir": "dist",
    "paths": {
      "@/*": ["src/*"]
    }
    // Add any overrides/extensions here...
  }
}

tsconfig.json

This is an example of a typescript configuration you can put into your project that extends the typescript configuration of this library.

{
  "extends": "./node_modules/@nokkel/typescript/tsconfig.json",
  "compilerOptions": {
    "baseUrl": "./",
    "outDir": "dist",
    "paths": {
      "@/*": ["src/*"]
    }
    // Add any overrides/extensions here...
  }
}

Enjoy!