@kubb/parser-ts 5.8.2 → 5.8.3

package/README.md

@@ -10,7 +10,7 @@
 [![Node][node-src]][node-href]
 
 <h4>
-<a href="https://kubb.dev" target="_blank">Documentation</a>
+<a href="https://kubb.dev/extensions/kubb-labs/parser-ts" target="_blank">Documentation</a>
 <span> · </span>
 <a href="https://github.com/kubb-labs/kubb/issues/" target="_blank">Report Bug</a>
 <span> · </span>

package/dist/index.cjs

@@ -10,7 +10,7 @@ var compatibility = {
 };
 //#endregion
 //#region package.json
-var version = "5.8.2";
+var version = "5.8.3";
 //#endregion
 //#region ../../internals/utils/src/fs.ts
 /**

package/dist/index.js

@@ -9,7 +9,7 @@ var compatibility = {
 };
 //#endregion
 //#region package.json
-var version = "5.8.2";
+var version = "5.8.3";
 //#endregion
 //#region ../../internals/utils/src/fs.ts
 /**

package/docs/options.md

@@ -0,0 +1,30 @@
+# Options
+
+`parserTs` and `parserTsx` accept the same single option, `extension`, which rewrites the import and export extensions the TypeScript parser emits.
+
+## Options overview
+
+| Option                    | Purpose                                                         | Default         |
+| ------------------------- | --------------------------------------------------------------- | --------------- |
+| [`extension`](#extension) | Rewrite the extensions emitted in `import`/`export` statements. | `{ '.ts': '' }` |
+
+## Option details
+
+### extension
+
+Rewrites the extensions emitted in `import`/`export` statements. Keys are the source extension, values the output, and `''` drops it. Only the module-specifier string changes, never the on-disk filename.
+
+Use it to emit `.js` imports from `.ts` sources for an ESM dual package, or to keep the source extension for Node16/NodeNext resolution.
+
+The same mapping applies to runtime templates a plugin copies into the output, such as the `.kubb/` runtime files of `@kubb/plugin-fetch`. Their top-level `import` and `export … from` statements become import and export nodes, so the whole output follows one convention.
+
+|          |                          |
+| -------- | ------------------------ |
+| Type     | `Record<string, string>` |
+| Required | `false`                  |
+| Default  | `{ '.ts': '' }`          |
+
+```typescript
+parserTs({ extension: { '.ts': '.js' } }) // import './api.js' instead of './api'
+parserTs({ extension: { '.ts': '.ts' } }) // import './api.ts' instead of './api'
+```

package/{OVERVIEW.md → docs/overview.md}

@@ -8,19 +8,24 @@ The package also exports `parserTsx`, which handles `.tsx` and `.jsx` files with
 
 Set `defineConfig.parsers` only to change an option. A custom `parsers` array replaces the default set, so list every parser your plugins need. Files no parser claims are written as their source text.
 
-```ts
+## Options
+
+`extension` rewrites the extension of relative imports and exports. Keys are the source extension and values the output, and `''` drops it. By default `.ts` imports have no extension. Use `{ '.ts': '.js' }` for ESM packages, or `{ '.ts': '.ts' }` for Node.js `NodeNext` resolution. Package imports stay unchanged. See [Options](https://kubb.dev/extensions/kubb-labs/parser-ts/options) for its type and default.
+
+## Example
+
+Override import extensions while keeping every default parser registered.
+
+```typescript [kubb.config.ts]
 import { defineConfig } from 'kubb/config'
 import { parserTs, parserTsx } from '@kubb/parser-ts'
 import { parserMd } from '@kubb/parser-md'
+import { pluginTs } from '@kubb/plugin-ts'
 
 export default defineConfig({
   input: './petStore.yaml',
   output: { path: './src/gen' },
   parsers: [parserTs({ extension: { '.ts': '.js' } }), parserTsx(), parserMd()],
-  plugins: [],
+  plugins: [pluginTs()],
 })
 ```
-
-## Options
-
-`extension` rewrites the extension of relative imports and exports. Keys are the source extension and values the output, and `''` drops it. By default `.ts` imports have no extension. Use `{ '.ts': '.js' }` for ESM packages, or `{ '.ts': '.ts' }` for Node.js `NodeNext` resolution. Package imports stay unchanged.

package/kubb-extension.json

@@ -10,7 +10,8 @@
     "light": "https://kubb.dev/feature/typescript.svg"
   },
   "tags": ["typescript", "tsx", "parser", "printer", "ast"],
-  "docs": "https://kubb.dev/parsers/parser-ts",
+  "docs": "https://kubb.dev/extensions/kubb-labs/parser-ts",
+  "maintainers": [{ "name": "Stijn Van Hulle", "github": "stijnvanhulle" }],
   "compatibility": {
     "kubb": ">=5.8.0",
     "node": ">=22"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/parser-ts",
-  "version": "5.8.2",
+  "version": "5.8.3",
   "description": "TypeScript and TSX source file parser for Kubb. Converts AST nodes into formatted source strings using the TypeScript compiler API.",
   "keywords": [
     "codegen",
@@ -10,7 +10,7 @@
     "tsx",
     "typescript"
   ],
-  "homepage": "https://kubb.dev/parsers/parser-ts",
+  "homepage": "https://kubb.dev/extensions/kubb-labs/parser-ts",
   "license": "MIT",
   "author": "stijnvanhulle",
   "repository": {
@@ -35,7 +35,7 @@
   "files": [
     "dist",
     "kubb-extension.json",
-    "OVERVIEW.md",
+    "docs",
     "!/**/**.test.**",
     "!/**/__tests__/**",
     "!/**/__snapshots__/**"
@@ -59,7 +59,7 @@
     "registry": "https://registry.npmjs.org/"
   },
   "dependencies": {
-    "@kubb/kit": "5.8.2",
+    "@kubb/kit": "5.8.3",
     "typescript": "^6.0.3"
   },
   "devDependencies": {