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

Suggestion: Fix doc to save-dev and not save #17

Closed
fokolo opened this issue Jan 17, 2024 · 3 comments
Closed

Suggestion: Fix doc to save-dev and not save #17

fokolo opened this issue Jan 17, 2024 · 3 comments

Comments

@fokolo
Copy link

fokolo commented Jan 17, 2024

Hi :)
As far as I understand this library is only for dev work therefore it should not be bundled in any production build no?

so in the doc instead of:

Installation
npm install --save kysely-migration-cli
If you prefer Yarn:
yarn add kysely-migration-cli

it should be

Installation
npm install --save kysely-migration-cli
If you prefer Yarn:
yarn add kysely-migration-cli
pnpm:
pnpm i -D kysely-migration-cli

Good job at the lightweight lib!

@acro5piano
Copy link
Owner

@fokolo Thank you for your interest in this project and the suggestion. I think it's up to users; some users want to install it as a production dependency to run migration to production DB, while others want to run them in a separate environment such as CI. I want to make the default unopionated, so the current doc sounds good.

Besides, your suggestion to include pnpm in the doc is great - if you create a PR for this, I'm happy to merge it.

marcosrjjunior added a commit to marcosrjjunior/kysely-migration-cli that referenced this issue Feb 27, 2024
@marcosrjjunior
Copy link
Contributor

yes, sometimes you want to perform this script on a production env.

A good example of that is when migrating latest changes on your automated deployment.

acro5piano added a commit that referenced this issue Feb 27, 2024
@acro5piano
Copy link
Owner

Closing as dev/non-dev policy is now clear and pnpm was added to readme.

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

3 participants