Merge branch 'open-cli-tools:main' into main

.github/workflows/test.yml

@@ -55,9 +55,13 @@ jobs:
       - name: Install dependencies
         run: pnpm install && pnpm add --global concurrently
 
-      - name: Build & Test
+      - name: Build & Unit Test
         run: concurrently --prefix none --group "pnpm:build" "pnpm:test"
 
+      - name: Smoke Test
+        # Don't collect coverage here as it overrides the unit test's coverage
+        run: pnpm test:smoke --coverage=false
+
       - name: Submit coverage
         uses: coverallsapp/github-action@master
         continue-on-error: true

.gitignore

@@ -1,5 +1,5 @@
 # Outputs
-/dist
+dist
 
 # Logs
 *.log

bin/concurrently.ts

@@ -3,7 +3,7 @@ import yargs from 'yargs';
 import { hideBin } from 'yargs/helpers';
 
 import * as defaults from '../src/defaults';
-import concurrently from '../src/index';
+import { concurrently } from '../src/index';
 import { epilogue } from './epilogue';
 
 // Clean-up arguments (yargs expects only the arguments after the program name)

index.d.mts

@@ -0,0 +1,7 @@
+/*
+ * While in local development, make sure you've run `pnpm run build` first.
+ */
+import { concurrently } from './dist/src/index.js';
+
+export * from './dist/src/index.js';
+export default concurrently;

index.d.ts

@@ -0,0 +1,11 @@
+/*
+ * While in local development, make sure you've run `pnpm run build` first.
+ */
+import { concurrently } from './dist/src/index.js';
+
+export * from './dist/src/index.js';
+// @ts-expect-error ignore the usage of `export =` along with `export default`.
+// This is seemingly fine, but the file needs to be included in the TS project, which can't be done
+// due to importing from `dist`. See https://stackoverflow.com/q/42609768/2083599
+export = concurrently;
+export default concurrently;

index.js

@@ -5,5 +5,10 @@
 // eslint-disable-next-line @typescript-eslint/no-var-requires
 const concurrently = require('./dist/src/index.js');
 
-module.exports = exports = concurrently.default;
+// For require()
+module.exports = exports = concurrently.concurrently;
+
+// For TS + import syntax; mimics `export default`
+exports.default = exports;
+
 Object.assign(exports, concurrently);

index.mjs

@@ -2,9 +2,9 @@
  * While in local development, make sure you've run `pnpm run build` first.
  */
 
-import concurrently from './dist/src/index.js';
+import { concurrently } from './dist/src/index.js';
 
 // NOTE: the star reexport doesn't work in Node <12.20, <14.13 and <15.
 export * from './dist/src/index.js';
 
-export default concurrently.default;
+export default concurrently;

jest.config.js

