Update: support custom persers

Author: mysticatea

README.md

@@ -36,6 +36,37 @@ $ eslint "src/**.{js,vue}"
 $ eslint src --ext .vue
 ```
 
+## :wrench: Options
+
+`parserOptions` is the same as what [espree](https://github.com/eslint/espree#usage), the default parser of ESLint, is supporting.
+For example:
+
+```json
+{
+    "parser": "vue-eslint-parser",
+    "parserOptions": {
+        "sourceType": "module",
+        "ecmaVersion": 2017
+        // ...
+    }
+}
+```
+
+On the other hand, you can specify a custom parser to parse `<script>` tags.
+In this case, specify `parser` property. Other properties than `parser` would be given to the specified parser.
+For example:
+
+```json
+{
+    "parser": "vue-eslint-parser",
+    "parserOptions": {
+        "parser": "babel-eslint",
+        "sourceType": "module",
+        "allowImportExportEverywhere": false
+    }
+}
+```
+
 ## :warning: Known Limitations
 
 - [no-trailing-spaces](http://eslint.org/docs/rules/no-trailing-spaces) rule is warning lines outside of `<script>` tags as well.

index.js

@@ -10,7 +10,6 @@
 //------------------------------------------------------------------------------
 
 const path = require("path")
-const espree = require("espree")
 const SAXParser = require("parse5").SAXParser
 
 //------------------------------------------------------------------------------
@@ -19,6 +18,18 @@ const SAXParser = require("parse5").SAXParser
 
 const LINE_TERMINATORS = /\r\n|\r|\n|\u2028|\u2029/g
 
+/**
+ * Gets the specified parser.
+ * If it's unspecified, this returns espree.
+ *
+ * @param {object} options - The option object.
+ * @param {string} [options.parser] - The parser name to get.
+ * @returns {object} The gotten parser.
+ */
+function getParser(options) {
+    return require(options.parser || "espree")
+}
+
 /**
  * Calculates the end location.
  *
@@ -132,12 +143,14 @@ function extractFirstScript(originalText) {
  * @returns {ASTNode} The AST object as the result of parsing.
  */
 module.exports.parse = function parse(text, options) {
+    const parser = getParser(options)
+
     if (path.extname(options.filePath || "unknown.js") !== ".vue") {
-        return espree.parse(text, options)
+        return parser.parse(text, options)
     }
 
     const script = extractFirstScript(text)
-    const ast = espree.parse(script.text, options)
+    const ast = parser.parse(script.text, options)
 
     ast.start = script.offset
     if (script.startToken) {

package.json

@@ -24,6 +24,7 @@
   },
   "devDependencies": {
     "@types/node": "^6.0.52",
+    "babel-eslint": "^7.1.1",
     "babel-preset-power-assert": "^1.0.0",
     "babel-register": "^6.18.0",
     "codecov": "^1.0.1",
@@ -34,7 +35,9 @@
     "nyc": "^10.0.0",
     "opener": "^1.4.2",
     "power-assert": "^1.4.2",
-    "rimraf": "^2.5.4"
+    "rimraf": "^2.5.4",
+    "typescript": "^2.1.4",
+    "typescript-eslint-parser": "^1.0.0"
   },
   "peerDependencies": {
     "eslint": ">=3.5.0"

test/fixtures/typed.vue

@@ -0,0 +1,22 @@
+<template>
+    <p>{{ greeting }} World!</p>
+</template>
+
+<script>
+interface Data {
+    greeting: string
+}
+
+export default {
+    data(): Data {
+        return {greeting: "Hello"}
+    },
+}
+</script>
+
+<style scoped>
+p {
+    font-size: 2em;
+    text-align: center;
+}
+</style>

test/fixtures/typed.vue.fixed

@@ -0,0 +1,22 @@
+<template>
+    <p>{{ greeting }} World!</p>
+</template>
+
+<script>
+interface Data {
+    greeting: string
+}
+
+export default {
+    data(): Data {
+        return {greeting: "Hello"};
+    },
+};
+</script>
+
+<style scoped>
+p {
+    font-size: 2em;
+    text-align: center;
+}
+</style>

test/index.js

@@ -198,3 +198,89 @@ describe("About fixtures/crlf.vue", () => {
         assert(messages.length === 0)
     })
 })
+
+describe("About fixtures/typed.vue", () => {
+    beforeEach(() => {
+        fs.copySync(ORIGINAL_FIXTURE_DIR, FIXTURE_DIR)
+    })
+    afterEach(() => {
+        fs.removeSync(FIXTURE_DIR)
+    })
+
+    it("should notify no error with 'babel-eslint'", () => {
+        const cli = new CLIEngine({
+            cwd: FIXTURE_DIR,
+            envs: ["es6", "node"],
+            parser: PARSER_PATH,
+            parserOptions: {
+                parser: "babel-eslint",
+                sourceType: "module",
+            },
+            rules: {semi: ["error", "never"]},
+            useEslintrc: false,
+        })
+        const report = cli.executeOnFiles(["typed.vue"])
+        const messages = report.results[0].messages
+
+        assert(messages.length === 0)
+    })
+
+    it("should notify no error with 'typescript-eslint-parser'", () => {
+        const cli = new CLIEngine({
+            cwd: FIXTURE_DIR,
+            envs: ["es6", "node"],
+            parser: PARSER_PATH,
+            parserOptions: {
+                parser: "typescript-eslint-parser",
+                sourceType: "module",
+            },
+            rules: {semi: ["error", "never"]},
+            useEslintrc: false,
+        })
+        const report = cli.executeOnFiles(["typed.vue"])
+        const messages = report.results[0].messages
+
+        assert(messages.length === 0)
+    })
+
+    it("should fix 'semi' errors with --fix option with 'babel-eslint'", () => {
+        const cli = new CLIEngine({
+            cwd: FIXTURE_DIR,
+            envs: ["es6", "node"],
+            fix: true,
+            parser: PARSER_PATH,
+            parserOptions: {
+                parser: "babel-eslint",
+                sourceType: "module",
+            },
+            rules: {semi: ["error", "always"]},
+            useEslintrc: false,
+        })
+        CLIEngine.outputFixes(cli.executeOnFiles(["typed.vue"]))
+
+        const actual = fs.readFileSync(path.join(FIXTURE_DIR, "typed.vue"), "utf8")
+        const expected = fs.readFileSync(path.join(FIXTURE_DIR, "typed.vue.fixed"), "utf8")
+
+        assert(actual === expected)
+    })
+
+    it("should fix 'semi' errors with --fix option with 'typescript-eslint-parser'", () => {
+        const cli = new CLIEngine({
+            cwd: FIXTURE_DIR,
+            envs: ["es6", "node"],
+            fix: true,
+            parser: PARSER_PATH,
+            parserOptions: { //
+                parser: "typescript-eslint-parser",
+            },
+            rules: {semi: ["error", "always"]},
+            useEslintrc: false,
+        })
+        CLIEngine.outputFixes(cli.executeOnFiles(["typed.vue"]))
+
+        const actual = fs.readFileSync(path.join(FIXTURE_DIR, "typed.vue"), "utf8")
+        const expected = fs.readFileSync(path.join(FIXTURE_DIR, "typed.vue.fixed"), "utf8")
+
+        assert(actual === expected)
+    })
+})