# darabonba-typescript-generator

**Repository Path**: aliyun/darabonba-typescript-generator

## Basic Information

- **Project Name**: darabonba-typescript-generator
- **Description**: Darabonba TypeScript Generator
- **Primary Language**: Unknown
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2025-05-08
- **Last Updated**: 2025-06-25

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

[English](/README.md) | 简体中文

# Darabonba Typescript 生成器

[![NPM version][npm-image]][npm-url]
[![CI](https://github.com/aliyun/darabonba-typescript-generator/actions/workflows/ci.yml/badge.svg)](https://github.com/aliyun/darabonba-typescript-generator/actions/workflows/ci.yml)
[![codecov](https://codecov.io/gh/aliyun/darabonba-typescript-generator/graph/badge.svg?token=t97XcVkcDB)](https://codecov.io/gh/aliyun/darabonba-typescript-generator)
[![npm download][download-image]][download-url]

[npm-image]: https://img.shields.io/npm/v/@darabonba/typescript-generator.svg?style=flat-square
[npm-url]: https://npmjs.org/package/@darabonba/typescript-generator
[download-image]: https://img.shields.io/npm/dm/@darabonba/typescript-generator.svg?style=flat-square
[download-url]: https://npmjs.org/package/@darabonba/typescript-generator

## 安装

Darabonba 生成器只能在 Node.js 环境下运行。建议使用 [NPM](https://www.npmjs.com/) 包管理工具安装。在终端输入以下命令进行安装:

```shell
npm install @darabonba/typescript-generator
```

## 使用示例

```js
"use strict";

const path = require("path");
const fs = require("fs");

const parser = require("@darabonba/parser");
const generator = require("@darabonba/typescript-generator");

const sourceDir = "<Darabonda package directory>";
const outputDir = "<Generate output directory>";

// generate AST data by parser
let packageMetaFilePath = path.join(sourceDir, "Darafile");
let packageMeta = JSON.parse(fs.readFileSync(packageMetaFilePath, "utf8"));
let mainFile = path.join(sourceDir, packageMeta.main);
let ast = parser.parse(fs.readFileSync(mainFile, "utf8"), mainFile);

// initialize generator
let generatorConfig = {
  ...packageMeta,
  pkgDir: sourceDir,
  outputDir,
};
let generator = new generator(generatorConfig);

// generate typescript code by generator
generator.visit(ast);

// The execution result will be output in the 'outputDir'
```

## 问题反馈

[提出问题](https://github.com/aliyun/darabonba-typescript-generator/issues/new/choose), 不符合指南的问题可能会立即关闭。

## 发布日志

发布详情会更新在 [release notes](/CHANGELOG.md) 文件中

## 许可证

[Apache-2.0](/LICENSE)
Copyright (c) 2009-present, Alibaba Cloud All rights reserved.