https://github.com/jeevanjames/codewriter

Fluent Node library for generating code blocks.
https://github.com/jeevanjames/codewriter

builder code code-builder code-generator code-writer code-writing generator writer

Last synced: about 1 month ago
JSON representation

Fluent Node library for generating code blocks.

• Host: GitHub
• URL: https://github.com/jeevanjames/codewriter
• Owner: JeevanJames
• License: apache-2.0
• Created: 2017-09-25T19:50:45.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2019-12-16T17:32:38.000Z (almost 5 years ago)
• Last Synced: 2024-10-20T07:42:40.237Z (about 1 month ago)
• Topics: builder, code, code-builder, code-generator, code-writer, code-writing, generator, writer
• Language: TypeScript
• Homepage:
• Size: 80.1 KB
• Stars: 1
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# CodeWriter

CodeWriter is a fluent Node library that can be used to generate code blocks. It is typically used by code generation tools to simplify the task of building the generated code.

CodeWriter is similar to concepts like `StringBuilder`'s or `StringWriter`'s in other languages. Instead of using string concatenation to build the generated code, CodeWriter adds support for code-specific concepts like indentation and language-specific comments.

## Installation

```sh

npm install --save-dev codewriter

```

## Usage

### JavaScript

```js

const CodeWriter = require('codewriter');

const options = { indentSize: 4 };

const writer = new CodeWriter(options);

// Use CodeWriter methods to build the code

const code = writer.toCode();

```

### Typescript

CodeWriter ships with a Typescript definition file, which provides strong-typing and compile-time support.

```ts

import { CodeWriter, CodeWriterOptions } from 'codewriter';

const options: CodeWriterOptions = { indentSize: 4 };

const writer = new CodeWriter(options);

// Use CodeWriter methods to build the code

const code: string = writer.toCode();

```

## Options

CodeWriter allows some options to be specified in the constructor to customize how the code is generated.

[Options reference](docs/options.md)

[Sample options for generating JavaScript code](docs/options-example.md)

Through the [`OptionsLibrary`](docs/options-library.md) class, CodeWriter also provides predefined options for certain common languages and language families.

## Examples

[Generate empty C# console program](docs/example-csharp-empty-console.md)

## API reference

[JSDoc Documentation](docs/API.md)

You can view the source code comments directly from [GitHub](https://github.com/JeevanJames/codewriter/blob/master/src/index.ts).

If you are using Typescript, you can install the package locally to get code completion support from supported IDE's and editors.

## Building the code

```sh

# Clone repo from GitHub

git clone https://github.com/JeevanJames/codewriter.git .

# Install dependencies

npm install

# Build code

npm run build

# Continuously watch for code changes and build

npm run watch

# Lint code

npm run lint

# The codebase has a test-harness directory that contains an index.ts file.

# You can update this file to quickly test code against the framework.

# To run the test-harness, run the following command:

npm run test-harness

```