@kubb/parser-ts 5.0.0-beta.6 → 5.0.0-beta.7

package/README.md

@@ -0,0 +1,112 @@
+<div align="center">
+  <h1>@kubb/parser-ts</h1>
+  <a href="https://kubb.dev" target="_blank" rel="noopener noreferrer">
+    <img width="180" src="https://raw.githubusercontent.com/kubb-labs/kubb/main/assets/logo.png" alt="Kubb logo">
+  </a>
+
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![Coverage][coverage-src]][coverage-href]
+[![License][license-src]][license-href]
+[![Sponsors][sponsors-src]][sponsors-href]
+
+<h4>
+<a href="https://kubb.dev/" target="_blank">Documentation</a>
+<span> · </span>
+<a href="https://github.com/kubb-labs/kubb/issues/" target="_blank">Report Bug</a>
+<span> · </span>
+<a href="https://github.com/kubb-labs/kubb/issues/" target="_blank">Request Feature</a>
+</h4>
+</div>
+
+TypeScript and TSX source file parser for Kubb. Converts AST nodes and raw TypeScript code into formatted source strings using the TypeScript compiler API.
+
+## Installation
+
+```bash
+bun add @kubb/parser-ts
+# or
+pnpm add @kubb/parser-ts
+# or
+npm install @kubb/parser-ts
+```
+
+## Usage
+
+```typescript
+import { print, createImport, createExport } from '@kubb/parser-ts'
+import ts from 'typescript'
+
+// Print a TypeScript source file from compiler AST nodes
+const source = print([
+  ts.factory.createVariableStatement(
+    [ts.factory.createModifier(ts.SyntaxKind.ExportKeyword)],
+    ts.factory.createVariableDeclarationList(
+      [ts.factory.createVariableDeclaration('hello', undefined, undefined, ts.factory.createStringLiteral('world'))],
+      ts.NodeFlags.Const,
+    ),
+  ),
+])
+// → export const hello = 'world'
+
+// Create an import declaration
+const importNode = createImport({ name: 'axios', path: 'axios' })
+
+// Create an export declaration
+const exportNode = createExport({ name: 'MyType', path: './types' })
+```
+
+## API
+
+### `print(nodes, options?)`
+
+Converts an array of TypeScript compiler `Node` instances into a formatted source string. Returns the printed source code.
+
+### `safePrint(nodes, options?)`
+
+Same as `print` but catches formatting errors and returns the unformatted output as a fallback.
+
+### `parserTs`
+
+Parser instance for `.ts` files. Use with Kubb's file system to emit TypeScript source files.
+
+### `parserTsx`
+
+Parser instance for `.tsx` files. Use with Kubb's file system to emit TSX source files.
+
+### `createImport(options)`
+
+Factory helper that creates a TypeScript `ImportDeclaration` node.
+
+### `createExport(options)`
+
+Factory helper that creates a TypeScript `ExportDeclaration` node.
+
+### `validateNodes(nodes)`
+
+Validates an array of TypeScript AST nodes for correctness before printing.
+
+## Supporting Kubb
+
+Kubb is an open source project with its ongoing development made possible entirely by the support of Sponsors. If you would like to become a sponsor, please consider:
+
+- [Become a Sponsor on GitHub](https://github.com/sponsors/stijnvanhulle)
+
+<p align="center">
+  <a href="https://github.com/sponsors/stijnvanhulle">
+    <img src="https://raw.githubusercontent.com/stijnvanhulle/sponsors/main/sponsors.svg" alt="My sponsors" />
+  </a>
+</p>
+
+<!-- Badges -->
+
+[npm-version-src]: https://img.shields.io/npm/v/@kubb/parser-ts?flat&colorA=18181B&colorB=f58517
+[npm-version-href]: https://npmjs.com/package/@kubb/parser-ts
+[npm-downloads-src]: https://img.shields.io/npm/dm/@kubb/parser-ts?flat&colorA=18181B&colorB=f58517
+[npm-downloads-href]: https://npmjs.com/package/@kubb/parser-ts
+[license-src]: https://img.shields.io/github/license/kubb-labs/kubb.svg?flat&colorA=18181B&colorB=f58517
+[license-href]: https://github.com/kubb-labs/kubb/blob/main/LICENSE
+[coverage-src]: https://img.shields.io/codecov/c/github/kubb-labs/kubb?style=flat&colorA=18181B&colorB=f58517
+[coverage-href]: https://www.npmjs.com/package/@kubb/parser-ts
+[sponsors-src]: https://img.shields.io/github/sponsors/stijnvanhulle?style=flat&colorA=18181B&colorB=f58517
+[sponsors-href]: https://github.com/sponsors/stijnvanhulle/

package/package.json

@@ -1,9 +1,8 @@
 {
   "name": "@kubb/parser-ts",
-  "version": "5.0.0-beta.6",
-  "description": "TypeScript and TSX file parser for Kubb, converting generated files to strings using the TypeScript compiler.",
+  "version": "5.0.0-beta.7",
+  "description": "TypeScript and TSX source file parser for Kubb. Converts AST nodes and raw TypeScript code into formatted source strings using the TypeScript compiler API.",
   "keywords": [
-    "code-generator",
     "codegen",
     "kubb",
     "parser",
@@ -43,11 +42,11 @@
   },
   "dependencies": {
     "typescript": "^6.0.3",
-    "@kubb/core": "5.0.0-beta.6"
+    "@kubb/core": "5.0.0-beta.7"
   },
   "devDependencies": {
     "@internals/utils": "0.0.0",
-    "@kubb/ast": "5.0.0-beta.6"
+    "@kubb/ast": "5.0.0-beta.7"
   },
   "engines": {
     "node": ">=22"