chore: clean code

fi3ework · Aug 26, 2022 · 6163d65 · 6163d65
1 parent e946e56
commit 6163d65
Show file tree

Hide file tree

Showing 35 changed files with 969 additions and 1,699 deletions.
diff --git a/packages/vite-plugin-checker/src/checkers/eslint/main.ts b/packages/vite-plugin-checker/src/checkers/eslint/main.ts
@@ -1,23 +1,25 @@
 import chokidar from 'chokidar'
 import { ESLint } from 'eslint'
-import { options as optionator } from './options.js'
-import invariant from 'tiny-invariant'
-import { parentPort } from 'worker_threads'
 import path from 'path'
+import { fileURLToPath } from 'url'
+import { parentPort } from 'worker_threads'
 
 import { Checker } from '../../Checker.js'
 import { FileDiagnosticManager } from '../../FileDiagnosticManager.js'
 import {
+  composeCheckerSummary,
   consoleLog,
-  diagnosticToTerminalLog,
   diagnosticToRuntimeError,
+  diagnosticToTerminalLog,
   filterLogLevel,
   normalizeEslintDiagnostic,
   toViteCustomPayload,
-  composeCheckerSummary,
 } from '../../logger.js'
 import { ACTION_TYPES, DiagnosticLevel } from '../../types.js'
 import { translateOptions } from './cli.js'
+import { options as optionator } from './options.js'
+
+const __filename = fileURLToPath(import.meta.url)
 
 const manager = new FileDiagnosticManager()
 let createServeAndBuild
