Skip to content

chore: improve CLAUDE.md with architecture and conventions#21

Merged
dbejarano820 merged 2 commits intomainfrom
chore/claude-md-improvements
Feb 22, 2026
Merged

chore: improve CLAUDE.md with architecture and conventions#21
dbejarano820 merged 2 commits intomainfrom
chore/claude-md-improvements

Conversation

@dbejarano820
Copy link
Copy Markdown
Contributor

Summary

  • Add missing SDK modules (config, tax, logging) and shared package structure
  • Add build/test details: tsup config, Vitest globals, Turbo caching behavior
  • Add coding conventions: consistent-type-imports, _ prefix for unused vars, ESM-only, test naming patterns
  • Update dependencies: replace outdated haciendacostarica-signer reference with actual signing stack (xadesjs, xmldsigjs, node-forge)
  • Add dependency flow diagram and build order note

Test plan

  • Verify CLAUDE.md renders correctly on GitHub
  • Confirm all referenced paths and module names are accurate

🤖 Generated with Claude Code

Add missing SDK modules (config, tax, logging), shared package structure,
build/test details (tsup, Vitest, Turbo caching), coding conventions
(type imports, ESM-only, test naming), and updated dependencies.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@greptile-apps
Copy link
Copy Markdown

greptile-apps bot commented Feb 22, 2026

Greptile Summary

This PR adds a comprehensive CLAUDE.md documentation file that accurately describes the project architecture, build tooling, and coding conventions for AI-assisted development.

Key improvements:

  • Documented all SDK modules (config/, tax/, logging/) with accurate purposes and locations
  • Added correct build/test configuration details (tsup ESM output, Vitest globals, Turbo caching)
  • Listed accurate coding conventions including consistent-type-imports, unused var prefix _, ESM-only modules, and test naming patterns
  • Updated dependencies section to reflect actual signing stack (xadesjs, xmldsigjs, node-forge) rather than outdated placeholder
  • All package names, paths, commands, frameworks, and configuration details verified against codebase

Minor issue found:

  • Line 58 claims "190+ symbols" in SDK exports, but actual count appears to be 80-100 based on packages/sdk/src/index.ts

Confidence Score: 4/5

  • This documentation-only PR is safe to merge with minimal risk
  • All technical references verified as accurate (module paths, package names, dependencies, configs). Only minor issue is an overstated export count claim that doesn't affect functionality. Documentation improves AI-assisted development experience.
  • No files require special attention - single documentation file with one minor accuracy issue

Important Files Changed

Filename Overview
CLAUDE.md Comprehensive documentation file with accurate architecture details and conventions; minor issue with export count claim

Last reviewed commit: 33ec845

Copy link
Copy Markdown

@greptile-apps greptile-apps bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

1 file reviewed, 1 comment

Edit Code Review Agent Settings | Greptile

| `tax/` | Tax calculation: rounding, line items, IVA math |
| `logging/` | Structured logger with levels (DEBUG→SILENT), text/JSON output |

Each module uses barrel exports via `index.ts`. The SDK root `src/index.ts` re-exports 190+ symbols organized by domain.
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The claim of "190+ symbols" appears overstated. Based on packages/sdk/src/index.ts, there are significantly fewer exported symbols (approximately 80-100 when counting all named exports, types, and re-exports). Consider updating to a more accurate count or removing the specific number.

Prompt To Fix With AI
This is a comment left during a code review.
Path: CLAUDE.md
Line: 58

Comment:
The claim of "190+ symbols" appears overstated. Based on `packages/sdk/src/index.ts`, there are significantly fewer exported symbols (approximately 80-100 when counting all named exports, types, and re-exports). Consider updating to a more accurate count or removing the specific number.

How can I resolve this? If you propose a fix, please make it concise.

Run Prettier on CLAUDE.md to fix formatting. Add husky + lint-staged
so Prettier runs automatically on all staged files before every commit.

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
@dbejarano820 dbejarano820 merged commit 93209e2 into main Feb 22, 2026
1 check passed
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