better-console-group 1.1.4 → 1.1.6

package/.cursor/rules/agent-workflow.mdc

@@ -0,0 +1,37 @@
+---
+description: Setup and validation commands required for this repository.
+alwaysApply: true
+---
+
+# Agent Instructions
+
+These instructions apply to all coding agents in this repository (Cursor, Claude Code, Codex).
+
+## Required setup command
+
+After opening or setting up the project, run:
+
+```bash
+yarn
+```
+
+## Required validation command
+
+After making changes, run:
+
+```bash
+yarn format && yarn lint --fix && yarn build && yarn flow && yarn test
+```
+
+Do not treat work as complete until the validation command succeeds. If it fails, fix the issues and run it again.
+
+## Pull Request issues
+
+**Failed tests**: When the user mentions failed tests, fetch the PR's failed checks and inspect the relevant workflow runs. The `link` field contains the run ID in the format `.../actions/runs/<RUN_ID>/jobs/...`:
+
+```bash
+gh pr checks <PR_NUMBER> --json name,state,link
+gh run view <RUN_ID> --log-failed
+```
+
+**Review comments**: When the user mentions comments, use `gh api graphql` to query `pullRequest.reviewThreads` and focus on threads where `isResolved` is `false`. The REST API does not expose resolution state — GraphQL `PullRequestReviewThread.isResolved` is required.

package/.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules

package/AGENTS.md

@@ -0,0 +1,32 @@
+# Agent Instructions
+
+These instructions apply to all coding agents in this repository (Cursor, Claude Code, Codex).
+
+## Required setup command
+
+After opening or setting up the project, run:
+
+```bash
+yarn
+```
+
+## Required validation command
+
+After making changes, run:
+
+```bash
+yarn format && yarn lint --fix && yarn build && yarn flow && yarn test
+```
+
+Do not treat work as complete until the validation command succeeds. If it fails, fix the issues and run it again.
+
+## Pull Request issues
+
+**Failed tests**: When the user mentions failed tests, fetch the PR's failed checks and inspect the relevant workflow runs. The `link` field contains the run ID in the format `.../actions/runs/<RUN_ID>/jobs/...`:
+
+```bash
+gh pr checks <PR_NUMBER> --json name,state,link
+gh run view <RUN_ID> --log-failed
+```
+
+**Review comments**: When the user mentions comments, use `gh api graphql` to query `pullRequest.reviewThreads` and focus on threads where `isResolved` is `false`. The REST API does not expose resolution state — GraphQL `PullRequestReviewThread.isResolved` is required.

package/CLAUDE.md

@@ -0,0 +1,32 @@
+# Agent Instructions
+
+These instructions apply to all coding agents in this repository (Cursor, Claude Code, Codex).
+
+## Required setup command
+
+After opening or setting up the project, run:
+
+```bash
+yarn
+```
+
+## Required validation command
+
+After making changes, run:
+
+```bash
+yarn format && yarn lint --fix && yarn build && yarn flow && yarn test
+```
+
+Do not treat work as complete until the validation command succeeds. If it fails, fix the issues and run it again.
+
+## Pull Request issues
+
+**Failed tests**: When the user mentions failed tests, fetch the PR's failed checks and inspect the relevant workflow runs. The `link` field contains the run ID in the format `.../actions/runs/<RUN_ID>/jobs/...`:
+
+```bash
+gh pr checks <PR_NUMBER> --json name,state,link
+gh run view <RUN_ID> --log-failed
+```
+
+**Review comments**: When the user mentions comments, use `gh api graphql` to query `pullRequest.reviewThreads` and focus on threads where `isResolved` is `false`. The REST API does not expose resolution state — GraphQL `PullRequestReviewThread.isResolved` is required.

package/README.md

@@ -134,7 +134,7 @@ for (let imageURL in imageURLs) {
       });
     }
 
-    group.log('Finish processing image.');=
+    group.log('Finish processing image.');
   });
   processingPromises.push(processingPromise);
 }

