diff --git a/.changeset/dry-melons-punch.md b/.changeset/dry-melons-punch.md new file mode 100644 index 0000000..2b6dda7 --- /dev/null +++ b/.changeset/dry-melons-punch.md @@ -0,0 +1,8 @@ +--- +'@emigrate/plugin-generate-js': patch +'@emigrate/plugin-tools': patch +'emigrate': patch +'@emigrate/tsconfig': patch +--- + +Add some simple README's for each package and add homepage, repository and bugs URLs to each package.json file diff --git a/package.json b/package.json index 3ee42d9..2ecac8b 100644 --- a/package.json +++ b/package.json @@ -31,6 +31,9 @@ "email": "joakim@aboviq.com" } ], + "homepage": "https://github.com/aboviq/emigrate", + "repository": "https://github.com/aboviq/emigrate", + "bugs": "https://github.com/aboviq/emigrate/issues", "license": "MIT", "volta": { "node": "20.9.0", diff --git a/packages/emigrate/README.md b/packages/emigrate/README.md new file mode 100644 index 0000000..1f750d1 --- /dev/null +++ b/packages/emigrate/README.md @@ -0,0 +1,21 @@ +# emigrate + +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: + +```bash +npm install --save-dev emigrate +``` + +## 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. diff --git a/packages/emigrate/package.json b/packages/emigrate/package.json index f64aaa3..6e1ca91 100644 --- a/packages/emigrate/package.json +++ b/packages/emigrate/package.json @@ -32,6 +32,9 @@ "@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", + "bugs": "https://github.com/aboviq/emigrate/issues", "license": "MIT", "dependencies": { "@emigrate/plugin-tools": "workspace:*", diff --git a/packages/plugin-generate-js/README.md b/packages/plugin-generate-js/README.md new file mode 100644 index 0000000..c04e9c8 --- /dev/null +++ b/packages/plugin-generate-js/README.md @@ -0,0 +1,28 @@ +# @emigrate/plugin-generate-js + +This package contains an Emigrate plugin for generating migration files using JavaScript as a language. + +## Usage + +Install the package: + +```bash +npm install --save-dev @emigrate/plugin-generate-js +``` + +Use the plugin with the `emigrate new` command: + +```bash +emigrate new --plugin generate-js create some fancy table +``` + +Or add it to your `emigrate.config.js` file: + +```js +import generateJs from '@emigrate/plugin-generate-js'; + +export default { + directory: 'migrations', + plugins: [generateJs], +}; +``` diff --git a/packages/plugin-generate-js/package.json b/packages/plugin-generate-js/package.json index a903557..e4a5995 100644 --- a/packages/plugin-generate-js/package.json +++ b/packages/plugin-generate-js/package.json @@ -26,6 +26,9 @@ "generate" ], "author": "Aboviq AB (https://www.aboviq.com)", + "homepage": "https://github.com/aboviq/emigrate/tree/main/packages/plugin-generate-js#readme", + "repository": "https://github.com/aboviq/emigrate/tree/main/packages/plugin-generate-js", + "bugs": "https://github.com/aboviq/emigrate/issues", "license": "MIT", "dependencies": { "@emigrate/plugin-tools": "workspace:*" diff --git a/packages/plugin-tools/README.md b/packages/plugin-tools/README.md new file mode 100644 index 0000000..a054f6c --- /dev/null +++ b/packages/plugin-tools/README.md @@ -0,0 +1,3 @@ +# @emigrate/plugin-tools + +This package contains utilities and types to simplify creating and working with Emigrate plugins. diff --git a/packages/plugin-tools/package.json b/packages/plugin-tools/package.json index d582260..8a31a78 100644 --- a/packages/plugin-tools/package.json +++ b/packages/plugin-tools/package.json @@ -31,6 +31,9 @@ "types" ], "author": "Aboviq AB (https://www.aboviq.com)", + "homepage": "https://github.com/aboviq/emigrate/tree/main/packages/plugin-tools#readme", + "repository": "https://github.com/aboviq/emigrate/tree/main/packages/plugin-tools", + "bugs": "https://github.com/aboviq/emigrate/issues", "license": "MIT", "devDependencies": { "@emigrate/tsconfig": "workspace:*" diff --git a/packages/tsconfig/README.md b/packages/tsconfig/README.md new file mode 100644 index 0000000..0810995 --- /dev/null +++ b/packages/tsconfig/README.md @@ -0,0 +1,3 @@ +# @emigrate/tsconfig + +This package contains the default TypeScript configuration for Emigrate packages. diff --git a/packages/tsconfig/package.json b/packages/tsconfig/package.json index 791cc3c..977ae82 100644 --- a/packages/tsconfig/package.json +++ b/packages/tsconfig/package.json @@ -9,6 +9,9 @@ "build.json" ], "author": "Aboviq AB (https://www.aboviq.com)", + "homepage": "https://github.com/aboviq/emigrate/tree/main/packages/tsconfig#readme", + "repository": "https://github.com/aboviq/emigrate/tree/main/packages/tsconfig", + "bugs": "https://github.com/aboviq/emigrate/issues", "license": "MIT", "volta": { "extends": "../../package.json"