Merge pull request #2222 from vega/next

Release

Author: domoritz

.github/workflows/publish-auto.yml

@@ -20,12 +20,13 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           registry-url: "https://registry.npmjs.org"
-          cache: "yarn"
+          cache: "npm"
+          node-version: 22
         env:
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
 
       - name: Install Node dependencies
-        run: yarn --frozen-lockfile
+        run: npm ci
 
       - name: Create release
         run: npm run release

.github/workflows/test.yml

@@ -25,19 +25,19 @@ jobs:
       - uses: actions/setup-node@v4
         with:
           node-version: 22
-          cache: "yarn"
+          cache: "npm"
 
       - name: Install Node dependencies
-        run: yarn --frozen-lockfile
+        run: npm ci
 
       - name: Lint
-        run: yarn lint
+        run: npm run lint
 
       - name: Build
-        run: yarn build
+        run: npm run build
 
       - name: Test coverage
-        run: yarn jest test/ --collectCoverage=true
+        run: npx jest test/ --collectCoverage=true
 
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v4
+        uses: codecov/codecov-action@v5

.gitignore

@@ -11,4 +11,4 @@ node_modules/
 
 # Other package managers
 pnpm-lock.yaml
-package-lock.json
+yarn.lock

README.md

@@ -35,6 +35,8 @@ Note that different platforms (e.g. Windows) may use different path separators s
 
 Also note that you need to quote paths with `*` as otherwise the shell will expand the paths and therefore only pass the first path to the generator.
 
+By default, the command-line generator will use the `tsconfig.json` file in the current working directory, or the first parent directory that contains a `tsconfig.json` file up to the root of the filesystem. If you want to use a different `tsconfig.json` file, you can use the `--tsconfig` option. In particular, if you need to use different compilation options for types, you may want to create a separate `tsconfig.json` file for the schema generation only.
+
 ### Options
 
 ```
@@ -232,14 +234,15 @@ fs.writeFile(outputPath, schemaString, (err) => {
 -   conditional types
 -   functions
 -   `Promise<T>` unwraps to `T`
+-   Overrides (like `@format`)
 
 ## Run locally
 
-`yarn --silent run run --path 'test/valid-data/type-mapped-array/*.ts' --type 'MyObject'`
+`npm run --silent run -- --path 'test/valid-data/type-mapped-array/*.ts' --type 'MyObject'`
 
 ## Debug
 
-`yarn --silent run debug --path 'test/valid-data/type-mapped-array/*.ts' --type 'MyObject'`
+`npm run --silent debug -- --path 'test/valid-data/type-mapped-array/*.ts' --type 'MyObject'`
 
 And connect via the debugger protocol.
 

eslint.config.mjs

@@ -3,10 +3,10 @@ import globals from "globals";
 import tseslint from "typescript-eslint";
 import eslintPluginPrettierRecommended from "eslint-plugin-prettier/recommended";
 
-/** @type {import('@types/eslint').Linter.FlatConfig[]} */
+/** @type {import('@types/eslint').Linter.Config[]} */
 export default tseslint.config(
     {
-        ignores: ["dist", "cjs", "build", "eslint.config.mjs"],
+        ignores: ["dist", "cjs", "build", "eslint.config.mjs", "bin/ts-json-schema-generator.js"],
     },
     eslint.configs.recommended,
     {
@@ -30,6 +30,7 @@ export default tseslint.config(
         rules: {
             "@typescript-eslint/explicit-function-return-type": "off",
             "@typescript-eslint/no-explicit-any": "off",
+            "@typescript-eslint/consistent-type-imports": "error",
             "@typescript-eslint/prefer-for-of": "error",
             "@typescript-eslint/no-require-imports": "error",
             "@typescript-eslint/no-parameter-properties": "off",

factory/formatter.ts

@@ -1,8 +1,8 @@
 import { ChainTypeFormatter } from "../src/ChainTypeFormatter.js";
 import { CircularReferenceTypeFormatter } from "../src/CircularReferenceTypeFormatter.js";
-import { CompletedConfig } from "../src/Config.js";
-import { MutableTypeFormatter } from "../src/MutableTypeFormatter.js";
-import { TypeFormatter } from "../src/TypeFormatter.js";
+import type { CompletedConfig } from "../src/Config.js";
+import type { MutableTypeFormatter } from "../src/MutableTypeFormatter.js";
+import type { TypeFormatter } from "../src/TypeFormatter.js";
 import { AliasTypeFormatter } from "../src/TypeFormatter/AliasTypeFormatter.js";
 import { AnnotatedTypeFormatter } from "../src/TypeFormatter/AnnotatedTypeFormatter.js";
 import { AnyTypeFormatter } from "../src/TypeFormatter/AnyTypeFormatter.js";

factory/generator.ts

@@ -1,4 +1,5 @@
-import { Config, DEFAULT_CONFIG } from "../src/Config.js";
+import type { Config } from "../src/Config.js";
+import { DEFAULT_CONFIG } from "../src/Config.js";
 import { SchemaGenerator } from "../src/SchemaGenerator.js";
 import { createFormatter } from "./formatter.js";
 import { createParser } from "./parser.js";

factory/parser.ts

@@ -114,7 +114,7 @@ export function createParser(program: ts.Program, config: CompletedConfig, augme
         .addNodeParser(new NumberLiteralNodeParser())
         .addNodeParser(new BooleanLiteralNodeParser())
         .addNodeParser(new NullLiteralNodeParser())
-        .addNodeParser(new ObjectLiteralExpressionNodeParser(chainNodeParser))
+        .addNodeParser(new ObjectLiteralExpressionNodeParser(chainNodeParser, typeChecker))
         .addNodeParser(new ArrayLiteralExpressionNodeParser(chainNodeParser))
 
         .addNodeParser(new PrefixUnaryExpressionNodeParser(chainNodeParser))