|
| 1 | +/** |
| 2 | + * @author Yosuke Ota |
| 3 | + * See LICENSE file in root directory for full license. |
| 4 | + */ |
| 5 | +'use strict' |
| 6 | + |
| 7 | +const utils = require('../utils') |
| 8 | +const regexp = require('../utils/regexp') |
| 9 | + |
| 10 | +/** |
| 11 | + * @typedef {object} ParsedOption |
| 12 | + * @property {Tester} test |
| 13 | + * @property {string|undefined} [message] |
| 14 | + */ |
| 15 | +/** |
| 16 | + * @typedef {object} MatchResult |
| 17 | + * @property {Tester | undefined} [next] |
| 18 | + * @property {boolean} [wildcard] |
| 19 | + * @property {string} keyName |
| 20 | + */ |
| 21 | +/** |
| 22 | + * @typedef { (name: string) => boolean } Matcher |
| 23 | + * @typedef { (node: Property | SpreadElement) => (MatchResult | null) } Tester |
| 24 | + */ |
| 25 | + |
| 26 | +/** |
| 27 | + * @param {string} str |
| 28 | + * @returns {Matcher} |
| 29 | + */ |
| 30 | +function buildMatcher(str) { |
| 31 | + if (regexp.isRegExp(str)) { |
| 32 | + const re = regexp.toRegExp(str) |
| 33 | + return (s) => { |
| 34 | + re.lastIndex = 0 |
| 35 | + return re.test(s) |
| 36 | + } |
| 37 | + } |
| 38 | + return (s) => s === str |
| 39 | +} |
| 40 | + |
| 41 | +/** |
| 42 | + * @param {string | string[] | { name: string | string[], message?: string } } option |
| 43 | + * @returns {ParsedOption} |
| 44 | + */ |
| 45 | +function parseOption(option) { |
| 46 | + if (typeof option === 'string' || Array.isArray(option)) { |
| 47 | + return parseOption({ |
| 48 | + name: option |
| 49 | + }) |
| 50 | + } |
| 51 | + |
| 52 | + /** |
| 53 | + * @typedef {object} Step |
| 54 | + * @property {Matcher} [test] |
| 55 | + * @property {boolean} [wildcard] |
| 56 | + */ |
| 57 | + |
| 58 | + /** @type {Step[]} */ |
| 59 | + const steps = [] |
| 60 | + for (const name of Array.isArray(option.name) ? option.name : [option.name]) { |
| 61 | + if (name === '*') { |
| 62 | + steps.push({ wildcard: true }) |
| 63 | + } else { |
| 64 | + steps.push({ test: buildMatcher(name) }) |
| 65 | + } |
| 66 | + } |
| 67 | + const message = option.message |
| 68 | + |
| 69 | + return { |
| 70 | + test: buildTester(0), |
| 71 | + message |
| 72 | + } |
| 73 | + |
| 74 | + /** |
| 75 | + * @param {number} index |
| 76 | + * @returns {Tester} |
| 77 | + */ |
| 78 | + function buildTester(index) { |
| 79 | + const { wildcard, test } = steps[index] |
| 80 | + const next = index + 1 |
| 81 | + const needNext = steps.length > next |
| 82 | + return (node) => { |
| 83 | + /** @type {string} */ |
| 84 | + let keyName |
| 85 | + if (wildcard) { |
| 86 | + keyName = '*' |
| 87 | + } else { |
| 88 | + if (node.type !== 'Property') { |
| 89 | + return null |
| 90 | + } |
| 91 | + const name = utils.getStaticPropertyName(node) |
| 92 | + if (!name || !test(name)) { |
| 93 | + return null |
| 94 | + } |
| 95 | + keyName = name |
| 96 | + } |
| 97 | + |
| 98 | + return { |
| 99 | + next: needNext ? buildTester(next) : undefined, |
| 100 | + wildcard, |
| 101 | + keyName |
| 102 | + } |
| 103 | + } |
| 104 | + } |
| 105 | +} |
| 106 | + |
| 107 | +module.exports = { |
| 108 | + meta: { |
| 109 | + type: 'suggestion', |
| 110 | + docs: { |
| 111 | + description: 'disallow specific component option', |
| 112 | + categories: undefined, |
| 113 | + url: 'https://eslint.vuejs.org/rules/no-restricted-component-options.html' |
| 114 | + }, |
| 115 | + fixable: null, |
| 116 | + schema: { |
| 117 | + type: 'array', |
| 118 | + items: { |
| 119 | + oneOf: [ |
| 120 | + { type: 'string' }, |
| 121 | + { |
| 122 | + type: 'array', |
| 123 | + items: { |
| 124 | + type: 'string' |
| 125 | + } |
| 126 | + }, |
| 127 | + { |
| 128 | + type: 'object', |
| 129 | + properties: { |
| 130 | + name: { |
| 131 | + anyOf: [ |
| 132 | + { type: 'string' }, |
| 133 | + { |
| 134 | + type: 'array', |
| 135 | + items: { |
| 136 | + type: 'string' |
| 137 | + } |
| 138 | + } |
| 139 | + ] |
| 140 | + }, |
| 141 | + message: { type: 'string', minLength: 1 } |
| 142 | + }, |
| 143 | + required: ['name'], |
| 144 | + additionalProperties: false |
| 145 | + } |
| 146 | + ] |
| 147 | + }, |
| 148 | + uniqueItems: true, |
| 149 | + minItems: 0 |
| 150 | + }, |
| 151 | + |
| 152 | + messages: { |
| 153 | + // eslint-disable-next-line eslint-plugin/report-message-format |
| 154 | + restrictedOption: '{{message}}' |
| 155 | + } |
| 156 | + }, |
| 157 | + /** @param {RuleContext} context */ |
| 158 | + create(context) { |
| 159 | + if (!context.options || context.options.length === 0) { |
| 160 | + return {} |
| 161 | + } |
| 162 | + /** @type {ParsedOption[]} */ |
| 163 | + const options = context.options.map(parseOption) |
| 164 | + |
| 165 | + return utils.defineVueVisitor(context, { |
| 166 | + onVueObjectEnter(node) { |
| 167 | + for (const option of options) { |
| 168 | + verify(node, option.test, option.message) |
| 169 | + } |
| 170 | + } |
| 171 | + }) |
| 172 | + |
| 173 | + /** |
| 174 | + * @param {ObjectExpression} node |
| 175 | + * @param {Tester} test |
| 176 | + * @param {string | undefined} customMessage |
| 177 | + * @param {string[]} path |
| 178 | + */ |
| 179 | + function verify(node, test, customMessage, path = []) { |
| 180 | + for (const prop of node.properties) { |
| 181 | + const result = test(prop) |
| 182 | + if (!result) { |
| 183 | + continue |
| 184 | + } |
| 185 | + if (result.next) { |
| 186 | + if ( |
| 187 | + prop.type !== 'Property' || |
| 188 | + prop.value.type !== 'ObjectExpression' |
| 189 | + ) { |
| 190 | + continue |
| 191 | + } |
| 192 | + verify(prop.value, result.next, customMessage, [ |
| 193 | + ...path, |
| 194 | + result.keyName |
| 195 | + ]) |
| 196 | + } else { |
| 197 | + const message = |
| 198 | + customMessage || defaultMessage([...path, result.keyName]) |
| 199 | + context.report({ |
| 200 | + node: prop.type === 'Property' ? prop.key : prop, |
| 201 | + messageId: 'restrictedOption', |
| 202 | + data: { message } |
| 203 | + }) |
| 204 | + } |
| 205 | + } |
| 206 | + } |
| 207 | + |
| 208 | + /** |
| 209 | + * @param {string[]} path |
| 210 | + */ |
| 211 | + function defaultMessage(path) { |
| 212 | + return `Using \`${path.join('.')}\` is not allowed.` |
| 213 | + } |
| 214 | + } |
| 215 | +} |
0 commit comments