35 lines (22 loc) · 1.65 KB

name	code-review
description	PR review checklist for contentstack-cli-tsgen (CLI, errors, Delivery/GraphQL, types-generator dependency).

Code review skill (`contentstack-cli-tsgen`)

CLI and docs

Help text, static examples, and README/oclif-generated docs stay in sync when flags or behavior change.
Short command name tsgen / TSGEN comes from csdxConfig in package.json.

Product language

Prefer Delivery token flows; GraphQL requires delivery token in code paths—reviewers should catch CMA-centric wording that misleads users.

Errors

printFormattedError in src/lib/helper.ts maps error_code to user-facing messages; extend switches carefully for backward compatibility.

Dependency on the library

Business logic for generateTS / graphqlTS belongs in @contentstack/types-generator (npm, GitHub). CLI changes should orchestrate and format, not reimplement generation.

Tests and CI

Integration tests depend on csdx and TOKEN_ALIAS; document env needs when adding cases.
Backward compatibility: Avoid breaking changes to flags, exit behavior, or output file contract without semver intent.
Supply chain: .github/workflows/sca-scan.yml runs Snyk on pull requests.

Optional severity

Blocker: Wrong token type handling, broken csdx contract, security issues.
Major: Missing integration coverage for new flags, unclear errors.
Minor: Copy, non-breaking refactors.