Codacy Styleguide
This is the Codacy awesome styleguide repository. It will include components, code snippets and how to use them.
Use
SBT
"org.webjars.npm" % "codacy__stylesheets" % "<VERSION>"
"org.webjars.npm" % "codacy__legacy-javascripts" % "<VERSION>"
NPM
"dependencies": {
// ...
"@codacy/stylesheets": "<VERSION>",
"@codacy/legacy-javascripts": "<VERSION>",
"@codacy/react-components": "<VERSION>"
}
Website
Structure
- .aws - Deployment scripts and configurations
- components - Custom react components
- legacy-javacripts - Codacy legacy javascripts
- stylesheets - Codacy stylesheets
- website-legacy - Codacy styleguide legacy website
Develop
Install Dependencies
yarn
yarn bolt:install
Legacy Website
# yarn start:website-legacy # Just rebuilds the website without updating on dependency changes
yarn start:website-legacy-and-dependencies
React Components
yarn build:components
Stylesheets
yarn build:stylesheets
Legacy Javascripts
yarn build:legacy-javascripts
Others
Check section scripts
in package.json
What is Codacy
Codacy 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 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, Jira, YouTrack
- Track issues 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.