Code Quality & Standards

[TheRustifyer]

Purpose

This category is dedicated to establishing a unified, comprehensive standard for ensuring code quality, consistency, and maintainability across the diverse tech stack of summoners-sync. Here, we will decide on the mandatory tools and practices for each language and framework used in the project. This ensures every component of the app meets professional-grade standards, highlighting our expertise in modern development practices.

Scope

The tools we will evaluate and choose fall under a single umbrella term: Code Assurance Tools. This term encompasses:

Linters: Tools that enforce coding standards by identifying syntax errors, stylistic issues, or anti-patterns.
Formatters: Automatic code formatters that ensure consistent code style across the team.
Code Coverage Tools: Tools that measure and report on how much of the codebase is exercised by automated tests.
Other Tools: Static analysis, dependency vulnerability scanners, and test-related utilities that ensure code integrity and reliability.

Goals of this Discussion:

Select and standardize mandatory Code Assurance Tools for each language, framework, or stack.
Ensure all selected tools integrate seamlessly into CI/CD pipelines, enhancing automation.
Prioritize tools with strong documentation, wide adoption, and Riot Games-compatible workflows.
Promote a culture of TDD (Test-Driven Development) by integrating these tools effectively into the development lifecycle.

Target Languages and Frameworks:

- Rust
- Java (Spring)
- Go
- Python
- JavaScript/TypeScript (React with Vite)
- C++

To ensure code quality, consistency, and maintainability across all components of summoners-sync, we propose the following suite of mandatory tools for each language and framework. These will be integrated into GitHub Actions for enforcement on pull requests against the default branch.

The techs discussed below are auto-generated by ChatGPT, so read it and think about it with caution. Those are just listed as reference, so we need to check them carefully and ensure that meets our quality standards criteria

Rust

- Linters: clippy
- Formatters: rustfmt
- Code Coverage Tools: cargo-xtask (custom Rust task runner, also integrates code coverage)
- Static Analysis: miri for memory safety checks
- Dependency Vulnerability Scanner: cargo-audit
- Test-Related Utilities: mockall for mocking, async-std for async unit testing, and testcontainers for integration testing
    Best Frameworks:
        Unit Testing: async-std
        Integration Testing: testcontainers

Java

- Linters: Checkstyle, PMD, SpotBugs
    Checkstyle for code style enforcement
    PMD for static analysis and code smells
    SpotBugs for finding potential bugs
- Formatters: Google Java Formatter, Eclipse Formatter
- Code Coverage Tools: JaCoCo
- Static Analysis: SonarQube
- Dependency Vulnerability Scanner: OWASP Dependency-Check
- Test-Related Utilities: JUnit for unit testing, Spring Boot Test for integration testing
    Best Frameworks:
        Unit Testing: JUnit
        Integration Testing: Spring Boot Test

Go

- Linters: golangci-lint
    Comprehensive linter covering style, errors, and performance
- Formatters: gofmt
- Code Coverage Tools: cover
- Static Analysis: go vet
- Dependency Vulnerability Scanner: govulncheck
- Test-Related Utilities: testify for unit testing, Ginkgo for integration testing
    Best Frameworks:
        Unit Testing: testify
        Integration Testing: Ginkgo

Python

- Linters: flake8, pylint
    flake8 for standard Python linting
    pylint for deeper code analysis
- Formatters: black
- Code Coverage Tools: pytest-cov
- Static Analysis: mypy for type checking, pylint for code review
- Dependency Vulnerability Scanner: safety
- Test-Related Utilities: pytest for unit and integration testing, mock or unittest.mock for mocking
    Best Frameworks:
        Unit Testing: pytest
        Integration Testing: pytest

JavaScript/TypeScript (React with Vite)

- Linters: eslint with prettier
    eslint for JavaScript and TypeScript linting
    prettier for consistent code formatting
- Formatters: prettier
- Code Coverage Tools: istanbul or nyc
- Static Analysis: tslint, eslint
- Dependency Vulnerability Scanner: npm audit
- Test-Related Utilities: jest for unit and integration testing, react-testing-library for UI tests
    Best Frameworks:
        Unit Testing: jest
        Integration Testing: jest + react-testing-library

C++

- Linters: clang-tidy
- Formatters: clang-format
- Code Coverage Tools: gcov
- Static Analysis: cppcheck
- Dependency Vulnerability Scanner: cppdeps
- Test-Related Utilities: Catch2 for unit testing, GTest for integration testing

Integration in GitHub Actions

Linters, Formatters, Code Coverage, Static Analysis, and Test Utilities will be enforced through individual GitHub Actions workflows.
PRs against the default branch will be blocked if issues are detected (e.g., failing tests, linting errors, poor code coverage, etc.).

This ensures all components of summoners-sync meet required quality standards for deployment in Kubernetes and usage within the Riot Games ecosystem.