Merge pull request #250 from mizdra/fix-windows

Support for Windows

Author: mizdra

.github/workflows/nodejs.yml

@@ -23,8 +23,13 @@ jobs:
       matrix:
         node: [14, 16]
         eslint: ['7.0.0', '^7.0.0', '8.0.0', '^8.0.0']
-    runs-on: ubuntu-latest
+        os: [ubuntu-latest, macos-latest, windows-latest]
+    runs-on: ${{ matrix.os }}
     steps:
+      # To avoid differences in snapshot tests.
+      - run: git config --global core.autocrlf false
+        if: ${{ matrix.os == 'windows-latest' }}
+
       - uses: actions/checkout@v3
       - uses: pnpm/action-setup@v2
       - uses: actions/setup-node@v3
@@ -43,3 +48,8 @@ jobs:
 
       - name: pnpm run postbuild:test
         run: pnpm run postbuild:test
+        # Currently the E2E test is written in bash shell script,
+        # so it is difficult to run on windows. Therefore,
+        # we are temporarily skipping the E2E test on windows.
+        # TODO: Enable E2E test on windows.
+        if: ${{ matrix.os != 'windows-latest' }}

bin/_eslint-interactive.js

@@ -0,0 +1,9 @@
+// @ts-check
+import { run } from '../dist/index.js';
+
+run({
+  argv: process.argv,
+}).catch((error) => {
+  console.error(error);
+  process.exit(1);
+});

bin/eslint-interactive.js

@@ -1,10 +1,23 @@
-#!/usr/bin/env -S node --enable-source-maps --unhandled-rejections=strict --experimental-import-meta-resolve
+#!/usr/bin/env node
+// @ts-check
 
-import { run } from '../dist/index.js';
+import { spawnSync } from 'child_process';
+import { resolve } from 'path';
+import { dirname, join } from 'path';
+import { fileURLToPath } from 'url';
 
-run({
-  argv: process.argv,
-}).catch((error) => {
-  console.error(error);
-  process.exit(1);
-});
+const dir = join(dirname(fileURLToPath(import.meta.url)));
+
+const scriptFile = resolve(dir, '_eslint-interactive.js');
+
+spawnSync(
+  'node',
+  [
+    '--enable-source-maps',
+    '--unhandled-rejections=strict',
+    '--experimental-import-meta-resolve',
+    scriptFile,
+    ...process.argv.slice(2),
+  ],
+  { stdio: 'inherit' },
+);

package.json

@@ -24,7 +24,7 @@
     "lint:tsc:test": "tsc -p tsconfig.test.json --noEmit",
     "lint:eslint": "eslint --ignore-pattern '/fixtures/' --ignore-pattern '/e2e-test/' .",
     "lint:prettier": "prettier --check .",
-    "test": "FORCE_HYPERLINK=1 NODE_OPTIONS=\"--experimental-vm-modules --experimental-import-meta-resolve $NODE_OPTIONS\" jest --colors",
+    "test": "cross-env FORCE_HYPERLINK=1 NODE_OPTIONS=\"--experimental-vm-modules --experimental-import-meta-resolve $NODE_OPTIONS\" jest --colors",
     "postbuild:test": "./run-e2e-test.sh",
     "postbuild:benchmark": "node benchmark/run.js"
   },
@@ -39,16 +39,19 @@
     "@types/eslint": "^8.4.6",
     "@types/estraverse": "^5.1.2",
     "@types/estree": "^1.0.0",
+    "@types/fs-extra": "^11.0.0",
     "@types/jest": "^29.0.0",
     "@types/node": "^18.0.5",
     "@types/terminal-link": "^1.2.0",
     "@types/yargs": "^17.0.13",
     "@typescript-eslint/eslint-plugin": "^5.30.6",
     "@typescript-eslint/parser": "^5.30.6",
     "babel-jest": "^29.0.1",
+    "cross-env": "^7.0.3",
     "eslint": "^8.23.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-import": "^2.26.0",
+    "fs-extra": "^11.1.0",
     "jest": "^29.0.1",
     "jest-mock-process": "^2.0.0",
     "npm-run-all": "^4.1.5",

pnpm-lock.yaml

@@ -34,7 +34,10 @@ function normalizeResults(results: ESLint.LintResult[]): ESLint.LintResult[] {
       ...result,
       // Usually, `filePath` changes depending on the environment, and the snapshot will fail.
       // So, remove the current directory from `filePath`.
-      filePath: result.filePath.replace(process.cwd(), ''),
+      filePath: result.filePath
+        .replace(process.cwd(), '')
+        // for windows
+        .replace(/\\/g, '/'),
       messages: result.messages.map(normalizeMessage),
       // Remove the source because the snapshot will be large
       source: 'ommitted',
@@ -136,7 +139,11 @@ describe('Core', () => {
   });
   test('printDetailsOfResults', async () => {
     const results = await core.lint();
-    expect(await core.formatResultDetails(results, ['import/order', 'ban-exponentiation-operator'])).toMatchSnapshot();
+    expect(
+      (await core.formatResultDetails(results, ['import/order', 'ban-exponentiation-operator']))
+        // for windows
+        .replace(/\\/g, '/'),
+    ).toMatchSnapshot();
   });
   describe('applyAutoFixes', () => {
     test('basic', async () => {

src/core.test.ts

@@ -1,7 +1,9 @@
 import { exec } from 'child_process';
-import { dirname, join } from 'path';
+import { rm } from 'fs/promises';
+import { dirname, join, resolve } from 'path';
 import { fileURLToPath } from 'url';
 import { promisify } from 'util';
+import fse from 'fs-extra/esm';
 
 const execPromise = promisify(exec);
 
@@ -19,9 +21,10 @@ export async function getSnapshotOfChangedFiles(): Promise<string> {
 }
 
 export async function setupFixturesCopy() {
-  await execPromise(`rm -rf fixtures-tmp && cp -r fixtures fixtures-tmp`, { cwd });
+  await rm(resolve(cwd, 'fixtures-tmp'), { recursive: true, force: true });
+  await fse.copy(resolve(cwd, 'fixtures'), resolve(cwd, 'fixtures-tmp'));
 }
 
 export async function cleanupFixturesCopy() {
-  await execPromise(`rm -rf fixtures-tmp`, { cwd });
+  await rm(resolve(cwd, 'fixtures-tmp'), { recursive: true, force: true });
 }