Skip to content

feat: add TypeScript SDK linting, testing, and CI workflows#657

Open
koxudaxi wants to merge 1 commit into08-05-feat_typescript_openai_opentelemetry_supportfrom
08-06-test_implement_100_test_coverage_for_openai_opentelemetry_support_in_typescript_add_ci
Open

feat: add TypeScript SDK linting, testing, and CI workflows#657
koxudaxi wants to merge 1 commit into08-05-feat_typescript_openai_opentelemetry_supportfrom
08-06-test_implement_100_test_coverage_for_openai_opentelemetry_support_in_typescript_add_ci

Conversation

@koxudaxi
Copy link
Copy Markdown
Contributor

@koxudaxi koxudaxi commented Aug 6, 2025

TL;DR

Add linting, formatting, and testing infrastructure to the TypeScript SDK along with GitHub Actions workflows for CI.

What changed?

  • Added ESLint configuration with TypeScript-specific rules
  • Added Prettier for code formatting
  • Set up Vitest for unit testing with coverage reporting
  • Created two GitHub Actions workflows:
    • typescript-sdk-lint.yml for linting and formatting checks
    • typescript-sdk-test.yml for running tests across Node.js versions 20, 22, and 24
  • Added npm scripts for running tests, linting, type checking, and formatting
  • Updated package.json with new development dependencies
  • Added configuration files for ESLint, Prettier, and Vitest
  • Updated .prettierignore and eslint.config.ts in the root directory to exclude the SDK directories

How to test?

  1. Navigate to the TypeScript SDK directory:
cd sdks/typescript
  1. Install dependencies:
npm ci
  1. Run the linting checks:
npm run lint
  1. Run the type checking:
npm run typecheck
  1. Run the formatting check:
npm run format:check
  1. Run the tests with coverage:
npm run test:coverage

Why make this change?

This change establishes a robust development environment for the TypeScript SDK with proper code quality tools and automated testing. The GitHub Actions workflows ensure that code quality is maintained on every pull request and push to main branches. This infrastructure will help maintain code quality, catch bugs early, and ensure the SDK remains reliable as it evolves.

Copy link
Copy Markdown
Contributor Author

koxudaxi commented Aug 6, 2025

@github-actions
Copy link
Copy Markdown

github-actions bot commented Aug 6, 2025

🚀 Preview Deployment

Your changes have been deployed to a preview environment:

Preview URL: https://lilypad-pr-657.mirascope.workers.dev

Database Branch: preview/pr-657


Last updated: 2025-08-06T14:04:55Z (Commit: 5e48a03)

@koxudaxi koxudaxi changed the title test: Implement 100% test coverage for OpenAI OpenTelemetry support in TypeScript feat: add TypeScript SDK linting, testing, and CI workflows Aug 6, 2025
@koxudaxi koxudaxi marked this pull request as ready for review August 6, 2025 13:25
@koxudaxi koxudaxi changed the base branch from 08-06-test_implement_100_test_coverage_for_openai_opentelemetry_support_in_typescript_fix_openai_types to graphite-base/657 August 6, 2025 13:32
@koxudaxi koxudaxi force-pushed the 08-06-test_implement_100_test_coverage_for_openai_opentelemetry_support_in_typescript_add_ci branch from f8ce5e1 to 97d0810 Compare August 6, 2025 13:33
@koxudaxi koxudaxi force-pushed the graphite-base/657 branch from 5f83ebd to 5bd4e72 Compare August 6, 2025 13:33
@koxudaxi koxudaxi changed the base branch from graphite-base/657 to 08-05-feat_typescript_openai_opentelemetry_support August 6, 2025 13:33
@koxudaxi koxudaxi force-pushed the 08-06-test_implement_100_test_coverage_for_openai_opentelemetry_support_in_typescript_add_ci branch 3 times, most recently from b92eefb to eb6d12b Compare August 6, 2025 13:58
@koxudaxi koxudaxi force-pushed the 08-06-test_implement_100_test_coverage_for_openai_opentelemetry_support_in_typescript_add_ci branch from eb6d12b to 3960052 Compare August 6, 2025 14:04
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