code-block-writer

A simple code writer that assists with formatting and visualizing blocks of JavaScript or TypeScript code.

npm install --save code-block-writer

Example

import CodeBlockWriter from "code-block-writer";

const writer = new CodeBlockWriter({
    // optional options
    newLine: "\r\n",         // default: "\n"
    indentNumberOfSpaces: 2, // default: 4
    useTabs: false,          // default: false
    useSingleQuote: true     // default: false
});
const className = "MyClass";

writer.write(`class ${className} extends OtherClass`).block(() => {
    writer.writeLine(`@MyDecorator(1, 2)`);
    writer.write(`myMethod(myParam: any)`).block(() => {
        writer.write("return this.post(").quote("myArgument").write(");");
    });
});

console.log(writer.toString());

Outputs (using "\r\n" for newlines):

class MyClass extends OtherClass {
  @MyDecorator(1, 2)
  myMethod(myParam: any) {
    return this.post('myArgument');
  }
}

Methods

• block(block?: () => void) - Indents all the code written within and surrounds it in braces.
• inlineBlock(block?: () => void) - Same as block, but doesn't add a space before the first brace and doesn't add a newline at the end.
• getLength() - Get the current number of characters.
• writeLine(str: string) - Writes some text and adds a newline.
• newLineIfLastNotNewLine() - Writes a newline if what was written last wasn't a newline.
• newLine() - Writes a newline.
• blankLine() - Writes a blank line. Does not allow consecutive blank lines.
• quote() - Writes a quote character.
• quote(text: string) - Writes text surrounded in quotes.
• indent() - Indents the current line.
• indentBlock(block: () => void) - Indents a block of code.
• spaceIfLastNotSpace() - Writes a space if the last was not a space.
• write(str: string) - Writes some text.
• conditionalNewLine(condition: boolean) - Writes a newline if the condition is matched.
• conditionalWrite(condition: boolean, str: string) - Writes if the condition is matched.
• conditionalWriteLine(condition: boolean, str: string) - Writes some text and adds a newline if the condition is matched.
• setIndentationLevel(indentationLevel: number) - Sets the current indentation level.
• queueIndentationLevel(indentationLevel: number) - Queues an indentation level to be used once a new line is written.
• isInComment() - Gets if the writer is currently in a comment.
• isInString() - Gets if the writer is currently in a string.
• isLastNewLine() - Gets if the writer last wrote a newline.
• isLastSpace() - Gets if the writer last wrote a space.
• getLastChar() - Gets the last character written.
• toString() - Gets the string.