package/index.js.flow

@@ -1,5 +1,30 @@
+declare class AsyncConsoleGroup {
+  asyncGroup<T>(
+    label: string,
+    callbackFn: (group: AsyncConsoleGroup) => Promise<T>,
+    thisArg?: any,
+  ): Promise<T>;
+  log(message?: any, ...optionalParams: any[]): void;
+  warn(message?: any, ...optionalParams: any[]): void;
+  error(message?: any, ...optionalParams: any[]): void;
+  debug(message?: any, ...optionalParams: any[]): void;
+  info(message?: any, ...optionalParams: any[]): void;
+  table(tabularData?: any, properties?: Array<string>): void;
+  trace(...data: any[]): void;
+  assert(condition?: boolean, message?: string, ...optionalParams: any[]): void;
+  time(label?: string): void;
+  timeEnd(label?: string): void;
+  dir(item?: any, options?: { ... }): void;
+}
+
 declare export function betterGroup<T>(
   label: string,
   callbackFn: () => T,
   thisArg?: any,
 ): T;
+
+declare export function asyncGroup<T>(
+  label: string,
+  callbackFn: (group: AsyncConsoleGroup) => Promise<T>,
+  thisArg?: any,
+): Promise<T>;

package/lib/BetterConsoleGroup.d.ts

@@ -0,0 +1,2 @@
+export * from './betterGroup.ts';
+export * from './asyncGroup.ts';

package/lib/BetterConsoleGroup.js

@@ -0,0 +1,2 @@
+export * from "./betterGroup.js";
+export * from "./asyncGroup.js";

package/lib/asyncGroup.js

