Merge branch 'master' into feature/optional-width

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

CHANGELOG.md

@@ -2,6 +2,24 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [9.0.1](https://github.com/yargs/cliui/compare/v9.0.0...v9.0.1) (2025-03-17)
+
+
+### Bug Fixes
+
+* make require("cliui") work as expected for CJS ([04ccc25](https://github.com/yargs/cliui/commit/04ccc250e30a059292c03fa1ef0a8661f8d93dfe))
+
+## [9.0.0](https://github.com/yargs/cliui/compare/v8.0.1...v9.0.0) (2025-03-16)
+
+
+### ⚠ BREAKING CHANGES
+
+* cliui is now ESM only ([#165](https://github.com/yargs/cliui/issues/165))
+
+### Features
+
+* cliui is now ESM only ([#165](https://github.com/yargs/cliui/issues/165)) ([5a521de](https://github.com/yargs/cliui/commit/5a521de7ea88f262236394c8d96775bcf50ff0a4))
+
 ## [8.0.1](https://github.com/yargs/cliui/compare/v8.0.0...v8.0.1) (2022-10-01)
 
 

README.md

@@ -9,8 +9,14 @@ easily create complex multi-column command-line-interfaces.
 
 ## Example
 
+```bash
+npm i cliui@latest chalk@latest
+```
+
 ```js
 const ui = require('cliui')()
+const {Chalk} = require('chalk');
+const chalk = new Chalk();
 
 ui.div('Usage: $0 [command] [options]')
 
@@ -46,7 +52,9 @@ As of `v7` `cliui` supports [Deno](https://github.com/denoland/deno) and
 [ESM](https://nodejs.org/api/esm.html#esm_ecmascript_modules):
 
 ```typescript
-import cliui from "https://deno.land/x/cliui/deno.ts";
+import cliui from "cliui";
+import chalk from "chalk";
+// Deno: import cliui from "https://deno.land/x/cliui/deno.ts";
 
 const ui = cliui({})
 
@@ -57,11 +65,23 @@ ui.div({
   padding: [2, 0, 1, 0]
 })
 
-ui.div({
-  text: "-f, --file",
-  width: 20,
-  padding: [0, 4, 0, 4]
-})
+ui.div(
+  {
+    text: "-f, --file",
+    width: 20,
+    padding: [0, 4, 0, 4]
+  },
+  {
+    text: "the file to load." +
+      chalk.green("(if this description is long it wraps).")
+    ,
+    width: 20
+  },
+  {
+    text: chalk.red("[required]"),
+    align: 'right'
+  }
+)
 
 console.log(ui.toString())
 ```

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,15 @@
 // 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
   })
 }
+
+export {ui as 'module.exports'};

lib/cjs.ts

@@ -352,7 +352,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
   }
@@ -374,7 +374,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

@@ -1,31 +1,22 @@
 {
   "name": "cliui",
-  "version": "8.0.1",
+  "version": "9.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",
+    "eslint-plugin-n": "^14.0.0",
+    "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', () => {