Merge pull request #841 from steveukx/feat/remove-legacy-promise

Fully deprecate legacy /promise interface
steveukx · Aug 13, 2022 · a975980 · a975980
2 parents a6168ae + 87b0d75
commit a975980
Show file tree

Hide file tree

Showing 25 changed files with 111 additions and 606 deletions.
diff --git a/.changeset/friendly-apples-watch.md b/.changeset/friendly-apples-watch.md
@@ -0,0 +1,5 @@
+---
+"simple-git": minor
+---
+
+Increase the level of deprecation notices for use of `simple-git/promise`, which will be fully removed in the next major
diff --git a/packages/test-typescript-consumer/package.json b/packages/test-typescript-consumer/package.json
@@ -12,7 +12,7 @@
   },
   "scripts": {
     "test": "yarn test:types && yarn test:jest",
-    "test:types": "tsc -p tsconfig-standard.json && tsc -p tsconfig-promise.json",
+    "test:types": "tsc",
     "test:jest": "jest"
   },
   "dependencies": {

diff --git a/packages/test-typescript-consumer/test/ts-promise-consumer.spec.ts b/packages/test-typescript-consumer/test/ts-promise-consumer.spec.ts
diff --git a/packages/test-typescript-consumer/tsconfig-promise.json b/packages/test-typescript-consumer/tsconfig-promise.json
diff --git a/packages/test-typescript-consumer/tsconfig-standard.json b/packages/test-typescript-consumer/tsconfig-standard.json
diff --git a/packages/test-typescript-consumer/tsconfig.json b/packages/test-typescript-consumer/tsconfig.json
@@ -5,8 +5,10 @@
     "moduleResolution": "Node",
     "noEmit": true,
     "composite": false,
-    "esModuleInterop": true,
     "baseUrl": ".",
-    "paths": {}
-  }
+    "paths": {},
+    "esModuleInterop": false,
+    "allowSyntheticDefaultImports": false
+  },
+  "files": ["test/ts-default-from-root.spec.ts"]
 }
diff --git a/simple-git/promise.d.ts b/simple-git/promise.d.ts
diff --git a/simple-git/promise.js b/simple-git/promise.js
@@ -1,8 +1,7 @@
-// TODO: deprecation warning
-console.warn(`=============================================
+console.error(`=============================================
 simple-git has supported promises / async await since version 2.6.0.
- Importing from 'simple-git/promise' has been deprecated and will be
- removed by July 2022.
+ Importing from 'simple-git/promise' has been deprecated and will
+ report this error until the next major release of version 4.
 
 To upgrade, change all 'simple-git/promise' imports to just 'simple-git'
 =============================================`);

diff --git a/simple-git/test/__fixtures__/instance.ts b/simple-git/test/__fixtures__/instance.ts
@@ -4,10 +4,3 @@ export function newSimpleGit(...args: [] | [string] | [Partial<SimpleGitOptions>
    const simpleGit = require('../..');
    return simpleGit(...args);
 }
-
-export function newSimpleGitP(baseDir: unknown | string = '/tmp/example-repo') {
-   if (typeof baseDir !== 'string') {
-      throw new Error('Bad arguments to newSimpleGitP');
-   }
-   return require('../../promise')(baseDir);
-}
diff --git a/simple-git/test/consumer/ts-default-from-root.spec.ts b/simple-git/test/consumer/ts-default-from-root.spec.ts
diff --git a/simple-git/test/consumer/ts-gitp-from-root.spec.ts b/simple-git/test/consumer/ts-gitp-from-root.spec.ts
diff --git a/simple-git/test/consumer/ts-promise-consumer.spec.ts b/simple-git/test/consumer/ts-promise-consumer.spec.ts
diff --git a/simple-git/test/consumer/tsconfig-promise.json b/simple-git/test/consumer/tsconfig-promise.json
diff --git a/simple-git/test/consumer/tsconfig-standard.json b/simple-git/test/consumer/tsconfig-standard.json
diff --git a/simple-git/test/integration/bad-initial-path.spec.ts b/simple-git/test/integration/bad-initial-path.spec.ts
@@ -1,10 +1,8 @@
-import { promiseError } from '@kwsites/promise-result';
 import {
    assertGitError,
    createTestContext,
    like,
    newSimpleGit,
-   newSimpleGitP,
    SimpleGitTestContext,
 } from '../__fixtures__';
 
@@ -15,24 +13,10 @@ describe('bad initial path', () => {
 
    beforeEach(async () => (context = await createTestContext()));
 
-   it('simple-git/promise', async () => {
-      const baseDir = context.path('foo');
-      const git = newSimpleGitP(baseDir);
-
-      const errorInstance = await promiseError(git.init());
-      assertGitError(errorInstance, `does not exist`, GitConstructError);
-      expect(errorInstance).toHaveProperty(
-         'config',
-         like({
-            baseDir,
-         })
-      );
-   });
-
    it('simple-git', async () => {
       const baseDir = context.path('foo');
 
-      let errorInstance: Error | undefined;
+      let errorInstance: Error | unknown;
       try {
          newSimpleGit(baseDir);
       } catch (e) {