Skip to content

feat: Add Conventionality evaluator to TypeScript SDK#25

Merged
adnanrhussain merged 3 commits intomainfrom
ahussain/typescript_sdk_add_conventionality
Mar 20, 2026
Merged

feat: Add Conventionality evaluator to TypeScript SDK#25
adnanrhussain merged 3 commits intomainfrom
ahussain/typescript_sdk_add_conventionality

Conversation

@adnanrhussain
Copy link
Contributor

@adnanrhussain adnanrhussain commented Mar 19, 2026

Summary

This PR implements the Conventionality evaluator to the TypeScript SDK

Documentation

See sdks/typescript/README.md

Testing

TODO: Add tests

  • CI workflow should build successfully

Copy link

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Adds the “Conventionality” qualitative text-complexity evaluator to the TypeScript SDK and integrates it into the existing composite Text Complexity evaluator.

Changes:

  • Introduces ConventionalityEvaluator (and evaluateConventionality) with a new Zod output schema and prompt helpers.
  • Extends TextComplexityEvaluator to run Conventionality alongside the existing sub-evaluators and returns it in TextComplexityResult.
  • Updates TypeScript SDK exports and README documentation to include the new evaluator.

Reviewed changes

Copilot reviewed 7 out of 7 changed files in this pull request and generated 4 comments.

Show a summary per file
File Description
sdks/typescript/src/schemas/conventionality.ts Adds Zod schema/type for Conventionality evaluator structured output.
sdks/typescript/src/prompts/conventionality/index.ts Adds system/user prompt loaders + template substitution for Conventionality.
sdks/typescript/src/evaluators/conventionality.ts Implements the Conventionality evaluator and functional API wrapper.
sdks/typescript/src/evaluators/text-complexity.ts Adds Conventionality as a 4th parallel sub-evaluator and returns it in results.
sdks/typescript/src/evaluators/index.ts Re-exports ConventionalityEvaluator and evaluateConventionality.
sdks/typescript/src/index.ts Exposes Conventionality types and evaluator APIs at the package entrypoint.
sdks/typescript/README.md Documents Conventionality evaluator and updates Text Complexity docs accordingly (but section numbering needs a fix).

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

You can also share your feedback on Copilot code review. Take the survey.

Copy link

@czi-fsisenda czi-fsisenda left a comment

Choose a reason for hiding this comment

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

Looks good! Very similar to SMK.
Needs tests and copilot has some comments that should be addressed.
Approving to unblock. Expecting final implementation will be very similar to SMK.

Base automatically changed from gmu/add-conventionality-prompt to main March 20, 2026 19:43
@adnanrhussain adnanrhussain force-pushed the ahussain/typescript_sdk_add_conventionality branch from fc3bdc2 to e6c3e51 Compare March 20, 2026 20:30
@adnanrhussain adnanrhussain merged commit 5ca6976 into main Mar 20, 2026
10 checks passed
@adnanrhussain adnanrhussain deleted the ahussain/typescript_sdk_add_conventionality branch March 20, 2026 20:39
@codecov
Copy link

codecov bot commented Mar 20, 2026

Codecov Report

❌ Patch coverage is 87.50000% with 7 lines in your changes missing coverage. Please review.

Files with missing lines Patch % Lines
sdks/typescript/src/evaluators/conventionality.ts 84.09% 7 Missing ⚠️

📢 Thoughts on this report? Let us know!

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.

3 participants