Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
feat(
require-returns): move settings to options
BREAKING CHANGE: The following settings has been removed and became options
under relevant rules.
* `settings.jsdoc.allowEmptyNamepaths` -> option in `valid-types`
* `settings.jsdoc.checkSeesForNamepaths` -> option in `valid-types`
* `settings.jsdoc.exemptEmptyFunctions` -> option in `require-jsdoc`
* `settings.jsdoc.forceRequireReturn` -> option in `require-returns`
* `settings.jsdoc.avoidExampleOnConstructors` -> option in `require-example`- Loading branch information
Showing
4 changed files
with
176 additions
and
62 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,107 @@ | ||
| /** | ||
| * @typedef {( | ||
| * | "require-jsdoc" | ||
| * | "require-returns" | ||
| * | "valid-types" | ||
| * | "require-example" | ||
| * | "check-examples" | ||
| * )} RulesWithMovedSettings | ||
| */ | ||
|
|
||
| /** @type {WeakMap<Object, Set<string>>} */ | ||
| const warnedSettings = new WeakMap(); | ||
|
|
||
| /** | ||
| * Warn only once for each context and setting | ||
| * | ||
| * @param {Object} context | ||
| * @param {string} setting | ||
| */ | ||
| const hasBeenWarned = (context, setting) => { | ||
| return warnedSettings.has(context) && warnedSettings.get(context).has(setting); | ||
| }; | ||
|
|
||
| const markSettingAsWarned = (context, setting) => { | ||
| if (!warnedSettings.has(context)) { | ||
| warnedSettings.set(context, new Set()); | ||
| } | ||
|
|
||
| warnedSettings.get(context).add(setting); | ||
| }; | ||
|
|
||
| /** | ||
| * @param {Object} obj | ||
| * @param {string} property | ||
| * @returns {boolean} | ||
| */ | ||
| const has = (obj, property) => { | ||
| return Object.prototype.hasOwnProperty.call(obj, property); | ||
| }; | ||
|
|
||
| /** | ||
| * | ||
| * @param {RulesWithMovedSettings} ruleName | ||
| * @returns {string[]} | ||
| */ | ||
| const getMovedSettings = (ruleName) => { | ||
| switch (ruleName) { | ||
| case 'require-jsdoc': | ||
| return ['exemptEmptyFunctions']; | ||
| case 'require-returns': | ||
| return ['forceRequireReturn']; | ||
| case 'valid-types': | ||
| return ['allowEmptyNamepaths', 'checkSeesForNamepaths']; | ||
| case 'require-example': | ||
| return ['avoidExampleOnConstructors']; | ||
|
|
||
| // TODO: move settings of check-examples to options | ||
| /* istanbul ignore next */ | ||
| case 'check-examples': | ||
| return [ | ||
| 'captionRequired', | ||
| 'exampleCodeRegex', | ||
| 'rejectExampleCodeRegex', | ||
| 'allowInlineConfig', | ||
| 'noDefaultExampleRules', | ||
| 'matchingFileName', | ||
| 'configFile', | ||
| 'eslintrcForExamples', | ||
| 'baseConfig', | ||
| 'reportUnusedDisableDirectives' | ||
| ]; | ||
| } | ||
|
|
||
| /* istanbul ignore next */ | ||
| return []; | ||
| }; | ||
|
|
||
| /** | ||
| * @param {Object} context | ||
| * @param {RulesWithMovedSettings} ruleName | ||
| */ | ||
| export default function warnRemovedSettings (context, ruleName) { | ||
| const movedSettings = getMovedSettings(ruleName); | ||
|
|
||
| if (!context.settings || !context.settings.jsdoc) { | ||
| return; | ||
| } | ||
|
|
||
| for (const setting of movedSettings) { | ||
| if ( | ||
| has(context.settings.jsdoc, setting) && | ||
| !hasBeenWarned(context, setting) | ||
| ) { | ||
| context.report({ | ||
| loc: { | ||
| start: { | ||
| column: 1, | ||
| line: 1 | ||
| } | ||
| }, | ||
| message: `\`settings.jsdoc.${setting}\` has been removed, ` + | ||
| `use options in the rule \`${ruleName}\` instead.` | ||
| }); | ||
| markSettingAsWarned(context, setting); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters