npmpackage.info

Gathering detailed insights and metrics for eslint-plugin-vtex

eslint-plugin-vtex

VTEX's TypeScript tools, style guide and best practices

2.3.0

MIT

JavaScript

1,465,651 3.3

Installations

npm install eslint-plugin-vtex

Pull Requests

Open

7

Total

67

Closed

5

Merged

55

Issues

Open

16

Total

49

Closed

33

Releases

Unable to fetch releases

Developer

vtex

Developer Guide

BETA

Module System

CommonJS

Min. Node Version

Typescript Support

Yes

Node Version

20.12.2

NPM Version

lerna/3.22.1/node@v20.12.2+x64 (linux)

Statistics

55 Stars

296 Commits

7 Forks

113 Watching

12 Branches

35 Contributors

Updated on 22 Sept 2024

Languages

JavaScript (64.01%)

TypeScript (35.52%)

Shell (0.47%)

Total Downloads

Cumulative downloads

Total Downloads

1,465,651

Last day

102.9%

1,804

Compared to previous day

Last week

39.3%

10,596

Compared to previous week

Last month

11.4%

38,508

Compared to previous month

Last year

-7.3%

379,754

Compared to previous year

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Versions

Typescript Standards

Main repository for VTEX's Typescript standards. Issues should be used to start discussions about standards and patterns. PRs are welcome after being rightfully discussed.

Content

`docs/`

Style Guide - VTEX Javascript/Typescript style guide
Getting Started - Getting starting guide to configure and automate our tooling process
Browser Support - VTEX browser support documentation

`packages/`

eslint-config-vtex - base eslint rule preset
eslint-config-vtex-react - eslint rule preset for react projects
eslint-plugin-vtex - eslint plugin with VTEX custom rules
prettier-config - prettier preset of all front-end projects
tsconfig - base tsconfig for all typescript projects

Add these packages to a new project

Bootstrap on a new node and typescript project

If you're not using Bash, change /bin/bash to your shell's executable path.

1/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/vtex/typescript/master/scripts/bootstrap-typescript.sh)"

Warning: This will override the following configuration files: .prettierrc, .eslintrc and tsconfig.json.

Contributing

Nothing is written in stone, so if there's some kind of rule or pattern that you wish to discuss or implement, we encourage an open discussion via this repository issues. The project use labels to keep everything organized and easy-to-find:

discussion - discussion thread;
style - related to code style, something that there's no wrong or right;
practices/patterns - related to good coding practices that should be standardized and documented;
documentation - a generic documentation issue;
todo - common TODO item, with no explicit SLA.

Feel free to use more than one label in an issue, but try keeping them semantic to help developers.

Working with the packages

This project uses lerna with yarn workspaces, so it's highly recommended to read at least the Lerna documentation.

Bootstrap the repository

Running yarn will automatically install all the dependencies for all packages and link them together when needed.

1yarn

Executing commands

To run a package.json script on all packages, you can use:

1lerna run {scriptName}
2# will run the scriptName script on all package directories

If you want to only run on some packages, pass a --scope=package-name to the command above. For more instructions, see the lerna run documentation.

1lerna run --scope="eslint-*" test
2# run the test script on all packages that match the pattern above

The same can be done for regular shell programs with the lerna exec command:

1lerna exec "pwd"
2# will print the pwd of all package directories

Note: The quotes are not needed if your command doesn't have a string with spaces.

Releasing new versions

For every release, there should be at least one new changelog entry for every modified package. This repository follows the keep a changelog format. The chan CLI can be used to help adding changelog entries:

1chan fixed "Fix that nasty potato bug"

It's also possible to run the command on multiple packages with the lerna exec command:

1lerna exec "chan fixed 'Fix that nasty potato bug'"
2# note the quotes

Every package has a version script that will automatically update their changelog with the new version and entries whenever lerna publish or lerna version is used.

Relevant commands:

lerna version - Only update versions without publishing the packages.
lerna publish - Update the version and publish the packages.

No vulnerabilities found.

10

Dangerous-Workflow

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

10

Binary-Artifacts

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

10

License

Determines if the project has defined a license.

5

Code-Review

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

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

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

0

Pinned-Dependencies

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

0

CII-Best-Practices

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

0

Fuzzing

Determines if the project uses fuzzing.

0

Security-Policy

Determines if the project has published a security policy.

0

SAST

Determines if the project uses static code analysis.

0

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

Score

3.3

/10

Last Scanned on 2024-11-18

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

eslint-plugin-vtex

Installations

Pull Requests

7

67

5

55

Issues

16

49

33

Releases

Unable to fetch releases

Developer

vtex

Developer Guide

CommonJS

Yes

20.12.2

lerna/3.22.1/node@v20.12.2+x64 (linux)

Statistics

Languages

Total Downloads

1,465,651

Daily Downloads

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

Peer Dependencies

Dev Dependencies

Typescript Standards

Content

docs/

packages/

Add these packages to a new project

Bootstrap on a new node and typescript project

Contributing

Working with the packages

Bootstrap the repository

Executing commands

Releasing new versions

10

10

10

5

0

0

0

0

0

0

0

0

3.3

/10

`docs/`

`packages/`