Merge pull request #20 from ag-grid/develop

Release CLI v31.2.0

.gitignore

@@ -1,4 +1,5 @@
 /node_modules/
 /packages/*/node_modules/
+/packages/*/vitest.config.mts.timestamp-*.mjs
 /coverage/
 /docs/

README.md

@@ -15,8 +15,10 @@ The following packages contain internal library helpers:
 
 - [`ast`](./packages/ast/): AST transformation tools
 - [`codemod-utils`](./packages/codemod-utils/): Codemod utility helpers
+- [`codemod-task-utils`](./packages/codemod-task-utils/): Codemod task runner helpers
 - [`systemjs-plugin`](./packages/systemjs-plugin/): SystemJS plugin for TypeScript/JSX/CSS source files
 - [`test-utils`](./packages/test-utils/): Automated testing helpers
+- [`worker-utils`](./packages/worker-utils/): Worker utility helpers
 - [`types`](./packages/types/): Shared type definitions
 
 The following packages contain configuration shared across multiple internal packages:

package.json

@@ -17,7 +17,7 @@
     "test": "vitest run",
     "test:watch": "vitest watch",
     "coverage": "vitest run --coverage",
-    "coverage:report": "vitest run --coverage --config ./report.vitest.config.ts",
+    "coverage:report": "vitest run --coverage --config ./report.vitest.config.mts",
     "clean": "rm -rf docs coverages packages/*/dist",
     "version": "pnpm --filter @ag-grid-community/cli exec -- pnpm run --silent version",
     "publish": "pnpm run --filter @ag-grid-community/cli publish"

packages/ast/tsconfig.json

@@ -1,4 +1,4 @@
 {
   "extends": "../build-config/templates/tsc/tsconfig.json",
-  "include": ["src", "lib.ts", "lib.test.ts", "*.config.ts", "package.json"]
+  "include": ["src", "lib.ts", "lib.test.ts", "*.config.mts", "package.json"]
 }

packages/ast/vitest.config.ts → packages/ast/vitest.config.mts

@@ -2,7 +2,7 @@
 import { join, resolve } from 'path';
 import { defineConfig, mergeConfig } from 'vite';
 
