Installations

npm install @emerson-eps/eslint-config

Developer Guide

BETA

Typescript

No

Module System

CommonJS

Node Version

18.20.5

NPM Version

10.8.2 Score

43.3

Supply Chain

82

Quality

85.6

Maintenance

100

Vulnerability

93.9

License

Pull Requests

Open

7

Total

275

Closed

94

Merged

174

Issues

Open

2

Total

17

Closed

15

Releases

58

v7.0.7

Published on 26 Nov 2024

v7.0.6

Published on 25 Sept 2024

v7.0.5

Published on 26 Aug 2024

v7.0.4

Published on 19 Aug 2024

v7.0.3

Published on 19 Aug 2024

v7.0.2

Published on 12 Aug 2024

View all 58 releases

Contributors

6

View all 6 contributors

Languages

2

JavaScript

TypeScript

JavaScript (91.94%)

TypeScript (8.06%)

Developer

emerson-eps

Download Statistics

Total Downloads

158,337

Last Day

73

Last Week

1,205

Last Month

9,751

Last Year

63,949

GitHub Statistics

3 Stars

180 Commits

3 Forks

6 Watching

10 Branches

6 Contributors

Maintainers

2

Package Meta Information

Latest Version

7.0.7

Package Id

@emerson-eps/eslint-config@7.0.7

Unpacked Size

13.40 kB

Size

4.39 kB

File Count

5

NPM Version

10.8.2

Node Version

18.20.5

Publised On

26 Nov 2024

Total Downloads

Cumulative downloads

Total Downloads

158,337

Last day

-82.5%

73

Compared to previous day

Last week

-48%

1,205

Compared to previous week

Last month

184.6%

9,751

Compared to previous month

Last year

23.8%

63,949

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

11

@typescript-eslint/eslint-plugin @typescript-eslint/parser @babel/eslint-parser eslint-config-prettier eslint-plugin-cypress eslint-plugin-flowtype eslint-plugin-import eslint-plugin-jsx-a11y eslint-plugin-react eslint-plugin-react-hooks eslint-plugin-sonarjs

Peer Dependencies

3

eslint prettier typescript

Dev Dependencies

6

@types/node conventional-changelog-conventionalcommits eslint prettier semantic-release typescript

Versions

Shared ESLint Config

This is the home of the shared E&P Software ESLint configs. The default config should be used for all React Typescript projects in E&P Software.

Usage

The ESLint config and Prettier config must both be added to get the full shared configuration.

(1) Install the shared Prettier and ESLint configs

1npm install --save-dev @emerson-eps/prettier-config @emerson-eps/eslint-config

If you have not already installed prettier and eslint install those as well:

1npm install --save-dev prettier eslint

(2) Configure Prettier

Add @emerson-eps/prettier-config to your .prettierrc.js:

1module.exports = {
2  ...require("@emerson-eps/prettier-config"),
3};

For more advanced setups, including how to override settings, see the instructions in the @emerson-eps/prettier-config repository.

(3) Configure ESLint

Specify the package in the extends section of your ESLint configuration:

1{
2  "extends": "@emerson-eps/eslint-config",
3  "rules": {
4    // Additional rules...
5  }
6}

List of current rules

The list of applied rules can be found here

Running ESLint on your code

Add a lint script to your package.json, for example:

1{
2  "scripts": {
3    "lint": "eslint . --max-warnings=0"
4  }
5}

Code can then be linted with:

1npm run lint

CI pipelines should be configured to fail on linting warnings.

Integration with Visual Studio Code

If not already installed, install the Prettier and ESLint extensions.

Overriding the shared configs

Try not to override the shared configs unless you really need to. If you must override them please consider proposing the override as a change to the relevant repository first to avoid divergence of code styles in different projects.

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Maintained

Determines if the project is "actively maintained".

10

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

License

Determines if the project has defined a license.

10

SAST

Determines if the project uses static code analysis.

9

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

1

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

Score

6.5

/10

Last Scanned on 2024-12-23

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More