Skip to content

Commit 3be9781

Browse files
authored
docs: update package org to bomb.sh (#41)
1 parent 85e5a6c commit 3be9781

File tree

5 files changed

+17
-12
lines changed

5 files changed

+17
-12
lines changed

.changeset/legal-maps-switch.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@bomb.sh/tab': patch
3+
---
4+
5+
Update package org to bomb.sh

README.2.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Autocompletions are the solution to not break the user's flow. The issue is they
1111
`my-cli.ts`:
1212

1313
```typescript
14-
import t from '@bombsh/tab';
14+
import t from '@bomb.sh/tab';
1515

1616
t.name('my-cli');
1717

@@ -87,7 +87,7 @@ And that made us develop our own autocompletion abstraction over npm, pnpm and y
8787
They'd only have to run this command once and inject it in their shell config.
8888

8989
```bash
90-
npx @bombsh/tab pnpm zsh
90+
npx @bomb.sh/tab pnpm zsh
9191
```
9292

9393
These autocompletions on top of the normal autocompletions that these package managers provide are going to be way more powerful.

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Check out the [examples directory](./examples) for complete examples of using Ta
1515
## Usage
1616

1717
```ts
18-
import { Completion, script } from '@bombsh/tab';
18+
import { Completion, script } from '@bomb.sh/tab';
1919

2020
const name = 'my-cli';
2121
const completion = new Completion();
@@ -70,11 +70,11 @@ Now your user can run `source <(my-cli complete zsh)` and they will get completi
7070

7171
Since we are heavy users of tools like `cac` and `citty`, we have created adapters for both of them. Ideally, tab would be integrated internally into these tools, but for now, this is a good compromise.
7272

73-
### `@bombsh/tab/cac`
73+
### `@bomb.sh/tab/cac`
7474

7575
```ts
7676
import cac from 'cac';
77-
import tab from '@bombsh/tab/cac';
77+
import tab from '@bomb.sh/tab/cac';
7878

7979
const cli = cac('my-cli');
8080

@@ -105,11 +105,11 @@ Now autocompletion will be available for any specified command and option in you
105105

106106
Suggestions are missing in the adapters since yet cac or citty do not have a way to provide suggestions (tab just came out!), we'd have to provide them manually. Mutations do not hurt in this situation.
107107

108-
### `@bombsh/tab/citty`
108+
### `@bomb.sh/tab/citty`
109109

110110
```ts
111111
import citty, { defineCommand, createMain } from 'citty';
112-
import tab from '@bombsh/tab/citty';
112+
import tab from '@bomb.sh/tab/citty';
113113

114114
const main = defineCommand({
115115
meta: {
@@ -154,11 +154,11 @@ const cli = createMain(main);
154154
cli();
155155
```
156156

157-
### `@bombsh/tab/commander`
157+
### `@bomb.sh/tab/commander`
158158

159159
```ts
160160
import { Command } from 'commander';
161-
import tab from '@bombsh/tab/commander';
161+
import tab from '@bomb.sh/tab/commander';
162162

163163
const program = new Command('my-cli');
164164
program.version('1.0.0');

bin/cli.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ async function main() {
3737
} else {
3838
console.error(`Error: Expected '--' followed by command to complete`);
3939
console.error(
40-
`Example: ${packageManager} exec @bombsh/tab ${packageManager} complete -- command-to-complete`
40+
`Example: ${packageManager} exec @bomb.sh/tab ${packageManager} complete -- command-to-complete`
4141
);
4242
process.exit(1);
4343
}
@@ -74,7 +74,7 @@ async function main() {
7474
// function generateCompletionScript(packageManager: string, shell: string) {
7575
// const name = packageManager;
7676
// const executable = process.env.npm_execpath
77-
// ? `${packageManager} exec @bombsh/tab ${packageManager}`
77+
// ? `${packageManager} exec @bomb.sh/tab ${packageManager}`
7878
// : `node ${process.argv[1]} ${packageManager}`;
7979
// script(shell as any, name, executable);
8080
// }

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "@bombsh/tab",
2+
"name": "@bomb.sh/tab",
33
"version": "0.0.1",
44
"main": "./dist/t.js",
55
"types": "./dist/t.d.ts",

0 commit comments

Comments
 (0)