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

package.json automatically generated does not match manual installation section #298

Open
justin13888 opened this issue Mar 27, 2024 · 1 comment

Comments

@justin13888
Copy link

justin13888 commented Mar 27, 2024

What is the type of issue?

Documentation is incorrect

What is the issue?

This is the scripts section in package.json when generated using bun create elysia app

"scripts": {
  "test": "echo \"Error: no test specified\" && exit 1",
  "dev": "bun run --watch src/index.ts"
}

This is what's currently what's written in manual installation section:

"scripts": {
  "dev": "bun --watch src/index.ts",
  "build": "bun build src/index.ts",
  "start": "NODE_ENV=production bun src/index.ts",
  "test": "bun test"
}

Suggested changes:

  • In the automatically generated Elysia template, it should be including the "build" and "start" commands for convenience
  • In the manual installation section in docs, the "test" script should be removed because that's redundant. bun test does its thing by default

Where did you find it?

https://elysiajs.com/quick-start.html

@justin13888
Copy link
Author

If the suggested changes are good, I could make the PRs @SaltyAom

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

No branches or pull requests

1 participant