🚀 Big News: Socket Acquires Coana to Bring Reachability Analysis to Every Appsec Team.Learn more
Socket
DemoInstallSign in
Socket

@cospired/eslint-config-typescript-base

Package Overview
Dependencies
Maintainers
2
Versions
1
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@cospired/eslint-config-typescript-base

Slightly opinionated eslint config for typescript based on airbnb's config

0.1.0
latest
Source
npm
Version published
Weekly downloads
0
-100%
Maintainers
2
Weekly downloads
 
Created
Source

Build Status

@cospired/eslint-config-typescript-base

This package provides cospired's base typescript .eslintrc (without React plugins) as an extensible shared config.

Usage

We export one ESLint configurations for your usage.

@cospired/eslint-config-typescript-base

Our default export contains all of our ESLint rules, including ECMAScript 6+. It requires eslint, eslint-plugin-eslint-comment, eslint-plugin-import and @hapi/eslint-plugin-hapi.

If you use yarn, run npm info "@cospired/eslint-config-typescript-base@latest" peerDependencies to list the peer dependencies and versions, then run yarn add --dev <dependency>@<version> for each listed peer dependency. See below for npm instructions.

  • Install the correct versions of each package, which are listed by the command:
npm info "@cospired/eslint-config-typescript-base@latest" peerDependencies

If using npm 5+, use this shortcut

npx install-peerdeps --dev @cospired/eslint-config-typescript-base

If using npm < 5, Linux/OSX users can run

(
  export PKG=@cospired/eslint-config-typescript-base;
  npm info "$PKG@latest" peerDependencies --json | command sed 's/[\{\},]//g ; s/: /@/g' | xargs npm install --save-dev "$PKG@latest"
)

Which produces and runs a command like:

  npm install --save-dev @cospired/eslint-config-typescript-base eslint@^#.#.# eslint-plugin-import@^#.#.#

If using npm < 5, Windows users can either install all the peer dependencies manually, or use the install-peerdeps cli tool.

npm install -g install-peerdeps
install-peerdeps --dev @cospired/eslint-config-typescript-base

The cli will produce and run a command like:

npm install --save-dev @cospired/eslint-config-typescript-base eslint@^#.#.# eslint-plugin-import@^#.#.#
  • Add "extends": "@cospired/eslint-config-typescript-base" to your .eslintrc.

Improving this config

Consider adding test cases if you're making complicated rules changes, like anything involving regexes. Perhaps in a distant future, we could use literate programming to structure our README as test cases for our .eslintrc?

You can run tests with npm test.

You can make sure this module lints with itself using npm run lint.

Acknowledgment

This package is based on the airbnb javascript styleguide and eslint packages and eslint-config-airbnb-typescript typescript extension.

Keywords

eslint

FAQs

Package last updated on 19 Jun 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts