Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

TypeScript checking #447

Closed
lukehesluke opened this issue Mar 5, 2024 · 0 comments · Fixed by #446
Closed

TypeScript checking #447

lukehesluke opened this issue Mar 5, 2024 · 0 comments · Fixed by #446
Assignees

Comments

@lukehesluke
Copy link
Contributor

lukehesluke commented Mar 5, 2024

Rationale

Changes to Data Model Validator are propagated to 1). The user-facing validator.openactive.io 2). Other libraries and tools like Test Suite.

For this reason, it's important to be sure not to break things. TypeScript, which we already use in other projects, and can be easily integrated into JS-only projects via JSDoc (which thus also improves documentation)

Suggestion

  • Add TS checking as part of npm test
  • Set coverage to include as much as possible, but exclude any files that have too many errors. Try to include at least fundamental files
  • Update the contributing guide to suggest adding new rules to tsconfig.json include list
@lukehesluke lukehesluke converted this from a draft issue Mar 5, 2024
@lukehesluke lukehesluke self-assigned this Mar 5, 2024
@lukehesluke lukehesluke moved this from 🏗 In progress to 👀 In review in OpenActive Infrastructure Mar 5, 2024
@github-project-automation github-project-automation bot moved this from 👀 In review to ✅ Done in OpenActive Infrastructure Mar 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: ✅ Done
Development

Successfully merging a pull request may close this issue.

1 participant