Conversation
There was a problem hiding this comment.
Pull request overview
Standardizes repository/package configuration by aligning lockfile metadata with the @ciscode/audit-kit package and adding a project-specific Copilot contributor guide to support consistent development across the codebase.
Changes:
- Updated
package-lock.jsonto reflect the@ciscode/audit-kitpackage name and refreshed dependency lock data. - Added
.github/copilot-instructions.mdcontributor guidance for project structure, testing, versioning, and workflows.
Reviewed changes
Copilot reviewed 1 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| package-lock.json | Aligns lockfile package metadata with @ciscode/audit-kit and updates locked dependency entries. |
| .github/copilot-instructions.md | Adds a Copilot-oriented developer guide intended to standardize contribution patterns and practices. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| ## 🏗️ AuditKit Project Structure | ||
|
|
||
| AuditKit uses the CSR pattern for all modules. All code is in `src/` and organized for maximum reusability and testability. | ||
|
|
||
| ``` | ||
| src/ | ||
| index.ts # Public API exports (only services, DTOs, guards, decorators, types) | ||
| core/ # Core logic, base types, and utilities | ||
| index.ts | ||
| infra/ # Infrastructure helpers (internal) | ||
| nest/ # NestJS-specific modules and adapters | ||
| index.ts | ||
| module.ts # Main NestJS module | ||
| # Add new modules as needed (e.g., audit/, logging/, etc.) | ||
| ``` | ||
|
|
There was a problem hiding this comment.
The project structure example references src/core/infra/ and multiple directories (controllers/, dto/, guards/, decorators/) that don't exist in this repo (currently there is src/infra/, and only src/core, src/infra, src/nest). This makes the guide misleading for contributors—please update the structure section to match the actual folder layout (or clearly label it as aspirational and point to the real paths).
| ### Path Aliases | ||
|
|
||
| Configured in `tsconfig.json`: | ||
|
|
||
| ```json | ||
| "@core/*" : ["src/core/*"], | ||
| "@nest/*" : ["src/nest/*"], | ||
| "@dto/*" : ["src/dto/*"], | ||
| "@guards/*" : ["src/guards/*"], | ||
| "@decorators/*": ["src/decorators/*"], | ||
| "@config/*" : ["src/config/*"], | ||
| "@utils/*" : ["src/core/utils/*"] | ||
| ``` | ||
|
|
||
| Use aliases for imports: | ||
|
|
||
| ```typescript | ||
| import { AuditService } from "@core/audit.service"; | ||
| import { AuditModule } from "@nest/module"; | ||
| import { CreateAuditDto } from "@dto/create-audit.dto"; | ||
| ``` | ||
|
|
There was a problem hiding this comment.
This guide claims TypeScript path aliases are configured in tsconfig.json (and lists @core/*, @nest/*, etc.), but the current tsconfig.json in this repo does not define any compilerOptions.paths. Either add the actual path alias configuration or adjust/remove this section to avoid sending contributors down a dead end.
|
|
||
| - Modular CSR (Controller-Service-Repository) architecture | ||
| - TypeScript strict mode, path aliases, and project references | ||
| - Jest and Vitest testing with 80%+ coverage required |
There was a problem hiding this comment.
The overview states "Jest and Vitest testing" but vitest is not present in package.json/package-lock.json (only Jest is installed). Please either add Vitest as a dependency + scripts, or update this doc to reflect the actual test runner(s) used so contributors don’t try to run non-existent tooling.
| - Jest and Vitest testing with 80%+ coverage required | |
| - Jest testing with 80%+ coverage required |
| npm link @ciscode/example-kit | ||
|
|
||
| # Develop and test | ||
| # Unlink when done | ||
| npm unlink @ciscode/example-kit |
There was a problem hiding this comment.
There are several remaining template placeholders referencing a different package name (e.g., changeset example uses "@ciscode/example-kit", and the npm link example links @ciscode/example-kit). These should be updated to @ciscode/audit-kit (or made intentionally generic) to prevent incorrect copy/paste during releases and local testing.
| npm link @ciscode/example-kit | |
| # Develop and test | |
| # Unlink when done | |
| npm unlink @ciscode/example-kit | |
| npm link @ciscode/audit-kit | |
| # Develop and test | |
| # Unlink when done | |
| npm unlink @ciscode/audit-kit |
|
Standardization Pull Request
Changes
Status
All 7 packages now have identical standardized configuration and workflows.