@textlint/kernel
Version:
textlint kernel is core logic by pure JavaScript.
101 lines (100 loc) • 2.65 kB
JavaScript
/**
* detect that ruleCreator has linter function
* @param {*} ruleCreator
* @returns {boolean}
*/
export function hasLinter(ruleCreator) {
if (typeof ruleCreator.linter === "function") {
return true;
}
if (typeof ruleCreator === "function") {
return true;
}
return false;
}
/**
* get linter function from ruleCreator
* if not found, throw error
* @param {Function|Object|any} ruleCreator
* @returns {Function} linter function
* @throws
*/
export function getLinter(ruleCreator) {
if (typeof ruleCreator.linter === "function") {
return ruleCreator.linter;
}
if (typeof ruleCreator === "function") {
return ruleCreator;
}
throw new Error("Not found linter function in the ruleCreator");
}
/**
* detect that ruleCreator has fixer function
* @param {*} ruleCreator
* @returns {boolean}
*/
export function hasFixer(ruleCreator) {
return typeof ruleCreator.fixer === "function" && hasLinter(ruleCreator);
}
/**
* get fixer function from ruleCreator
* if not found, throw error
* @param {Function|Object|any} ruleCreator
* @returns {Function} fixer function
* @throws
*/
export function getFixer(ruleCreator) {
if (!hasLinter(ruleCreator)) {
throw new Error("fixer module should have also linter function.");
}
if (hasFixer(ruleCreator)) {
return ruleCreator.fixer;
}
throw new Error("Not found fixer function in the ruleCreator");
}
/**
* RuleModule should has either linter or fixer.
* @param {*} ruleCreator
* @returns {boolean}
**/
export function isRuleModule(ruleCreator) {
return hasLinter(ruleCreator) || hasFixer(ruleCreator);
}
/**
* Validate rule module.
* if invalid throw error
* @param {*} ruleModule
* @param {string} [key]
* @throws
*/
export function assertRuleShape(ruleModule, key = "") {
if (ruleModule === undefined) {
throw new Error(`Definition of rule '${key}' was not found.`);
}
/*
Check old rule function
module.exports = function(context){
}
*/
if (!isRuleModule(ruleModule)) {
throw new Error(`Definition of rule '${key}' was not rule module.
Rule should export function:
module.exports = function(context){
// Your rule
};`);
}
}
/**
* get linter function from ruleCreator
* if not found, throw error
* @param {*} ruleCreator
* @returns {Function} linter function
* @throws
*/
export function getFilter(ruleCreator) {
if (typeof ruleCreator === "function") {
return ruleCreator;
}
throw new Error("Not found filter function in the ruleCreator");
}
//# sourceMappingURL=rule-creator-helper.js.map