File path formatting for checkIgnore running on Windows (#1084)

* Add windows test runner to Github Actions
* Add support for `.win32.spec.ts` to find tests that need to be run on Windows

Author: steveukx

.github/workflows/ci.yml

@@ -10,7 +10,7 @@ permissions:
    contents: read
 
 jobs:
-   build:
+   build-ubuntu:
       runs-on: ubuntu-latest
       strategy:
          matrix:
@@ -29,3 +29,20 @@ jobs:
               GIT_AUTHOR_NAME: 'Simple Git Tests'
               GIT_AUTHOR_EMAIL: 'tests@simple-git.dev'
            run: yarn test
+
+   build-windows:
+      runs-on: windows-latest
+      steps:
+         - uses: actions/checkout@v5
+         - name: Use Node.js 24
+           uses: actions/setup-node@v6
+           with:
+              node-version: 24
+              cache: yarn
+         - run: yarn install --immutable
+         - run: yarn build
+         - name: Test
+           env:
+              GIT_AUTHOR_NAME: 'Simple Git Tests'
+              GIT_AUTHOR_EMAIL: 'tests@simple-git.dev'
+           run: yarn test:win

package.json

@@ -15,7 +15,8 @@
     "clean:cache": "git clean -fxd .yarn node_modules packages simple-git",
     "lint": "biome check",
     "lint:fix": "biome check --write",
-    "test": "yarn workspaces foreach -A run test"
+    "test": "yarn workspaces foreach -A run test",
+    "test:win": "yarn workspaces foreach -A run test:win"
   },
   "dependencies": {
     "@changesets/changelog-github": "^0.5.1",

packages/test-utils/index.ts

@@ -8,3 +8,4 @@ export * from './src/wait';
 export * from './src/setup/setup-conflicted';
 export * from './src/setup/setup-files';
 export * from './src/setup/setup-init';
+export * from './src/setup/setup-ignored';

packages/test-utils/src/create-test-context.ts

@@ -1,5 +1,7 @@
-import { join } from 'path';
+import { tmpdir } from 'node:os';
+import { join } from 'node:path';
 import { existsSync, mkdir, mkdtemp, realpathSync, writeFile, WriteFileOptions } from 'fs';
+
 import { simpleGit, SimpleGit } from 'simple-git';
 
 export interface SimpleGitTestContext {
@@ -36,7 +38,7 @@ const io = {
    },
    mkdtemp(): Promise<string> {
       return new Promise((done, fail) => {
-         mkdtemp((process.env.TMPDIR || '/tmp/') + 'simple-git-test-', (err, path) => {
+         mkdtemp(join(process.env.TMPDIR || tmpdir(), 'simple-git-test-'), (err, path) => {
             err ? fail(err) : done(path);
          });
       });

packages/test-utils/src/setup/setup-ignored.ts

@@ -0,0 +1,9 @@
+import { SimpleGitTestContext } from '../create-test-context';
+
+export async function setUpIgnored({ git, file }: SimpleGitTestContext, paths: string[] = [], filename = '.gitignore') {
+   await file(filename, paths.join('\n') + '\n');
+
+   await git.add(filename);
+   await git.commit(`setUpIgnored: ${filename}`);
+}
+

simple-git/package.json

@@ -63,7 +63,8 @@
     "build:defs": "tsc -p tsconfig.release.json --outDir dist && cp -r typings dist",
     "build:pkg": "node scripts/package-json.js",
     "prepublishOnly": "yarn build:pkg",
-    "test": "jest --coverage"
+    "test": "jest --coverage",
+    "test:win": "jest '\\.win32.spec.ts$'"
   },
   "publish": {
     "main": "dist/cjs/index.js",

simple-git/test/integration/check-ignore.win32.spec.ts

@@ -0,0 +1,26 @@
+import { createTestContext, setUpIgnored, setUpInit, SimpleGitTestContext } from '@simple-git/test-utils';
+
+describe('checkIgnore', () => {
+
+   let context: SimpleGitTestContext;
+
+   beforeEach(async () => (context = await createTestContext()));
+   beforeEach(async () => {
+      await setUpInit(context);
+      await setUpIgnored(context, ['ignored', 'partially/untracked']);
+   });
+
+   it('detects ignored files', async () => {
+      const actual = await context.git.checkIgnore([
+         'ignored/anything',
+         'tracked/anything',
+         'partially/tracked',
+         'partially/untracked/file',
+      ]);
+
+      expect(actual).toEqual([
+         'ignored/anything',
+         'partially/untracked/file',
+      ]);
+   });
+});