feat!: cliui is now ESM only (#165)

Author: shadowspawn

.github/workflows/ci.yaml

@@ -10,7 +10,7 @@ jobs:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        node: [12, 16, 18]
+        node: [20, 22]
     steps:
       - uses: actions/checkout@v1
       - uses: actions/setup-node@v1
@@ -28,7 +28,7 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v1
         with:
-          node-version: 12
+          node-version: 22
       - run: npm install
         env:
           PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: true
@@ -39,28 +39,19 @@ jobs:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v1
         with:
-          node-version: 14
+          node-version: 22
       - run: npm install
         env:
           PUPPETEER_SKIP_CHROMIUM_DOWNLOAD: true
       - run: npm test
       - run: npm run coverage
-  esm:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v2
-      - uses: actions/setup-node@v1
-        with:
-          node-version: 14
-      - run: npm install
-      - run: npm run test:esm
   deno:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
       - uses: actions/setup-node@v1
         with:
-          node-version: 14
+          node-version: 22
       - run: npm install
       - run: npm run compile
       - uses: denolib/setup-deno@v2

deno.ts

@@ -1,14 +1,14 @@
 // Bootstrap cliui with CommonJS dependencies:
 import { cliui, UI } from './build/lib/index.js'
 import type { UIOptions } from './build/lib/index.d.ts'
-import { wrap, stripAnsi } from './build/lib/string-utils.js'
+import stringWidth from 'string-width'
+import stripAnsi from 'strip-ansi'
+import wrapAnsi from 'wrap-ansi'
 
 export default function ui (opts: UIOptions): UI {
   return cliui(opts, {
-    stringWidth: (str: string) => {
-      return [...str].length
-    },
+    stringWidth,
     stripAnsi,
-    wrap
+    wrap: wrapAnsi
   })
 }

index.mjs

@@ -1,13 +1,13 @@
 // Bootstrap cliui with CommonJS dependencies:
 import { cliui } from './build/lib/index.js'
-import { wrap, stripAnsi } from './build/lib/string-utils.js'
+import stringWidth from 'string-width'
+import stripAnsi from 'strip-ansi'
+import wrapAnsi from 'wrap-ansi'
 
 export default function ui (opts) {
   return cliui(opts, {
-    stringWidth: (str) => {
-      return [...str].length
-    },
+    stringWidth,
     stripAnsi,
-    wrap
+    wrap: wrapAnsi
   })
 }

lib/cjs.ts

@@ -349,7 +349,7 @@ function _minWidth (col: Column) {
 }
 
 function getWindowWidth (): number {
-  /* istanbul ignore next: depends on terminal */
+  /* c8 ignore next 5: depends on terminal */
   if (typeof process === 'object' && process.stdout && process.stdout.columns) {
     return process.stdout.columns
   }
@@ -371,7 +371,7 @@ function alignCenter (str: string, width: number): string {
   str = str.trim()
   const strWidth = mixin.stringWidth(str)
 
-  /* istanbul ignore next */
+  /* c8 ignore next 3 */
   if (strWidth >= width) {
     return str
   }

lib/index.ts

@@ -2,30 +2,21 @@
   "name": "cliui",
   "version": "8.0.1",
   "description": "easily create complex multi-column command-line-interfaces",
-  "main": "build/index.cjs",
+  "main": "build/index.mjs",
   "exports": {
-    ".": [
-      {
-        "import": "./index.mjs",
-        "require": "./build/index.cjs"
-      },
-      "./build/index.cjs"
-    ]
+    ".": "./index.mjs"
   },
   "type": "module",
   "module": "./index.mjs",
   "scripts": {
-    "check": "standardx '**/*.ts' && standardx '**/*.js' && standardx '**/*.cjs'",
-    "fix": "standardx --fix '**/*.ts' && standardx --fix '**/*.js' && standardx --fix '**/*.cjs'",
-    "pretest": "rimraf build && tsc -p tsconfig.test.json && cross-env NODE_ENV=test npm run build:cjs",
-    "test": "c8 mocha ./test/*.cjs",
-    "test:esm": "c8 mocha ./test/esm/cliui-test.mjs",
+    "check": "standardx '**/*.ts' && standardx '**/*.js'",
+    "fix": "standardx --fix '**/*.ts' && standardx --fix '**/*.js'",
+    "pretest": "rimraf build && tsc -p tsconfig.test.json",
+    "test": "c8 mocha ./test/*.mjs",
     "postest": "check",
     "coverage": "c8 report --check-coverage",
     "precompile": "rimraf build",
     "compile": "tsc",
-    "postcompile": "npm run build:cjs",
-    "build:cjs": "rollup -c",
     "prepare": "npm run compile"
   },
   "repository": "yargs/cliui",
@@ -49,35 +40,33 @@
   "author": "Ben Coe <[email protected]>",
   "license": "ISC",
   "dependencies": {
-    "string-width": "^4.2.0",
-    "strip-ansi": "^6.0.1",
-    "wrap-ansi": "^7.0.0"
+    "string-width": "^7.2.0",
+    "strip-ansi": "^7.1.0",
+    "wrap-ansi": "^9.0.0"
   },
   "devDependencies": {
-    "@types/node": "^14.0.27",
+    "@types/node": "^22.13.10",
     "@typescript-eslint/eslint-plugin": "^4.0.0",
     "@typescript-eslint/parser": "^4.0.0",
-    "c8": "^7.3.0",
-    "chai": "^4.2.0",
-    "chalk": "^4.1.0",
+    "c8": "^10.1.3",
+    "chai": "^5.2.0",
+    "chalk": "^5.4.1",
     "cross-env": "^7.0.2",
     "eslint": "^7.6.0",
     "eslint-plugin-import": "^2.22.0",
     "eslint-plugin-node": "^11.1.0",
-    "gts": "^3.0.0",
-    "mocha": "^10.0.0",
-    "rimraf": "^3.0.2",
-    "rollup": "^2.23.1",
-    "rollup-plugin-ts": "^3.0.2",
+    "gts": "^6.0.2",
+    "mocha": "^11.1.0",
+    "rimraf": "^6.0.1",
     "standardx": "^7.0.0",
-    "typescript": "^4.0.0"
+    "typescript": "^5.8.2"
   },
   "files": [
     "build",
     "index.mjs",
     "!*.d.ts"
   ],
   "engines": {
-    "node": ">=12"
+    "node": ">=20"
   }
 }

lib/string-utils.ts

@@ -1,16 +1,14 @@
-'use strict'
+import chalk from 'chalk'
+import cliui from '../index.mjs'
+import stripAnsi from 'strip-ansi'
+import { should } from 'chai'
 
 /* global describe, it */
-
-require('chai').should()
+should()
 
 // Force chalk to enable color, if it's disabled the test fails.
 process.env.FORCE_COLOR = 1
 
-const chalk = require('chalk')
-const cliui = require('../build/index.cjs')
-const stripAnsi = require('strip-ansi')
-
 describe('cliui', () => {
   describe('resetOutput', () => {
     it('should set lines to empty', () => {

package.json

@@ -6,6 +6,8 @@ import {
 } from 'https://deno.land/std/testing/asserts.ts'
 import cliui from '../../deno.ts'
 
+// Just run a couple of the tests as a light check working from the Deno runtime.
+
 Deno.test("wraps text at 'width' if a single column is given", () => {
   const ui = cliui({
     width: 10
@@ -39,10 +41,11 @@ Deno.test('evenly divides text across columns if multiple columns are given', ()
   // TODO: we should flesh out the Deno and ESM implementation
   // such that it spreads words out over multiple columns appropriately:
   const expected = [
-    'i am a string ti am a seconi am a third',
-    'hat should be wd string tha string that',
-    'rapped         t should be  should be w',
-    '               wrapped     rapped'
+    'i am a string  i am a      i am a third',
+    'that should be second      string that',
+    'wrapped        string that should be',
+    '               should be   wrapped',
+    '               wrapped'
   ]
 
   ui.toString().split('\n').forEach((line: string, i: number) => {