1.0.1 • Published 3 years ago

eslint-config-softwaredesignsolution v1.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
3 years ago

eslint-config-softwaredesignsolution

eslint-config-softwaredesignsolution contains a strict ESLint configuration for ES2015+ and TypeScript.

Status

CategoryStatus
Versionnpm
DependenciesDavid
Dev dependenciesDavid
BuildGitHub Actions
LicenseGitHub

Installation

$ npm install eslint-config-softwaredesignsolution

The following additional ESLint plugins are included by default, so you don't have to install them:

PluginAutomatically enabled
eslint-plugin-eslint-commentsYes
eslint-plugin-extendedYes
eslint-plugin-mochaYes
eslint-plugin-reactNo
eslint-plugin-unicornYes
@typescript-eslint/eslint-pluginNo

To enable support for React and JSX, all you need to do is to install the react module. The appropriate rules will become enabled automatically.

To enable support for TypeScript, all you need to do is to install the typescript module. The appropriate rules will become enabled automatically for .ts and .tsx files. The generated configuration expects a tsconfig.json at the project root.

Quick Start

This module contains a very strict ESLint configuration for ES2015 and above, both for Node.js and browser development. Its aims to eradicate any variation in code style. If you can not tell any more, based on little individual manners, who of your co-workers wrote a piece of code, this module succeeded. This helps you to narrow down your focus to pure functionality, as you do not have to think about code styling any more at all.

To use one of those configurations, create a .eslintrc.json file in your project and use the extends keyword.

{
  "extends": "es/node"
}

Alternatively, you may also use es/browser.

If you want to override any rules, you can do so in your configuration file. For details on how to do this, e.g. to get an explanation on how to enable or disable specific rules, see the ESLint documentation on extending configuration files.

Running quality assurance

To run quality assurance for this module use eslint:

eslint \"**/*.ts\" --ignore-path .eslintignore