feat: add typed readJSON overload for package.json#162
Merged
rhuanbarreto merged 1 commit intomainfrom Mar 23, 2026
Merged
Conversation
Add a PackageJson interface and a readJSON("package.json") overload
that returns Promise<PackageJson> instead of Promise<unknown>, removing
the need for manual type assertions in rules. Includes workspaces and
catalog fields. Mirrors the overload in both the canonical RuleContext
and the generated rules.d.ts shim.
Deploying archgate-cli with
|
| Latest commit: |
06ef9c7
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://41012145.archgate-cli.pages.dev |
| Branch Preview URL: | https://feat-readjson-package-json-o.archgate-cli.pages.dev |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
PackageJsoninterface with common fields (name,version,dependencies,devDependencies,scripts,workspaces,catalog, etc.) plus an index signature for flexibilityreadJSON("package.json")overload onRuleContextthat returnsPromise<PackageJson>instead ofPromise<unknown>rules.d.tsshimascasts from existing rules (ARCH-006, ARCH-013)Test plan
bun run validatepasses (lint, typecheck, format, tests, ADR check, build)