Skip to content

Add shared scanner contract aliases#39

Merged
alyldas merged 1 commit into
mainfrom
issue-38-scanner-contract-aliases
Jul 1, 2026
Merged

Add shared scanner contract aliases#39
alyldas merged 1 commit into
mainfrom
issue-38-scanner-contract-aliases

Conversation

@alyldas

@alyldas alyldas commented Jul 1, 2026

Copy link
Copy Markdown
Contributor

Summary

  • Add short shared scanner contract aliases: ScanInput, ScanHints, and ScanResult.
  • Export the aliases from the public package entrypoint while keeping existing longer contract names.
  • Document the aliases in the README and add compile-time coverage for the shared scanner shapes.

Validation

  • npm ci
  • npm run check with a temporary npm cache because the local user cache has permission-owned files
  • npm pack --dry-run with a temporary npm cache

Benchmark Evidence

  • No runtime benchmark is applicable for this PR because the change is type-only and does not alter scanner runtime behavior.
  • Existing scanner check/scan/censor tests pass through npm run check.

Compatibility Notes

  • Backward compatible additive public type exports only.
  • Existing PreparedText, TextHints, and TextRangePipelineScanResult names remain supported.

Closes #38

BEGIN_COMMIT_OVERRIDE
feat: add shared scanner contract aliases
END_COMMIT_OVERRIDE

@alyldas alyldas merged commit 9e8a8bf into main Jul 1, 2026
4 checks passed
@alyldas alyldas deleted the issue-38-scanner-contract-aliases branch July 1, 2026 13:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

Add allocation-aware scanner contracts and shared text hints

1 participant