feat: adds the remove command type

HiDeoo · May 24, 2024 · 43ee408 · 43ee408
1 parent 3f267f5
commit 43ee408
Show file tree

Hide file tree

Showing 4 changed files with 31 additions and 2 deletions.
diff --git a/docs/src/content/docs/getting-started.mdx b/docs/src/content/docs/getting-started.mdx
@@ -7,7 +7,7 @@ import PackageManagers from '../../components/PackageManagers.astro'
 ## Features
 
 - Support for various package managers: [npm](https://www.npmjs.com), [yarn](https://yarnpkg.com), [pnpm](https://pnpm.io), [bun](https://bun.sh) & [ni](https://github.com/antfu/ni).
-- Support for various types of command: [`add`](/usage/#add), [`create`](/usage/#create), [`exec`](/usage/#exec) & [`run`](/usage/#run).
+- Support for various types of command: [`add`](/usage/#add), [`create`](/usage/#create), [`exec`](/usage/#exec), [`run`](/usage/#run) & [`remove`](/usage/#remove).
 - Synced tabs between each instance on the same page.
 - Customizable output with [extra arguments](/usage/#extra-arguments), [comments](/usage/#comment) & [prefixes](/usage/#prefix).
 

diff --git a/docs/src/content/docs/usage.mdx b/docs/src/content/docs/usage.mdx
@@ -94,6 +94,20 @@ The code above generates the following commands:
 
 <PackageManagers type="run" args="dev" />
 
+### `remove`
+
+The `pkg` prop is used to specify the name of the package to remove.
+
+```mdx title="src/content/docs/example.mdx" 'type="remove"'
+import { PackageManagers } from 'starlight-package-managers'
+
+<PackageManagers type="remove" pkg="@astrojs/starlight" />
+```
+
+The code above generates the following commands:
+
+<PackageManagers type="remove" pkg="@astrojs/starlight" />
+
 ## Extra arguments
 
 You can provide extra arguments to any command using the `args` prop.

diff --git a/packages/starlight-package-managers/pkg.ts b/packages/starlight-package-managers/pkg.ts
@@ -9,32 +9,37 @@ const commands: Commands = {
     devOption: '-D',
     exec: 'npx',
     run: 'npm run',
+    remove: 'npm uninstall',
   },
   yarn: {
     add: 'yarn add',
     create: 'yarn create',
     devOption: '-D',
     exec: 'yarn',
     run: 'yarn run',
+    remove: 'yarn remove',
   },
   pnpm: {
     add: 'pnpm add',
     create: 'pnpm create',
     devOption: '-D',
     exec: 'pnpm',
     run: 'pnpm run',
+    remove: 'pnpm remove',
   },
   bun: {
     add: 'bun add',
     devOption: '-d',
     exec: 'bunx',
     run: 'bun run',
+    remove: 'bun remove',
   },
   ni: {
     add: 'ni',
     devOption: '-D',
     exec: 'nlx',
     run: 'nr',
+    remove: 'nun',
   },
 }
 
@@ -93,7 +98,7 @@ export function getCommand(
   return command
 }
 
-export type CommandType = 'add' | 'create' | 'exec' | 'run'
+export type CommandType = 'add' | 'create' | 'exec' | 'run' | 'remove'
 
 export interface CommandOptions {
   args?: string

diff --git a/packages/starlight-package-managers/tests/unit/commands.test.ts b/packages/starlight-package-managers/tests/unit/commands.test.ts
@@ -80,6 +80,16 @@ yarn create astro`,
 pnpm create astro`,
     ])
   })
+
+  test("should generate the 'remove' command", () => {
+    expect(getCommands('remove', 'astro', {})).toEqual([
+      'npm uninstall astro',
+      'yarn remove astro',
+      'pnpm remove astro',
+      'bun remove astro',
+      'nun astro',
+    ])
+  })
 })
 
 describe('exec', () => {