eslint-plugin-openreachtech/lib/newline-per-parameter.js

ESLint custom rules by Open Reach Tech.

'use strict'

const ParameterNewlineValidator = require('./newline-per-parameter/ParameterNewlineValidator')

/** @type {import('eslint').Rule.RuleModule} */
module.exports = {
  meta: {
    docs: {
      category: '',
      description: 'Require to chop down per parameter of function declaration.',
      recommended: false,
      url: 'https://eslint.org',
    },
    hasSuggestions: false,
    messages: {
      errorMessage: 'Require to chop down per parameter of function declaration.',
    },
    schema: [],
    type: 'layout',
  },

  /**
   * Create rule listener.
   * exclude ArrowFunctionExpression
   *
   * @param {import('eslint').Rule.RuleContext} context - Rule context.
   * @returns {import('eslint').Rule.RuleListener} - Rule listener.
   */
  create (context) {
    const SELECTOR = [
      'FunctionDeclaration',
      'FunctionExpression',
    ].join(',')

    return {
      /**
       * Rule body.
       *
       * @param {import('eslint').Rule.Node} node - AST node.
       */
      [SELECTOR] (node) {
        const validator = new ParameterNewlineValidator({
          context,
          node,
        })

        if (validator.isValid()) {
          return
        }

        context.report({
          node,
          messageId: 'errorMessage',
        })
      },
    }
  },
}