https://github.com/codacy/codacy-spectral
Codacy Tool for Spectral
https://github.com/codacy/codacy-spectral
Last synced: 7 months ago
JSON representation
Codacy Tool for Spectral
- Host: GitHub
- URL: https://github.com/codacy/codacy-spectral
- Owner: codacy
- License: apache-2.0
- Created: 2021-10-18T14:20:08.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2025-03-28T17:44:21.000Z (10 months ago)
- Last Synced: 2025-06-22T02:03:40.771Z (7 months ago)
- Language: TypeScript
- Size: 1.65 MB
- Stars: 0
- Watchers: 10
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Codacy Spectral
This is an integration created so that Codacy can run the [spectral](https://github.com/stoplightio/spectral)
tool in its infrastructure, or using its [CLI](https://github.com/codacy/codacy-analysis-cli).
## Generating documentation
```bash
cd doc-generator
npm install
npm run compile && node dist/index.js
```
## Build docker image
```bash
docker build -t codacy-spectral .
```
## Test changes to codacy-seed locally
You may need to test changes that comes from our [codacy-engine-typescript-seed](https://github.com/codacy/codacy-engine-typescript-seed).
1. Create a package with your changes on the seed:
* Don't forget to update the dependencies: `npm install`
* Compile the library: `npm run compile`
* Package the library: `npm pack`
> This should generate a codacy-seed-0.0.1.tgz on your codacy-seed repository
2. Copy the `codacy-seed-0.0.1.tgz` into the root of this repository
3. Install the package: `npm install codacy-seed-0.0.1.tgz`
4. Update Dockerfile and `.dockerignore` so you copy the `codacy-seed-0.0.1.tgz` inside the docker you will be building
* Add `!codacy-seed-0.0.1.tgz` to your `.dockerignore`
* Add the package to the docker before `RUN npm install`: `COPY codacy-seed-0.0.1.tgz ./`
* Remove multi-stage docker steps
* Lines from `FROM node:$NODE_IMAGE_VERSION` to `RUN rm -rf /package.json /package-lock.json`
> This way you skip copying the files to the other docker, and another `npm install`
5. Publish your docker locally as normal: `docker build -t codacy-spectral .`
## 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.