@@ -1,24 +1,3 @@
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
-var __classPrivateFieldSet = (this && this.__classPrivateFieldSet) || function (receiver, state, value, kind, f) {
-    if (kind === "m") throw new TypeError("Private method is not writable");
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a setter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot write private member to an object whose class did not declare it");
-    return (kind === "a" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;
-};
-var __classPrivateFieldGet = (this && this.__classPrivateFieldGet) || function (receiver, state, kind, f) {
-    if (kind === "a" && !f) throw new TypeError("Private accessor was defined without a getter");
-    if (typeof state === "function" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError("Cannot read private member from an object whose class did not declare it");
-    return kind === "m" ? f : kind === "a" ? f.call(receiver) : f ? f.value : state.get(receiver);
-};
-var _AsyncConsoleGroup_instances, _AsyncConsoleGroup_buffer, _AsyncConsoleGroup_ended, _AsyncConsoleGroup_push;
 /**
  * A private class. Each of its instance represents a grouping of console messages.
  * You will receive an instance of this class when you call asyncGroup.
@@ -29,11 +8,15 @@ var _AsyncConsoleGroup_instances, _AsyncConsoleGroup_buffer, _AsyncConsoleGroup_
  * @param buffer The buffer that stores the console messages.
  */
 class AsyncConsoleGroup {
+    #buffer;
+    #ended = false;
     constructor(buffer) {
-        _AsyncConsoleGroup_instances.add(this);
-        _AsyncConsoleGroup_buffer.set(this, void 0);
-        _AsyncConsoleGroup_ended.set(this, false);
-        __classPrivateFieldSet(this, _AsyncConsoleGroup_buffer, buffer, "f");
+        this.#buffer = buffer;
+    }
+    #push(method, ...params) {
+        if (!this.#ended) {
+            this.#buffer.push([method, ...params]);
+        }
     }
     /**
      * Creates a new group nested inside the current group.
@@ -43,16 +26,14 @@ class AsyncConsoleGroup {
      * @template T The type of the value returned from the callback function.
      * @returns Anything returned from the callback function.
      */
-    asyncGroup(label, callbackFn, thisArg) {
-        return __awaiter(this, void 0, void 0, function* () {
-            const group = new AsyncConsoleGroup([]);
-            const result = yield callbackFn.call(thisArg !== null && thisArg !== void 0 ? thisArg : globalThis, group); // eslint-disable-line @typescript-eslint/no-unsafe-assignment
-            const buffer = group.end();
-            __classPrivateFieldGet(this, _AsyncConsoleGroup_buffer, "f").push(['group', label]);
-            __classPrivateFieldGet(this, _AsyncConsoleGroup_buffer, "f").push(...buffer);
-            __classPrivateFieldGet(this, _AsyncConsoleGroup_buffer, "f").push(['groupEnd']);
-            return result;
-        });
+    async asyncGroup(label, callbackFn, thisArg) {
+        const group = new AsyncConsoleGroup([]);
+        const result = await callbackFn.call(thisArg ?? globalThis, group);
+        const buffer = group.end();
+        this.#buffer.push(['group', label]);
+        this.#buffer.push(...buffer);
+        this.#buffer.push(['groupEnd']);
+        return result;
     }
     /**
      * Equivalent of console.log when used inside a group.
@@ -60,7 +41,7 @@ class AsyncConsoleGroup {
      * @param optionalParams Optional parameters to log.
      */
     log(message, ...optionalParams) {
-        __classPrivateFieldGet(this, _AsyncConsoleGroup_instances, "m", _AsyncConsoleGroup_push).call(this, 'log', message, ...optionalParams);
+        this.#push('log', message, ...optionalParams);
     }
     /**
      * Equivalent of console.warn when used inside a group.
@@ -68,7 +49,7 @@ class AsyncConsoleGroup {
      * @param optionalParams Optional parameters to log.
      */
     warn(message, ...optionalParams) {
-        __classPrivateFieldGet(this, _AsyncConsoleGroup_instances, "m", _AsyncConsoleGroup_push).call(this, 'warn', message, ...optionalParams);
+        this.#push('warn', message, ...optionalParams);
     }
     /**
      * Equivalent of console.error when used inside a group.
@@ -76,7 +57,7 @@ class AsyncConsoleGroup {
      * @param optionalParams Optional parameters to log.
      */
     error(message, ...optionalParams) {
-        __classPrivateFieldGet(this, _AsyncConsoleGroup_instances, "m", _AsyncConsoleGroup_push).call(this, 'error', message, ...optionalParams);
+        this.#push('error', message, ...optionalParams);
     }
     /**
      * Equivalent of console.debug when used inside a group.
@@ -84,7 +65,7 @@ class AsyncConsoleGroup {
      * @param optionalParams Optional parameters to log.
      */
     debug(message, ...optionalParams) {
-        __classPrivateFieldGet(this, _AsyncConsoleGroup_instances, "m", _AsyncConsoleGroup_push).call(this, 'debug', message, ...optionalParams);
+        this.#push('debug', message, ...optionalParams);
     }
     /**
      * Equivalent of console.info when used inside a group.
@@ -92,7 +73,7 @@ class AsyncConsoleGroup {
      * @param optionalParams Optional parameters to log.
      */
     info(message, ...optionalParams) {
-        __classPrivateFieldGet(this, _AsyncConsoleGroup_instances, "m", _AsyncConsoleGroup_push).call(this, 'info', message, ...optionalParams);
+        this.#push('info', message, ...optionalParams);
     }
     /**
      * Equivalent of console.table when used inside a group.
@@ -100,14 +81,14 @@ class AsyncConsoleGroup {
      * @param properties Optional list of property names to include in the table.
      */
     table(tabularData, properties) {
-        __classPrivateFieldGet(this, _AsyncConsoleGroup_instances, "m", _AsyncConsoleGroup_push).call(this, 'table', tabularData, properties);
+        this.#push('table', tabularData, properties);
     }
     /**
      * Equivalent of console.trace when used inside a group.
      * @param data Optional values to include with the stack trace output.
      */
     trace(...data) {
-        __classPrivateFieldGet(this, _AsyncConsoleGroup_instances, "m", _AsyncConsoleGroup_push).call(this, 'trace', ...data);
+        this.#push('trace', ...data);
     }
     /**
      * Equivalent of console.assert when used inside a group.
@@ -116,21 +97,21 @@ class AsyncConsoleGroup {
      * @param optionalParams Optional parameters to log when the assertion fails.
      */
     assert(condition, message, ...optionalParams) {
-        __classPrivateFieldGet(this, _AsyncConsoleGroup_instances, "m", _AsyncConsoleGroup_push).call(this, 'assert', condition, message, ...optionalParams);
+        this.#push('assert', condition, message, ...optionalParams);
     }
     /**
      * Equivalent of console.time when used inside a group.
      * @param label Optional timer label.
      */
     time(label) {
-        __classPrivateFieldGet(this, _AsyncConsoleGroup_instances, "m", _AsyncConsoleGroup_push).call(this, 'time', label);
+        this.#push('time', label);
     }
     /**
      * Equivalent of console.timeEnd when used inside a group.
      * @param label Optional timer label.
      */
     timeEnd(label) {
-        __classPrivateFieldGet(this, _AsyncConsoleGroup_instances, "m", _AsyncConsoleGroup_push).call(this, 'timeEnd', label);
+        this.#push('timeEnd', label);
     }
     /**
      * Equivalent of console.dir when used inside a group.
@@ -138,7 +119,7 @@ class AsyncConsoleGroup {
      * @param options Optional inspection options.
      */
     dir(item, options) {
-        __classPrivateFieldGet(this, _AsyncConsoleGroup_instances, "m", _AsyncConsoleGroup_push).call(this, 'dir', item, options);
+        this.#push('dir', item, options);
     }
     /**
      * You should not call this method directly. It is called automatically when the async callback finishes.
@@ -146,15 +127,10 @@ class AsyncConsoleGroup {
      * @returns The buffer that stores the console messages.
      */
     end() {
-        __classPrivateFieldSet(this, _AsyncConsoleGroup_ended, true, "f");
-        return __classPrivateFieldGet(this, _AsyncConsoleGroup_buffer, "f");
+        this.#ended = true;
+        return this.#buffer;
     }
 }
-_AsyncConsoleGroup_buffer = new WeakMap(), _AsyncConsoleGroup_ended = new WeakMap(), _AsyncConsoleGroup_instances = new WeakSet(), _AsyncConsoleGroup_push = function _AsyncConsoleGroup_push(method, ...params) {
-    if (!__classPrivateFieldGet(this, _AsyncConsoleGroup_ended, "f")) {
-        __classPrivateFieldGet(this, _AsyncConsoleGroup_buffer, "f").push([method, ...params]);
-    }
-};
 /**
  * The async version of betterGroup, which is a better version of console.group and console.groupEnd pair.
  * It allows you to use async/await inside the group and still have the console output correctly grouped together.
@@ -164,85 +140,30 @@ _AsyncConsoleGroup_buffer = new WeakMap(), _AsyncConsoleGroup_ended = new WeakMa
  * @template T The type of the value returned from the callback function.
  * @returns Anything returned from the callback function.
  */
-export function asyncGroup(label, callbackFn, thisArg) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const group = new AsyncConsoleGroup([]);
-        try {
-            const result = yield callbackFn.call(thisArg !== null && thisArg !== void 0 ? thisArg : globalThis, group); // eslint-disable-line @typescript-eslint/no-unsafe-assignment
-            return result;
-        }
-        finally {
-            const buffer = group.end();
-            console.group(label);
-            while (buffer.length > 0) {
-                const [...methodAndParams] = buffer.shift(); // eslint-disable-line @typescript-eslint/no-unnecessary-type-assertion
-                switch (methodAndParams[0]) {
-                    case 'group': {
-                        const [, nestedLabel] = methodAndParams;
-                        console.group(nestedLabel);
-                        break;
-                    }
-                    case 'groupEnd':
-                        console.groupEnd();
-                        break;
-                    case 'log': {
-                        const [, ...params] = methodAndParams;
-                        console.log(...params);
-                        break;
-                    }
-                    case 'warn': {
-                        const [, ...params] = methodAndParams;
-                        console.warn(...params);
-                        break;
-                    }
-                    case 'error': {
-                        const [, ...params] = methodAndParams;
-                        console.error(...params);
-                        break;
-                    }
-                    case 'debug': {
-                        const [, ...params] = methodAndParams;
-                        console.debug(...params);
-                        break;
-                    }
-                    case 'info': {
-                        const [, ...params] = methodAndParams;
-                        console.info(...params);
-                        break;
-                    }
-                    case 'table': {
-                        const [, ...params] = methodAndParams;
-                        console.table(...params);
-                        break;
-                    }
-                    case 'trace': {
-                        const [, ...params] = methodAndParams;
-                        console.trace(...params);
-                        break;
-                    }
-                    case 'assert': {
-                        const [, ...params] = methodAndParams;
-                        console.assert(...params);
-                        break;
-                    }
-                    case 'time': {
-                        const [, ...params] = methodAndParams;
-                        console.time(...params);
-                        break;
-                    }
-                    case 'timeEnd': {
-                        const [, ...params] = methodAndParams;
-                        console.timeEnd(...params);
-                        break;
-                    }
-                    case 'dir': {
-                        const [, ...params] = methodAndParams;
-                        console.dir(...params);
-                        break;
-                    }
+export async function asyncGroup(label, callbackFn, thisArg) {
+    const group = new AsyncConsoleGroup([]);
+    try {
+        const result = await callbackFn.call(thisArg ?? globalThis, group);
+        return result;
+    }
+    finally {
+        const buffer = group.end();
+        console.group(label);
+        while (buffer.length > 0) {
+            const methodAndParams = buffer.shift();
+            switch (methodAndParams[0]) {
+                case 'group':
+                    console.group(methodAndParams[1]);
+                    break;
+                case 'groupEnd':
+                    console.groupEnd();
+                    break;
+                default: {
+                    const [method, ...params] = methodAndParams;
+                    console[method](...params);
                 }
             }
-            console.groupEnd();
         }
-    });
+        console.groupEnd();
+    }
 }

package/lib/betterGroup.js

@@ -9,7 +9,7 @@
 export function betterGroup(label, callbackFn, thisArg) {
     console.group(label);
     try {
-        const result = callbackFn.call(thisArg !== null && thisArg !== void 0 ? thisArg : globalThis); // eslint-disable-line @typescript-eslint/no-unsafe-assignment
+        const result = callbackFn.call(thisArg ?? globalThis);
         return result;
     }
     finally {

package/package.json

@@ -1,66 +1,76 @@
 {
   "name": "better-console-group",
-  "version": "1.1.4",
+  "version": "1.1.6",
   "description": "Better API for console.group.",
-  "funding": "https://github.com/CatChen/versioned-storage?sponsor=1",
-  "type": "module",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/CatChen/better-console-group"
+  },
+  "author": "catchen",
+  "homepage": "https://github.com/CatChen/better-console-group#readme",
+  "bugs": {
+    "url": "https://github.com/CatChen/better-console-group/issues"
+  },
   "main": "index.js",
-  "types": "index.d.ts",
+  "type": "module",
+  "exports": {
+    ".": {
+      "import": "./index.js",
+      "types": "./index.d.ts"
+    }
+  },
+  "engines": {
+    "node": ">=20"
+  },
   "scripts": {
-    "test": "jest",
     "build": "tsc",
-    "registry:github": "cat package.json | json -e 'this.name = \"@CatChen/\" + this.name; this.publishConfig = {}; this.publishConfig.registry = \"https://npm.pkg.github.com/\"' > package.github.json && mv -f package.github.json package.json",
-    "registry:npm": "cat package.json | json -e 'this.name = this.name.replace(new RegExp(\"^@CatChen/\"), \"\"); this.publishConfig = undefined' > package.npm.json && mv -f package.npm.json package.json",
-    "prepublish": "rm -rf lib && yarn build",
+    "format": "prettier --write .",
+    "lint": "eslint -c eslint.config.js",
+    "postpublish": "pinst --enable",
     "prepare": "is-ci || husky",
+    "prepublish": "rm -rf lib && yarn build",
     "prepublishOnly": "pinst --disable",
-    "postpublish": "pinst --enable"
-  },
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/CatChen/better-console-group"
+    "registry:github": "cat package.json | json -e 'this.name = \"@CatChen/\" + this.name; this.publishConfig = {}; this.publishConfig.registry = \"https://npm.pkg.github.com/\"' > package.github.json && mv -f package.github.json package.json",
+    "registry:npm": "cat package.json | json -e 'this.name = this.name.replace(new RegExp(\"^@CatChen/\"), \"\"); this.publishConfig = undefined' > package.npm.json && mv -f package.npm.json package.json",
+    "test": "jest"
   },
   "keywords": [
     "console",
     "group"
   ],
-  "author": "catchen",
-  "license": "MIT",
-  "bugs": {
-    "url": "https://github.com/CatChen/better-console-group/issues"
+  "optionalDependencies": {
+    "husky": "^9.1.4",
+    "lint-staged": "^16.0.0"
   },
-  "homepage": "https://github.com/CatChen/better-console-group#readme",
   "devDependencies": {
     "@eslint/eslintrc": "^3.2.0",
     "@eslint/js": "^10.0.1",
-    "@serverless-guru/prettier-plugin-import-order": "^0.4.1",
+    "@ianvs/prettier-plugin-sort-imports": "^4.7.1",
     "@types/jest": "^30.0.0",
     "codecov": "^3.6.1",
     "eslint": "^10.0.0",
     "eslint-config-prettier": "^10.0.1",
-    "eslint-plugin-flowtype": "^8.0.2",
     "eslint-plugin-prettier": "^5.2.1",
-    "flow-bin": "^0.307.0",
+    "flow-bin": "^0.309.0",
     "is-ci": "^4.1.0",
     "jest": "^30.0.0",
     "json": "^11.0.0",
     "pinst": "^3.0.0",
     "prettier": "^3.0.2",
+    "prettier-plugin-package": "^2.0.0",
     "ts-jest": "^29.2.5",
     "typescript": "^6.0.2",
     "typescript-eslint": "^8.15.0"
   },
-  "optionalDependencies": {
-    "husky": "^9.1.4",
-    "lint-staged": "^16.0.0"
-  },
-  "engines": {
-    "node": ">=20"
-  },
+  "types": "index.d.ts",
+  "funding": "https://github.com/CatChen/versioned-storage?sponsor=1",
   "lint-staged": {
-    "*.(js,ts,js.flow)": "yarn eslint --fix",
-    "*.json": "yarn eslint --fix",
-    "*.(yml,yaml)": "yarn prettier -w",
-    "*.(md,markdown)": "yarn prettier -w"
-  }
+    "*.{ts,js}": [
+      "yarn format",
+      "yarn lint --fix"
+    ],
+    "*.{json,yml,yaml,md,markdown}": "yarn format"
+  },
+  "packageManager": "yarn@4.13.0"
 }

package/tsconfig.json

@@ -3,11 +3,12 @@
     "rootDir": "src",
     "outDir": "lib",
     "declaration": true,
-    "target": "ES2015",
     "lib": ["es2015", "dom"],
-    "module": "es2022",
-    "moduleResolution": "bundler",
+    "module": "nodenext",
+    "moduleResolution": "nodenext",
     "esModuleInterop": true,
+    "skipLibCheck": true,
+    "rewriteRelativeImportExtensions": true,
     "types": ["jest"]
   },
   "include": ["src"],

package/BetterConsoleGroup.ts

@@ -1,2 +0,0 @@
-export * from './src/betterGroup.ts';
-export * from './src/asyncGroup.ts';