From 305f9e5f6ef34bfeec46517b970a716db04d8d24 Mon Sep 17 00:00:00 2001 From: naokie Date: Tue, 24 Jan 2023 18:25:50 +0900 Subject: [PATCH 1/3] chore: rename bin script --- package-lock.json | 2 +- package.json | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/package-lock.json b/package-lock.json index 00cebc16f..c9bd2828c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -16,7 +16,7 @@ "json-schema-ref-parser": "^9.0.9" }, "bin": { - "openapi": "bin/index.js" + "openapi-typescript-codegen": "bin/index.js" }, "devDependencies": { "@angular-devkit/build-angular": "14.2.7", diff --git a/package.json b/package.json index 80bbea6a5..d5c4eb339 100644 --- a/package.json +++ b/package.json @@ -34,7 +34,7 @@ "main": "dist/index.js", "types": "types/index.d.ts", "bin": { - "openapi": "bin/index.js" + "openapi-typescript-codegen": "bin/index.js" }, "files": [ "bin/index.js", From 83fdc1fa77dabdf32dfd1ef7754e52e09e17a575 Mon Sep 17 00:00:00 2001 From: naokie Date: Tue, 24 Jan 2023 18:30:41 +0900 Subject: [PATCH 2/3] feat: show bin script nama from package.name --- bin/index.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/bin/index.js b/bin/index.js index ed8b0889b..3ab1da652 100755 --- a/bin/index.js +++ b/bin/index.js @@ -7,7 +7,7 @@ const { program } = require('commander'); const pkg = require('../package.json'); const params = program - .name('openapi') + .name(pkg.name) .usage('[options]') .version(pkg.version) .requiredOption('-i, --input ', 'OpenAPI specification, can be a path, url or string content (required)') From 2a988d810125c3f0b2860d9336b421955ade2cb6 Mon Sep 17 00:00:00 2001 From: naokie Date: Tue, 24 Jan 2023 18:30:53 +0900 Subject: [PATCH 3/3] docs: update readme.md --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 429f905ee..c08a2b16a 100644 --- a/README.md +++ b/README.md @@ -31,9 +31,9 @@ npm install openapi-typescript-codegen --save-dev ## Usage ``` -$ openapi --help +$ openapi-typescript-codegen --help - Usage: openapi [options] + Usage: openapi-typescript-codegen [options] Options: -V, --version output the version number @@ -54,8 +54,8 @@ $ openapi --help -h, --help display help for command Examples - $ openapi --input ./spec.json --output ./generated - $ openapi --input ./spec.json --output ./generated --client xhr + $ openapi-typescript-codegen --input ./spec.json --output ./generated + $ openapi-typescript-codegen --input ./spec.json --output ./generated --client xhr ``` Documentation