From 0b78d5cf326978e155e12e57fd5f5a533418e8f2 Mon Sep 17 00:00:00 2001 From: Joakim Carlstein Date: Wed, 15 Nov 2023 14:41:25 +0100 Subject: [PATCH] refactor(cli): rename the emigrate package to @emigrate/cli to be more in line with other tools --- .changeset/cold-nails-film.md | 2 +- .changeset/healthy-bulldogs-sell.md | 5 +++++ .changeset/yellow-students-compare.md | 2 +- README.md | 18 ++++++++++++++++++ packages/{emigrate => cli}/CHANGELOG.md | 0 packages/{emigrate => cli}/README.md | 6 +++--- packages/{emigrate => cli}/package.json | 6 +++--- packages/{emigrate => cli}/src/cli.ts | 0 packages/{emigrate => cli}/src/get-config.ts | 0 packages/{emigrate => cli}/src/index.ts | 0 packages/{emigrate => cli}/src/new-command.ts | 0 .../{emigrate => cli}/src/show-usage-error.ts | 0 packages/{emigrate => cli}/src/types.ts | 0 packages/{emigrate => cli}/tsconfig.json | 0 packages/plugin-tools/src/types.ts | 4 ++-- pnpm-lock.yaml | 2 +- 16 files changed, 34 insertions(+), 11 deletions(-) create mode 100644 .changeset/healthy-bulldogs-sell.md rename packages/{emigrate => cli}/CHANGELOG.md (100%) rename packages/{emigrate => cli}/README.md (81%) rename packages/{emigrate => cli}/package.json (94%) rename packages/{emigrate => cli}/src/cli.ts (100%) rename packages/{emigrate => cli}/src/get-config.ts (100%) rename packages/{emigrate => cli}/src/index.ts (100%) rename packages/{emigrate => cli}/src/new-command.ts (100%) rename packages/{emigrate => cli}/src/show-usage-error.ts (100%) rename packages/{emigrate => cli}/src/types.ts (100%) rename packages/{emigrate => cli}/tsconfig.json (100%) diff --git a/.changeset/cold-nails-film.md b/.changeset/cold-nails-film.md index aa323c5..9dfd189 100644 --- a/.changeset/cold-nails-film.md +++ b/.changeset/cold-nails-film.md @@ -1,7 +1,7 @@ --- '@emigrate/plugin-generate-js': patch '@emigrate/plugin-tools': patch -'emigrate': patch +'@emigrate/cli': patch --- Specify files to include in published NPM package diff --git a/.changeset/healthy-bulldogs-sell.md b/.changeset/healthy-bulldogs-sell.md new file mode 100644 index 0000000..824c535 --- /dev/null +++ b/.changeset/healthy-bulldogs-sell.md @@ -0,0 +1,5 @@ +--- +'@emigrate/cli': minor +--- + +Rename the "emigrate" package to "@emigrate/cli" to mimic other tools diff --git a/.changeset/yellow-students-compare.md b/.changeset/yellow-students-compare.md index 3f767ae..c851311 100644 --- a/.changeset/yellow-students-compare.md +++ b/.changeset/yellow-students-compare.md @@ -1,7 +1,7 @@ --- '@emigrate/plugin-generate-js': minor '@emigrate/plugin-tools': minor -'emigrate': minor +'@emigrate/cli': minor --- Simplify plugin interfaces by getting rid of the "type" string, in preparation for having packages that contains multiple different plugins diff --git a/README.md b/README.md index e2f79b7..e6d277f 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,24 @@ It's effectively a successor of [klei-migrate](https://www.npmjs.com/package/kle - Easy to debug - Emigrate will store any errors that occur during migration in the migration history so you can easily debug them +## Installation + +Install the Emigrate CLI in your project: + +```bash +npm install --save-dev @emigrate/cli +``` + +## Usage + +Create a new migration: + +```bash +emigrate new -d migrations -e .js create some fancy table +``` + +Will create a new empty JavaScript migration file with the name "YYYYMMDDHHmmssuuu_create_some_fancy_table.js" in the `migrations` directory. + ## License Emigrate is licensed under the MIT license. See [LICENSE](LICENSE) for the full license text. diff --git a/packages/emigrate/CHANGELOG.md b/packages/cli/CHANGELOG.md similarity index 100% rename from packages/emigrate/CHANGELOG.md rename to packages/cli/CHANGELOG.md diff --git a/packages/emigrate/README.md b/packages/cli/README.md similarity index 81% rename from packages/emigrate/README.md rename to packages/cli/README.md index 1f750d1..6e01f65 100644 --- a/packages/emigrate/README.md +++ b/packages/cli/README.md @@ -1,13 +1,13 @@ -# emigrate +# @emigrate/cli Emigrate is a tool for managing database migrations. It is designed to be simple yet support advanced setups, modular and extensible. ## Installation -Install Emigrate in your project: +Install the Emigrate CLI in your project: ```bash -npm install --save-dev emigrate +npm install --save-dev @emigrate/cli ``` ## Usage diff --git a/packages/emigrate/package.json b/packages/cli/package.json similarity index 94% rename from packages/emigrate/package.json rename to packages/cli/package.json index b705d5e..33e24cc 100644 --- a/packages/emigrate/package.json +++ b/packages/cli/package.json @@ -1,5 +1,5 @@ { - "name": "emigrate", + "name": "@emigrate/cli", "version": "0.2.1", "publishConfig": { "access": "public" @@ -35,8 +35,8 @@ "@emigrate/tsconfig": "workspace:*" }, "author": "Aboviq AB (https://www.aboviq.com)", - "homepage": "https://github.com/aboviq/emigrate/tree/main/packages/emigrate#readme", - "repository": "https://github.com/aboviq/emigrate/tree/main/packages/emigrate", + "homepage": "https://github.com/aboviq/emigrate/tree/main/packages/cli#readme", + "repository": "https://github.com/aboviq/emigrate/tree/main/packages/cli", "bugs": "https://github.com/aboviq/emigrate/issues", "license": "MIT", "dependencies": { diff --git a/packages/emigrate/src/cli.ts b/packages/cli/src/cli.ts similarity index 100% rename from packages/emigrate/src/cli.ts rename to packages/cli/src/cli.ts diff --git a/packages/emigrate/src/get-config.ts b/packages/cli/src/get-config.ts similarity index 100% rename from packages/emigrate/src/get-config.ts rename to packages/cli/src/get-config.ts diff --git a/packages/emigrate/src/index.ts b/packages/cli/src/index.ts similarity index 100% rename from packages/emigrate/src/index.ts rename to packages/cli/src/index.ts diff --git a/packages/emigrate/src/new-command.ts b/packages/cli/src/new-command.ts similarity index 100% rename from packages/emigrate/src/new-command.ts rename to packages/cli/src/new-command.ts diff --git a/packages/emigrate/src/show-usage-error.ts b/packages/cli/src/show-usage-error.ts similarity index 100% rename from packages/emigrate/src/show-usage-error.ts rename to packages/cli/src/show-usage-error.ts diff --git a/packages/emigrate/src/types.ts b/packages/cli/src/types.ts similarity index 100% rename from packages/emigrate/src/types.ts rename to packages/cli/src/types.ts diff --git a/packages/emigrate/tsconfig.json b/packages/cli/tsconfig.json similarity index 100% rename from packages/emigrate/tsconfig.json rename to packages/cli/tsconfig.json diff --git a/packages/plugin-tools/src/types.ts b/packages/plugin-tools/src/types.ts index 2847dc2..a35e013 100644 --- a/packages/plugin-tools/src/types.ts +++ b/packages/plugin-tools/src/types.ts @@ -94,5 +94,5 @@ export type PluginType = 'storage' | 'generator'; export type PluginFromType = T extends 'storage' ? StoragePlugin : T extends 'generator' - ? GeneratorPlugin - : never; + ? GeneratorPlugin + : never; diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 5d0b303..17745ce 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -54,7 +54,7 @@ importers: specifier: 0.56.0 version: 0.56.0(webpack@5.89.0) - packages/emigrate: + packages/cli: dependencies: '@emigrate/plugin-tools': specifier: workspace:*