ts-creator
TypeScript icon, indicating that this package has built-in type declarations

1.2.5 • Public • Published

# ts-creator

A code generator to generate TypeScript code generator from TypeScript code

Build Status NPM version codecov

👉 Try It! 👈

How to use it:

npm install ts-creator

1. generate from code

import creator from 'ts-creator'
 
const generatedFactoryCode = creator(`const foo = "your code here"`)

2. transform source file

import { transformSourceFile } from 'ts-creator'
 
declare const file: ts.SourceFile
const factoryFile = transformSourceFile(file)

3. transform node

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:

function foo(bar: number): number {
  return bar + 1
}

ts-creator generate TypeScript factory from given code to:

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:

function foo(bar: number): number {
    return bar + 1;
}

Cli usage

Use ts-creator cli to generate code:

ts-creator <input> [options]

Simple usage:

# 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.

npm i -g ts-creator
# or yarn 
yarn global add ts-creator

If you install locally, may prepend npx or yarn you need.

# 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

Readme

Keywords

none

Package Sidebar

Install

npm i ts-creator

Weekly Downloads

89

Version

1.2.5

License

MIT

Unpacked Size

22.4 MB

Total Files

25

Last publish

Collaborators

  • kingwl