@@ -1,11 +1,30 @@
-/** @type {import('@jest/types').Config.InitialOptions} */
-const config = {
+// Need to extend from a base config because projects don't inherit configurations as documented
+// https://github.com/jestjs/jest/issues/11411
+/** @type {import('@jest/types').Config.InitialProjectOptions} */
+const baseConfig = {
     transform: {
-        '^.+\\.(t|j)sx?$': ['@swc/jest'],
+        '.*': ['@swc/jest'],
     },
-    collectCoverage: true,
-    collectCoverageFrom: ['src/**/*.ts', '!src/index.ts'],
     testPathIgnorePatterns: ['/node_modules/', '/dist'],
 };
 
+/** @type {import('@jest/types').Config.InitialOptions} */
+const config = {
+    collectCoverage: true,
+    projects: [
+        {
+            ...baseConfig,
+            displayName: 'unit',
+            collectCoverageFrom: ['src/**/*.ts', '!src/index.ts'],
+            // (src|bin) doesn't seem to work on Windows
+            testMatch: ['src', 'bin'].map((dir) => `<rootDir>/${dir}/**/*.spec.ts`),
+        },
+        {
+            ...baseConfig,
+            displayName: 'smoke',
+            testMatch: ['<rootDir>/tests/**/*.spec.ts'],
+        },
+    ],
+};
+
 module.exports = config;

package.json

@@ -3,7 +3,7 @@
   "version": "8.2.2",
   "description": "Run commands concurrently",
   "main": "index.js",
-  "types": "dist/src/index.d.ts",
+  "types": "index.d.ts",
   "type": "commonjs",
   "bin": {
     "concurrently": "./dist/bin/concurrently.js",
@@ -14,10 +14,14 @@
   },
   "exports": {
     ".": {
-      "types": "./dist/src/index.d.ts",
-      "import": "./index.mjs",
-      "require": "./index.js",
-      "default": "./index.js"
+      "import": {
+        "types": "./index.d.mts",
+        "default": "./index.mjs"
+      },
+      "require": {
+        "types": "./index.d.ts",
+        "default": "./index.js"
+      }
     },
     "./package.json": "./package.json"
   },
@@ -31,7 +35,8 @@
     "lint:fix": "pnpm run lint --fix",
     "prepublishOnly": "safe-publish-latest && pnpm run build",
     "report-coverage": "cat coverage/lcov.info | coveralls",
-    "test": "jest",
+    "test": "jest --selectProjects unit",
+    "test:smoke": "jest --selectProjects smoke",
     "prepare": "husky install"
   },
   "repository": {
@@ -94,7 +99,9 @@
   "files": [
     "dist",
     "index.js",
+    "index.d.ts",
     "index.mjs",
+    "index.d.mts",
     "!**/fixtures",
     "!**/*.spec.js",
     "!**/*.spec.d.ts"

src/index.ts

@@ -2,7 +2,7 @@ import { Readable } from 'stream';
 
 import { CloseEvent, Command, CommandIdentifier, TimerEvent } from './command';
 import {
-    concurrently,
+    concurrently as createConcurrently,
     ConcurrentlyCommandInput,
     ConcurrentlyOptions as BaseConcurrentlyOptions,
     ConcurrentlyResult,
@@ -91,10 +91,10 @@ export type ConcurrentlyOptions = BaseConcurrentlyOptions & {
     additionalArguments?: string[];
 };
 
-export default (
+export function concurrently(
     commands: ConcurrentlyCommandInput[],
     options: Partial<ConcurrentlyOptions> = {},
-) => {
+) {
     const logger = new Logger({
         hide: options.hide,
         prefixFormat: options.prefix,
@@ -103,7 +103,7 @@ export default (
         timestampFormat: options.timestampFormat,
     });
 
-    return concurrently(commands, {
+    return createConcurrently(commands, {
         maxProcesses: options.maxProcesses,
         raw: options.raw,
         successCondition: options.successCondition,
@@ -141,28 +141,26 @@ export default (
         prefixColors: options.prefixColors || [],
         additionalArguments: options.additionalArguments,
     });
-};
+}
 
 // Export all flow controllers, types, and the main concurrently function,
 // so that 3rd-parties can use them however they want
+
+// Main
+export { ConcurrentlyCommandInput, ConcurrentlyResult, createConcurrently, Logger };
+
+// Command specific
+export { CloseEvent, Command, CommandIdentifier, TimerEvent };
+
+// Flow controllers
 export {
-    CloseEvent,
-    // Command specific
-    Command,
-    CommandIdentifier,
-    concurrently,
-    ConcurrentlyCommandInput,
-    ConcurrentlyResult,
-    // Flow controllers
     FlowController,
     InputHandler,
     KillOnSignal,
     KillOthers,
     LogError,
     LogExit,
-    Logger,
     LogOutput,
     LogTimings,
     RestartProcess,
-    TimerEvent,
 };

tests/cjs-import/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

tests/cjs-import/smoke-test.ts

@@ -0,0 +1,15 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import type { ConcurrentlyResult } from 'concurrently';
+import concurrently, { concurrently as concurrently2, createConcurrently } from 'concurrently';
+
+const result: ConcurrentlyResult = concurrently(['ls'], {
+    raw: true,
+});
+
+const result2: ConcurrentlyResult = concurrently2(['ls'], {
+    killOthers: ['failure'],
+});
+
+const result3: ConcurrentlyResult = createConcurrently(['ls'], {
+    successCondition: 'all',
+});

tests/cjs-import/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "outDir": "dist",
+    "module": "CommonJS",
+    "moduleResolution": "Node",
+    "skipLibCheck": true
+  }
+}

tests/cjs-require/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "commonjs"
+}

tests/cjs-require/smoke-test.ts

@@ -0,0 +1,17 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+
+import concurrently = require('concurrently');
+
+const { concurrently: concurrently2, createConcurrently } = concurrently;
+
+const result: concurrently.ConcurrentlyResult = concurrently(['ls'], {
+    raw: true,
+});
+
+const result2: concurrently.ConcurrentlyResult = concurrently2(['ls'], {
+    killOthers: ['failure'],
+});
+
+const result3: concurrently.ConcurrentlyResult = createConcurrently(['ls'], {
+    successCondition: 'all',
+});

tests/cjs-require/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "outDir": "dist",
+    "module": "CommonJS",
+    "moduleResolution": "Node",
+    "skipLibCheck": true
+  }
+}

tests/esm/package.json

@@ -0,0 +1,3 @@
+{
+  "type": "module"
+}

tests/esm/smoke-test.ts

@@ -0,0 +1,15 @@
+/* eslint-disable @typescript-eslint/no-unused-vars */
+import type { ConcurrentlyResult } from 'concurrently';
+import concurrently, { concurrently as concurrently2, createConcurrently } from 'concurrently';
+
+const result: ConcurrentlyResult = concurrently(['ls'], {
+    raw: true,
+});
+
+const result2: ConcurrentlyResult = concurrently2(['ls'], {
+    killOthers: ['failure'],
+});
+
+const result3: ConcurrentlyResult = createConcurrently(['ls'], {
+    successCondition: 'all',
+});

tests/esm/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "compilerOptions": {
+    "outDir": "dist",
+    "module": "Node16",
+    "moduleResolution": "Node16"
+  }
+}

tests/package.json

@@ -0,0 +1,8 @@
+{
+  "dependencies": {
+    "concurrently": "file:.."
+  },
+  "scripts": {
+    "test": "pnpm --prefix .. test -- --selectProjects smoke"
+  }
+}