Revert "chore: remove tslint specific code"

This reverts commit 4ced550.

Author: Christopher Quadflieg

packages/@vue/cli-plugin-e2e-cypress/__tests__/cypressPlugin.spec.js

@@ -30,6 +30,7 @@ test('should work with TS', async () => {
     plugins: {
       '@vue/cli-plugin-typescript': {
         'classComponent': true,
+        'tsLint': true,
         'lintOn': ['save']
       },
       '@vue/cli-plugin-e2e-cypress': {}

packages/@vue/cli-plugin-typescript/__tests__/tsConvertLintFlags.spec.js

@@ -0,0 +1,19 @@
+const fn = require('../lib/convertLintFlags')
+
+test('convert ESLint flags to TSLint flags', () => {
+  expect(fn(`
+/* eslint-disable */
+/* eslint-disable no-console, foo-bar, haha */
+// eslint-disable-next-line
+// eslint-disable-next-line no-console, foo-bar, haha
+foo() // eslint-disable-line
+foo() // eslint-disable-line no-console, foo-bar, haha
+  `)).toMatch(`
+/* tslint:disable */
+/* tslint:disable:no-console, foo-bar, haha */
+// tslint:disable-next-line
+// tslint:disable-next-line:no-console, foo-bar, haha
+foo() // tslint:disable-line
+foo() // tslint:disable-line:no-console, foo-bar, haha
+  `)
+})

packages/@vue/cli-plugin-typescript/__tests__/tsGenerator.spec.js

@@ -81,11 +81,12 @@ test('use with router', async () => {
 })
 
 test('lint', async () => {
-  const { pkg } = await generateWithPlugin([
+  const { pkg, files } = await generateWithPlugin([
     {
       id: 'ts',
       apply: require('../generator'),
       options: {
+        tsLint: true,
         lintOn: ['save', 'commit']
       }
     }
@@ -98,6 +99,8 @@ test('lint', async () => {
     '*.ts': ['vue-cli-service lint', 'git add'],
     '*.vue': ['vue-cli-service lint', 'git add']
   })
+
+  expect(files['tslint.json']).toBeTruthy()
 })
 
 test('lint with no lintOnSave', async () => {
@@ -106,6 +109,7 @@ test('lint with no lintOnSave', async () => {
       id: 'ts',
       apply: require('../generator'),
       options: {
+        tsLint: true,
         lintOn: ['commit']
       }
     }

packages/@vue/cli-plugin-typescript/__tests__/tsPluginTSLint.spec.js

@@ -0,0 +1,115 @@
+jest.setTimeout(30000)
+
+const create = require('@vue/cli-test-utils/createTestProject')
+
+test('should work', async () => {
+  const project = await create('ts-tslint', {
+    plugins: {
+      '@vue/cli-plugin-typescript': {
+        tsLint: true
+      }
+    }
+  })
+  const { read, write, run } = project
+  const main = await read('src/main.ts')
+  expect(main).toMatch(';')
+  const app = await read('src/App.vue')
+  expect(main).toMatch(';')
+  // remove semicolons
+  const updatedMain = main.replace(/;/g, '')
+  await write('src/main.ts', updatedMain)
+  // for Vue file, only remove semis in script section
+  const updatedApp = app.replace(/<script(.|\n)*\/script>/, $ => {
+    return $.replace(/;/g, '')
+  })
+  await write('src/App.vue', updatedApp)
+  // lint
+  await run('vue-cli-service lint')
+  expect(await read('src/main.ts')).toMatch(';')
+
+  const lintedApp = await read('src/App.vue')
+  expect(lintedApp).toMatch(';')
+  // test if tslint is fixing vue files properly
+  expect(lintedApp).toBe(app)
+})
+
+test('should not fix with --no-fix option', async () => {
+  const project = await create('ts-tslint-nofix', {
+    plugins: {
+      '@vue/cli-plugin-typescript': {
+        tsLint: true
+      }
+    }
+  })
+  const { read, write, run } = project
+  const main = await read('src/main.ts')
+  expect(main).toMatch(';')
+  const app = await read('src/App.vue')
+  expect(main).toMatch(';')
+  // remove semicolons
+  const updatedMain = main.replace(/;/g, '')
+  await write('src/main.ts', updatedMain)
+  // for Vue file, only remove semis in script section
+  const updatedApp = app.replace(/<script(.|\n)*\/script>/, $ => {
+    return $.replace(/;/g, '')
+  })
+  await write('src/App.vue', updatedApp)
+
+  // lint with no fix should fail
+  try {
+    await run('vue-cli-service lint --no-fix')
+  } catch (e) {
+    expect(e.code).toBe(1)
+    expect(e.failed).toBeTruthy()
+  }
+
+  // files should not have been fixed
+  expect(await read('src/main.ts')).not.toMatch(';')
+  expect((await read('src/App.vue')).match(/<script(.|\n)*\/script>/)[1]).not.toMatch(';')
+})
+
+test('should ignore issues in node_modules', async () => {
+  const project = await create('ts-lint-node_modules', {
+    plugins: {
+      '@vue/cli-plugin-typescript': {
+        tsLint: true
+      }
+    }
+  })
+
+  const { read, write, run } = project
+  const main = await read('src/main.ts')
+
+  // update file to not match tslint spec and dump it into the node_modules directory
+  const updatedMain = main.replace(/;/g, '')
+  await write('node_modules/bad.ts', updatedMain)
+
+  // lint
+  await run('vue-cli-service lint')
+  expect(await read('node_modules/bad.ts')).toMatch(updatedMain)
+})
+
+test('should be able to fix mixed line endings', async () => {
+  const project = await create('ts-lint-mixed-line-endings', {
+    plugins: {
+      '@vue/cli-plugin-typescript': {
+        tsLint: true
+      }
+    }
+  })
+
+  const { write, run } = project
+
+  const b64 = 'PHRlbXBsYXRlPjwvdGVtcGxhdGU+DQoNCjxzY3JpcHQgbGFuZz0idHMiPg0KZXhwb3J0IGRlZmF1bHQgY2xhc3MgVGVzdCAgew0KICBnZXQgYXNzaWduZWUoKSB7DQogICAgdmFyIGl0ZW1zOnt0ZXh0OnN0cmluZzsgdmFsdWU6c3RyaW5nIHwgbnVtYmVyIHwgbnVsbH1bXSA9IFtdOw0KICAgIHJldHVybiBpdGVtczsNCiAgfQ0KDQp9DQo8L3NjcmlwdD4NCg0K'
+  const buf = Buffer.from(b64, 'base64')
+
+  await write('src/bad.vue', buf)
+
+  // Try twice to fix the file.
+  // For now, it will fail the first time, which corresponds to the behaviour of tslint.
+  try {
+    await run('vue-cli-service lint -- src/bad.vue')
+  } catch (e) { }
+
+  await run('vue-cli-service lint -- src/bad.vue')
+})

packages/@vue/cli-plugin-typescript/generator/index.js

@@ -34,6 +34,42 @@ module.exports = (
     }
   }
 
+  if (tsLint) {
+    api.extendPackage({
+      scripts: {
+        lint: "vue-cli-service lint",
+      },
+    });
+
+    if (!lintOn.includes("save")) {
+      api.extendPackage({
+        vue: {
+          lintOnSave: false,
+        },
+      });
+    }
+
+    if (lintOn.includes("commit")) {
+      api.extendPackage({
+        devDependencies: {
+          "lint-staged": "^9.5.0",
+        },
+        gitHooks: {
+          "pre-commit": "lint-staged",
+        },
+        "lint-staged": {
+          "*.ts": ["vue-cli-service lint", "git add"],
+          "*.vue": ["vue-cli-service lint", "git add"],
+        },
+      });
+    }
+
+    // lint and fix files on creation complete
+    api.onCreateComplete(() => {
+      return require("../lib/tslint")({}, api, true);
+    });
+  }
+
   // late invoke compat
   if (invoking) {
     if (api.hasPlugin("unit-mocha")) {

packages/@vue/cli-plugin-typescript/generator/template/src/shims-tsx.d.ts

@@ -2,7 +2,9 @@ import Vue, { VNode } from 'vue'
 
 declare global {
   namespace JSX {
+    // tslint:disable no-empty-interface
     interface Element extends VNode {}
+    // tslint:disable no-empty-interface
     interface ElementClass extends Vue {}
     interface IntrinsicElements {
       [elem: string]: any

packages/@vue/cli-plugin-typescript/generator/template/tslint.json

@@ -0,0 +1,21 @@
+<%_ if (options.tsLint) { _%>
+{
+  "defaultSeverity": "warning",
+  "extends": [
+    "tslint:recommended"
+  ],
+  "linterOptions": {
+    "exclude": [
+      "node_modules/**"
+    ]
+  },
+  "rules": {
+    "indent": [true, "spaces", 2],
+    "interface-name": false,
+    "no-consecutive-blank-lines": false,
+    "object-literal-sort-keys": false,
+    "ordered-imports": false,
+    "quotemark": [true, "single"]
+  }
+}
+<%_ } _%>

packages/@vue/cli-plugin-typescript/lib/convertLintFlags.js

@@ -0,0 +1,11 @@
+module.exports = function convertLintFlags (file) {
+  return file
+    .replace(/\/\*\s?eslint-(enable|disable)([^*]+)?\*\//g, (_, $1, $2) => {
+      if ($2) $2 = $2.trim()
+      return `/* tslint:${$1}${$2 ? `:${$2}` : ``} */`
+    })
+    .replace(/\/\/\s?eslint-disable-(next-)?line(.+)?/g, (_, $1, $2) => {
+      if ($2) $2 = $2.trim()
+      return `// tslint:disable-${$1 || ''}line${$2 ? `:${$2}` : ``}`
+    })
+}