aboviq/emigrate
1
0
Fork 0
Code Issues Pull requests 1 Projects Releases Packages Wiki Activity Actions

docs: update all command docs with package manager variants

Browse source
This commit is contained in:
Joakim Carlstein 2023-12-18 13:49:06 +01:00 • committed by Joakim Carlstein
parent 1fc24269f4
commit 445fe69e60
4 changed files with 112 additions and 12 deletions
Download patch file Download diff file Expand all files Collapse all files

27
docs/src/content/docs/commands/list.mdx
View file

@ -3,6 +3,8 @@ title: "`emigrate list`"
description: "List migrations and their status."
---
import { Tabs, TabItem } from '@astrojs/starlight/components';
The `list` command is used to list _all_ migrations, i.e. both already run migrations and migrations that haven't been run yet.
Emigrate takes all migration files in the given directory that haven't been run yet and all migrations from the migration history.
@ -10,9 +12,32 @@ It then sorts the migrations by filename in ascending order and outputs them and
## Usage
<Tabs>
<TabItem label="npm">
```bash
emigrate list [options]
npx emigrate list [options]
```
</TabItem>
<TabItem label="pnpm">
```bash
pnpm exec emigrate list [options]
```
</TabItem>
<TabItem label="yarn">
```bash
yarn exec emigrate -- list [options]
```
</TabItem>
<TabItem label="package.json">
```json {3}
{
"scripts": {
"emigrate": "emigrate list [options]"
}
}
```
</TabItem>
</Tabs>
## Options

27
docs/src/content/docs/commands/new.mdx
View file

@ -3,15 +3,40 @@ title: "`emigrate new`"
description: "Create new migration."
---
import { Tabs, TabItem } from '@astrojs/starlight/components';
The `new` command is used to create a new migration file in the given directory.
The migration file can be based on a template, generated by a [generator plugin](/plugins/generators/), or just be an empty file.
## Usage
<Tabs>
<TabItem label="npm">
```bash
emigrate new [options] <name>
npx emigrate new [options] <name>
```
</TabItem>
<TabItem label="pnpm">
```bash
pnpm exec emigrate new [options] <name>
```
</TabItem>
<TabItem label="yarn">
```bash
yarn exec emigrate -- new [options] <name>
```
</TabItem>
<TabItem label="package.json">
```json {3}
{
"scripts": {
"emigrate": "emigrate new [options] <name>"
}
}
```
</TabItem>
</Tabs>
## Arguments

27
docs/src/content/docs/commands/remove.mdx
View file

@ -3,13 +3,38 @@ title: "`emigrate remove`"
description: "Remove a migration from the history."
---
import { Tabs, TabItem } from '@astrojs/starlight/components';
The `remove` command is used to remove a migration from the history. This is useful if you want to retry a migration that has failed.
## Usage
<Tabs>
<TabItem label="npm">
```bash
emigrate remove [options] <name>
npx emigrate remove [options] <name>
```
</TabItem>
<TabItem label="pnpm">
```bash
pnpm exec emigrate remove [options] <name>
```
</TabItem>
<TabItem label="yarn">
```bash
yarn exec emigrate -- remove [options] <name>
```
</TabItem>
<TabItem label="package.json">
```json {3}
{
"scripts": {
"emigrate": "emigrate remove [options] <name>"
}
}
```
</TabItem>
</Tabs>
## Arguments

27
docs/src/content/docs/commands/up.mdx
View file

@ -3,6 +3,8 @@ title: "`emigrate up`"
description: "Run migrations"
---
import { Tabs, TabItem } from '@astrojs/starlight/components';
The `up` command is used to either list or run all pending migrations, i.e. migrations that haven't been run yet.
Emigrate takes all migration files in the given directory and compares them to the migration history so that it knows which migrations are pending.
@ -12,9 +14,32 @@ If any of the migrations fail, the command will be aborted and the rest of the m
## Usage
<Tabs>
<TabItem label="npm">
```bash
emigrate up [options]
npx emigrate up [options]
```
</TabItem>
<TabItem label="pnpm">
```bash
pnpm exec emigrate up [options]
```
</TabItem>
<TabItem label="yarn">
```bash
yarn exec emigrate -- up [options]
```
</TabItem>
<TabItem label="package.json">
```json {3}
{
"scripts": {
"emigrate": "emigrate up [options]"
}
}
```
</TabItem>
</Tabs>
## Options