-import base from './vite.config';
+import base from './vite.config.mts';
 
 export default mergeConfig(
   base,

packages/build-config/package.json

@@ -17,7 +17,7 @@
     "lint": "eslint --ext js,cjs,mjs,ts ."
   },
   "dependencies": {
-    "@types/node": "20.5.9",
+    "@types/node": "20.11.29",
     "@types/react": "18.2.21",
     "@typescript-eslint/eslint-plugin": "6.6.0",
     "@typescript-eslint/parser": "6.6.0",

packages/build-config/templates/vite/lib.vite.config.ts

@@ -8,7 +8,7 @@ export default mergeConfig(
   defineConfig({
     plugins: [
       dts({
-        exclude: ['node_modules/**', '*.config.ts', '**/*.test.ts'],
+        exclude: ['node_modules/**', '*.config.mts', '**/*.test.ts'],
       }),
     ],
   }),

packages/build-tools/package.json

@@ -21,9 +21,6 @@
     "task": "./scripts/task.cjs",
     "lint": "eslint --ext cjs ."
   },
-  "dependencies": {
-    "ts-node": "^10"
-  },
   "devDependencies": {
     "@ag-grid-devtools/build-config": "workspace:*"
   }

packages/build-tools/src/prompt.mjs

@@ -1,3 +1,4 @@
+import { clearScreenDown, moveCursor } from 'node:readline';
 import readline from 'node:readline/promises';
 import { parseArgs } from 'node:util';
 import { gray, green, red } from './cli.mjs';
@@ -30,6 +31,7 @@ export function createPrompt(variables) {
       const {
         prompt: promptLabel = label,
         value: optionsValue,
+        options: choices,
         default: defaultValue = null,
         parse = String,
         format = JSON.stringify,
@@ -50,7 +52,7 @@ export function createPrompt(variables) {
           return existingValue;
         } else {
           const answer = defaultValue;
-          return parse(await readline(question, answer));
+          return parse(await readline(question, answer, choices));
         }
       })();
       const error = validate ? validate(value, values, env) : null;
@@ -86,12 +88,63 @@ export function createPrompt(variables) {
 }
 
 export function createPromptReader({ input, output }) {
-  return (line, defaultValue) => {
+  return (line, defaultValue, options) => {
     const rl = readline.createInterface({ input, output });
     const response = rl.question(`${line} `);
+    if (options && options.length > 0) {
+      const defaultOptionIndex = defaultValue != null ? options.indexOf(defaultValue) : -1;
+      let selectedOptionIndex = defaultOptionIndex !== -1 ? defaultOptionIndex : null;
+      listOptions(rl, options, selectedOptionIndex);
+      rl.input.on('keypress', (char, key) => {
+        switch (key.name) {
+          case 'tab':
+          case 'down': {
+            selectedOptionIndex = ((selectedOptionIndex ?? -1) + 1) % options.length;
+            changeSelectedIndex(rl, options, selectedOptionIndex);
+            break;
+          }
+          case 'up': {
+            selectedOptionIndex =
+              (options.length + (selectedOptionIndex ?? 0) - 1) % options.length;
+            changeSelectedIndex(rl, options, selectedOptionIndex);
+            break;
+          }
+          case 'return': {
+            clearScreenDown(rl.output);
+            break;
+          }
+          default: {
+            selectedOptionIndex = null;
+          }
+        }
+      });
+      function changeSelectedIndex(rl, options, selectedOptionIndex) {
+        clearInput(rl);
+        listOptions(rl, options, selectedOptionIndex);
+        rl.write(options[selectedOptionIndex]);
+      }
+    }
     if (defaultValue != null) rl.write(defaultValue);
     return response.finally(() => rl.close());
   };
+
+  function clearInput(rl) {
+    rl.write(null, { ctrl: true, name: 'u' });
+  }
+
+  function listOptions(rl, options, selectedIndex) {
+    rl.pause();
+    const inputCursorPos = rl.getCursorPos();
+    const formattedOptions = options.map((value, index) => {
+      const isSelected = index === selectedIndex;
+      const message = `${isSelected ? '◉' : '◯'} ${value}`;
+      return isSelected ? green(message) : message;
+    });
+    const outputLines = ['', ...formattedOptions, ''];
+    rl.output.write(outputLines.join('\n'));
+    moveCursor(rl.input, inputCursorPos.cols, -(outputLines.length - 1));
+    rl.resume();
+  }
 }
 
 export function createPromptWriter(output) {

packages/build-tools/src/validate.mjs

@@ -51,6 +51,13 @@ export function validateOneOf(options) {
   };
 }
 
+export function validateOptional(validator) {
+  return function validateOptional(value) {
+    if (value === null) return null;
+    return validator(value);
+  };
+}
+
 function getPathStats(path) {
   try {
     return statSync(path);

packages/cli/codemods.vite.config.ts → packages/cli/codemods.vite.config.mts

@@ -1,7 +1,7 @@
 import { resolve } from 'path';
 import { defineConfig, mergeConfig } from 'vite';
 
-import base from '../codemods/vite.config';
+import base from '../codemods/vite.config.mts';
 
 import pkg from '../codemods/package.json' assert { type: 'json' };
 

packages/cli/package.json

@@ -1,7 +1,7 @@
 {
   "private": true,
   "name": "@ag-grid-community/cli",
-  "version": "31.1.0",
+  "version": "31.2.0",
   "license": "MIT",
   "description": "AG Grid developer toolkit",
   "author": "AG Grid <[email protected]>",
@@ -21,7 +21,7 @@
     "build:readme": "cp README.md dist/README.md",
     "build:pkg": "pnpm run --filter build-tools pkg $PWD $PWD/dist/package.json",
     "build:codemods": "pnpm run build:codemods:lib && pnpm run build:codemods:pkg",
-    "build:codemods:lib": "vite build --config codemods.vite.config.js",
+    "build:codemods:lib": "vite build --config codemods.vite.config.mts",
     "build:codemods:pkg": "pnpm run --filter build-tools pkg $PWD/../codemods $PWD/dist/node_modules/@ag-grid-community/codemods/package.json",
     "lint": "pnpm run '/^lint:.*/'",
     "lint:eslint": "eslint --ext js,cjs,mjs,ts .",
@@ -43,11 +43,13 @@
   },
   "devDependencies": {
     "@ag-grid-devtools/build-config": "workspace:*",
+    "@ag-grid-devtools/codemod-task-utils": "workspace:*",
     "@ag-grid-devtools/types": "workspace:*",
     "@ag-grid-devtools/utils": "workspace:*",
     "@ag-grid-devtools/worker-utils": "workspace:*",
     "@types/diff": "5.0.8",
     "@types/graceful-fs": "4.1.9",
+    "@types/node": "20.11.29",
     "@types/semver": "7.5.6",
     "diff": "5.1.0",
     "graceful-fs": "4.2.11",

packages/cli/src/commands/migrate.ts

@@ -1,4 +1,5 @@
 import codemods from '@ag-grid-community/codemods';
+import { createCodemodTask } from '@ag-grid-devtools/codemod-task-utils';
 import {
   Codemod,
   CodemodTaskInput,
@@ -22,7 +23,6 @@ import { getCliCommand } from '../utils/pkg';
 import { green, indentErrorMessage, log } from '../utils/stdio';
 import { Worker, WorkerTaskQueue } from '../utils/worker';
 import { requireDynamicModule, resolveDynamicModule } from '../utils/module';
-import { createCodemodTask } from '../../../codemod-utils/src/taskHelpers';
 
 const { versions } = codemods;
 

packages/cli/tsconfig.json

@@ -1,10 +1,4 @@
 {
   "extends": "../build-config/templates/tsc/tsconfig.json",
-  "include": [
-    "src",
-    "index.ts",
-    "*.config.ts",
-    "package.json",
-    "../codemod-utils/src/taskHelpers.ts"
-  ]
+  "include": ["src", "index.ts", "*.config.mts", "package.json"]
 }

packages/test-utils/vitest.config.ts → packages/cli/vitest.config.mts

@@ -2,7 +2,7 @@
 import { join, resolve } from 'path';
 import { defineConfig, mergeConfig } from 'vite';
 
-import base from './vite.config';
+import base from './vite.config.mts';
 
 export default mergeConfig(
   base,

packages/codemod-task-utils/.eslintignore

@@ -0,0 +1,2 @@
+/dist/
+/vitest.config.ts.timestamp-*.mjs

packages/codemod-task-utils/.eslintrc.cjs

@@ -0,0 +1 @@
+module.exports = require('@ag-grid-devtools/build-config/templates/eslint/lib.eslintrc.cjs');

packages/codemod-task-utils/.gitignore

@@ -0,0 +1 @@
+/dist/

packages/codemod-task-utils/lib.test.ts

@@ -0,0 +1,10 @@
+import { expect, test } from 'vitest';
+
+import * as lib from './lib';
+
+test('module exports', () => {
+  expect({ ...lib }).toEqual({
+    createCodemodTask: lib.createCodemodTask,
+    initCodemodTaskWorker: lib.initCodemodTaskWorker,
+  });
+});

packages/codemod-task-utils/lib.ts

@@ -0,0 +1,2 @@
+export * from './src/task';
+export * from './src/worker';

packages/codemod-task-utils/package.json

@@ -0,0 +1,57 @@
+{
+  "private": true,
+  "name": "@ag-grid-devtools/codemod-task-utils",
+  "version": "0.0.1",
+  "license": "MIT",
+  "description": "Codemod task runner helpers",
+  "author": "AG Grid <[email protected]>",
+  "homepage": "https://www.ag-grid.com/",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ag-grid/devtools.git"
+  },
+  "bugs": {
+    "url": "https://github.com/ag-grid/devtools/issues"
+  },
+  "type": "module",
+  "main": "./lib.ts",
+  "module": "./lib.ts",
+  "scripts": {
+    "build": "pnpm run build:lib && pnpm run build:docs && pnpm run build:pkg",
+    "build:lib": "vite build",
+    "build:docs": "typedoc",
+    "build:pkg": "pnpm run --filter build-tools pkg $PWD $PWD/dist/package.json",
+    "lint": "pnpm run '/^lint:.*/'",
+    "lint:eslint": "eslint --ext js,cjs,mjs,ts .",
+    "lint:typescript": "tsc --noEmit",
+    "test": "vitest run",
+    "test:watch": "vitest watch",
+    "update-event-keys": "./scripts/update-event-keys ./src/eventKeys.ts"
+  },
+  "pkg": {
+    "type": "module",
+    "main": "./lib/lib.cjs",
+    "module": "/lib/lib.js",
+    "types": "./lib.d.ts",
+    "exports": {
+      ".": {
+        "import": "./lib/lib.js",
+        "require": "./lib/lib.cjs"
+      }
+    }
+  },
+  "dependencies": {
+    "@ag-grid-devtools/types": "workspace:*",
+    "@ag-grid-devtools/worker-utils": "workspace:*"
+  },
+  "devDependencies": {
+    "@ag-grid-devtools/build-config": "workspace:*"
+  },
+  "peerDependencies": {
+    "eslint": "^8",
+    "typedoc": "^0.25",
+    "typescript": "^5",
+    "vite": "^5",
+    "vitest": "^1"
+  }
+}

packages/codemod-task-utils/prettier.config.mjs

@@ -0,0 +1 @@
+export { default } from '@ag-grid-devtools/build-config/templates/prettier/prettier.config.mjs';

packages/worker-utils/src/codemod.ts → packages/codemod-task-utils/src/worker.ts

@@ -1,5 +1,5 @@
 import { type CodemodTask, type CodemodTaskInput, type FsUtils } from '@ag-grid-devtools/types';
-import { configureWorkerTask, initTaskWorker } from './worker';
+import { configureWorkerTask, initTaskWorker } from '@ag-grid-devtools/worker-utils';
 
 export function initCodemodTaskWorker(
   task: CodemodTask,

packages/codemod-task-utils/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  "extends": "../build-config/templates/tsc/tsconfig.json",
+  "include": ["src", "lib.ts", "lib.test.ts", "*.config.mts", "package.json"]
+}

packages/codemod-task-utils/typedoc.json

@@ -0,0 +1,5 @@
+{
+  "extends": ["../build-config/templates/typedoc/base.typedoc.json"],
+  "entryPoints": ["lib.ts"],
+  "out": "./dist/docs"
+}

packages/cli/vitest.config.ts → packages/codemod-task-utils/vitest.config.mts

@@ -2,7 +2,7 @@
 import { join, resolve } from 'path';
 import { defineConfig, mergeConfig } from 'vite';
 
-import base from './vite.config';
+import base from './vite.config.mts';
 
 export default mergeConfig(
   base,

packages/codemod-utils/lib.test.ts

@@ -22,7 +22,6 @@ test('module exports', () => {
     VueTemplateFormatter: lib.VueTemplateFormatter,
     createAngularBooleanLiteral: lib.createAngularBooleanLiteral,
     createBabelPlugin: lib.createBabelPlugin,
-    createCodemodTask: lib.createCodemodTask,
     createVueAstNode: lib.createVueAstNode,
     createVueBooleanLiteral: lib.createVueBooleanLiteral,
     createVueExpressionContainer: lib.createVueExpressionContainer,

packages/codemod-utils/lib.ts

@@ -4,7 +4,6 @@ export * from './src/angularHelpers';
 export * from './src/babelHelpers';
 export * from './src/plugins';
 export * from './src/prettierHelpers';
-export * from './src/taskHelpers';
 export * from './src/templateHelpers';
 export * from './src/transformer';
 export * from './src/vueHelpers';

packages/codemod-utils/tsconfig.json

@@ -1,12 +1,4 @@
 {
   "extends": "../build-config/templates/tsc/tsconfig.json",
-  "include": [
-    "src",
-    "lib.ts",
-    "lib.test.ts",
-    "*.config.ts",
-    "package.json",
-    "lib.test.ts",
-    "lib.ts"
-  ]
+  "include": ["src", "lib.ts", "lib.test.ts", "*.config.mts", "package.json"]
 }