You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

105 lines
3.3 KiB

4 years ago
/**
* @fileOverview Enforce a defaultProps definition for every prop that is not a required prop.
* @author Vitor Balocco
*/
'use strict';
const Components = require('../util/Components');
const docsUrl = require('../util/docsUrl');
const astUtil = require('../util/ast');
// ------------------------------------------------------------------------------
// Rule Definition
// ------------------------------------------------------------------------------
module.exports = {
meta: {
docs: {
description: 'Enforce a defaultProps definition for every prop that is not a required prop.',
category: 'Best Practices',
url: docsUrl('require-default-props')
},
schema: [{
type: 'object',
properties: {
forbidDefaultForRequired: {
type: 'boolean'
},
ignoreFunctionalComponents: {
type: 'boolean'
}
},
additionalProperties: false
}]
},
create: Components.detect((context, components) => {
const configuration = context.options[0] || {};
const forbidDefaultForRequired = configuration.forbidDefaultForRequired || false;
const ignoreFunctionalComponents = configuration.ignoreFunctionalComponents || false;
/**
* Reports all propTypes passed in that don't have a defaultProps counterpart.
* @param {Object[]} propTypes List of propTypes to check.
* @param {Object} defaultProps Object of defaultProps to check. Keys are the props names.
* @return {void}
*/
function reportPropTypesWithoutDefault(propTypes, defaultProps) {
// If this defaultProps is "unresolved", then we should ignore this component and not report
// any errors for it, to avoid false-positives with e.g. external defaultProps declarations or spread operators.
if (defaultProps === 'unresolved') {
return;
}
Object.keys(propTypes).forEach((propName) => {
const prop = propTypes[propName];
if (prop.isRequired) {
if (forbidDefaultForRequired && defaultProps[propName]) {
context.report({
node: prop.node,
message: 'propType "{{name}}" is required and should not have a defaultProps declaration.',
data: {name: propName}
});
}
return;
}
if (defaultProps[propName]) {
return;
}
context.report({
node: prop.node,
message: 'propType "{{name}}" is not required, but has no corresponding defaultProps declaration.',
data: {name: propName}
});
});
}
// --------------------------------------------------------------------------
// Public API
// --------------------------------------------------------------------------
return {
'Program:exit'() {
const list = components.list();
Object.keys(list).filter((component) => {
if (ignoreFunctionalComponents &&
(astUtil.isFunction(list[component].node) || astUtil.isFunctionLikeExpression(list[component].node))) {
return false;
}
return list[component].declaredPropTypes;
}).forEach((component) => {
reportPropTypesWithoutDefault(
list[component].declaredPropTypes,
list[component].defaultProps || {}
);
});
}
};
})
};