dtsgenerator 3.19.1 → 4.0.0

package/docs/npm-trusted-publishing.md

@@ -0,0 +1,60 @@
+# npm trusted publishing への移行
+
+リリースworkflowは、npmの長期トークンを使う方式からGitHub ActionsのOIDCを使うtrusted publishingへ移行する。GitHub Actions側に`NPM_TOKEN`などの新しいsecretを追加する必要はない。Node.js 24系に同梱されるnpm 11.5.1以降を使用し、`id-token: write`権限でnpmへ短時間だけ有効な認証情報を要求する。
+
+## npmでの設定
+
+各パッケージのnpmページで `Settings` → `Trusted Publisher` を開き、publisherとして `GitHub Actions` を選択する。次の値を登録する。
+
+| npmパッケージ | GitHub owner/repository | Workflow filename | Environment |
+| --- | --- | --- | --- |
+| `@dtsgenerator/eslint-config` | `dtsgenerator/eslint-config` | `release.yml` | 空欄 |
+| `@dtsgenerator/do-nothing` | `dtsgenerator/do-nothing` | `workflow-release.yaml` | 空欄 |
+| `@dtsgenerator/replace-namespace` | `dtsgenerator/replace-namespace` | `workflow-release.yaml` | 空欄 |
+| `@dtsgenerator/single-quote` | `dtsgenerator/single-quote` | `workflow-release.yaml` | 空欄 |
+| `@dtsgenerator/decorate-typename` | `dtsgenerator/decorate-typename` | `workflow-release.yaml` | 空欄 |
+| `dtsgenerator` | `horiuchi/dtsgenerator` | `workflow-release.yaml` | 空欄 |
+| `@dtsgenerator/create` | `dtsgenerator/create` | なし（手動リリース） | 対象外 |
+
+`create`が生成したプラグインでは、生成先の実際のGitHub owner/repositoryと`workflow-release.yaml`を登録し、Environmentは空欄にする。trusted publisherを登録できるのはnpmレジストリにすでに存在するパッケージだけなので、新規パッケージは最初にnpmへログインし、buildとtestを確認してから`npm publish --ignore-scripts`で一度だけ手動公開する。
+
+npmのtrusted publisher設定にある `Allow direct npm publish` を明示的に有効にする。新規設定ではstage publishが既定のため、この設定が無効なままでは現在のworkflowにある`npm publish`を実行できない。
+
+## 公開順序
+
+1. `@dtsgenerator/eslint-config`
+2. `@dtsgenerator/do-nothing`
+3. `@dtsgenerator/replace-namespace`、`@dtsgenerator/single-quote`、`@dtsgenerator/decorate-typename`、`dtsgenerator`
+4. `@dtsgenerator/create`（必要な場合は手動公開）
+
+`@dtsgenerator/eslint-config@1.0.0`と`@dtsgenerator/do-nothing@3.0.1`は
+2026-09-18時点で公開済みであり、両方のconsumer lockfileを公開registryの
+artifactから更新済みである。`dtsgenerator`を公開する前提パッケージの公開と
+lockfile更新は完了している。
+
+## 公開後のlockfile更新
+
+前提パッケージを公開するたびに、そのパッケージを参照するすべての
+`package-lock.json`を公開registryの実体に合わせて更新する。registryの
+version、dependencies、peerDependenciesが公開対象と一致することを確認する。
+さらに`dist.tarball`を取得して実体のhashを検証し、lockfileの`resolved`と
+`integrity`がそのartifactおよび`dist` metadataと一致することを確認する。
+その後、作業ツリーとは別のコピーと空のnpm cacheを使って`npm ci`を実行する。
+
+公開前の結合確認にローカルでpackしたartifactを使用しても、そのintegrityを
+registry URLのlock entryへ転記しない。ローカルartifactをcacheへ事前投入した
+検証は、公開registryだけを使ったinstall確認として扱わない。main lockfileの
+`@dtsgenerator/do-nothing` entryは、公開された3.0.1のtarball URLとintegrityに
+更新済みである。
+
+## workflowを実行する前の注意
+
+変更したworkflowを含むコミットを先にGitHubへpushする。失敗した古いrunを再実行しても、そのrunが参照していた古いYAMLが使われるためOIDCへの移行確認にはならない。タグで起動するworkflowでは、タグが移行済みコミットを指していることを確認してからpushする。
+
+ローカルで確認できるのはYAMLの構文と設定内容までである。npm UIでtrusted publisherを登録した後、GitHub Actionsから実際に公開し、OIDC認証が成功することを確認する。
+
+参考資料:
+
+- [npm trusted publishing](https://docs.npmjs.com/trusted-publishers/)
+- [npm trust](https://docs.npmjs.com/cli/v11/commands/npm-trust/)
+- [actions/setup-node advanced usage](https://github.com/actions/setup-node/blob/main/docs/advanced-usage.md)

package/eslint.config.cjs

@@ -0,0 +1,24 @@
+const shared = require('@dtsgenerator/eslint-config');
+
+module.exports = [
+    ...shared,
+    { ignores: ['test/snapshots/**'] },
+    { rules: { '@typescript-eslint/no-explicit-any': 'off' } },
+    {
+        files: ['**/*_test.ts'],
+        rules: {
+            '@typescript-eslint/ban-ts-comment': 'off',
+            '@typescript-eslint/no-empty-object-type': 'off',
+            '@typescript-eslint/no-explicit-any': 'off',
+            '@typescript-eslint/no-floating-promises': 'off',
+            '@typescript-eslint/no-implied-eval': 'off',
+            '@typescript-eslint/no-misused-promises': 'off',
+            '@typescript-eslint/no-unsafe-assignment': 'off',
+            '@typescript-eslint/no-unsafe-call': 'off',
+            '@typescript-eslint/no-unsafe-member-access': 'off',
+            '@typescript-eslint/no-unsafe-return': 'off',
+            '@typescript-eslint/no-require-imports': 'off',
+            '@typescript-eslint/unbound-method': 'off',
+        },
+    },
+];

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "dtsgenerator",
-    "version": "3.19.1",
+    "version": "4.0.0",
     "description": "TypeScript d.ts file generator for JSON Schema file",
     "bin": {
         "dtsgen": "bin/dtsgen"
@@ -11,8 +11,10 @@
         "build": "tsc -p ./tsconfig-build.json",
         "clean": "rimraf dist/ build/ {src,test}/**/*.{js,js.map} *.tsbuildinfo",
         "compile": "tsc -p .",
-        "lint": "eslint --fix --ext ts src/ test/",
-        "format": "prettier --cache --write 'src/**/*.ts' 'test/*.ts' 'test/core/*.ts'",
+        "lint": "eslint --report-unused-disable-directives src/ test/",
+        "lint:fix": "npm run lint -- --fix",
+        "format": "prettier --check 'src/**/*.ts' 'test/*.ts' 'test/core/*.ts'",
+        "format:fix": "prettier --cache --write 'src/**/*.ts' 'test/*.ts' 'test/core/*.ts'",
         "precompile": "npm run lint && npm run format",
         "prepublishOnly": "npm run build",
         "pretest": "npm run compile",
@@ -20,7 +22,7 @@
         "test": "nyc npm run do-test",
         "test:update-snapshot": "UPDATE_SNAPSHOT=1 npm run test",
         "coverage": "nyc report --reporter=lcov",
-        "prepare": "husky install"
+        "prepare": "husky"
     },
     "directories": {
         "test": "test/"
@@ -41,40 +43,39 @@
         "url": "https://github.com/horiuchi/dtsgenerator/issues"
     },
     "engines": {
-        "node": ">= 16.0"
+        "node": "^22.22.2 || >=24.15.0"
     },
     "dependencies": {
-        "commander": "^11.0.0",
-        "cross-fetch": "^4.0.0",
-        "debug": "^4.3.4",
-        "glob": "^10.3.3",
-        "http-proxy-agent": "^7.0.0",
-        "https-proxy-agent": "^7.0.1",
-        "js-yaml": "^4.1.0",
-        "tslib": "^2.6.2",
-        "typescript": "^5.1.6"
+        "commander": "^15.0.0",
+        "cross-fetch": "^4.1.0",
+        "debug": "^4.4.3",
+        "glob": "^13.0.6",
+        "http-proxy-agent": "^9.1.0",
+        "https-proxy-agent": "^9.1.0",
+        "js-yaml": "^4.3.2",
+        "tslib": "^2.8.1",
+        "typescript": "^6.0.3"
     },
     "devDependencies": {
-        "@dtsgenerator/do-nothing": "^2.6.0",
-        "@dtsgenerator/eslint-config": "^0.6.5",
+        "@dtsgenerator/do-nothing": "^3.0.1",
+        "@dtsgenerator/eslint-config": "^1.0.0",
         "@dtsgenerator/replace-namespace": "^1.6.0",
         "@dtsgenerator/single-quote": "^1.7.0",
         "@istanbuljs/nyc-config-typescript": "^1.0.2",
-        "@types/debug": "^4.1.8",
-        "@types/glob": "^8.1.0",
-        "@types/js-yaml": "^4.0.5",
-        "@types/mocha": "^10.0.1",
-        "@types/node": "^16.18.46",
-        "cross-env": "^7.0.3",
-        "eslint": "^8.47.0",
-        "husky": "^8.0.3",
-        "lint-staged": "^14.0.1",
-        "mocha": "^10.2.0",
-        "nyc": "^15.1.0",
-        "prettier": "^3.0.2",
-        "rimraf": "^5.0.1",
+        "@types/debug": "^4.1.13",
+        "@types/js-yaml": "^4.0.9",
+        "@types/mocha": "^10.0.10",
+        "@types/node": "^22.20.1",
+        "cross-env": "^10.1.0",
+        "eslint": "^10.10.0",
+        "husky": "^9.1.7",
+        "lint-staged": "^17.5.0",
+        "mocha": "^12.0.0",
+        "nyc": "^18.0.0",
+        "prettier": "^3.9.6",
+        "rimraf": "^6.1.3",
         "source-map-support": "^0.5.21",
-        "ts-node": "^10.9.1"
+        "ts-node": "^10.9.2"
     },
     "lint-staged": {
         "**/*.ts": [

package/src/commandOptions.ts

@@ -40,7 +40,7 @@ function parse(options: CommandOptions, argv: string[]): commander.Command {
         return memo;
     }
 
-    // eslint-disable-next-line @typescript-eslint/no-var-requires, @typescript-eslint/no-unsafe-assignment
+    // eslint-disable-next-line @typescript-eslint/no-require-imports, @typescript-eslint/no-unsafe-assignment
     const pkg: { name: string; version: string } = require('../package.json');
 
     // <hoge> is required, [hoge] is optional
@@ -66,6 +66,7 @@ function parse(options: CommandOptions, argv: string[]): commander.Command {
             'for developer mode. output loaded config and plugin details only.',
         )
         .option('--output-ast', 'output TypeScript AST instead of d.ts file.')
+        .allowExcessArguments(true)
         .addHelpText(
             'afterAll',
             `

package/src/core/astBuilder.ts

@@ -48,6 +48,15 @@ export function buildStringLiteralTypeNode(s: string): ts.LiteralTypeNode {
     return ts.factory.createLiteralTypeNode(ts.factory.createStringLiteral(s));
 }
 export function buildNumericLiteralTypeNode(n: string): ts.LiteralTypeNode {
+    if (!isNaN(parseFloat(n)) && parseFloat(n) < 0) {
+        return ts.factory.createLiteralTypeNode(
+            ts.factory.createPrefixUnaryExpression(
+                ts.SyntaxKind.MinusToken,
+                ts.factory.createNumericLiteral(Math.abs(parseFloat(n))),
+            ),
+        );
+    }
+
     return ts.factory.createLiteralTypeNode(ts.factory.createNumericLiteral(n));
 }
 export function buildBooleanLiteralTypeNode(b: boolean): ts.LiteralTypeNode {
@@ -117,10 +126,9 @@ export function buildPropertySignature(
     isPattern: boolean | undefined,
 ): ts.PropertySignature | ts.IndexSignatureDeclaration {
     const modifiers = undefined;
-    const questionToken =
-        required == null || !required.includes(propertyName)
-            ? ts.factory.createToken(ts.SyntaxKind.QuestionToken)
-            : undefined;
+    const questionToken = !required?.includes(propertyName)
+        ? ts.factory.createToken(ts.SyntaxKind.QuestionToken)
+        : undefined;
     if (isPattern) {
         return ts.factory.createIndexSignature(
             modifiers,
@@ -223,13 +231,12 @@ export function buildTupleTypeNode(
     for (let i = 0; i < itemCount; i++) {
         let node = typesIsArray(types)
             ? i < types.length
-                ? // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
-                  types[i]!
+                ? types[i]!
                 : additionalItems !== undefined
-                ? additionalItems === false
-                    ? buildNeverKeyword()
-                    : additionalItems
-                : buildAnyKeyword()
+                  ? additionalItems === false
+                      ? buildNeverKeyword()
+                      : additionalItems
+                  : buildAnyKeyword()
             : types;
         if (minItems == null || i >= minItems) {
             node = ts.factory.createOptionalTypeNode(node);

package/src/core/config.ts

@@ -8,9 +8,7 @@ export interface Config {
     target: ScriptTarget;
     outputAST: boolean;
 
-    plugins: {
-        [pluginName: string]: boolean | Record<string, unknown>;
-    };
+    plugins: Record<string, boolean | Record<string, unknown>>;
 }
 
 interface InputConfig {

package/src/core/dtsGenerator.ts

@@ -57,7 +57,7 @@ export default class DtsGenerator {
 
         const postProcess = await this.getPostProcess(plugins.post);
         const result = ts.transform(file, postProcess);
-        // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
+
         const transformedNodes = result.transformed[0]!;
 
         const transformedContent = config.outputAST
@@ -263,12 +263,10 @@ export default class DtsGenerator {
     ): ts.DeclarationStatement {
         const content = schema.content;
         if (
-            /* eslint-disable @typescript-eslint/prefer-nullish-coalescing */
             content.$ref ||
             content.oneOf ||
             content.anyOf ||
             content.enum ||
-            /* eslint-enable @typescript-eslint/prefer-nullish-coalescing */
             'const' in content ||
             content.type !== 'object'
         ) {
@@ -553,14 +551,14 @@ export default class DtsGenerator {
             const additionalItems = schema.content.additionalItems
                 ? this.normalizeContent(schema, '/additionalItems')
                 : schema.content.additionalItems === false
-                ? false
-                : undefined;
+                  ? false
+                  : undefined;
 
             return additionalItems === undefined
                 ? undefined
                 : additionalItems === false
-                ? false
-                : this.generateTypeProperty(additionalItems, false);
+                  ? false
+                  : this.generateTypeProperty(additionalItems, false);
         };
 
         if (items == null) {

package/src/core/jsonSchema.ts

@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/no-unsafe-member-access */
 import * as JsonPointer from '../jsonPointer';
 import { JsonSchemaDraft04 } from './jsonSchemaDraft04';
 import { OpenApisV2 } from './openApiV2';
@@ -103,7 +102,7 @@ export function searchAllSubSchema(
         });
     };
     const walkObject = (
-        obj: { [name: string]: JsonSchema } | undefined,
+        obj: Record<string, JsonSchema> | undefined,
         paths: string[],
         parentIds: string[],
     ): void => {
@@ -202,7 +201,7 @@ export function searchAllSubSchema(
         }
         function setSubIdToAnyObject<T>(
             f: (t: T, keys: string[]) => void,
-            obj: { [key: string]: T } | undefined,
+            obj: Record<string, T> | undefined,
             keys: string[],
         ): void {
             if (obj == null) {
@@ -297,7 +296,7 @@ export function searchAllSubSchema(
             const paths = keys
                 .slice(0, keys.length - 1)
                 .concat(inType + 'Parameters');
-            const properties: { [name: string]: JsonSchemaDraft04.Schema } = {};
+            const properties: Record<string, JsonSchemaDraft04.Schema> = {};
             params.forEach(([key, _]) => {
                 properties[key] = {
                     $ref: createId(keys.concat(key)),
@@ -323,8 +322,7 @@ export function searchAllSubSchema(
         ) => setSubIdToAnyObject(setSubIdToResponseV2, responses, keys);
         function setSubIdToResponseV2(
             response:
-                | OpenApisV2.SchemaJson.Definitions.ResponseValue
-                | undefined,
+                OpenApisV2.SchemaJson.Definitions.ResponseValue | undefined,
             keys: string[],
         ): void {
             if (response == null) {
@@ -332,10 +330,10 @@ export function searchAllSubSchema(
             }
             if ('schema' in response) {
                 const s = response.schema;
-                if (s != null && s.type === 'file') {
+                if (s?.type === 'file') {
                     return;
                 }
-                setSubId(s as JsonSchemaObject, keys);
+                setSubId(s, keys);
             }
         }
         function setSubIdToOperationV2(
@@ -347,7 +345,6 @@ export function searchAllSubSchema(
             }
             const operationId = ops.operationId;
             if (operationId) {
-                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
                 keys = [keys[0]!, convertKeyToTypeName(operationId)];
             }
             setSubIdToParameters(ops.parameters, keys.concat('parameters'));
@@ -446,7 +443,6 @@ export function searchAllSubSchema(
             }
             const operationId = ops.operationId;
             if (operationId) {
-                // eslint-disable-next-line @typescript-eslint/no-non-null-assertion
                 keys = [keys[0]!, convertKeyToTypeName(operationId)];
             }
             setSubIdToParameters(ops.parameters, keys.concat('parameters'));
@@ -476,7 +472,7 @@ export function searchAllSubSchema(
         }
 
         function setSubIdToObject(
-            obj: { [name: string]: JsonSchema } | undefined,
+            obj: Record<string, JsonSchema> | undefined,
             paths: string[],
         ): void {
             if (obj == null) {
@@ -558,7 +554,7 @@ export function selectSchemaType(content: JsonSchema | OpenApiSchema): {
         );
     }
     if ('$schema' in content) {
-        const schema = content['$schema'] ?? '';
+        const schema = content.$schema ?? '';
         if (/^https?:\/\/json-schema.org\/schema#?$/.test(schema)) {
             return { type: 'Latest' };
         }

package/src/core/jsonSchemaDraft04.ts

@@ -1,4 +1,3 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
 /* eslint-disable @typescript-eslint/no-namespace */
 
 export namespace JsonSchemaDraft04 {
@@ -31,22 +30,13 @@ export namespace JsonSchemaDraft04 {
         minProperties?: Schema.Definitions.PositiveIntegerDefault0;
         required?: Schema.Definitions.StringArray;
         additionalProperties?: boolean | Schema;
-        definitions?: {
-            [name: string]: Schema;
-        };
-        properties?: {
-            [name: string]: Schema;
-        };
-        patternProperties?: {
-            [name: string]: Schema;
-        };
-        dependencies?: {
-            [name: string]: Schema | Schema.Definitions.StringArray;
-        };
+        definitions?: Record<string, Schema>;
+        properties?: Record<string, Schema>;
+        patternProperties?: Record<string, Schema>;
+        dependencies?: Record<string, Schema | Schema.Definitions.StringArray>;
         enum?: any[];
         type?:
-            | Schema.Definitions.SimpleTypes
-            | Schema.Definitions.SimpleTypes[];
+            Schema.Definitions.SimpleTypes | Schema.Definitions.SimpleTypes[];
         format?: string;
         allOf?: Schema.Definitions.SchemaArray;
         anyOf?: Schema.Definitions.SchemaArray;
@@ -89,8 +79,7 @@ export namespace JsonSchemaDraft04 {
             export type Required = Definitions.StringArray;
             export type Title = string;
             export type Type =
-                | Definitions.SimpleTypes
-                | Definitions.SimpleTypes[];
+                Definitions.SimpleTypes | Definitions.SimpleTypes[];
             export type UniqueItems = boolean;
         }
     }

package/src/core/jsonSchemaDraft07.ts

@@ -1,8 +1,7 @@
-/* eslint-disable @typescript-eslint/no-explicit-any */
 /* eslint-disable @typescript-eslint/no-namespace */
 
 export namespace JsonSchemaDraft07 {
-    export type SchemaObject = {
+    export interface SchemaObject {
         $id?: string; // uri-reference
         $schema?: string; // uri
         $ref?: string; // uri-reference
@@ -31,24 +30,15 @@ export namespace JsonSchemaDraft07 {
         minProperties?: Schema.Definitions.NonNegativeIntegerDefault0;
         required?: Schema.Definitions.StringArray;
         additionalProperties?: Schema;
-        definitions?: {
-            [name: string]: Schema;
-        };
-        properties?: {
-            [name: string]: Schema;
-        };
-        patternProperties?: {
-            [name: string]: Schema;
-        };
-        dependencies?: {
-            [name: string]: Schema | Schema.Definitions.StringArray;
-        };
+        definitions?: Record<string, Schema>;
+        properties?: Record<string, Schema>;
+        patternProperties?: Record<string, Schema>;
+        dependencies?: Record<string, Schema | Schema.Definitions.StringArray>;
         propertyNames?: Schema;
         const?: any;
         enum?: any[];
         type?:
-            | Schema.Definitions.SimpleTypes
-            | Schema.Definitions.SimpleTypes[];
+            Schema.Definitions.SimpleTypes | Schema.Definitions.SimpleTypes[];
         format?: string;
         contentMediaType?: string;
         contentEncoding?: string;
@@ -59,7 +49,7 @@ export namespace JsonSchemaDraft07 {
         anyOf?: Schema.Definitions.SchemaArray;
         oneOf?: Schema.Definitions.SchemaArray;
         not?: Schema;
-    };
+    }
     export type Schema = SchemaObject | boolean;
     export namespace Schema {
         export namespace Definitions {