Initial project structure, first rule

Author: alecxe

.editorconfig

@@ -0,0 +1,13 @@
+# http://editorconfig.org
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

.gitignore

@@ -6,6 +6,16 @@ bin-release/
 # Other files and folders
 .settings/
 
-# Project files, i.e. `.project`, `.actionScriptProperties` and `.flexProperties`
-# should NOT be excluded as they contain compiler settings and other important
-# information for Eclipse / Flash Builder.
+/node_modules
+coverage/
+build/
+npm-debug.log
+.DS_Store
+tmp/
+.idea
+jsdoc/
+versions.json
+*.iml
+.eslintcache
+.cache
+/packages/**/node_modules

.travis.yml

@@ -0,0 +1,15 @@
+sudo: false
+language: node_js
+cache:
+  directories:
+    - node_modules
+notifications:
+  email: false
+node_js:
+  - '0.10'
+before_install:
+  - npm i -g npm@^2.0.0
+before_script:
+  - npm prune
+after_success:
+  - npm run semantic-release

README.md

@@ -0,0 +1,58 @@
+# eslint-plugin-protractor
+
+[![Build Status][travis-image]][travis-url]
+
+[travis-url]: https://travis-ci.org/alecxe/eslint-plugin-protractor
+[travis-image]: https://img.shields.io/travis/alecxe/eslint-plugin-protractor.svg
+
+> ESLint rules for Protractor
+
+## Usage
+
+1. Install `eslint-plugin-protractor` as a dev-dependency:
+
+    ```shell
+    npm install --save-dev eslint-plugin-protractor
+    ```
+
+2. Enable the plugin by adding it to your `.eslintrc`:
+
+    ```yaml
+    plugins:
+      - protractor
+    ```
+
+## Configuration
+
+This plugin ships with a default configuration for each rule:
+
+Rule                         | Default       | Options
+----                         | -------       | -------
+[missing-perform][]          | 2             |
+
+
+For example, the `missing-perform` rule is enabled by default and will cause
+ESLint to throw an error (with an exit code of `1`) when triggered.
+
+You may customise each rule by adding a value in your `.eslintrc` `rules`
+property:
+
+```yaml
+plugins:
+  - protractor
+rules:
+  jasmine/missing-perform: 0
+```
+
+See [configuring rules][] for more information.
+
+[missing-perform]: docs/rules/missing-perform.md
+[configuring rules]: http://eslint.org/docs/user-guide/configuring#configuring-rules
+
+## Author
+
+© 2016 Alexander Afanasyev
+
+## License
+
+Licensed under the [MIT license](LICENSE).

docs/rules/missing-perform.md

@@ -0,0 +1,24 @@
+# Enforce valid `browser.actions()` usage (missing-perform)
+
+Ensure `perform()` is called on `browser.actions()` chain of actions.
+
+## Rule details
+
+This rule triggers an error if there is no `perform()` at the end of the `browser.actions()` chain. 
+Note that there has to be at least one applied action to trigger the rule. In other words, `var actions = browser.actions();` is a considered valid since it is quite a common pattern.
+
+The following patterns are considered errors:
+
+```js
+browser.actions().click();
+browser.actions().mouseMove(elm);
+```
+
+The following patterns are not errors:
+
+```js
+var actions = browser.actions();
+browser.actions().click(elm).perform();
+browser.actions().mouseMove(elm).click().perform();
+browser.actions().dragAndDrop(elm1, elm2).perform();
+```

index.js

@@ -0,0 +1,10 @@
+'use strict'
+
+module.exports = {
+  rules: {
+    'missing-perform': require('./lib/rules/missing-perform')
+  },
+  rulesConfig: {
+    'missing-perform': 2
+  }
+}

lib/rules/missing-perform.js

@@ -0,0 +1,36 @@
+'use strict'
+
+/**
+ * @fileoverview perform() has to be called on browser.actions()
+ * @author Alexander Afanasyev
+ */
+
+module.exports = function (context) {
+  return {
+    'MemberExpression': function (node) {
+      // find browser.actions() code parts
+      if (node.property.name === 'actions' && node.object.name === 'browser') {
+        // here is a tricky part - getting the parent nodes
+        // continue searching for perform call only if there is something called on browser.actions()
+        var parent = node.parent.parent
+        var performMissing = true
+
+        if (parent.type === 'MemberExpression') {
+          while (parent) {
+            if (parent.property && parent.property.name === 'perform') {
+              performMissing = false
+              break
+            }
+
+            node = parent
+            parent = node.parent
+          }
+
+          if (performMissing) {
+            context.report(node, 'No perform() called on browser.actions()')
+          }
+        }
+      }
+    }
+  }
+}

package.json

@@ -0,0 +1,37 @@
+{
+  "name": "eslint-plugin-protractor",
+  "description": "ESLint rules for Protractor",
+  "main": "index.js",
+  "directories": {
+    "doc": "docs",
+    "test": "tests"
+  },
+  "scripts": {
+    "pretest": "standard",
+    "test": "mocha",
+    "watch": "mocha --watch",
+    "semantic-release": "semantic-release pre && npm publish && semantic-release post"
+  },
+  "keywords": [
+    "eslint",
+    "eslint-plugin",
+    "eslintplugin",
+    "protractor"
+  ],
+  "author": "Alexander Afanasyev <[email protected]>",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/alecxe/eslint-plugin-protractor.git"
+  },
+  "bugs": {
+    "url": "https://github.com/alecxe/eslint-plugin-protractor/issues"
+  },
+  "homepage": "https://github.com/alecxe/eslint-plugin-protractor",
+  "devDependencies": {
+    "eslint": "^1.8.0",
+    "mocha": "^2.2.5",
+    "semantic-release": "^4.0.2",
+    "standard": "^5.3.1"
+  }
+}

test/mocha.opts

@@ -0,0 +1,2 @@
+--recursive
+--bail

test/rules/missing-perform.js

@@ -0,0 +1,35 @@
+'use strict'
+
+var rule = require('../../lib/rules/missing-perform')
+var RuleTester = require('eslint').RuleTester
+
+var eslintTester = new RuleTester()
+
+eslintTester.run('missing-perform', rule, {
+  valid: [
+    'var actions = browser.actions();',
+    'var actions = browser.actions()',
+    'browser.actions().click(elm).perform();',
+    'browser.actions().mouseMove(elm).click().perform();',
+    'browser.actions().dragAndDrop(elm1, elm2).perform();'
+  ],
+
+  invalid: [
+    {
+      code: 'browser.actions().click();',
+      errors: [
+        {
+          message: 'No perform() called on browser.actions()'
+        }
+      ]
+    },
+    {
+      code: 'browser.actions().mouseMove(elm);',
+      errors: [
+        {
+          message: 'No perform() called on browser.actions()'
+        }
+      ]
+    }
+  ]
+})