feat: prepare run() for async use with ESM

README.md

@@ -55,7 +55,7 @@ Create a script, for example `scripts/check-package.js`. Add it in `"scripts"` i
 
 const { createCheckPackage } = require('check-package-dependencies');
 
-createCheckPackage(/* '.' */)
+await createCheckPackage(/* '.' */)
   // Check that your package.json contains only exact versions of package, not range.
   .checkExactVersions({
     // When isLibrary is true, it doesnt check "dependencies" as they should mostly have a range, not an exact version
@@ -110,18 +110,20 @@ createCheckPackage(/* '.' */)
         devDependencies: ['react-test-renderer'],
       },
     },
-  });
+  })
+  .run();
 ```
 
 ```js
 'use script';
 
 const { createCheckPackage } = require('check-package-dependencies');
 
-createCheckPackage(/* '.' */)
+await createCheckPackage(/* '.' */)
   // Call .checkExactVersions(), checkDirectPeerDependencies(), checkDirectDuplicateDependencies()
   // checkResolutionsVersionsMatch() and checkResolutionsHasExplanation()
-  .checkRecommended({});
+  .checkRecommended({})
+  .run();
 ```
 
 If you use workspaces:
@@ -133,7 +135,7 @@ const {
   createCheckPackageWithWorkspaces,
 } = require('check-package-dependencies');
 
-createCheckPackageWithWorkspaces()
+await createCheckPackageWithWorkspaces()
   // Call .checkExactVersions(), checkDirectPeerDependencies(), checkDirectDuplicateDependencies()
   // checkResolutionsVersionsMatch() and checkResolutionsHasExplanation() for root package and workspaces packages, but also
   // checks your workspaces packages doesn't have different versions than the ones in devDependencies of root packages.
@@ -147,5 +149,6 @@ createCheckPackageWithWorkspaces()
   })
   .for('packageName', (pkgCheck) => {
     /* pkgCheck has the same API presented for single package */
-  });
+  })
+  .run();
 ```

scripts/check-package.mjs

@@ -1,8 +1,10 @@
 import { createCheckPackage } from '../dist/index-node14.cjs.js';
 
-createCheckPackage(undefined, { tryToAutoFix: true }).checkRecommended({
-  isLibrary: true,
-  onlyWarnsForInDependencies: {
-    '@babel/core': { duplicateDirectDependency: ['semver'] },
-  },
-});
+await createCheckPackage(undefined, { tryToAutoFix: true })
+  .checkRecommended({
+    isLibrary: true,
+    onlyWarnsForInDependencies: {
+      '@babel/core': { duplicateDirectDependency: ['semver'] },
+    },
+  })
+  .run();

src/check-package-with-workspaces.ts

@@ -54,6 +54,8 @@ export interface CheckPackageWithWorkspacesRecommendedOptions {
 }
 
 export interface CheckPackageWithWorkspacesApi {
+  run: () => Promise<void>;
+
   checkRecommended: (
     options?: CheckPackageWithWorkspacesRecommendedOptions,
   ) => CheckPackageWithWorkspacesApi;
@@ -113,7 +115,24 @@ export function createCheckPackageWithWorkspaces(
     }),
   );
 
+  let runCalled = false;
+
+  process.on('beforeExit', () => {
+    if (!runCalled) {
+      console.warn('\nFor future compatibility, call .run()');
+    }
+  });
+
   return {
+    async run() {
+      runCalled = true;
+      await Promise.all(
+        [...checksWorkspaces.values()].map((checksWorkspace) =>
+          checksWorkspace.run(),
+        ),
+      );
+    },
+
     checkRecommended({
       isLibrary = () => false,
       allowRangeVersionsInLibraries = true,

src/check-package.ts

@@ -91,6 +91,8 @@ export interface CheckExactVersionsOptions {
 }
 
 export interface CheckPackageApi {
+  run: () => Promise<void>;
+
   /** @internal */
   pkg: PackageJson;
   /** @internal */
@@ -197,7 +199,22 @@ export function createCheckPackage(
     pkgDirname,
   });
 
+  let runCalled = false;
+
+  process.on('beforeExit', () => {
+    if (!runCalled) {
+      console.warn(
+        '\nFor future compatibility, call .run() and await the result.',
+      );
+    }
+  });
+
   return {
+    run() {
+      runCalled = true;
+      return Promise.resolve();
+    },
+
     pkg,
     pkgDirname,
     pkgPathName,