Unleash awesomeness. Private packages, team management tools, and powerful integrations. Get started with npm Orgs »

@yellicode/typescript

1.5.1 • Public • Published

TypeScript extension for Yellicode

Generate TypeScript code using powerful TypeScript code generation templates! This extension contains a code writer and other utilities that make it easier to generate TypeScript code from a Yellicode template.

License: MIT

About Yellicode

Yellicode lets you build your own code generation templates with TypeScript. It consists of a Node.js CLI and extensible APIs, making it easy for developers to create, share and re-use code generators for their favorite programming languages and frameworks.

Check out our website for more.

Using the TypeScript package

Prerequisites

In order to run a code generation template, you must have the CLI installed (@yellicode/cli) globally and have a valid codegenconfig.json file in your working directory. Please refer to the installation instructions and the quick start for more.

You should also have the @yellicode/elements package installed in your working directory:

npm install @yellicode/elements --save-dev

Installation

Open a terminal/command prompt in your working directory and install this package as a dev dependency:

npm install @yellicode/typescript --save-dev

Sample template

This template generates a TypeScript code file with all classes in the model and, for each class, writes a property for each class attribute.

import * as elements from '@yellicode/elements';
import { Generator, TextWriter } from '@yellicode/templating';
import { TypeScriptWriter } from '@yellicode/typescript';
 
Generator.generateFromModel({ outputFile: `my-classes.ts` }, (textWriter: TextWriter, model: elements.Model) => {
    const writer = new TypeScriptWriter(textWriter);   
    model.getAllClasses().forEach(c => {
        writer.writeLine();
        writer.writeClassBlock(c, () => {
            c.ownedAttributes.forEach(att => {
                writer.writeProperty(att);
            })
        }, { export: true });
    });
});    

API Documentation

For all TypeScriptWriter functions and options, check out the API documentation.

install

npm i @yellicode/typescript

Downloadsweekly downloads

2

version

1.5.1

license

MIT

homepage

github.com

repository

Gitgithub

last publish

collaborators

  • avatar
Report a vulnerability