textlint/src/DEPRECATED/engine/textlint-module-mapper.ts

The pluggable linting tool for text and markdown.

// LICENSE : MIT
"use strict";
/**
 * This class is a helper to create mapping of rules and rulesConfig
 * Main purpose hide the RuleSeparator "/".
 */
// The separator of `<plugin>/<rule>`
const RuleSeparator = "/";

export class TextLintModuleMapper {
    // TODO: Why does this return strings.  See module loader loadPreset
    /**
     * create entities from rules/rulesConfig and prefix
     * entities is a array which contain [key, value]
     *  it just create entity without normalization
     * see https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object/entries
     * @param {Object} pluginRules an object is like "rules" or "rulesConfig" of plugin
     * @param {string} prefixKey prefix key is plugin name or preset name
     * @returns {[string, any][]}
     */
    static createEntities(pluginRules: { [index: string]: any }, prefixKey: string): [string, any][] {
        const entities: [string, any][] = [];
        Object.keys(pluginRules).forEach((ruleId) => {
            const qualifiedRuleId = prefixKey + RuleSeparator + ruleId;
            const ruleCreator = pluginRules[ruleId];
            entities.push([qualifiedRuleId, ruleCreator]);
        });
        return entities;
    }

    // TODO: Why does this return strings.  See module loader loadPreset
    /**
     * create an object from rules/rulesConfig and prefix
     * the object shape is { key: value, key2: value }
     *
     * it just create object without normalization
     * @param {Object} pluginRules an object is like "rules" or "rulesConfig" of plugin
     * @param {string} prefixKey prefix key is plugin name or preset name
     * @returns {Object}
     */
    static createMappedObject(pluginRules: { [index: string]: any }, prefixKey: string): { [index: string]: any } {
        const mapped: { [index: string]: any } = {};
        Object.keys(pluginRules).forEach((key) => {
            mapped[`${prefixKey}/${key}`] = pluginRules[key];
        });
        return mapped;
    }
}