Skip to content

Commit

Permalink
refactor(cli): rename @kksh/cli package to kksh, it's easier to type …
Browse files Browse the repository at this point in the history
…in terminal
  • Loading branch information
HuakunShen committed Oct 30, 2024
1 parent cf5014e commit 315c87c
Show file tree
Hide file tree
Showing 12 changed files with 23 additions and 32 deletions.
2 changes: 1 addition & 1 deletion apps/cli/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# @kksh/cli
# kksh

## 0.0.22

Expand Down
6 changes: 3 additions & 3 deletions apps/cli/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# @kksh/cli
# kksh

This is a CLI tool for developers to develop Kunkun extensions.

Expand All @@ -9,8 +9,8 @@ This is a CLI tool for developers to develop Kunkun extensions.
npm init kunkun@latest

# You can verify the extension manifest, this expect `npm run build` is done already and all generated artifacts listed in manifest is present.
npx @kksh/cli verify <path to extension>
npx kksh verify <path to extension>

# Build extension with docker, simulate how Kunkun's CI builds the extension
npx @kksh/cli build <path to extension>
npx kksh build <path to extension>
```
9 changes: 0 additions & 9 deletions apps/cli/jsr.json

This file was deleted.

6 changes: 3 additions & 3 deletions apps/cli/package.json
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
{
"name": "@kksh/cli",
"name": "kksh",
"module": "dist/cli.js",
"version": "0.0.22",
"version": "0.0.23",
"type": "module",
"bin": {
"@kksh/cli": "./dist/cli.js",
"kksh": "./dist/cli.js",
"docker-entrypoint.sh": "./dist/docker/entrypoint.sh"
},
"author": "Huakun",
Expand Down
2 changes: 1 addition & 1 deletion packages/api/jsr.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"$schema": "https://jsr.io/schema/config-file.v1.json",
"name": "@kunkun/api",
"version": "0.0.18",
"version": "0.0.23",
"license": "MIT",
"exports": {
".": "./src/index.ts",
Expand Down
4 changes: 2 additions & 2 deletions templates/template-ext-next/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The main benefit of using a meta-framework is that it comes with routing, and wi

```bash
pnpm build # make sure the build npm script works
npx @kksh/cli@latest verify # Verify some basic settings before publishing
npx kksh@latest verify # Verify some basic settings before publishing
```

It is recommended to build the extension with the same environment our CI uses.
Expand All @@ -49,7 +49,7 @@ You can use the following command to build the extension with the same environme
This requires you to have docker installed, and the shell you are using has access to it via `docker` command.

```bash
npx @kksh/cli@latest build # Build the extension with
npx kksh@latest build # Build the extension with
```

`pnpm` is used to install dependencies and build the extension.
Expand Down
4 changes: 2 additions & 2 deletions templates/template-ext-nuxt/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The main benefit of using a meta-framework is that it comes with routing, and wi

```bash
pnpm build # make sure the build npm script works
npx @kksh/cli@latest verify # Verify some basic settings before publishing
npx kksh@latest verify # Verify some basic settings before publishing
```

It is recommended to build the extension with the same environment our CI uses.
Expand All @@ -49,7 +49,7 @@ You can use the following command to build the extension with the same environme
This requires you to have docker installed, and the shell you are using has access to it via `docker` command.

```bash
npx @kksh/cli@latest build # Build the extension with
npx kksh@latest build # Build the extension with
```

`pnpm` is used to install dependencies and build the extension.
Expand Down
4 changes: 2 additions & 2 deletions templates/template-ext-react/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Kunkun provides meta-framework templates for Nuxt, Next, SvelteKit.

```bash
pnpm build # make sure the build npm script works
npx @kksh/cli@latest verify # Verify some basic settings before publishing
npx kksh@latest verify # Verify some basic settings before publishing
```

It is recommended to build the extension with the same environment our CI uses.
Expand All @@ -47,7 +47,7 @@ You can use the following command to build the extension with the same environme
This requires you to have docker installed, and the shell you are using has access to it via `docker` command.

```bash
npx @kksh/cli@latest build # Build the extension with
npx kksh@latest build # Build the extension with
```

`pnpm` is used to install dependencies and build the extension.
Expand Down
4 changes: 2 additions & 2 deletions templates/template-ext-svelte/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Kunkun provides meta-framework templates for Nuxt, Next, SvelteKit.

```bash
pnpm build # make sure the build npm script works
npx @kksh/cli@latest verify # Verify some basic settings before publishing
npx kksh@latest verify # Verify some basic settings before publishing
```

It is recommended to build the extension with the same environment our CI uses.
Expand All @@ -47,7 +47,7 @@ You can use the following command to build the extension with the same environme
This requires you to have docker installed, and the shell you are using has access to it via `docker` command.

```bash
npx @kksh/cli@latest build # Build the extension with
npx kksh@latest build # Build the extension with
```

`pnpm` is used to install dependencies and build the extension.
Expand Down
4 changes: 2 additions & 2 deletions templates/template-ext-sveltekit/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ The main benefit of using a meta-framework is that it comes with routing, and wi

```bash
pnpm build # make sure the build npm script works
npx @kksh/cli@latest verify # Verify some basic settings before publishing
npx kksh@latest verify # Verify some basic settings before publishing
```

It is recommended to build the extension with the same environment our CI uses.
Expand All @@ -49,7 +49,7 @@ You can use the following command to build the extension with the same environme
This requires you to have docker installed, and the shell you are using has access to it via `docker` command.

```bash
npx @kksh/cli@latest build # Build the extension with
npx kksh@latest build # Build the extension with
```

`pnpm` is used to install dependencies and build the extension.
Expand Down
4 changes: 2 additions & 2 deletions templates/template-ext-vue/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ Kunkun provides meta-framework templates for Nuxt, Next, SvelteKit.

```bash
pnpm build # make sure the build npm script works
npx @kksh/cli@latest verify # Verify some basic settings before publishing
npx kksh@latest verify # Verify some basic settings before publishing
```

It is recommended to build the extension with the same environment our CI uses.
Expand All @@ -47,7 +47,7 @@ You can use the following command to build the extension with the same environme
This requires you to have docker installed, and the shell you are using has access to it via `docker` command.

```bash
npx @kksh/cli@latest build # Build the extension with
npx kksh@latest build # Build the extension with
```

`pnpm` is used to install dependencies and build the extension.
Expand Down
6 changes: 3 additions & 3 deletions templates/template-ext-worker/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,8 +78,8 @@ Then in `package.json`, register the new command.

```bash
pnpm build # make sure the build npm script works
npx @kksh/cli@latest verify # Verify some basic settings
npx @kksh/cli@latest verify --publish # Verify some basic settings before publishing
npx kksh@latest verify # Verify some basic settings
npx kksh@latest verify --publish # Verify some basic settings before publishing
```

It is recommended to build the extension with the same environment our CI uses.
Expand All @@ -90,7 +90,7 @@ You can use the following command to build the extension with the same environme
This requires you to have docker installed, and the shell you are using has access to it via `docker` command.

```bash
npx @kksh/cli@latest build # Build the extension with
npx kksh@latest build # Build the extension with
```

`pnpm` is used to install dependencies and build the extension.
Expand Down

0 comments on commit 315c87c

Please sign in to comment.