meteor/tests/lib/rules/eventmap-params.js

/**
 * @fileoverview Ensures that the names of the arguments of event handlers are always the same
 * @author Philipp Sporrer, Dominik Ferber
 * @copyright 2015 Philipp Sporrer. All rights reserved.
 * See LICENSE file in root directory for full license.
 */

// -----------------------------------------------------------------------------
// Requirements
// -----------------------------------------------------------------------------

import rule from '../../../lib/rules/eventmap-params'
import { RuleTester } from 'eslint'

// -----------------------------------------------------------------------------
// Tests
// -----------------------------------------------------------------------------

const ruleTester = new RuleTester()
ruleTester.run('eventmap-params', rule, {
  valid: [
    `
      Foo.bar.events({
        'submit form': function (bar, baz) {
          // no error, because not on Template
        }
      })
    `,
    `
      Template.foo.events({
        'submit form': function (event) {}
      })
    `,
    `
      Template['foo'].events({
        'submit form': function (event) {}
      })
    `,
    `
      Template['foo']['events']({
        'submit form': function (event) {}
      })
    `,
    `
      Template.foo['events']({
        'submit form': function (event) {}
      })
    `,
    `
      Template.foo.events({
        'submit form': {}
      })
    `,
    `
      Template.foo.events()
    `,
    `
      Template.foo.events(null)
    `,
    {
      code: `
        Template.foo.events({
          'submit form': function (evt) {}
        })
      `,
      options: [{
        eventParamName: 'evt',
      }],
    },
    {
      code: `
        Template.foo.events({
          'submit form': function (evt, tmplInst) {}
        })
      `,
      options: [{
        eventParamName: 'evt',
        templateInstanceParamName: 'tmplInst',
      }],
    },
    `
      Template.foo.events({
        'submit form': function (event, templateInstance) {}
      })
    `,
    {
      code: `
        Template.foo.events({
          'submit form': (event, templateInstance) => {}
        })
      `,
      parser: 'babel-eslint',
    },
    `
      Nontemplate.foo.events({
        'submit form': function (bar, baz) {
          // no error, because not on Template
        }
      })
    `,
    `
      if (Meteor.isCordova) {
        Template.foo.events({
          'submit form': function (event, templateInstance) {}
        })
      }
    `,
    `
      if (Meteor.isClient) {
        Template.foo.events({
          'submit form': function (event, templateInstance) {}
        })
      }
    `,
    {
      code: `
        if (Meteor.isClient) {
          Template.foo.events({
            'submit form': (event, templateInstance) => {}
          })
        }
      `,
      parser: 'babel-eslint',
    },
    {
      code: `
        Template.foo.events({
          'submit form': function (evt, templateInstance) {}
        })
      `,
      options: [{
        eventParamName: 'evt',
      }],
    },
    {
      code: `
        Template.foo.events({
          'submit form': function (event, tmplInst) {}
        })
      `,
      options: [{
        templateInstanceParamName: 'tmplInst',
      }],
    },
  ],

  invalid: [
    {
      code: `
        Template.foo.events({
          'submit form': function (foo, bar) {}
        })
      `,
      errors: [
        { message: 'Invalid parameter name, use "event" instead', type: 'Identifier' },
        { message: 'Invalid parameter name, use "templateInstance" instead', type: 'Identifier' },
      ],
    },
    {
      code: `
        Template['foo'].events({
          'submit form': function (foo, bar) {}
        })
      `,
      errors: [
        { message: 'Invalid parameter name, use "event" instead', type: 'Identifier' },
        { message: 'Invalid parameter name, use "templateInstance" instead', type: 'Identifier' },
      ],
    },
    {
      code: `
        Template['foo']['events']({
          'submit form': function (foo, bar) {}
        })
      `,
      errors: [
        { message: 'Invalid parameter name, use "event" instead', type: 'Identifier' },
        { message: 'Invalid parameter name, use "templateInstance" instead', type: 'Identifier' },
      ],
    },
    {
      code: `
        Template.foo['events']({
          'submit form': function (foo, bar) {}
        })
      `,
      errors: [
        { message: 'Invalid parameter name, use "event" instead', type: 'Identifier' },
        { message: 'Invalid parameter name, use "templateInstance" instead', type: 'Identifier' },
      ],
    },
    {
      code: `
        Template.foo.events({
          'submit form': (foo, bar) => {}
        })
      `,
      errors: [
        { message: 'Invalid parameter name, use "event" instead', type: 'Identifier' },
        { message: 'Invalid parameter name, use "templateInstance" instead', type: 'Identifier' },
      ],
      parser: 'babel-eslint',
    },
    {
      code: `
        Template.foo.events({
          'submit form': function (foo, templateInstance) {}
        })
      `,
      errors: [
        { message: 'Invalid parameter name, use "event" instead', type: 'Identifier' },
      ],
    },
    {
      code: `
        Template.foo.events({
          'submit form': function (event, bar) {}
        })
      `,
      errors: [
        { message: 'Invalid parameter name, use "templateInstance" instead', type: 'Identifier' },
      ],
    },
    {
      code: `
        if (Meteor.isClient) {
          Template.foo.events({
            'submit form': function (foo, bar) {}
          })
        }
      `,
      errors: [
        { message: 'Invalid parameter name, use "event" instead', type: 'Identifier' },
        { message: 'Invalid parameter name, use "templateInstance" instead', type: 'Identifier' },
      ],
    },
    {
      code: `
        Template.foo.events({
          'submit form': function (foo, templateInstance) {}
        })
      `,
      options: [{
        eventParamName: 'evt',
      }],
      errors: [
        { message: 'Invalid parameter name, use "evt" instead', type: 'Identifier' },
      ],
    },
    {
      code: `
        Template.foo.events({
          'submit form': function (foo, instance) {}
        })
      `,
      options: [{
        templateInstanceParamName: 'instance',
      }],
      errors: [
        { message: 'Invalid parameter name, use "event" instead', type: 'Identifier' },
      ],
    },
    {
      code: `
      Template.foo.events({
        'submit form': function (evt, foo) {}
      })
      `,
      options: [{
        eventParamName: 'evt',
      }],
      errors: [
        { message: 'Invalid parameter name, use "templateInstance" instead', type: 'Identifier' },
      ],
    },
    {
      code: `
      Template.foo.events({
        'submit form': function (event, foo) {}
      })
      `,
      options: [{
        templateInstanceParamName: 'instance',
      }],
      errors: [
        { message: 'Invalid parameter name, use "instance" instead', type: 'Identifier' },
      ],
    },
  ],
})