New: Initial commit

Author: not-an-aardvark

.eslintrc.js

@@ -0,0 +1,28 @@
+'use strict';
+const fs = require('fs');
+const path = require('path');
+const PACKAGE_NAME = require('./package').name;
+const SYMLINK_LOCATION = path.join(__dirname, 'node_modules', PACKAGE_NAME);
+
+// Symlink node_modules/{package name} to this directory so that ESLint resolves this plugin name correctly.
+if (!fs.existsSync(SYMLINK_LOCATION)) {
+  fs.symlinkSync(__dirname, SYMLINK_LOCATION);
+}
+
+module.exports = {
+  plugins: [ 'node', 'eslint-plugin', PACKAGE_NAME ],
+  extends: [
+    'not-an-aardvark/node',
+    'plugin:node/recommended',
+    'plugin:eslint-plugin/recommended'
+  ],
+  root: true,
+  rules: {
+    'prettier/prettier': [ 'error', { singleQuote: true } ],
+    'eslint-plugin/report-message-format': [ 'error', '^[^a-z].*\\.$' ],
+    'array-bracket-spacing': 'off',
+    'comma-dangle': 'off',
+    'lines-around-directive': 'off',
+    'space-before-function-paren': 'off'
+  }
+};

.gitignore

@@ -0,0 +1,2 @@
+node_modules/
+npm-debug.log

.travis.yml

@@ -0,0 +1,5 @@
+language: node_js
+node_js:
+  - '4'
+  - '6'
+  - '7'

LICENSE.md

