document that node.js is required to run drizzle-kit

Open Beginner friendly
#538 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
62/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
node.js
Domain
documentation

Research direction

Start with the gotchas page linked in the issue and find the section covering drizzle-kit prerequisites. Document that Node.js is required to run drizzle-kit, including that missing Node.js can produce the shown misleading error; done means the requirement is clearly visible in the published documentation.

Written by the indexing model from the issue text.

Description

Hi.

I just noticed that drizzle-kit fails with seemingly irrelevant error messages if I don't have node.js installed.

(this is the message that I got)

$ bun drizzle-kit push
No config path provided, using default 'drizzle.config.ts'
Reading config file '/path/to/drizzle.config.ts'
require() async module "/path/to/drizzle.config.ts" is unsupported. use "await import()" instead.
error: "drizzle-kit" exited with code 1

Is it possible to state that node.js is required to run drizzle-kit? maybe in gotchas?

Dominant language
MDX
Stars
241
Forks
402
Avg merge
4d 6h
Merged PRs (30d)
4

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from drizzle-team/drizzle-orm-docs

All issues in drizzle-team/drizzle-orm-docs

Similar issues

More Documentation issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.