@jict/eslint-plugin
Advanced tools
Weekly downloads
Readme
@jict/eslint-plugin
justInCaseTechnologies's ESLint rules and configs.
You'll first need to install ESLint:
With Yarn
yarn add --dev eslint
With npm
$ npm i eslint --save-dev
Next, install @jict/eslint-plugin
:
With Yarn
yarn add --dev @jict/eslint-plugin
With npm
$ npm install @jict/eslint-plugin --save-dev
Note: If you installed ESLint globally (using the -g
flag) then you must also install @jict/eslint-plugin
globally.
justInCaseTechnologies's ESLint configs come bundled in this package. In order to use them, you simply extend the relevant configuration in your project's .eslintrc
. For example, the following will extend the ESNext (ES2015 and later) config:
{
"extends": "plugin:@jict/esnext"
}
If you are working on an ES5 project, extend the ES5 version of the configuration:
{
"extends": "plugin:@jict/es5"
}
You can also add some "augmenting" configs on top of the "core" config by extending an array of linting configs. For example, the following configuration would provide a base ESNext config that is augmented by a React config:
{
"extends": [
"plugin:@jict/esnext",
"plugin:@jict/react"
]
}
Likewise, if you are using TypeScript and React, the following configuration extends the TypeScript base config with the React-specific rules provided by the React configuration file. To demonstrate multiple augmentations, we've also added the Prettier config, which disables rules that will conflict in projects using prettier.
{
"extends": [
"plugin:@jict/typescript",
"plugin:@jict/react",
"plugin:@jict/prettier",
]
}
This plugin provides the following core configurations:
typescript-type-checking
config mentioned below.This plugin also provides the following tool-specific configurations, which can be used on top of the core configurations:
typescript
config to enable all TypeScript rules, including those that require type checking. These rules are slower to run and and you will need to specify a path to your tsconfig.json file in the "project" property of "parserOptions". The following example would provide all of the TypeScript rules, assuming the tsconfig.json is in the same directory as you ESlint configuration.{
"extends": [
"plugin:@jict/typescript",
"plugin:@jict/typescript-type-checking"
],
"parserOptions": {
"project": "tsconfig.json"
}
}
If you are working on a node module, we also provide the node configuration for you. Note that this configuration needs to be used in conjunction with one of the core configurations (either es5
or esnext
). If you plan to transpile your code using Babel, use the esnext
config. If you do not plan to do so, the config you choose depends on the version of node you wish to support, and how many ESNext features are natively available in that version. You can see a detailed list of what version of node supports what new JavaScript features by visiting http://node.green.
A node project that will use Babel for transpilation would need the following ESLint config:
{
"extends": [
"plugin:@jict/esnext",
"plugin:@jict/node"
]
}
The supported version of TypeScript is constrained by the @typescipt-eslint parser support that is installed.
FAQs
justInCaseTechnologies's ESLint rules and configs.
The npm package @jict/eslint-plugin receives a total of 384 weekly downloads. As such, @jict/eslint-plugin popularity was classified as not popular.
We found that @jict/eslint-plugin demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 3 open source maintainers collaborating on the project.
Did you know?
Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.