[Fix] move error messages to meta property

Author: acdvs

lib/rules/boolean-prop-naming.js

@@ -14,6 +14,10 @@ const propWrapperUtil = require('../util/propWrapper');
 // Rule Definition
 // ------------------------------------------------------------------------------
 
+// Predefine message for use in context.report conditional.
+// messageId will still be usable in tests.
+const PATTERN_MISMATCH_MSG = 'Prop name ({{propName}}) doesn\'t match rule ({{pattern}})';
+
 module.exports = {
  meta: {
  docs: {
@@ -23,6 +27,10 @@ module.exports = {
  url: docsUrl('boolean-prop-naming')
  },
 
+ messages: {
+ patternMismatch: PATTERN_MISMATCH_MSG
+ },
+
  schema: [{
  additionalProperties: false,
  properties: {
@@ -193,15 +201,14 @@ module.exports = {
  function reportInvalidNaming(component) {
  component.invalidProps.forEach((propNode) => {
  const propName = getPropName(propNode);
- context.report({
+ context.report(Object.assign({
  node: propNode,
- message: config.message || 'Prop name ({{ propName }}) doesn\'t match rule ({{ pattern }})',
  data: {
  component: propName,
  propName,
  pattern: config.rule
  }
- });
+ }, config.message ? {message: config.message} : {messageId: 'patternMismatch'}));
  });
  }
 

lib/rules/button-has-type.js

@@ -42,6 +42,14 @@ module.exports = {
  recommended: false,
  url: docsUrl('button-has-type')
  },
+
+ messages: {
+ missingType: 'Missing an explicit type attribute for button',
+ complexType: 'The button type attribute must be specified by a static string or a trivial ternary expression',
+ invalidValue: '"{{value}}" is an invalid value for button type attribute',
+ forbiddenValue: '"{{value}}" is an invalid value for button type attribute'
+ },
+
  schema: [{
  type: 'object',
  properties: {
@@ -68,28 +76,33 @@ module.exports = {
  function reportMissing(node) {
  context.report({
  node,
- message: 'Missing an explicit type attribute for button'
+ messageId: 'missingType'
  });
  }
 
  function reportComplex(node) {
  context.report({
  node,
- message: 'The button type attribute must be specified by a static string or a trivial ternary expression'
+ messageId: 'complexType'
  });
  }
 
  function checkValue(node, value) {
- const q = (x) => `"${x}"`;
  if (!(value in configuration)) {
  context.report({
  node,
- message: `${q(value)} is an invalid value for button type attribute`
+ messageId: 'invalidValue',
+ data: {
+ value
+ }
  });
  } else if (!configuration[value]) {
  context.report({
  node,
- message: `${q(value)} is a forbidden value for button type attribute`
+ messageId: 'forbiddenValue',
+ data: {
+ value
+ }
  });
  }
  }

lib/rules/default-props-match-prop-types.js

@@ -21,6 +21,11 @@ module.exports = {
  url: docsUrl('default-props-match-prop-types')
  },
 
+ messages: {
+ requiredHasDefault: 'defaultProp "{{name}}" defined for isRequired propType.',
+ defaultHasNoType: 'defaultProp "{{name}}" has no corresponding propTypes declaration.'
+ },
+
  schema: [{
  type: 'object',
  properties: {
@@ -62,14 +67,18 @@ module.exports = {
  if (prop) {
  context.report({
  node: defaultProp.node,
- message: 'defaultProp "{{name}}" defined for isRequired propType.',
- data: {name: defaultPropName}
+ messageId: 'requiredHasDefault',
+ data: {
+ name: defaultPropName
+ }
  });
  } else {
  context.report({
  node: defaultProp.node,
- message: 'defaultProp "{{name}}" has no corresponding propTypes declaration.',
- data: {name: defaultPropName}
+ messageId: 'defaultHasNoType',
+ data: {
+ name: defaultPropName
+ }
  });
  }
  });

lib/rules/destructuring-assignment.js

@@ -18,6 +18,14 @@ module.exports = {
  recommended: false,
  url: docsUrl('destructuring-assignment')
  },
+
+ messages: {
+ noDestructPropsInSFCArg: 'Must never use destructuring props assignment in SFC argument',
+ noDestructContextInSFCArg: 'Must never use destructuring context assignment in SFC argument',
+ noDestructAssignment: 'Must never use destructuring {{type}} assignment',
+ useDestructAssignment: 'Must use destructuring {{type}} assignment'
+ },
+
  schema: [{
  type: 'string',
  enum: [
@@ -50,12 +58,12 @@ module.exports = {
  if (destructuringProps && components.get(node) && configuration === 'never') {
  context.report({
  node,
- message: 'Must never use destructuring props assignment in SFC argument'
+ messageId: 'noDestructPropsInSFCArg'
  });
  } else if (destructuringContext && components.get(node) && configuration === 'never') {
  context.report({
  node,
- message: 'Must never use destructuring context assignment in SFC argument'
+ messageId: 'noDestructContextInSFCArg'
  });
  }
  }
@@ -66,7 +74,10 @@ module.exports = {
  if (isPropUsed && configuration === 'always') {
  context.report({
  node,
- message: `Must use destructuring ${node.object.name} assignment`
+ messageId: 'useDestructAssignment',
+ data: {
+ type: node.object.name
+ }
  });
  }
  }
@@ -96,7 +107,10 @@ module.exports = {
  ) {
  context.report({
  node,
- message: `Must use destructuring ${node.object.property.name} assignment`
+ messageId: 'useDestructAssignment',
+ data: {
+ type: node.object.property.name
+ }
  });
  }
  }
@@ -135,7 +149,10 @@ module.exports = {
  if (SFCComponent && destructuringSFC && configuration === 'never') {
  context.report({
  node,
- message: `Must never use destructuring ${node.init.name} assignment`
+ messageId: 'noDestructAssignment',
+ data: {
+ type: node.init.name
+ }
  });
  }
 
@@ -145,7 +162,10 @@ module.exports = {
  ) {
  context.report({
  node,
- message: `Must never use destructuring ${node.init.property.name} assignment`
+ messageId: 'noDestructAssignment',
+ data: {
+ type: node.init.property.name
+ }
  });
  }
  }

lib/rules/display-name.js

@@ -23,6 +23,10 @@ module.exports = {
  url: docsUrl('display-name')
  },
 
+ messages: {
+ noDisplayName: 'Component definition is missing display name'
+ },
+
  schema: [{
  type: 'object',
  properties: {
@@ -38,8 +42,6 @@ module.exports = {
  const config = context.options[0] || {};
  const ignoreTranspilerName = config.ignoreTranspilerName || false;
 
- const MISSING_MESSAGE = 'Component definition is missing display name';
-
  /**
  * Mark a prop type as declared
  * @param {ASTNode} node The AST node being checked.
@@ -57,10 +59,7 @@ module.exports = {
  function reportMissingDisplayName(component) {
  context.report({
  node: component.node,
- message: MISSING_MESSAGE,
- data: {
- component: component.name
- }
+ messageId: 'noDisplayName'
  });
  }
 

lib/rules/forbid-component-props.js

@@ -26,6 +26,10 @@ module.exports = {
  url: docsUrl('forbid-component-props')
  },
 
+ messages: {
+ propIsForbidden: 'Prop "{{prop}}" is forbidden on Components'
+ },
+
  schema: [{
  type: 'object',
  properties: {
@@ -94,12 +98,13 @@ module.exports = {
  }
 
  const customMessage = forbid.get(prop).message;
- const errorMessage = customMessage || `Prop \`${prop}\` is forbidden on Components`;
 
- context.report({
+ context.report(Object.assign({
  node,
- message: errorMessage
- });
+ data: {
+ prop
+ }
+ }, customMessage ? {message: customMessage} : {messageId: 'propIsForbidden'}));
  }
  };
  }

lib/rules/forbid-dom-props.js

@@ -26,6 +26,10 @@ module.exports = {
  url: docsUrl('forbid-dom-props')
  },
 
+ messages: {
+ propIsForbidden: 'Prop "{{prop}}" is forbidden on DOM Nodes'
+ },
+
  schema: [{
  type: 'object',
  properties: {
@@ -83,12 +87,13 @@ module.exports = {
  }
 
  const customMessage = forbid.get(prop).message;
- const errorMessage = customMessage || `Prop \`${prop}\` is forbidden on DOM Nodes`;
 
- context.report({
+ context.report(Object.assign({
  node,
- message: errorMessage
- });
+ data: {
+ prop
+ }
+ }, customMessage ? {message: customMessage} : {messageId: 'propIsForbidden'}));
  }
  };
  }

lib/rules/forbid-elements.js

@@ -21,6 +21,11 @@ module.exports = {
  url: docsUrl('forbid-elements')
  },
 
+ messages: {
+ forbiddenElement: '<{{element}}> is forbidden',
+ forbiddenElement_message: '<{{element}}> is forbidden, {{message}}'
+ },
+
  schema: [{
  type: 'object',
  properties: {
@@ -60,17 +65,6 @@ module.exports = {
  }
  });
 
- function errorMessageForElement(name) {
- const message = `<${name}> is forbidden`;
- const additionalMessage = indexedForbidConfigs[name].message;
-
- if (additionalMessage) {
- return `${message}, ${additionalMessage}`;
- }
-
- return message;
- }
-
  function isValidCreateElement(node) {
  return node.callee
  && node.callee.type === 'MemberExpression'
@@ -81,9 +75,15 @@ module.exports = {
 
  function reportIfForbidden(element, node) {
  if (has(indexedForbidConfigs, element)) {
+ const message = indexedForbidConfigs[element].message;
+
  context.report({
  node,
- message: errorMessageForElement(element)
+ messageId: message ? 'forbiddenElement_message' : 'forbiddenElement',
+ data: {
+ element,
+ message
+ }
  });
  }
  }

lib/rules/forbid-foreign-prop-types.js

@@ -17,6 +17,10 @@ module.exports = {
  url: docsUrl('forbid-foreign-prop-types')
  },
 
+ messages: {
+ forbiddenPropType: 'Using propTypes from another component is not safe because they may be removed in production builds'
+ },
+
  schema: [
  {
  type: 'object',
@@ -109,7 +113,7 @@ module.exports = {
  ) {
  context.report({
  node: node.property,
- message: 'Using propTypes from another component is not safe because they may be removed in production builds'
+ messageId: 'forbiddenPropType'
  });
  }
  },
@@ -120,7 +124,7 @@ module.exports = {
  if (propTypesNode) {
  context.report({
  node: propTypesNode,
- message: 'Using propTypes from another component is not safe because they may be removed in production builds'
+ messageId: 'forbiddenPropType'
  });
  }
  }

lib/rules/forbid-prop-types.js

@@ -29,6 +29,10 @@ module.exports = {
  url: docsUrl('forbid-prop-types')
  },
 
+ messages: {
+ forbiddenPropType: 'Prop type "{{target}}" is forbidden'
+ },
+
  schema: [{
  type: 'object',
  properties: {
@@ -63,7 +67,10 @@ module.exports = {
  if (isForbidden(type)) {
  context.report({
  node: declaration,
- message: `Prop type \`${target}\` is forbidden`
+ messageId: 'forbiddenPropType',
+ data: {
+ target
+ }
  });
  }
  }