Files

18 lines
703 B
JavaScript

import { ESLintUtils } from '@typescript-eslint/utils'
/**
* Factory function for creating ESLint rules with consistent structure and
* documentation.
*
* Wraps the ESLintUtils.RuleCreator to automatically generate documentation
* URLs for each rule based on its name. All rules created with this function
* will have their documentation hosted at perfectionist.dev.
*
* @see {@link https://typescript-eslint.io/packages/utils/} - TypeScript ESLint
* Utils documentation
* @see {@link https://perfectionist.dev/} - Perfectionist plugin documentation
*/
var createEslintRule = ESLintUtils.RuleCreator(
ruleName => `https://perfectionist.dev/rules/${ruleName}`,
)
export { createEslintRule }