@@ -0,0 +1,25 @@
+The MIT License (MIT)
+=====================
+
+Copyright © 2017 Teddy Katz
+
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the “Software”), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -0,0 +1,54 @@
+# eslint-plugin-prettier
+
+Runs [prettier](https://github.com/jlongster/prettier) as an eslint rule
+
+## Installation
+
+You'll first need to install [ESLint](http://eslint.org):
+
+```
+$ npm install eslint --save-dev
+```
+
+Next, install `eslint-plugin-prettier`:
+
+```
+$ npm install eslint-plugin-prettier --save-dev
+```
+
+**Note:** If you installed ESLint globally (using the `-g` flag) then you must also install `eslint-plugin-prettier` globally.
+
+## Usage
+
+Add `prettier` to the plugins section of your `.eslintrc` configuration file. You can omit the `eslint-plugin-` prefix:
+
+```json
+{
+    "plugins": [
+        "prettier"
+    ]
+}
+```
+
+
+Then configure the `prettier` rule under the `rules` section:
+
+```json
+{
+    "rules": {
+        "prettier/prettier": "error"
+    }
+}
+```
+
+You can also pass `prettier` configuration as an option:
+
+```json
+{
+    "rules": {
+        "prettier/prettier": ["error", {"trailingComma": true, "singleQuote": true}]
+    }
+}
+```
+
+The rule will report an error if your code does not match `prettier` style. The rule is autofixable -- if you run `eslint` with the `--fix` flag, your code will be formatted according to `prettier` style.

lib/index.js

@@ -0,0 +1,16 @@
+/**
+ * @fileoverview Runs prettier as an eslint rule
+ * @author Teddy Katz
+ */
+'use strict';
+// ------------------------------------------------------------------------------
+// Requirements
+// ------------------------------------------------------------------------------
+
+const requireIndex = require('requireindex');
+
+// ------------------------------------------------------------------------------
+// Plugin Definition
+// ------------------------------------------------------------------------------
+// import all rules in lib/rules
+module.exports.rules = requireIndex(__dirname + '/rules');

lib/rules/prettier.js

@@ -0,0 +1,58 @@
+/**
+ * @fileoverview runs `prettier` as an eslint rule
+ * @author Teddy Katz
+ */
+'use strict';
+const util = require('util');
+const prettier = require('prettier');
+const astUtils = require('eslint/lib/ast-utils');
+
+// ------------------------------------------------------------------------------
+// Rule Definition
+// ------------------------------------------------------------------------------
+module.exports = {
+  meta: { fixable: 'code', schema: [ { type: 'object' } ] },
+  create(context) {
+    const sourceCode = context.getSourceCode();
+
+    return {
+      Program() {
+        // This isn't really very performant (prettier needs to reparse the text).
+        // However, I don't think it's possible to run `prettier` on an ESTree AST.
+        const desiredText = prettier.format(
+          sourceCode.text,
+          context.options[0]
+        );
+
+        if (sourceCode.text !== desiredText) {
+          // Find the first character that differs
+          const firstBadIndex = Array
+            .from(desiredText)
+            .findIndex((char, index) => char !== sourceCode.text[index]);
+          const expectedChar = firstBadIndex === -1
+            ? 'EOF'
+            : desiredText[firstBadIndex];
+          const foundChar = firstBadIndex >= sourceCode.text.length
+            ? 'EOF'
+            : firstBadIndex === -1
+              ? sourceCode.text[desiredText.length]
+              : sourceCode.text[firstBadIndex];
+
+          context.report({
+            loc: astUtils.getLocationFromRangeIndex(
+              sourceCode,
+              firstBadIndex === -1 ? desiredText.length : firstBadIndex
+            ),
+            message: 'Follow `prettier` formatting (expected {{expectedChar}} but found {{foundChar}}).',
+            data: {
+              expectedChar: util.inspect(expectedChar),
+              foundChar: util.inspect(foundChar)
+            },
+            fix: fixer =>
+              fixer.replaceTextRange([ 0, sourceCode.text.length ], desiredText)
+          });
+        }
+      }
+    };
+  }
+};

package.json

@@ -0,0 +1,34 @@
+{
+  "name": "eslint-plugin-prettier",
+  "version": "1.0.0",
+  "description": "Runs prettier as an eslint rule",
+  "keywords": [
+    "eslint",
+    "eslintplugin",
+    "eslint-plugin"
+  ],
+  "author": "Teddy Katz",
+  "main": "lib/index.js",
+  "scripts": {
+    "lint": "eslint .eslintrc.js lib/ tests/ --ignore-pattern !.eslintrc.js",
+    "test": "npm run lint && mocha tests --recursive"
+  },
+  "dependencies": {
+    "prettier": "^0.11.0",
+    "requireindex": "~1.1.0"
+  },
+  "peerDependencies": {
+    "eslint": "^3.14.1"
+  },
+  "devDependencies": {
+    "eslint": "^3.14.1",
+    "eslint-config-not-an-aardvark": "^2.0.0",
+    "eslint-plugin-eslint-plugin": "^0.2.1",
+    "eslint-plugin-node": "^3.0.5",
+    "mocha": "^3.1.2"
+  },
+  "engines": {
+    "node": ">=4.0.0"
+  },
+  "license": "MIT"
+}

tests/lib/rules/prettier.js

@@ -0,0 +1,59 @@
+/**
+ * @fileoverview runs `prettier` as an eslint rule
+ * @author Teddy Katz
+ */
+'use strict';
+// ------------------------------------------------------------------------------
+// Requirements
+// ------------------------------------------------------------------------------
+
+const rule = require('../../../lib/rules/prettier');
+const RuleTester = require('eslint').RuleTester;
+
+// ------------------------------------------------------------------------------
+// Tests
+// ------------------------------------------------------------------------------
+const ruleTester = new RuleTester();
+
+ruleTester.run('prettier', rule, {
+  valid: [
+    'foo(bar);\n',
+    'foo("bar");\n',
+    { code: "foo('bar');\n", options: [ { singleQuote: true } ] }
+  ],
+  invalid: [
+    {
+      code: 'foo(bar  )',
+      output: 'foo(bar);\n',
+      errors: [
+        {
+          line: 1,
+          column: 8,
+          message: "Follow `prettier` formatting (expected ')' but found ' ')."
+        }
+      ]
+    },
+    {
+      code: 'foo(bar);',
+      output: 'foo(bar);\n',
+      errors: [
+        {
+          line: 1,
+          column: 10,
+          message: "Follow `prettier` formatting (expected '\\n' but found 'EOF')."
+        }
+      ]
+    },
+    {
+      code: 'foo(bar);\n\n',
+      output: 'foo(bar);\n',
+      errors: [
+        {
+          line: 2,
+          column: 1,
+          message: "Follow `prettier` formatting (expected 'EOF' but found '\\n')."
+        }
+      ]
+    }
+  ]
+});