fix: removed old binary

vega · May 23, 2024 · b26d0a3 · b26d0a3
1 parent 6ea7714
commit b26d0a3
Show file tree

Hide file tree

Showing 11 changed files with 54 additions and 147 deletions.
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -15,7 +15,7 @@
       "request": "launch",
       "runtimeExecutable": "node",
       "runtimeArgs": ["--nolazy", "-r", "ts-node/register"],
-      "args": ["ts-json-schema-generator.ts", "-p", "${file}"],
+      "args": ["bin/run.js", "${file}"],
       "cwd": "${workspaceFolder}",
       "internalConsoleOptions": "openOnSessionStart",
       "skipFiles": ["<node_internals>/**", "node_modules/**"]

diff --git a/README.md b/README.md
@@ -46,7 +46,7 @@ Or install the package and then run it
 
 ```bash
 $ npm install -D ts-json-schema-generator
-$ node_modules/.bin/ts-json-schema-generator -t 'My.Type.Name' 'my/project/**/*.ts'
+$ node_modules/.bin/tsjg -t 'My.Type.Name' 'my/project/**/*.ts'
 ```
 
 Note that different platforms (e.g. Windows) may use different path separators so you may have to adjust the command above.
@@ -60,7 +60,7 @@ Also note that you need to quote paths with `*` as otherwise the shell will expa
 <!-- commands -->
 
 -   [`tjsg autocomplete [SHELL]`](#tjsg-autocomplete-shell)
--   [`tjsg generate [PATH]`](#tjsg-generate-path)
+-   [`tjsg generate PATH`](#tjsg-generate-path)
 -   [`tjsg help [COMMAND]`](#tjsg-help-command)
 
 ## `tjsg autocomplete [SHELL]`
@@ -94,19 +94,19 @@ EXAMPLES
 
 _See code: [@oclif/plugin-autocomplete](https://github.com/oclif/plugin-autocomplete/blob/v3.0.18/src/commands/autocomplete/index.ts)_
 
-## `tjsg generate [PATH]`
+## `tjsg generate PATH`
 
 Generate JSON schema from your Typescript sources
 
 ```
 USAGE
-  $ tjsg generate [PATH] [-t <value>] [--top-ref] [-i <value>] [-p <value>] [-e all|none|export] [-j
+  $ tjsg generate PATH [-t <value>] [--top-ref] [-i <value>] [-p <value>] [-e all|none|export] [-j
     none|basic|extended] [--markdown-description] [--sort-props] [--strict-tuples] [--type-check] [--ref-encode]
     [--additional-properties] [--functions fail|comment|hide] [--minify] [-o <value>] [--extra-tags <value>]
     [--discriminator-type json-schema|open-api]
 
 ARGUMENTS
-  PATH  Source file path
+  PATH  [default: *] Source file path
 
 FLAGS
   -e, --expose=<option>              [default: export] Type exposing
@@ -115,7 +115,8 @@ FLAGS
   -j, --jsdoc=<option>               [default: extended] Read JsDoc annotations
                                      <options: none|basic|extended>
   -o, --out=<value>                  Set the output file (default: stdout)
-  -p, --tsconfig=<value>             Your tsconfig.json to load entry files and compilation settings
+  -p, --tsconfig=<value>             [default: tsconfig.json] Your tsconfig.json to load entry files and compilation
+                                     settings
   -t, --type=<value>                 Type name
       --additional-properties        Allow additional properties for objects with no index signature
       --discriminator-type=<option>  [default: json-schema] Type of discriminator to use
@@ -137,9 +138,13 @@ DESCRIPTION
   Generate JSON schema from your Typescript sources
 
 EXAMPLES
-  Analyzes src/types.ts using tsconfig.json and writes the schema to schema.json.
+  Analyzes src/types.ts using tsconfig.json and pipes to stdout
+
+    $ tjsg generate src/types.ts -p tsconfig.json
+
+  Analyzes src/types.ts and writes the schema to schema.json
 
-    $ tjsg generate -f tsconfig.json -o schema.json src/types.ts
+    $ tjsg generate src/types.ts -o schema.json
 ```
 
 _See code: [src/commands/generate.ts](https://github.com/vega/ts-json-schema-generator/blob/v2.0.0/src/commands/generate.ts)_

diff --git a/bin/ts-json-schema-generator.js b/bin/ts-json-schema-generator.js
diff --git a/commands/generate.ts b/commands/generate.ts
@@ -11,14 +11,17 @@ export default class Generate extends Command {
 
     static override examples = [
         {
-            command: "<%= config.bin %> <%= command.id %> -f tsconfig.json -o schema.json src/types.ts ",
-            description: "Analyzes src/types.ts using tsconfig.json and writes the schema to schema.json.",
+            command: "<%= config.bin %> <%= command.id %> src/types.ts -p tsconfig.json",
+            description: "Analyzes src/types.ts using tsconfig.json and pipes to stdout",
+        },
+        {
+            command: "<%= config.bin %> <%= command.id %> src/types.ts -o schema.json",
+            description: "Analyzes src/types.ts and writes the schema to schema.json",
         },
     ];
 
     static override args = {
         path: Args.file({
-            required: false,
             description: "Source file path",
         }),
     };
@@ -42,6 +45,7 @@ export default class Generate extends Command {
             char: "p", // Keep similar to tsc and other cli tools
             aliases: ["project"],
             description: "Your tsconfig.json to load entry files and compilation settings",
+            default: "tsconfig.json",
         }),
         expose: Flags.string({
             char: "e",
@@ -119,7 +123,11 @@ export default class Generate extends Command {
         }
 
         if (flags["type-check"] && !flags.tsconfig) {
-            this.warn("Cannot type check without a tsconfig file. Skipping type check.");
+            // When printing to stdout, we cannot output anything else than a JSON
+            if (flags.out) {
+                this.warn("Cannot type check without a tsconfig file. Skipping type check.");
+            }
+
             flags["type-check"] = false;
         }
 
@@ -160,7 +168,14 @@ export default class Generate extends Command {
                 // write to stdout
                 process.stdout.write(`${schemaString}\n`);
             }
+
+            // When printing to stdout, we cannot output anything else than a JSON
+            if (flags.out) {
+                this.log("Schema generated successfully");
+            }
         } catch (error) {
+            this.error("Could not generate schema", { exit: false });
+
             if (error instanceof BaseError) {
                 process.stderr.write(error.format());
                 process.exit(1);

diff --git a/eslint.config.js b/eslint.config.js
@@ -10,15 +10,7 @@ export default tseslint.config(
     },
     eslint.configs.recommended,
     {
-        files: [
-            "ts-json-schema-generator.ts",
-            "index.ts",
-            "src/**/*.ts",
-            "factory/**/*.ts",
-            "bin/**",
-            "test/**/*.test.ts",
-            "test/utils.ts",
-        ],
+        files: ["index.ts", "src/**/*.ts", "factory/**/*.ts", "bin/**", "test/**/*.test.ts", "test/utils.ts"],
         extends: tseslint.configs.recommendedTypeChecked,
         languageOptions: {
             sourceType: "module",

diff --git a/factory/generator.ts b/factory/generator.ts
@@ -1,4 +1,4 @@
-import { Config, DEFAULT_CONFIG } from "../src/Config.js";
+import { type Config, DEFAULT_CONFIG } from "../src/Config.js";
 import { SchemaGenerator } from "../src/SchemaGenerator.js";
 import { createFormatter } from "./formatter.js";
 import { createParser } from "./parser.js";

diff --git a/oclif.manifest.json b/oclif.manifest.json
@@ -4,16 +4,21 @@
       "aliases": [],
       "args": {
         "path": {
+          "default": "*",
           "description": "Source file path",
           "name": "path",
-          "required": false
+          "required": true
         }
       },
       "description": "Generate JSON schema from your Typescript sources",
       "examples": [
         {
-          "command": "<%= config.bin %> <%= command.id %> -f tsconfig.json -o schema.json src/types.ts ",
-          "description": "Analyzes src/types.ts using tsconfig.json and writes the schema to schema.json."
+          "command": "<%= config.bin %> <%= command.id %> src/types.ts -p tsconfig.json",
+          "description": "Analyzes src/types.ts using tsconfig.json and pipes to stdout"
+        },
+        {
+          "command": "<%= config.bin %> <%= command.id %> src/types.ts -o schema.json",
+          "description": "Analyzes src/types.ts and writes the schema to schema.json"
         }
       ],
       "flags": {
@@ -45,6 +50,7 @@
           "char": "p",
           "description": "Your tsconfig.json to load entry files and compilation settings",
           "name": "tsconfig",
+          "default": "tsconfig.json",
           "hasDynamicHelp": false,
           "multiple": false,
           "type": "option"

diff --git a/package.json b/package.json
@@ -37,29 +37,27 @@
   "types": "dist/index.d.ts",
   "bin": {
     "tjsg": "./bin/run.js",
-    "tjsg-dev": "./bin/dev.js",
-    "ts-json-schema-generator": "./bin/ts-json-schema-generator.js"
+    "tjsg-dev": "./bin/dev.js"
   },
   "files": [
     "dist",
     "cjs",
     "src",
     "factory",
     "commands",
-    "index.*",
-    "ts-json-schema-generator.*"
+    "index.*"
   ],
   "scripts": {
     "build": "npm run build:cjs && npm run build:esm",
     "postbuild": "oclif manifest && oclif readme && prettier --write README.md oclif.manifest.json",
     "build:cjs": "tsc -p tsconfig.cjs.json",
     "build:esm": "tsc -p tsconfig.json",
-    "debug": "tsx --inspect-brk ts-json-schema-generator.ts",
+    "debug": "tsx --inspect-brk bin/run.js",
     "format": "eslint --fix",
     "lint": "eslint",
     "prepublishOnly": "yarn build",
     "release": "yarn build && git diff && auto shipit",
-    "run": "tsx ts-json-schema-generator.ts",
+    "run": "tsx bin/run.js",
     "test": "jest test/ --verbose",
     "test:coverage": "yarn jest test/ --collectCoverage=true",
     "test:fast": "cross-env FAST_TEST=1 jest test/ --verbose",
@@ -116,10 +114,6 @@
   },
   "oclif": {
     "bin": "tjsg",
-    "binAliases": [
-      "tjsg-dev",
-      "ts-json-schema-generator"
-    ],
     "dirname": "ts-json-schema-generator",
     "topicSeparator": " ",
     "additionalHelpFlags": [

diff --git a/test/minify/index.test.ts b/test/minify/index.test.ts
@@ -1,7 +1,7 @@
-import { execSync } from "child_process";
-import path from "path";
+import { execSync } from "node:child_process";
+import path from "node:path";
 
-const BIN = path.resolve(__dirname, "../../dist/ts-json-schema-generator.js");
+const BIN = path.resolve(__dirname, "../../bin/run.js");
 const SCHEMA_PATH = path.resolve(__dirname, "./schema.ts");
 
 const EXPECTED = {
@@ -22,7 +22,7 @@ const EXPECTED = {
 
 describe("Tests --minify output", () => {
     it("With minify", () => {
-        const stdout = execSync(`node ${BIN} -p ${SCHEMA_PATH} --minify`).toString().trimEnd();
+        const stdout = execSync(`node ${BIN} generate ${SCHEMA_PATH} --no-type-check --minify`).toString().trimEnd();
 
         // Only a newline at the end
         expect(stdout.split("\n").length).toBe(1);
@@ -35,7 +35,7 @@ describe("Tests --minify output", () => {
     });
 
     it("Without minify", () => {
-        const stdout = execSync(`node ${BIN} -p ${SCHEMA_PATH}`).toString().trimEnd();
+        const stdout = execSync(`node ${BIN} generate ${SCHEMA_PATH} --no-type-check`).toString().trimEnd();
 
         // There's more than one \n (formatting)
         expect(stdout.split("\n").length).toBeGreaterThan(2);

diff --git a/ts-json-schema-generator.ts b/ts-json-schema-generator.ts
diff --git a/tsconfig.json b/tsconfig.json
@@ -25,7 +25,7 @@
     "incremental": true,
     "importHelpers": true
   },
-  "files": ["ts-json-schema-generator.ts", "index.ts"],
+  "files": ["index.ts"],
   "include": ["src/**/*.ts", "factory/**/*.ts", "commands/**/*.ts"],
   "exclude": ["node_modules", "dist", "cjs"]
 }