test: split e2e and unit cases (#421)

close #412

Author: JounQin

.env.yarn

@@ -1,2 +1 @@
 CONFIG_PREFER_PRETTIER=1
-NODE_OPTIONS="--no-warnings=ESLintRCWarning"

.lintstagedrc.js

@@ -1 +1,7 @@
-export { default } from '@1stg/lint-staged/tsc'
+import base from '@1stg/lint-staged/tsc'
+
+export default {
+  ...base,
+  'tests/e2e/absoluteAlias/**/*.ts?(x)': () =>
+    'tsc -p tests/e2e/absoluteAlias --noEmit',
+}

.prettierignore

@@ -1,4 +1,5 @@
 .yarn
+/auto-imports.d.ts
 /pnpm-lock.yaml
-/tests/pnp/.pnp.*
-**/*.svg
+.pnp.*
+*.svg

.vscode/settings.json

@@ -0,0 +1,22 @@
+/* eslint-disable */
+/* prettier-ignore */
+// @ts-nocheck
+// noinspection JSUnusedGlobalSymbols
+// Generated by unplugin-auto-import
+// biome-ignore lint: disable
+export {}
+declare global {
+  const afterAll: typeof import('vitest')['afterAll']
+  const afterEach: typeof import('vitest')['afterEach']
+  const assert: typeof import('vitest')['assert']
+  const beforeAll: typeof import('vitest')['beforeAll']
+  const beforeEach: typeof import('vitest')['beforeEach']
+  const chai: typeof import('vitest')['chai']
+  const describe: typeof import('vitest')['describe']
+  const expect: typeof import('vitest')['expect']
+  const it: typeof import('vitest')['it']
+  const suite: typeof import('vitest')['suite']
+  const test: typeof import('vitest')['test']
+  const vi: typeof import('vitest')['vi']
+  const vitest: typeof import('vitest')['vitest']
+}

auto-imports.d.ts

@@ -1,6 +1,6 @@
 // @ts-check
 
-import recommended from '@1stg/eslint-config'
+import base from '@1stg/eslint-config'
 
 /**
  * @import {TSESLint} from '@typescript-eslint/utils'
@@ -10,7 +10,7 @@ const config = [
   {
     ignores: ['tests'],
   },
-  ...recommended,
+  ...base,
   {
     files: ['dummy.js/*'],
     languageOptions: {

eslint.config.js

@@ -54,30 +54,13 @@
     "build": "run-p -c 'build:*'",
     "build:r": "r -f cjs",
     "build:ts": "tsc -b",
-    "eslint": "ESLINT_USE_FLAT_CONFIG=false eslint",
     "format": "prettier --write .",
     "lint": "run-p 'lint:*'",
     "lint:es": "eslint . --cache",
     "lint:tsc": "tsc -b --noEmit",
-    "prepare": "simple-git-hooks && yarn-berry-deduplicate && cd tests/nestedPackageJson && yarn || exit 0",
+    "prepare": "simple-git-hooks && yarn-berry-deduplicate || exit 0",
     "release": "clean-pkg-json && changeset publish",
-    "test": "run-p 'test:*'",
-    "test:absoluteAlias": "yarn eslint --ext ts,tsx tests/absoluteAlias",
-    "test:dotInclude": "yarn eslint --ext ts,tsx tests/dotInclude --ignore-pattern \"!.dot\"",
-    "test:dotPaths": "yarn eslint --ext ts,tsx tests/dotPaths --ignore-pattern \"!.dot\"",
-    "test:dotProject": "yarn eslint --ext ts,tsx tests/dotProject --ignore-pattern \"!.dot\"",
-    "test:importXResolverV3": "eslint --config=tests/importXResolverV3/eslint.config.cjs tests/importXResolverV3",
-    "test:multipleEslintrcs": "yarn eslint --ext ts,tsx tests/multipleEslintrcs",
-    "test:multipleTsconfigs": "yarn eslint --ext ts,tsx tests/multipleTsconfigs",
-    "test:nearestTsconfig": "yarn eslint --ext ts,tsx tests/nearestTsconfig",
-    "test:nestedPackageJson": "yarn eslint --ext ts,tsx tests/nestedPackageJson",
-    "test:unit": "vitest --run",
-    "test:withJsExtension": "node tests/withJsExtension/test.js && yarn eslint --ext ts,tsx tests/withJsExtension",
-    "test:withJsconfig": "yarn eslint --ext js tests/withJsconfig",
-    "test:withPaths": "yarn eslint --ext ts,tsx tests/withPaths",
-    "test:withPathsAndNestedBaseUrl": "yarn eslint --ext ts,tsx tests/withPathsAndNestedBaseUrl",
-    "test:withQuerystring": "yarn eslint --ext ts,tsx tests/withQuerystring",
-    "test:withoutPaths": "yarn eslint --ext ts,tsx tests/withoutPaths",
+    "test": "node tests/e2e/withJsExtension/test.cjs && vitest run",
     "typecov": "type-coverage"
   },
   "peerDependencies": {
@@ -107,6 +90,7 @@
     "@changesets/cli": "^2.28.1",
     "@commitlint/cli": "^19.8.0",
     "@mozilla/glean": "^5.0.3",
+    "@pkgr/core": "^0.2.0",
     "@pkgr/rollup": "^6.0.1",
     "@total-typescript/ts-reset": "^0.6.1",
     "@types/debug": "^4.1.12",
@@ -130,6 +114,7 @@
     "tinyexec": "^1.0.1",
     "type-coverage": "^2.29.7",
     "typescript": "~5.8.2",
+    "unplugin-auto-import": "^19.1.2",
     "vitest": "^3.0.9",
     "yarn-berry-deduplicate": "^6.1.1"
   },

package.json

@@ -0,0 +1,121 @@
+// Vitest Snapshot v1, https://vitest.dev/guide/snapshot.html
+
+exports[`e2e cases > should exec eslint successfully > absoluteAlias 1`] = `
+{
+  "exitCode": 0,
+  "stderr": "",
+  "stdout": "",
+}
+`;
+
+exports[`e2e cases > should exec eslint successfully > dotInclude 1`] = `
+{
+  "exitCode": 0,
+  "stderr": "",
+  "stdout": "",
+}
+`;
+
+exports[`e2e cases > should exec eslint successfully > dotPaths 1`] = `
+{
+  "exitCode": 0,
+  "stderr": "",
+  "stdout": "",
+}
+`;
+
+exports[`e2e cases > should exec eslint successfully > dotProject 1`] = `
+{
+  "exitCode": 0,
+  "stderr": "",
+  "stdout": "",
+}
+`;
+
+exports[`e2e cases > should exec eslint successfully > importXResolverV3 1`] = `
+{
+  "exitCode": 0,
+  "stderr": "",
+  "stdout": "",
+}
+`;
+
+exports[`e2e cases > should exec eslint successfully > multipleEslintrcs 1`] = `
+{
+  "exitCode": 0,
+  "stderr": "",
+  "stdout": "",
+}
+`;
+
+exports[`e2e cases > should exec eslint successfully > multipleTsconfigs 1`] = `
+{
+  "exitCode": 0,
+  "stderr": "",
+  "stdout": "",
+}
+`;
+
+exports[`e2e cases > should exec eslint successfully > nearestTsconfig 1`] = `
+{
+  "exitCode": 0,
+  "stderr": "",
+  "stdout": "",
+}
+`;
+
+exports[`e2e cases > should exec eslint successfully > nestedPackageJson 1`] = `
+{
+  "exitCode": 0,
+  "stderr": "",
+  "stdout": "",
+}
+`;
+
+exports[`e2e cases > should exec eslint successfully > withJsExtension 1`] = `
+{
+  "exitCode": 0,
+  "stderr": "",
+  "stdout": "",
+}
+`;
+
+exports[`e2e cases > should exec eslint successfully > withJsconfig 1`] = `
+{
+  "exitCode": 0,
+  "stderr": "",
+  "stdout": "",
+}
+`;
+
+exports[`e2e cases > should exec eslint successfully > withPaths 1`] = `
+{
+  "exitCode": 0,
+  "stderr": "",
+  "stdout": "",
+}
+`;
+
+exports[`e2e cases > should exec eslint successfully > withPathsAndNestedBaseUrl 1`] = `
+{
+  "exitCode": 0,
+  "stderr": "",
+  "stdout": "",
+}
+`;
+
+exports[`e2e cases > should exec eslint successfully > withQuerystring 1`] = `
+{
+  "exitCode": 0,
+  "stderr": "",
+  "stdout": "",
+}
+`;
+
+exports[`e2e cases > should exec eslint successfully > withoutPaths 1`] = `
+{
+  "exitCode": 0,
+  "stderr": "",
+  "stdout": "",
+}
+`;

tests/e2e/__snapshots__/e2e.spec.ts.snap

@@ -1,4 +1,5 @@
 {
+  "extends": "../../../tsconfig.base",
   "compilerOptions": {
     "paths": {
       "/*": ["./public/*"]

tests/absoluteAlias/.eslintrc.cjs tests/e2e/absoluteAlias/.eslintrc.cjs

@@ -32,12 +32,19 @@ const base = project => ({
         tsx: 'never',
       },
     ],
-    'node/no-extraneous-import': 0,
-    'node/no-missing-import': 0,
+    'import-x/order': [
+      2,
+      {
+        alphabetize: {
+          order: 'asc',
+        },
+        'newlines-between': 'always',
+      },
+    ],
   },
   overrides: [
     {
-      files: '**/.*.cjs',
+      files: '**/*.{cjs,cts}',
       env: {
         node: true,
       },

tests/absoluteAlias/public/images/foo.ts tests/e2e/absoluteAlias/public/images/foo.ts

@@ -0,0 +1,56 @@
+import fs from 'node:fs/promises'
+import path from 'node:path'
+
+import { tryFile } from '@pkgr/core'
+import { exec } from 'tinyexec'
+
+describe('e2e cases', async () => {
+  const { dirname } = import.meta
+
+  const dirents = await fs.readdir(dirname, { withFileTypes: true })
+
+  for (const dirent of dirents) {
+    const dirName = dirent.name
+
+    if (!dirent.isDirectory() || dirName === '__snapshots__') {
+      continue
+    }
+
+    const absoluteDir = path.resolve(dirname, dirName)
+
+    if (tryFile('yarn.lock', false, absoluteDir)) {
+      await exec('yarn', ['--immutable'], {
+        nodeOptions: {
+          cwd: absoluteDir,
+        },
+      })
+    }
+
+    it('should exec eslint successfully', async () => {
+      const eslintConfig = tryFile('eslint.config.js', false, absoluteDir)
+      expect(
+        await exec(
+          'yarn',
+          [
+            'eslint',
+            ...(eslintConfig
+              ? ['-c', eslintConfig]
+              : ['--ignore-pattern', '!.dot']),
+            '--ext',
+            'cjs,cts,js,jsx,mjs,mts,ts,tsx',
+            '--report-unused-disable-directives',
+            absoluteDir,
+          ],
+          {
+            nodeOptions: {
+              env: {
+                ESLINT_USE_FLAT_CONFIG: eslintConfig ? undefined : 'false',
+                NODE_OPTIONS: '--no-warnings=ESLintRCWarning',
+              },
+            },
+          },
+        ),
+      ).toMatchSnapshot(dirName)
+    })
+  }
+})

tests/absoluteAlias/test.ts tests/e2e/absoluteAlias/test.ts

@@ -0,0 +1,35 @@
+import path from 'node:path'
+import { fileURLToPath } from 'node:url'
+
+import { createTypeScriptImportResolver } from 'eslint-import-resolver-typescript'
+import importX, { flatConfigs } from 'eslint-plugin-import-x'
+
+import base from '../base.eslintrc.cjs'
+
+const globPattern = './packages/*/tsconfig.json'
+
+// in normal cases this is not needed because the `dirname` would be the root
+const absoluteGlobPath = path.resolve(
+  fileURLToPath(import.meta.url),
+  '..',
+  globPattern,
+)
+
+export default +process.versions.node.split('.')[0] <= 16
+  ? {}
+  : {
+      files: ['**/*.ts', '**/*.tsx'],
+      plugins: {
+        'import-x': importX,
+      },
+      settings: {
+        ...flatConfigs.typescript.settings,
+        'import-x/resolver-next': [
+          createTypeScriptImportResolver({
+            project: absoluteGlobPath,
+            noWarnOnMultipleProjects: true,
+          }),
+        ],
+      },
+      rules: base().rules,
+    }

tests/absoluteAlias/tsconfig.json tests/e2e/absoluteAlias/tsconfig.json

@@ -1,4 +1,4 @@
 {
-  "type": "commonjs",
+  "type": "module",
   "private": true
 }

tests/base.eslintrc.cjs tests/e2e/base.eslintrc.cjs

@@ -1,4 +1,3 @@
-/* eslint-env node */
 const config = require('../base.eslintrc.cjs')(__dirname)
 
 module.exports = {

tests/dotInclude/.dot/index.ts tests/e2e/dotInclude/.dot/index.ts

@@ -1,5 +1,6 @@
 // import relative
 import './tsImportee.js'
+import './tsxImportee.js'
 import './tsxImportee.jsx'
 import './dtsImportee.js'
 import './dtsImportee.jsx'

tests/dotInclude/.dot/module/module.d.ts tests/e2e/dotInclude/.dot/module/module.d.ts

@@ -1,10 +1,7 @@
-/* eslint-env node */
-/* eslint-disable @typescript-eslint/no-var-requires */
+const assert = require('node:assert')
+const path = require('node:path')
 
-const path = require('path')
-const assert = require('assert')
-
-const { resolve } = require('../../')
+const { resolve } = require('../../..')
 
 const config = {
   project: path.join(__dirname, 'tsconfig.json'),
@@ -128,4 +125,4 @@ assertResolve(
 )
 
 // resolves symlinks by default
-assertResolve('dummy.js', '../../dummy.js/index.js')
+assertResolve('dummy.js', '../../../dummy.js/index.js')

tests/dotInclude/.dot/module/package.json tests/e2e/dotInclude/.dot/module/package.json

@@ -0,0 +1 @@
+module.exports = require('../base.eslintrc.cjs')(__dirname)

tests/dotInclude/.dot/subfolder/tsImportee.ts tests/e2e/dotInclude/.dot/subfolder/tsImportee.ts

@@ -0,0 +1 @@
+module.exports = require('../base.eslintrc.cjs')(__dirname)