Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/HearTao/ts-creator
A code generator to generate TypeScript code generator from TypeScript code
https://github.com/HearTao/ts-creator
Last synced: about 1 month ago
JSON representation
A code generator to generate TypeScript code generator from TypeScript code
- Host: GitHub
- URL: https://github.com/HearTao/ts-creator
- Owner: HearTao
- License: mit
- Created: 2019-01-11T10:43:38.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-03-06T18:46:51.000Z (almost 2 years ago)
- Last Synced: 2024-08-02T16:12:27.620Z (4 months ago)
- Language: TypeScript
- Homepage: https://ts-creator.js.org/
- Size: 1.25 MB
- Stars: 385
- Watchers: 11
- Forks: 20
- Open Issues: 22
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-list - ts-creator
- awesome-typescript-ecosystem - ts-creator - A code generator to generate TypeScript code generator from TypeScript code (Tools / Optimization)
README
# ts-creator
A code generator to generate TypeScript code generator from TypeScript code
[](https://travis-ci.com/HearTao/ts-creator) [](https://www.npmjs.com/package/ts-creator) [](https://codecov.io/gh/HearTao/ts-creator)
👉 [Try It!](https://ts-creator.js.org/) 👈
## How to use it:
```shell
npm install ts-creator
```
### 1. generate from code
```ts
import creator from 'ts-creator'
const generatedFactoryCode = creator(`const foo = "your code here"`)
```
### 2. transform source file
```ts
import { transformSourceFile } from 'ts-creator'
declare const file: ts.SourceFile
const factoryFile = transformSourceFile(file)
```
### 3. transform node
```ts
import { transformNode } from 'ts-creator'
declare const node: ts.Expression
const factoryNode = transformNode(node)
```
## How does it work?
If you want to write a TypeScript codegen.
You got TypeScript code:
```ts
function foo(bar: number): number {
return bar + 1
}
```
ts-creator generate TypeScript factory from given code to:
```ts
ts.createFunctionDeclaration(
undefined,
undefined,
undefined,
ts.createIdentifier('foo'),
undefined,
[
ts.createParameter(
undefined,
undefined,
undefined,
ts.createIdentifier('bar'),
undefined,
ts.createKeywordTypeNode(ts.SyntaxKind.NumberKeyword),
undefined
)
],
ts.createKeywordTypeNode(ts.SyntaxKind.NumberKeyword),
ts.createBlock(
[
ts.createReturn(
ts.createBinary(
ts.createIdentifier('bar'),
ts.createToken(ts.SyntaxKind.PlusToken),
ts.createNumericLiteral('1')
)
)
],
true
)
)
```
Result after run the generated factory code:
```ts
function foo(bar: number): number {
return bar + 1;
}
```
## Cli usage
Use `ts-creator` cli to generate code:
```sh
ts-creator [options]
```
Simple usage:
```sh
# print generate code
ts-creator foo.ts
# or read data from pipeline
echo 42 | ts-creator
cat foo.ts | ts-creator
ts-creator < foo.ts
# write to file
ts-creator foo.ts -o foo.js
ts-creator foo.ts > foo.js
```
### Installation
You can install `ts-creator` globally.
```sh
npm i -g ts-creator
# or yarn
yarn global add ts-creator
```
If you install locally, may prepend `npx` or `yarn` you need.
```sh
# use npm
npm i ts-creator
npx ts-creator -h
# use yarn
yarn add ts-creator
yarn ts-creator -h
```
### Cli options
| option | description | type | default |
|---|---|---|---|
| --target, -t | generate targets | Enum { `expression`, `runnable`, `esmodule`, `commonjs` } | `expression` |
| --output, -o | output to filepath | String | `undefined` |
| --tsx | tsx support | Boolean | `false` |
| --color | colorful print | Boolean | `true` |
| --semi | print semicolons at the ends of statements | Boolean | `false` |
| --single-quote | use single quotes instead of double quotes | Boolean | `true` |
| --jsx-single-quote | use single quotes in JSX | Boolean | `false` |
| --bracket-spacing | print spaces between brackets in object literals | Boolean | `true` |
| --tab-width | pecify the number of spaces per indentation-level | Number | `2` |
| --use-tabs | indent lines with tabs instead of spaces | Boolean | `false` |
| --trailing-comma | print trailing commas wherever possible | Enum { `none`, `es5`, `all` } | `none` |
| --prose-wrap | how to wrap output | Enum { `always`, `never`, `preserve` } | `preserve` |
| --version, -v | show ts-creator versions | Boolean | `false` |
| --help, -h | show helper | Boolean | `false` |
## TODO:
- [ ] JSDoc