Skip to content

Commit a52bb86

Browse files
committed
- Refactoring: Toward resolving #216, group settings by which rules use them
1 parent 2769847 commit a52bb86

File tree

1 file changed

+16
-2
lines changed

1 file changed

+16
-2
lines changed

src/iterateJsdoc.js

Lines changed: 16 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -237,24 +237,38 @@ export default (iterator, options) => {
237237
*/
238238
create (context) {
239239
const sourceCode = context.getSourceCode();
240+
241+
// `check-tag-names` and many require/param rules
240242
const tagNamePreference = _.get(context, 'settings.jsdoc.tagNamePreference') || {};
243+
244+
// `check-tag-names` only
245+
const additionalTagNames = _.get(context, 'settings.jsdoc.additionalTagNames') || {};
246+
247+
// `check-examples` only
241248
const exampleCodeRegex = _.get(context, 'settings.jsdoc.exampleCodeRegex') || null;
242249
const rejectExampleCodeRegex = _.get(context, 'settings.jsdoc.rejectExampleCodeRegex') || null;
243250
const matchingFileName = _.get(context, 'settings.jsdoc.matchingFileName') || null;
244-
const additionalTagNames = _.get(context, 'settings.jsdoc.additionalTagNames') || {};
245251
const baseConfig = _.get(context, 'settings.jsdoc.baseConfig') || {};
246252
const configFile = _.get(context, 'settings.jsdoc.configFile');
247253
const eslintrcForExamples = _.get(context, 'settings.jsdoc.eslintrcForExamples') !== false;
248254
const allowInlineConfig = _.get(context, 'settings.jsdoc.allowInlineConfig') !== false;
249-
const allowEmptyNamepaths = _.get(context, 'settings.jsdoc.allowEmptyNamepaths') !== false;
250255
const reportUnusedDisableDirectives = _.get(context, 'settings.jsdoc.reportUnusedDisableDirectives') !== false;
251256
const captionRequired = Boolean(_.get(context, 'settings.jsdoc.captionRequired'));
252257
const noDefaultExampleRules = Boolean(_.get(context, 'settings.jsdoc.noDefaultExampleRules'));
258+
259+
// `require-param` only
253260
const allowOverrideWithoutParam = Boolean(_.get(context, 'settings.jsdoc.allowOverrideWithoutParam'));
254261
const allowImplementsWithoutParam = Boolean(_.get(context, 'settings.jsdoc.allowImplementsWithoutParam'));
255262
const allowAugmentsExtendsWithoutParam = Boolean(_.get(context, 'settings.jsdoc.allowAugmentsExtendsWithoutParam'));
263+
264+
// `valid-types` only
265+
const allowEmptyNamepaths = _.get(context, 'settings.jsdoc.allowEmptyNamepaths') !== false;
256266
const checkSeesForNamepaths = Boolean(_.get(context, 'settings.jsdoc.checkSeesForNamepaths'));
267+
268+
// `require-returns` only
257269
const forceRequireReturn = Boolean(_.get(context, 'settings.jsdoc.forceRequireReturn'));
270+
271+
// `require-example` only
258272
const avoidExampleOnConstructors = Boolean(_.get(context, 'settings.jsdoc.avoidExampleOnConstructors'));
259273

260274
const checkJsdoc = (node) => {

0 commit comments

Comments
 (0)