The package contains eslint
and TypeScript
configurations used for Element Framework development.
Use ESLint to lint your es6 code.
Use TypeScript to keep the code easier to deploy, read and debug.
Configurations are used across all Element Framework components for consistency and code quality.
npm install @refinitiv-ui/configurations --save-dev
This will install the following files:
eslint-config.js
- generic ESLint configurationtypescript.eslint-config.js
- extends ofeslint-config.js
with support of recommended linting for TypeScripttsconfig.json
- development TypeScript parser configurations to meet ES6 specsprod.tsconfig.json
- extendstsconfig.json
to provide production configurations
You can override/use your own files to meet project requirements.
Below configurations are used with TypeScript (Element Framework v6).
Your project level (local) .eslintrc
:
{
"root": true,
"extends": [
"./node_modules/@refinitiv-ui/configurations/typescript.eslint-config.js"
],
"parserOptions": {
"project": "./tsconfig.json"
}
}
eslint
from version 6 does not support global modules and cannot resolve extensions by generic package name. Therefore you must ensure that extends
contain the full path to the location of this module.
Your project level tsconfig.json
:
{
"extends": "@refinitiv-ui/configurations/tsconfig.json"
}
Below configurations are used when TypeScript is not required.
Your project level (local) .eslintrc
:
{
"root": true,
"extends": ["./node_modules/@refinitiv-ui/configurations/eslint-config.js"]
}
Modern IDE should pick up configurations automatically and apply to the project.