https://github.com/codacy/codacy-metrics-eslint
Eslint Tool for Codacy Metrics
https://github.com/codacy/codacy-metrics-eslint
Last synced: 9 months ago
JSON representation
Eslint Tool for Codacy Metrics
- Host: GitHub
- URL: https://github.com/codacy/codacy-metrics-eslint
- Owner: codacy
- Created: 2018-08-08T14:10:56.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2025-04-15T09:07:48.000Z (10 months ago)
- Last Synced: 2025-04-20T11:43:56.135Z (9 months ago)
- Language: TypeScript
- Homepage:
- Size: 1.73 MB
- Stars: 1
- Watchers: 11
- Forks: 2
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Codacy Metrics ESLint
[](https://app.codacy.com/gh/codacy/codacy-metrics-eslint/dashboard?utm_source=gh&utm_medium=referral&utm_content=&utm_campaign=Badge_grade)
[](https://circleci.com/gh/codacy/codacy-metrics-eslint)
## Usage
You can create the docker by doing:
```bash
npm run build:docker
```
The docker is ran with the following command:
```bash
docker run -it -v $srcDir:/src :
docker run -it -v $PWD/src/test/resources:/src codacy/codacy-metrics-eslint:latest
```
## Test
Before running the tests, you need to install the dependencies:
```bash
npm install
```
Then you can run tests using:
```bash
npm test
```
### codacy-plugins-test
We use [codacy-plugins-test](https://github.com/codacy/codacy-plugins-test) to run integration tests
in our tools. After downloading the binary and creating the docker image you can run:
```bash
codacy-plugins-test metrics codacy-metrics-eslint
```
## What is Codacy
[Codacy](https://www.codacy.com/) is an Automated Code Review Tool that monitors your technical debt, helps you improve your code quality, teaches best practices to your developers, and helps you save time in Code Reviews.
### Among Codacy’s features
- Identify new Static Analysis issues
- Commit and Pull Request Analysis with GitHub, BitBucket/Stash, GitLab (and also direct git repositories)
- Auto-comments on Commits and Pull Requests
- Integrations with Slack, HipChat, Jira, YouTrack
- Track issues in Code Style, Security, Error Proneness, Performance, Unused Code and other categories
Codacy also helps keep track of Code Coverage, Code Duplication and Code Complexity.
Codacy supports PHP, Python, Ruby, Java, JavaScript and Scala, among others.
### Free for Open Source
Codacy is free for Open Source projects.