@textlint/kernel/module/src/context/TextlintSourceCodeImpl.js

textlint kernel is core logic by pure JavaScript.

import { ASTNodeTypes } from "@textlint/ast-node-types";
import { StructuredSource } from "structured-source";
import { invariant } from "../util/invariant";
/**
 * Validates that the given AST has the required information.
 * @param {AnyTxtNode} [ast] The Program node of the AST to check.
 * @throws {Error} If the AST doesn't contain the correct information.
 * @returns {void}
 * @private
 */
function validate(ast) {
    if (!ast.loc) {
        throw new Error("AST is missing location information.");
    }
    if (!ast.range) {
        throw new Error("AST is missing range information");
    }
}
/**
 * This class represent of source code.
 */
export class TextlintSourceCodeImpl {
    /**
     * @param {string} text
     * @param {Object} ast
     * @param {string} ext
     * @param {string} [filePath]
     */
    constructor({ text = "", ast, ext, filePath }) {
        validate(ast);
        invariant(ext || filePath, "should be set either of fileExt or filePath.");
        this.hasBOM = text.charCodeAt(0) === 0xfeff;
        this.text = this.hasBOM ? text.slice(1) : text;
        /**
         * @type StructuredSource
         */
        this._structuredSource = new StructuredSource(this.text);
        this.ast = ast;
        this.filePath = filePath;
        /**
         * fileType .md .txt ...
         * @type {string}
         */
        this.ext = ext;
    }
    /**
     * @returns {ASTNodeTypes}
     */
    getSyntax() {
        return ASTNodeTypes;
    }
    /**
     * get filePath
     * @returns {string|undefined}
     */
    getFilePath() {
        return this.filePath;
    }
    /**
     * Gets the source code for the given node.
     * @param {AnyTxtNode=} node The AST node to get the text for.
     * @param {int=} beforeCount The number of characters before the node to retrieve.
     * @param {int=} afterCount The number of characters after the node to retrieve.
     * @returns {string} The text representing the AST node.
     */
    getSource(node, beforeCount, afterCount) {
        const currentText = this.text;
        if (node) {
            const start = Math.max(node.range[0] - (beforeCount || 0), 0);
            const end = node.range[1] + (afterCount || 0);
            return currentText.slice(start, end);
        }
        else {
            return currentText;
        }
    }
    // StructuredSource wrapper
    // line is 1-based
    // column is 1-based
    /**
     * @param {TextlintSourceCodeLocation} loc - location indicator.
     * @return {[ number, number ]} range.
     */
    locationToRange(loc) {
        return this._structuredSource.locationToRange(loc);
    }
    /**
     * @param {[ number, number ]} range - pair of indice.
     * @return {TextlintSourceCodeLocation} location.
     */
    rangeToLocation(range) {
        const rangeToLocation = this._structuredSource.rangeToLocation([range[0], range[1]]);
        return {
            start: {
                line: rangeToLocation.start.line,
                column: rangeToLocation.start.column
            },
            end: {
                line: rangeToLocation.end.line,
                column: rangeToLocation.end.column
            }
        };
    }
    /**
     * @param pos - position indicator.
     * @return {number} index.
     */
    positionToIndex(pos) {
        return this._structuredSource.positionToIndex(pos);
    }
    /**
     * @param index - index to the source code.
     */
    indexToPosition(index) {
        const indexToPosition = this._structuredSource.indexToPosition(index);
        return {
            line: indexToPosition.line,
            column: indexToPosition.column
        };
    }
}
//# sourceMappingURL=TextlintSourceCodeImpl.js.map