Skip to content

Type check code examples in .code-samples.meilisearch.yaml #1947

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.

Sign up for GitHub

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

Jump to bottom
Open
flevi29 opened this issue May 14, 2025 · 0 comments · May be fixed by #1948
Open

Type check code examples in .code-samples.meilisearch.yaml #1947

flevi29 opened this issue May 14, 2025 · 0 comments · May be fixed by #1948
Labels
maintenance Issue about maintenance (CI, tests, refacto...)

Comments

@flevi29
Copy link
Collaborator

flevi29 commented May 14, 2025

It is not rare that we get problems regarding outdated code samples.

We should create a script that generates temporary TypeScript code from the examples before the type checker runs, so that it can check the code samples as well.
@flevi29 flevi29 added the maintenance Issue about maintenance (CI, tests, refacto...) label May 14, 2025
@flevi29 flevi29 linked a pull request May 16, 2025 that will close this issue
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
maintenance Issue about maintenance (CI, tests, refacto...)
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add script for manipulating and checking code samples flevi29/meilisearch-js
1 participant
@flevi29