Skip to content

20 code samples in your docs no longer compile #709

Description

@David19876543210

I ran snippetcheck against the drizzle-orm docs — it type-checks every TypeScript sample in a docs site against the package's own published declarations, nothing executed.

Against drizzle-orm@0.45.2, 20 findings marked included after review:

Kind Symbol Section Page
removed-export getColumns drizzle-graphql > Customizing schema > SQLite > Step 4 - Pull Gel types to Drizzle schema https://orm.drizzle.team/docs/guides/include-or-exclude-columns
removed-export defineRelations drizzle-graphql > Customizing schema > SQLite > Step 4 - Pull Gel types to Drizzle schema https://orm.drizzle.team/docs/guides/include-or-exclude-columns
removed-export mediumblob Cache > --- > mediumblob https://orm.drizzle.team/docs/mysql/column-types
removed-export defineRelations Drizzle relations > --- > One-to-many https://orm.drizzle.team/docs/mysql/relations
removed-export defineRelations Drizzle relations > --- > Performance > Many-to-many Relationships https://orm.drizzle.team/docs/mysql/relations
removed-export defineRelations Drizzle Queries https://orm.drizzle.team/docs/mysql/rqb
removed-export numeric Drizzle Seed > Complex example https://orm.drizzle.team/docs/mysql/seed-overview
unknown-option codec Codecs > How codecs work in customType() https://orm.drizzle.team/docs/codecs
unknown-option codec Codecs > How codecs work in customType() https://orm.drizzle.team/docs/codecs
renamed-property update_counter Codecs > --- > Default value https://orm.drizzle.team/docs/column-types
removed-export getColumns Drizzle <> PostgreSQL > Get Typed Columns https://orm.drizzle.team/docs/goodies
removed-export defineRelations Drizzle relations > --- > Performance > One-to-one Relationships https://orm.drizzle.team/docs/relations
removed-property withRLS Row-Level Security (RLS) > Enable RLS https://orm.drizzle.team/docs/rls
removed-export defineRelations Drizzle Queries https://orm.drizzle.team/docs/rqb
removed-export defineRelations Drizzle relations > --- > Many-to-many https://orm.drizzle.team/docs/singlestore/relations-v2
removed-export defineRelations Drizzle Queries https://orm.drizzle.team/docs/singlestore/rqb-v2
removed-export defineRelations Drizzle relations > --- > One-to-many https://orm.drizzle.team/docs/sqlite/relations
removed-export defineRelations Drizzle relations > --- > Performance > Many-to-many Relationships https://orm.drizzle.team/docs/sqlite/relations
removed-export defineRelations Drizzle Queries https://orm.drizzle.team/docs/sqlite/rqb
removed-export getColumns Drizzle Sustainability > Query examples > Insert data > Select data https://orm.drizzle.team/docs/tutorials/drizzle-with-vercel

Method: type-checked against the package's own .d.ts declarations, nothing executed. 136 of 4037 extracted TypeScript samples checked. Skipped: 88 before-example, 550 historical-section, 291 no-target-import, 61 unresolved-import, 12 unparseable.

Happy to share the full report, or re-run this after your next release.

— David

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions