require-meta-docs-description.js

'use strict';

const utils = require('../utils');

// ------------------------------------------------------------------------------
// Rule Definition
// ------------------------------------------------------------------------------

const DEFAULT_PATTERN = new RegExp('^(enforce|require|disallow)');

/**
 * Whether or not the node is a string literal
 *
 * @param {object} node
 * @returns {boolean} whether or not the node is a string literal
 */
function isStringLiteral (node) {
  return node.type === 'Literal' && typeof node.value === 'string';
}

module.exports = {
  meta: {
    docs: {
      description: 'require rules to implement a meta.docs.description property with the correct format',
      category: 'Rules',
      recommended: false, // TODO: enable it in a major release.
    },
    type: 'suggestion',
    fixable: null,
    schema: [
      {
        type: 'object',
        properties: {
          pattern: {
            type: 'string',
          },
        },
        additionalProperties: false,
      },
    ],
    messages: {
      missing: '`meta.docs.description` is required.',
      wrongType: '`meta.docs.description` must be a non-empty string.',
      extraWhitespace: '`meta.docs.description` must not have leading nor trailing whitespace.',
    },
  },

  create (context) {
    const sourceCode = context.getSourceCode();
    const info = utils.getRuleInfo(sourceCode);

    return {
      Program () {
        if (info === null || info.meta === null) {
          return;
        }

        const pattern = context.options[0] && context.options[0].pattern ? new RegExp(context.options[0].pattern) : DEFAULT_PATTERN;

        const metaNode = info.meta;
        const docsNode =
          metaNode &&
          metaNode.properties &&
          metaNode.properties.find(p => p.type === 'Property' && utils.getKeyName(p) === 'docs');

        const descriptionNode =
          docsNode &&
          docsNode.value.properties &&
          docsNode.value.properties.find(p => p.type === 'Property' && utils.getKeyName(p) === 'description');

        if (!descriptionNode) {
          context.report({ node: docsNode ? docsNode : metaNode, messageId: 'missing' });
        } else if (!isStringLiteral(descriptionNode.value) || descriptionNode.value.value === '') {
          context.report({ node: descriptionNode.value, messageId: 'wrongType' });
        } else if (descriptionNode.value.value !== descriptionNode.value.value.trim()) {
          context.report({ node: descriptionNode.value, messageId: 'extraWhitespace' });
        } else if (!pattern.test(descriptionNode.value.value)) {
          context.report({
            node: descriptionNode.value,
            message: '`meta.docs.description` must match the regexp {{pattern}}.',
            data: { pattern },
          });
        }
      },
    };
  },
};