To enable support for ES modules in TypeScript >=4.7 (enabled with module and moduleResolution of node16 or nodenext in the tsconfig), export simpleGit as a named export instead of as the default export from the simple-git package.

steveukx · steveukx · commit aef5f677d70f · 2022-06-25T19:52:37.000+01:00
Add `simpleGit` to the TypeScript types while keeping default export for backward compatibility.
diff --git a/package.json b/package.json
@@ -7,7 +7,7 @@
     "simple-git"
   ],
   "resolutions": {
-    "typescript": "4.1.2"
+    "typescript": "4.7.4"
   },
   "scripts": {
     "build": "lerna run build",
diff --git a/packages/test-es-module-consumer/suite.mjs b/packages/test-es-module-consumer/suite.mjs
@@ -0,0 +1,28 @@
+import { strictEqual } from "assert";
+
+export async function suite(name, simpleGit, ResetMode) {
+   exec(`${name}: imports default`, async () => {
+      strictEqual(
+         await simpleGit().checkIsRepo(),
+         true,
+         'expected the current directory to be a valid git root',
+      );
+   });
+
+   exec(`${name}: imports named exports`, async () => {
+      strictEqual(
+         /hard/.test(ResetMode.HARD),
+         true,
+         'expected valid ResetMode enum'
+      );
+   });
+}
+
+function exec (name, runner) {
+   runner()
+      .then(() => console.log(`${ name }: OK`))
+      .catch((e) => {
+         console.error(`${ name }: ${ e.message }`);
+         throw e;
+      });
+}
diff --git a/packages/test-es-module-consumer/test-default-as.mjs b/packages/test-es-module-consumer/test-default-as.mjs
@@ -0,0 +1,4 @@
+import { simpleGit, ResetMode } from 'simple-git';
+import { suite } from './suite.mjs';
+
+await suite('import named', simpleGit, ResetMode);
diff --git a/packages/test-es-module-consumer/test-default.mjs b/packages/test-es-module-consumer/test-default.mjs
@@ -0,0 +1,4 @@
+import simpleGit, { ResetMode } from 'simple-git';
+import { suite } from './suite.mjs';
+
+await suite('import default', simpleGit, ResetMode);
diff --git a/packages/test-es-module-consumer/test-named.mjs b/packages/test-es-module-consumer/test-named.mjs
@@ -0,0 +1,4 @@
+import { default as simpleGit, ResetMode } from 'simple-git';
+import { suite } from './suite.mjs';
+
+await suite('import default-as', simpleGit, ResetMode);
diff --git a/packages/test-es-module-consumer/test.mjs b/packages/test-es-module-consumer/test.mjs
@@ -1,27 +1,3 @@
-import { strictEqual } from 'assert';
-import simpleGit, { ResetMode } from 'simple-git';
-
-exec('imports default', async () => {
-   strictEqual(
-      await simpleGit().checkIsRepo(),
-      true,
-      'expected the current directory to be a valid git root',
-   );
-});
-
-exec('imports named exports', async () => {
-   strictEqual(
-      /hard/.test(ResetMode.HARD),
-      true,
-      'expected valid ResetMode enum'
-   );
-});
-
-function exec (name, runner) {
-   runner()
-      .then(() => console.log(`${ name }: OK`))
-      .catch((e) => {
-         console.error(`${ name }: ${ e.message }`);
-         throw e;
-      });
-}
+import './test-default.mjs';
+import './test-default-as.mjs';
+import './test-named.mjs';
diff --git a/packages/test-javascript-consumer/suite.js b/packages/test-javascript-consumer/suite.js
@@ -0,0 +1,30 @@
+const {strictEqual} = require('assert');
+
+module.exports = {
+   async suite (name, simpleGit, ResetMode) {
+      exec(`${ name }: imports default`, async () => {
+         strictEqual(
+            await simpleGit().checkIsRepo(),
+            true,
+            'expected the current directory to be a valid git root',
+         );
+      });
+
+      exec(`${ name }: imports named exports`, async () => {
+         strictEqual(
+            /hard/.test(ResetMode.HARD),
+            true,
+            'expected valid ResetMode enum'
+         );
+      });
+   }
+};
+
+function exec (name, runner) {
+   runner()
+      .then(() => console.log(`${ name }: OK`))
+      .catch((e) => {
+         console.error(`${ name }: ${ e.message }`);
+         throw e;
+      });
+}
diff --git a/packages/test-javascript-consumer/test-default-as.js b/packages/test-javascript-consumer/test-default-as.js
@@ -0,0 +1,6 @@
+const {default: simpleGit, ResetMode} = require('simple-git');
+const {suite} = require('./suite');
+
+(async () => {
+   await suite('require default-as', simpleGit, ResetMode);
+})();
diff --git a/packages/test-javascript-consumer/test-default.js b/packages/test-javascript-consumer/test-default.js
@@ -1,27 +1,7 @@
-const {default: simpleGit, ResetMode} = require('simple-git');
-const {strictEqual} = require("assert");
+const simpleGit = require('simple-git');
+const {suite} = require('./suite');
 
-exec('requires default', async () => {
-   strictEqual(
-      await simpleGit().checkIsRepo(),
-      true,
-      'expected the current directory to be a valid git root',
-   );
-});
+(async () => {
+   await suite('require default', simpleGit, simpleGit.ResetMode);
+})();
 
-exec('imports named exports', async () => {
-   strictEqual(
-      /hard/.test(ResetMode.HARD),
-      true,
-      'expected valid ResetMode enum'
-   );
-});
-
-function exec (name, runner) {
-   runner()
-      .then(() => console.log(`${ name }: OK`))
-      .catch((e) => {
-         console.error(`${ name }: ${ e.message }`);
-         throw e;
-      });
-}
diff --git a/packages/test-javascript-consumer/test-named.js b/packages/test-javascript-consumer/test-named.js
@@ -0,0 +1,7 @@
+const {simpleGit, ResetMode} = require('simple-git');
+const {suite} = require('./suite');
+
+(async () => {
+   await suite('require named', simpleGit, ResetMode);
+})();
+
diff --git a/packages/test-javascript-consumer/test.js b/packages/test-javascript-consumer/test.js
@@ -1,27 +1,3 @@
-const simpleGit = require('simple-git');
-const {strictEqual} = require("assert");
-
-exec('requires default', async () => {
-   strictEqual(
-      await simpleGit().checkIsRepo(),
-      true,
-      'expected the current directory to be a valid git root',
-   );
-});
-
-exec('imports named exports', async () => {
-   strictEqual(
-      /hard/.test(simpleGit.ResetMode.HARD),
-      true,
-      'expected valid ResetMode enum'
-   );
-});
-
-function exec (name, runner) {
-   runner()
-      .then(() => console.log(`${ name }: OK`))
-      .catch((e) => {
-         console.error(`${ name }: ${ e.message }`);
-         throw e;
-      });
-}
+require('./test-default');
+require('./test-default-as');
+require('./test-named');
diff --git a/packages/test-typescript-consumer/test/ts-default-from-root.spec.ts b/packages/test-typescript-consumer/test/ts-default-from-root.spec.ts
@@ -1,8 +1,8 @@
-import simpleGit, { gitP, CleanOptions, SimpleGit, TaskConfigurationError } from 'simple-git';
+import { simpleGit, CleanOptions, SimpleGit, TaskConfigurationError } from 'simple-git';
 
 describe('simple-git', () => {
 
-   describe('default export', () => {
+   describe('named export', () => {
       it('is the simple-git factory', async () => {
          expect(await simpleGit().checkIsRepo()).toBe(true);
       });
@@ -14,28 +14,6 @@ describe('simple-git', () => {
       });
    });
 
-   describe('gitP export', () => {
-      it('is the simple-git factory', async () => {
-         expect(await gitP().checkIsRepo()).toBe(true);
-      });
-
-      it('builds exported types', async () => {
-         const git: SimpleGit = gitP();
-
-         expect(git).not.toBeUndefined();
-      });
-   });
-
-   it('default export is the simple-git factory', async () => {
-      expect(await simpleGit().checkIsRepo()).toBe(true);
-   });
-
-   it('named type exports', async () => {
-      const git: SimpleGit = simpleGit();
-
-      expect(git).not.toBeUndefined();
-   });
-
    it('named class constructors', async () => {
       expect(new TaskConfigurationError('foo')).toBeInstanceOf(TaskConfigurationError);
    });
diff --git a/packages/test-typescript-consumer/test/ts-named-import.spec.ts b/packages/test-typescript-consumer/test/ts-named-import.spec.ts
@@ -0,0 +1,47 @@
+import simpleGit, { gitP, CleanOptions, SimpleGit, TaskConfigurationError } from 'simple-git';
+
+describe('simple-git', () => {
+
+   describe('default export', () => {
+      it('is the simple-git factory', async () => {
+         expect(await simpleGit().checkIsRepo()).toBe(true);
+      });
+
+      it('builds exported types', async () => {
+         const git: SimpleGit = simpleGit();
+
+         expect(git).not.toBeUndefined();
+      });
+   });
+
+   describe('gitP export', () => {
+      it('is the simple-git factory', async () => {
+         expect(await gitP().checkIsRepo()).toBe(true);
+      });
+
+      it('builds exported types', async () => {
+         const git: SimpleGit = gitP();
+
+         expect(git).not.toBeUndefined();
+      });
+   });
+
+   it('default export is the simple-git factory', async () => {
+      expect(await simpleGit().checkIsRepo()).toBe(true);
+   });
+
+   it('named type exports', async () => {
+      const git: SimpleGit = simpleGit();
+
+      expect(git).not.toBeUndefined();
+   });
+
+   it('named class constructors', async () => {
+      expect(new TaskConfigurationError('foo')).toBeInstanceOf(TaskConfigurationError);
+   });
+
+   it('named enums', async () => {
+      expect(CleanOptions.DRY_RUN).toBe('n');
+   });
+
+});
diff --git a/packages/test-typescript-esm-consumer/babel.config.js b/packages/test-typescript-esm-consumer/babel.config.js
@@ -0,0 +1 @@
+module.exports = require('@simple-git/babel-config')(true);
diff --git a/packages/test-typescript-esm-consumer/package.json b/packages/test-typescript-esm-consumer/package.json
@@ -0,0 +1,25 @@
+{
+  "name": "@simple-git/test-typescript-esm-consumer",
+  "private": true,
+  "version": "1.0.0",
+  "jest": {
+    "roots": [
+      "<rootDir>/test/"
+    ],
+    "testMatch": [
+      "**/test/*.spec.ts"
+    ]
+  },
+  "scripts": {
+    "test": "jest"
+  },
+  "dependencies": {
+    "@simple-git/babel-config": "^1.0.0",
+    "simple-git": "^3.0.0"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/steveukx/git-js.git",
+    "directory": "packages/test-typescript-consumer"
+  }
+}
diff --git a/packages/test-typescript-esm-consumer/test/ts-default-renamed-import.spec.ts b/packages/test-typescript-esm-consumer/test/ts-default-renamed-import.spec.ts
@@ -0,0 +1,31 @@
+import { default as simpleGit, CleanOptions, SimpleGit, TaskConfigurationError } from 'simple-git';
+
+describe('simple-git', () => {
+
+   describe('renamed default export', () => {
+      it('is the simple-git factory', async () => {
+         expect(await simpleGit().checkIsRepo()).toBe(true);
+      });
+
+      it('builds exported types', async () => {
+         const git: SimpleGit = simpleGit();
+
+         expect(git).not.toBeUndefined();
+      });
+   });
+
+   it('named type exports', async () => {
+      const git: SimpleGit = simpleGit();
+
+      expect(git).not.toBeUndefined();
+   });
+
+   it('named class constructors', async () => {
+      expect(new TaskConfigurationError('foo')).toBeInstanceOf(TaskConfigurationError);
+   });
+
+   it('named enums', async () => {
+      expect(CleanOptions.DRY_RUN).toBe('n');
+   });
+
+});
diff --git a/packages/test-typescript-esm-consumer/test/ts-named-import.spec.ts b/packages/test-typescript-esm-consumer/test/ts-named-import.spec.ts
@@ -0,0 +1,31 @@
+import { simpleGit, CleanOptions, SimpleGit, TaskConfigurationError } from 'simple-git';
+
+describe('simple-git', () => {
+
+   describe('named export', () => {
+      it('is the simple-git factory', async () => {
+         expect(await simpleGit().checkIsRepo()).toBe(true);
+      });
+
+      it('builds exported types', async () => {
+         const git: SimpleGit = simpleGit();
+
+         expect(git).not.toBeUndefined();
+      });
+   });
+
+   it('named type exports', async () => {
+      const git: SimpleGit = simpleGit();
+
+      expect(git).not.toBeUndefined();
+   });
+
+   it('named class constructors', async () => {
+      expect(new TaskConfigurationError('foo')).toBeInstanceOf(TaskConfigurationError);
+   });
+
+   it('named enums', async () => {
+      expect(CleanOptions.DRY_RUN).toBe('n');
+   });
+
+});
diff --git a/packages/test-typescript-esm-consumer/tsconfig.json b/packages/test-typescript-esm-consumer/tsconfig.json
@@ -0,0 +1,22 @@
+{
+  "compilerOptions": {
+    "target": "es2020",
+    "module": "node16",
+    "moduleResolution": "node16",
+    "noEmit": true,
+    "allowSyntheticDefaultImports": true,
+    "baseUrl": ".",
+//    "emitDecoratorMetadata": true,
+//    "experimentalDecorators": true,
+//    "forceConsistentCasingInFileNames": true,
+//    "incremental": true,
+//    "noFallthroughCasesInSwitch": false,
+//    "noImplicitAny": false,
+//    "outDir": "./dist",
+//    "removeComments": true,
+//    "skipLibCheck": true,
+//    "sourceMap": true,
+//    "strictBindCallApply": true,
+//    "strictNullChecks": false,
+  }
+}
diff --git a/simple-git/package.json b/simple-git/package.json
diff --git a/simple-git/src/esm.mjs b/simple-git/src/esm.mjs
diff --git a/simple-git/src/index.js b/simple-git/src/index.js
diff --git a/simple-git/src/lib/api.ts b/simple-git/src/lib/api.ts
diff --git a/simple-git/src/lib/git-factory.ts b/simple-git/src/lib/git-factory.ts
diff --git a/simple-git/src/lib/plugins/completion-detection.plugin.ts b/simple-git/src/lib/plugins/completion-detection.plugin.ts
diff --git a/simple-git/src/lib/runners/git-executor-chain.ts b/simple-git/src/lib/runners/git-executor-chain.ts
diff --git a/simple-git/typings/index.d.ts b/simple-git/typings/index.d.ts
diff --git a/yarn.lock b/yarn.lock
