ts-budgie/src/output/transformation.ts

Converts TypeScript code to Budgie.

import * as ts from "typescript";

import { BudgieLine } from "./budgieLine";
import { IRange } from "./range";

/**
 * Output from any level of node.
 */
export type IOutput = (string | BudgieLine | Transformation)[];

/**
 * How a range of source should become Budgie output.
 */
export class Transformation {
    /**
     * Area in the source file to transform.
     */
    public readonly range: IRange;

    /**
     * Output transformation.
     */
    public readonly output: IOutput;

    /**
     * Initializes a new instance of the Transformation class.
     *
     * @param range   Area in the source file to transform.
     * @param output   Output transformation.
     * @param sourceFile   Source file of the transformation.
     */
    private constructor(range: IRange, output: IOutput) {
        this.range = range;
        this.output = output;
    }

    /**
     * Initializes a new Transformation for a comment range.
     *
     * @param range   Area in the source file to transform.
     * @param output   Output transformation.
     * @param sourceFile   Source file of the transformation.
     * @returns A new Transformation for the comment range.
     */
    public static fromCommentRange(range: ts.CommentRange, output: IOutput): Transformation {
        return new Transformation(
            {
                end: range.end,
                start: range.pos,
            },
            output,
        );
    }

    /**
     * Initializes a new Transform for a standard node.
     *
     * @param node   Node from the source file.
     * @param sourceFile   Source file for the node.
     * @param output   Output transformation.
     * @returns A new Transformation for the node.
     */
    public static fromNode(node: ts.Node, sourceFile: ts.SourceFile, output: IOutput): Transformation {
        return new Transformation(
            {
                end: node.getEnd(),
                start: node.getStart(sourceFile),
            },
            output,
        );
    }

    /**
     * Initializes a new Transform for the ending character of a standard node.
     *
     * @param node   Node from the source file.
     * @param sourceFile   Source file for the node.
     * @param output   Output transformation.
     * @returns A new Transformation for the node.
     */
    public static fromNodeEnd(node: ts.Node, output: IOutput): Transformation {
        const end = node.getEnd();

        return new Transformation(
            {
                end,
                start: end - 1,
            },
            output,
        );
    }

    /**
     * Initializes a new Transform for the starting character of a standard node.
     *
     * @param node   Node from the source file.
     * @param sourceFile   Source file for the node.
     * @param output   Output transformation.
     * @returns A new Transformation for the node.
     */
    public static fromNodeStart(node: ts.Node, sourceFile: ts.SourceFile, output: IOutput): Transformation {
        const start = node.getStart(sourceFile);

        return new Transformation(
            {
                end: start + 1,
                start,
            },
            output,
        );
    }
}