@@ -138,7 +140,6 @@ export class EslintChecker extends Checker<'eslint'> {
 
   public init() {
     const _createServeAndBuild = super.initMainThread()
-    // module.exports.createServeAndBuild = createServeAndBuild
     createServeAndBuild = _createServeAndBuild
     super.initWorkerThread()
   }

diff --git a/packages/vite-plugin-checker/src/checkers/typescript/main.ts b/packages/vite-plugin-checker/src/checkers/typescript/main.ts
@@ -3,12 +3,13 @@ import path from 'path'
 import invariant from 'tiny-invariant'
 import ts from 'typescript'
 import { parentPort } from 'worker_threads'
+import { fileURLToPath } from 'url'
 
 import { Checker } from '../../Checker.js'
 import {
   consoleLog,
-  diagnosticToTerminalLog,
   diagnosticToRuntimeError,
+  diagnosticToTerminalLog,
   ensureCall,
   normalizeTsDiagnostic,
   toViteCustomPayload,
@@ -21,6 +22,7 @@ import {
   DiagnosticToRuntime,
 } from '../../types.js'
 
+const __filename = fileURLToPath(import.meta.url)
 let createServeAndBuild
 
 const createDiagnostic: CreateDiagnostic<'typescript'> = (pluginConfig) => {

diff --git a/packages/vite-plugin-checker/src/checkers/vls/main.ts b/packages/vite-plugin-checker/src/checkers/vls/main.ts
@@ -1,4 +1,5 @@
 import os from 'os'
+import { fileURLToPath } from 'url'
 import { parentPort } from 'worker_threads'
 
 import { Checker } from '../../Checker.js'
@@ -13,9 +14,10 @@ import { ACTION_TYPES } from '../../types.js'
 import { DiagnosticOptions, diagnostics } from './diagnostics.js'
 
 import type { ConfigEnv } from 'vite'
-
 import type { CreateDiagnostic } from '../../types.js'
 
+const __filename = fileURLToPath(import.meta.url)
+
 let createServeAndBuild
 
 export const createDiagnostic: CreateDiagnostic<'vls'> = (pluginConfig) => {

diff --git a/packages/vite-plugin-checker/src/checkers/vueTsc/main.ts b/packages/vite-plugin-checker/src/checkers/vueTsc/main.ts
@@ -1,10 +1,11 @@
+import { createRequire } from 'module'
 import os from 'os'
 import path from 'path'
 import invariant from 'tiny-invariant'
 import ts from 'typescript'
+import { fileURLToPath } from 'url'
 import { parentPort } from 'worker_threads'
-import { createRequire } from 'module'
-const _require = createRequire(import.meta.url)
+
 import { Checker } from '../../Checker.js'
 import {
   consoleLog,
@@ -18,6 +19,9 @@ import {
 import { ACTION_TYPES, CreateDiagnostic, DiagnosticToRuntime } from '../../types.js'
 import { prepareVueTsc } from './prepareVueTsc.js'
 
+const _require = createRequire(import.meta.url)
+const __filename = fileURLToPath(import.meta.url)
+
 let createServeAndBuild
 
 const createDiagnostic: CreateDiagnostic<'vueTsc'> = (pluginConfig) => {
@@ -30,10 +34,10 @@ const createDiagnostic: CreateDiagnostic<'vueTsc'> = (pluginConfig) => {
       overlay = enableOverlay
       terminal = enableTerminal
     },
-    configureServer({ root }) {
+    async configureServer({ root }) {
       invariant(pluginConfig.vueTsc, 'config.vueTsc should be `false`')
 
-      const { targetTsDir } = prepareVueTsc()
+      const { targetTsDir } = await prepareVueTsc()
 
       const vueTs = _require(path.resolve(targetTsDir, 'lib/tsc.js'))
 
@@ -160,7 +164,6 @@ export class VueTscChecker extends Checker<'vueTsc'> {
 
   public init() {
     const _createServeAndBuild = super.initMainThread()
-    // module.exports.createServeAndBuild = createServeAndBuild
     createServeAndBuild = _createServeAndBuild
     super.initWorkerThread()
   }

diff --git a/packages/vite-plugin-checker/src/checkers/vueTsc/prepareVueTsc.ts b/packages/vite-plugin-checker/src/checkers/vueTsc/prepareVueTsc.ts
@@ -45,14 +45,18 @@ export function prepareVueTsc() {
   let shouldPrepare = true
   const targetDirExist = fs.existsSync(targetTsDir)
   if (targetDirExist) {
-    const targetTsVersion = _require(path.resolve(targetTsDir, 'package.json')).version
-    const currTsVersion = _require('typescript/package.json').version
-    // check fixture versions before re-use
-    if (
-      targetTsVersion === currTsVersion &&
-      fs.existsSync(vueTscFlagFile) &&
-      fs.readFileSync(vueTscFlagFile, 'utf8') === proxyPath
-    ) {
+    try {
+      const targetTsVersion = _require(path.resolve(targetTsDir, 'package.json')).version
+      const currTsVersion = _require('typescript/package.json').version
+      // check fixture versions before re-use
+      if (
+        targetTsVersion === currTsVersion &&
+        fs.existsSync(vueTscFlagFile) &&
+        fs.readFileSync(vueTscFlagFile, 'utf8') === proxyPath
+      ) {
+        shouldPrepare = true
+      }
+    } catch {
       shouldPrepare = true
     }
   }

diff --git a/packages/vite-plugin-checker/src/main.ts b/packages/vite-plugin-checker/src/main.ts
@@ -55,7 +55,7 @@ export function checker(userConfig: UserPluginConfig): Plugin {
   return {
     name: 'vite-plugin-checker',
     // @ts-ignore
-    __checker: Checker,
+    __internal__checker: Checker,
     config: async (config, env) => {
       // for dev mode (1/2)
       // Initialize checker with config

diff --git a/packages/vite-plugin-checker/tsup.config.ts b/packages/vite-plugin-checker/tsup.config.ts
@@ -10,6 +10,7 @@ export default defineConfig({
   bundle: false,
   format: ['esm'],
   sourcemap: true,
+  // do not clean @runtime code on watch mode
   clean: false,
   target: 'node14',
   platform: 'node',

diff --git a/...ests__/__snapshots__/default.spec.ts.snap → ...__tests__/__snapshots__/test.spec.ts.snap b/...ests__/__snapshots__/default.spec.ts.snap → ...__tests__/__snapshots__/test.spec.ts.snap
diff --git a/.../config-default/__tests__/default.spec.ts → ...und/config-default/__tests__/test.spec.ts b/.../config-default/__tests__/default.spec.ts → ...und/config-default/__tests__/test.spec.ts
@@ -2,26 +2,27 @@ import stringify from 'fast-json-stable-stringify'
 import { describe, expect, it } from 'vitest'
 
 import {
-  expectStderrContains,
-  sleepForServerReady,
   diagnostics,
+  expectStderrContains,
   isBuild,
   isServe,
   log,
+  sleepForServerReady,
   stripedLog,
 } from '../../testUtils'
 
 describe('config-default', () => {
   describe.runIf(isServe)('serve', () => {
     it('get initial error', async () => {
       await sleepForServerReady()
+
       expect(stringify(diagnostics)).toMatchSnapshot()
       expect(stripedLog).toMatchSnapshot()
     })
   })
 
   describe.runIf(isBuild)('build', () => {
-    it('default', async () => {
+    it('should fail', async () => {
       const expectedMsg = 'Unexpected var, use let or const instead  no-var'
       expectStderrContains(log, expectedMsg)
     })

diff --git a/...ableBuild-false/__tests__/default.spec.ts → ...-enableBuild-false/__tests__/test.spec.ts b/...ableBuild-false/__tests__/default.spec.ts → ...-enableBuild-false/__tests__/test.spec.ts
@@ -1,9 +1,10 @@
+import { describe, expect, it } from 'vitest'
+
 import { buildSucceed, isBuild } from '../../testUtils'
-import { describe, it, expect } from 'vitest'
 
-describe('enableBuild-false', () => {
+describe('config-enableBuild-false', () => {
   describe.runIf(isBuild)('build', () => {
-    it('build', async () => {
+    it('should pass', async () => {
       expect(buildSucceed).toBe(true)
     })
   })

diff --git a/...ialIsOpen-false/__tests__/default.spec.ts → ...nitialIsOpen-false/__tests__/test.spec.ts b/...ialIsOpen-false/__tests__/default.spec.ts → ...nitialIsOpen-false/__tests__/test.spec.ts
@@ -1,10 +1,10 @@
 import { describe, expect, it } from 'vitest'
 
-import { isServe, sleepForServerReady, getHmrOverlayText } from '../../testUtils'
+import { getHmrOverlayText, isServe, sleepForServerReady } from '../../testUtils'
 
-describe('initial-is-open-false', () => {
+describe('config-initialIsOpen-false', () => {
   describe.runIf(isServe)('serve', () => {
-    it('default', async () => {
+    it('should not find overlay', async () => {
       if (isServe) {
         await sleepForServerReady()
         try {

diff --git a/...untime-in-build/__tests__/default.spec.ts → ...o-runtime-in-build/__tests__/test.spec.ts b/...untime-in-build/__tests__/default.spec.ts → ...o-runtime-in-build/__tests__/test.spec.ts
@@ -1,12 +1,13 @@
 import fs from 'fs'
 import klaw from 'klaw'
 import path from 'path'
-import { sleepForServerReady, isBuild, testDir } from '../../testUtils'
 import { describe, expect, it } from 'vitest'
 
-describe('no-runtime-code-in-build', () => {
+import { isBuild, sleepForServerReady, testDir } from '../../testUtils'
+
+describe('config-no-runtime-code-in-build', () => {
   describe.runIf(isBuild)('build', () => {
-    it('test', async () => {
+    it('should not contain plugin code in build artifacts', async () => {
       await sleepForServerReady()
       for await (const file of klaw(path.resolve(testDir, 'dist'))) {
         if (file.stats.isFile()) {

diff --git a/playground/config-overlay-changes/__tests__/__snapshots__/test.spec.ts.snap b/playground/config-overlay-changes/__tests__/__snapshots__/test.spec.ts.snap
@@ -0,0 +1,25 @@
+// Vitest Snapshot v1
+
+exports[`config-overlay-changes > serve > get initial error from overlay and overlay error content changes on modifying 1`] = `"Unexpected var, use let or const instead. (no-var)"`;
+
+exports[`config-overlay-changes > serve > get initial error from overlay and overlay error content changes on modifying 2`] = `"<PROJECT_ROOT>/playground-temp/config-overlay-changes/src/main.ts:3:1"`;
+
+exports[`config-overlay-changes > serve > get initial error from overlay and overlay error content changes on modifying 3`] = `
+"    1 | import { text } from './text'
+    2 |
+  > 3 | var hello = 'Hello'
+      | ^^^^^^^^^^^^^^^^^^^
+    4 |
+    5 | const rootDom = document.querySelector('#root')! as HTMLElement
+    6 | rootDom.innerHTML = hello + text"
+`;
+
+exports[`config-overlay-changes > serve > get initial error from overlay and overlay error content changes on modifying 4`] = `
+"    1 | import { text } from './text'
+    2 |
+  > 3 | var hello = 'Hello1'
+      | ^^^^^^^^^^^^^^^^^^^^
+    4 |
+    5 | const rootDom = document.querySelector('#root')! as HTMLElement
+    6 | rootDom.innerHTML = hello + text"
+`;
diff --git a/...overlay-changes/__tests__/default.spec.ts → ...ig-overlay-changes/__tests__/test.spec.ts b/...overlay-changes/__tests__/default.spec.ts → ...ig-overlay-changes/__tests__/test.spec.ts
@@ -1,4 +1,5 @@
 import { describe, expect, it } from 'vitest'
+
 import {
   editFile,
   getHmrOverlay,
@@ -10,9 +11,9 @@ import {
   sleepForServerReady,
 } from '../../testUtils'
 
-describe('config-default', () => {
+describe('config-overlay-changes', () => {
   describe.runIf(isServe)('serve', () => {
-    it('get initial and following errors', async () => {
+    it('get initial error from overlay and overlay error content changes on modifying', async () => {
       await sleepForServerReady()
       const [message1, file1, frame1] = await getHmrOverlayText()
       expect(message1).toMatchSnapshot()

diff --git a/...g-overlay-false/__tests__/default.spec.ts → ...nfig-overlay-false/__tests__/test.spec.ts b/...g-overlay-false/__tests__/default.spec.ts → ...nfig-overlay-false/__tests__/test.spec.ts
@@ -1,9 +1,10 @@
-import { isServe, getHmrOverlayText, sleepForServerReady } from '../../testUtils'
 import { describe, expect, it } from 'vitest'
 
-describe('overlay-false', () => {
-  it('serve', async () => {
-    describe.runIf(isServe)('serve', async () => {
+import { getHmrOverlayText, isServe, sleepForServerReady } from '../../testUtils'
+
+describe('config-overlay-false', () => {
+  describe.runIf(isServe)('serve', async () => {
+    it('should not find overlay', async () => {
       await sleepForServerReady()
       try {
         await getHmrOverlayText()

diff --git a/...position-style/__tests__/default.specx.ts → ...lay-position-style/__tests__/test.spec.ts b/...position-style/__tests__/default.specx.ts → ...lay-position-style/__tests__/test.spec.ts
@@ -3,7 +3,7 @@ import { describe, expect, it } from 'vitest'
 
 describe('config-overlay-position-style', () => {
   describe.runIf(isServe)('serve', () => {
-    it('get initial error and subsequent error', async () => {
+    it('find badge in right top corner', async () => {
       await sleepForServerReady()
       const shadowRoot = await getHmrOverlay()
       const badge = await shadowRoot!.$('.badge-base')

diff --git a/playground/config-terminal-false/__tests__/__snapshots__/test.spec.ts.snap b/playground/config-terminal-false/__tests__/__snapshots__/test.spec.ts.snap
@@ -0,0 +1,5 @@
+// Vitest Snapshot v1
+
+exports[`config-terminal-false > serve > should not log into terminal 1`] = `"[{\\"checkerId\\":\\"ESLint\\",\\"frame\\":\\"    1 | import { text } from './text'/n    2 |/n  > 3 | var hello = 'Hello'/n      | ^^^^^^^^^^^^^^^^^^^/n    4 |/n    5 | const rootDom = document.querySelector('#root')! as HTMLElement/n    6 | rootDom.innerHTML = hello + text\\",\\"id\\":\\"<PROJECT_ROOT>/playground-temp/config-terminal-false/src/main.ts\\",\\"level\\":1,\\"loc\\":{\\"column\\":1,\\"file\\":\\"<PROJECT_ROOT>/playground-temp/config-terminal-false/src/main.ts\\",\\"line\\":3},\\"message\\":\\"Unexpected var, use let or const instead. (no-var)\\",\\"stack\\":\\"\\"},{\\"checkerId\\":\\"ESLint\\",\\"frame\\":\\"    3 | var hello = 'Hello'/n    4 |/n  > 5 | const rootDom = document.querySelector('#root')! as HTMLElement/n      |                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^/n    6 | rootDom.innerHTML = hello + text/n    7 |/n    8 | export {}\\",\\"id\\":\\"<PROJECT_ROOT>/playground-temp/config-terminal-false/src/main.ts\\",\\"level\\":0,\\"loc\\":{\\"column\\":17,\\"file\\":\\"<PROJECT_ROOT>/playground-temp/config-terminal-false/src/main.ts\\",\\"line\\":5},\\"message\\":\\"Forbidden non-null assertion. (@typescript-eslint/no-non-null-assertion)\\",\\"stack\\":\\"\\"}]"`;
+
+exports[`config-terminal-false > serve > should not log into terminal 2`] = `""`;
diff --git a/...-terminal-false/__tests__/default.spec.ts → ...fig-terminal-false/__tests__/test.spec.ts b/...-terminal-false/__tests__/default.spec.ts → ...fig-terminal-false/__tests__/test.spec.ts
@@ -1,19 +1,11 @@
 import stringify from 'fast-json-stable-stringify'
 import { describe, expect, it } from 'vitest'
 
-import {
-  expectStderrContains,
-  sleepForServerReady,
-  diagnostics,
-  isBuild,
-  isServe,
-  log,
-  stripedLog,
-} from '../../testUtils'
+import { diagnostics, isServe, sleepForServerReady, stripedLog } from '../../testUtils'
 
-describe('overlay-terminal-false', () => {
+describe('config-terminal-false', () => {
   describe.runIf(isServe)('serve', () => {
-    it('get initial error and subsequent error', async () => {
+    it('should not log into terminal', async () => {
       await sleepForServerReady()
       expect(stringify(diagnostics)).toMatchSnapshot()
       expect(stripedLog).toMatchSnapshot()

diff --git a/playground/eslint-config-log-level/__tests__/__snapshots__/test.spec.ts.snap b/playground/eslint-config-log-level/__tests__/__snapshots__/test.spec.ts.snap
@@ -1,19 +1,9 @@
 // Vitest Snapshot v1
 
-exports[`eslint-config-log-level > serve > get initial error and subsequent error 1`] = `undefined`;
+exports[`eslint-config-log-level > serve > should only emit warning logs 1`] = `"[{\\"checkerId\\":\\"ESLint\\",\\"frame\\":\\"    3 | var hello = 'Hello'/n    4 |/n  > 5 | const rootDom = document.querySelector('#root')!/n      |                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^/n    6 | rootDom.innerHTML = hello + text/n    7 |/n    8 | export {}\\",\\"id\\":\\"<PROJECT_ROOT>/playground-temp/eslint-config-log-level/src/main.ts\\",\\"level\\":0,\\"loc\\":{\\"column\\":17,\\"file\\":\\"<PROJECT_ROOT>/playground-temp/eslint-config-log-level/src/main.ts\\",\\"line\\":5},\\"message\\":\\"Forbidden non-null assertion. (@typescript-eslint/no-non-null-assertion)\\",\\"stack\\":\\"\\"}]"`;
 
-exports[`eslint-config-log-level > serve > get initial error and subsequent error 2`] = `
-" ERROR(ESLint)  Unexpected var, use let or const instead. (no-var)
- FILE  <PROJECT_ROOT>/playground-temp/eslint-config-log-level/src/main.ts:3:1
-
-    1 | import { text } from './text'
-    2 |
-  > 3 | var hello = 'Hello'
-      | ^^^^^^^^^^^^^^^^^^^
-    4 |
-    5 | const rootDom = document.querySelector('#root')!
-    6 | rootDom.innerHTML = hello + text
- WARNING(ESLint)  Forbidden non-null assertion. (@typescript-eslint/no-non-null-assertion)
+exports[`eslint-config-log-level > serve > should only emit warning logs 2`] = `
+" WARNING(ESLint)  Forbidden non-null assertion. (@typescript-eslint/no-non-null-assertion)
  FILE  <PROJECT_ROOT>/playground-temp/eslint-config-log-level/src/main.ts:5:17
 
     3 | var hello = 'Hello'
@@ -23,23 +13,13 @@ exports[`eslint-config-log-level > serve > get initial error and subsequent erro
     6 | rootDom.innerHTML = hello + text
     7 |
     8 | export {}
-[ESLint] Found 1 error and 1 warning"
+[ESLint] Found 0 error and 1 warning"
 `;
 
-exports[`eslint-config-log-level > serve > get initial error and subsequent error 3`] = `undefined`;
+exports[`eslint-config-log-level > serve > should only emit warning logs 3`] = `"[{\\"checkerId\\":\\"ESLint\\",\\"frame\\":\\"    3 | var hello = 'Hello~'/n    4 |/n  > 5 | const rootDom = document.querySelector('#root')!/n      |                 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^/n    6 | rootDom.innerHTML = hello + text/n    7 |/n    8 | export {}\\",\\"id\\":\\"<PROJECT_ROOT>/playground-temp/eslint-config-log-level/src/main.ts\\",\\"level\\":0,\\"loc\\":{\\"column\\":17,\\"file\\":\\"<PROJECT_ROOT>/playground-temp/eslint-config-log-level/src/main.ts\\",\\"line\\":5},\\"message\\":\\"Forbidden non-null assertion. (@typescript-eslint/no-non-null-assertion)\\",\\"stack\\":\\"\\"}]"`;
 
-exports[`eslint-config-log-level > serve > get initial error and subsequent error 4`] = `
-" ERROR(ESLint)  Unexpected var, use let or const instead. (no-var)
- FILE  <PROJECT_ROOT>/playground-temp/eslint-config-log-level/src/main.ts:3:1
-
-    1 | import { text } from './text'
-    2 |
-  > 3 | var hello = 'Hello~'
-      | ^^^^^^^^^^^^^^^^^^^^
-    4 |
-    5 | const rootDom = document.querySelector('#root')!
-    6 | rootDom.innerHTML = hello + text
- WARNING(ESLint)  Forbidden non-null assertion. (@typescript-eslint/no-non-null-assertion)
+exports[`eslint-config-log-level > serve > should only emit warning logs 4`] = `
+" WARNING(ESLint)  Forbidden non-null assertion. (@typescript-eslint/no-non-null-assertion)
  FILE  <PROJECT_ROOT>/playground-temp/eslint-config-log-level/src/main.ts:5:17
 
     3 | var hello = 'Hello~'
@@ -49,5 +29,5 @@ exports[`eslint-config-log-level > serve > get initial error and subsequent erro
     6 | rootDom.innerHTML = hello + text
     7 |
     8 | export {}
-[ESLint] Found 1 error and 1 warning"
+[ESLint] Found 0 error and 1 warning"
 `;