Skip to content

Conversation

@pxlvre
Copy link

@pxlvre pxlvre commented Oct 25, 2025

Summary

This PR introduces code quality tooling and workspace management to improve development workflow, code consistency, and maintainability across the entire project.

Changes Made

Workspace Management

  • Added root package.json with workspace configuration for all three packages
  • Consolidated dependency management and tooling at the repository level

Code Quality Tools

  • ESLint: Configured with TypeScript support and strict linting rules
  • Prettier: Set up for consistent code formatting across all files
  • TypeDoc: Added configuration for API documentation generation

Development Workflow

  • Commitizen: Implemented standardized conventional commit messages
  • Husky: Configured git hooks for automated code quality checks
  • lint-staged: Set up to run tools only on changed files during commits

TypeScript Configuration

  • Created shared root tsconfig.json with common compiler settings
  • Updated individual project configs to extend the root configuration
  • Maintains existing build processes while reducing duplication

Code Formatting

  • Applied Prettier formatting to all existing code for consistency
  • Updated repository URLs in package.json files to reference correct GitHub repository

Available Scripts

After merging, the following commands will be available at the root level:

  • npm run lint / npm run lint:fix - ESLint checking and fixing
  • npm run format / npm run format:check - Prettier formatting
  • npm run docs - Generate TypeDoc documentation
  • npm run commit - Interactive conventional commit tool
  • npm run type-check - TypeScript compilation check

Notes

  • All existing functionality and build processes are preserved
  • The strict ESLint configuration reveals existing code quality issues that can be addressed incrementally
  • Git hooks are configured but can be bypassed with --no-verify if needed during transition
  • This establishes the foundation for improved code quality without breaking existing workflows

Test Plan

  • Verify all three packages still build correctly
  • Test that existing development workflows continue to function
  • Confirm new tooling commands work as expected
  • Validate TypeScript compilation across all projects

- Add root package.json with workspace management for all three packages
- Configure ESLint with TypeScript support and strict linting rules
- Set up Prettier for consistent code formatting across the project
- Add TypeDoc configuration for API documentation generation
- Implement Commitizen for standardized conventional commit messages
- Configure Husky git hooks for pre-commit linting and formatting
- Add lint-staged to run tools only on changed files
- Create shared root tsconfig.json with common TypeScript settings
- Update individual tsconfig.json files to extend root configuration
- Format all existing code with Prettier for consistency
- Update repository URLs in package.json to point to correct GitHub repo

This establishes a foundation for code quality, consistency, and
maintainability across the entire project while preserving existing
functionality and build processes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant