cliui - npm Package Compare versions

Comparing version 6.0.0 to 7.0.0

CHANGELOG.md

@@ -5,2 +5,19 @@ # Change Log
 
+## [7.0.0](https://www.github.com/yargs/cliui/compare/v6.0.0...v7.0.0) (2020-08-16)
+
+
+### ⚠ BREAKING CHANGES
+
+* tsc/ESM/Deno support (#82)
+* modernize deps and build (#80)
+
+### Build System
+
+* modernize deps and build ([#80](https://www.github.com/yargs/cliui/issues/80)) ([339d08d](https://www.github.com/yargs/cliui/commit/339d08dc71b15a3928aeab09042af94db2f43743))
+
+
+### Code Refactoring
+
+* tsc/ESM/Deno support ([#82](https://www.github.com/yargs/cliui/issues/82)) ([4b777a5](https://www.github.com/yargs/cliui/commit/4b777a5fe01c5d8958c6708695d6aab7dbe5706c))
+
 ## [6.0.0](https://www.github.com/yargs/cliui/compare/v5.0.0...v6.0.0) (2019-11-10)
@@ -7,0 +24,0 @@

package.json

 {
   "name": "cliui",
-  "version": "6.0.0",
+  "version": "7.0.0",
   "description": "easily create complex multi-column command-line-interfaces",
   "main": "index.js",
+  "exports": {
+    "import": "./index.mjs",
+    "require": "./build/index.cjs"
+  },
+  "type": "module",
+  "module": "./index.mjs",
   "scripts": {
-    "pretest": "standard",
-    "test": "nyc mocha",
-    "coverage": "nyc --reporter=text-lcov mocha | coveralls"
+    "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",
+    "postest": "check",
+    "posttest": "npm run 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": {
-    "type": "git",
-    "url": "http://github.com/yargs/cliui.git"
-  },
-  "config": {
-    "blanket": {
-      "pattern": [
-        "index.js"
-      ],
-      "data-cover-never": [
-        "node_modules",
-        "test"
-      ],
-      "output-reporter": "spec"
-    }
-  },
+  "repository": "yargs/cliui",
   "standard": {
@@ -49,18 +50,31 @@ "ignore": [
     "strip-ansi": "^6.0.0",
-    "wrap-ansi": "^6.2.0"
+    "wrap-ansi": "^7.0.0"
   },
   "devDependencies": {
+    "@types/node": "^14.0.27",
+    "@typescript-eslint/eslint-plugin": "^3.8.0",
+    "@typescript-eslint/parser": "^3.8.0",
+    "@wessberg/rollup-plugin-ts": "^1.3.2",
+    "c8": "^7.3.0",
     "chai": "^4.2.0",
-    "chalk": "^3.0.0",
-    "coveralls": "^3.0.3",
-    "mocha": "^6.2.2",
-    "nyc": "^14.1.1",
-    "standard": "^12.0.1"
+    "chalk": "^4.1.0",
+    "cross-env": "^7.0.2",
+    "eslint": "^7.6.0",
+    "eslint-plugin-import": "^2.22.0",
+    "eslint-plugin-node": "^11.1.0",
+    "gts": "^2.0.2",
+    "mocha": "^8.1.1",
+    "rimraf": "^3.0.2",
+    "rollup": "^2.23.1",
+    "standardx": "^5.0.0",
+    "typescript": "^3.9.7"
   },
   "files": [
-    "index.js"
+    "build",
+    "index.mjs",
+    "!*.d.ts"
   ],
   "engine": {
-    "node": ">=8"
+    "node": ">=10"
   }
 }

README.md

 # cliui
 
-[![Build Status](https://travis-ci.org/yargs/cliui.svg)](https://travis-ci.org/yargs/cliui)
-[![Coverage Status](https://coveralls.io/repos/yargs/cliui/badge.svg?branch=)](https://coveralls.io/r/yargs/cliui?branch=)
+![ci](https://github.com/yargs/cliui/workflows/ci/badge.svg)
 [![NPM version](https://img.shields.io/npm/v/cliui.svg)](https://www.npmjs.com/package/cliui)
-[![Standard Version](https://img.shields.io/badge/release-standard%20version-brightgreen.svg)](https://github.com/conventional-changelog/standard-version)
+[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
+![nycrc config on GitHub](https://img.shields.io/nycrc/yargs/cliui)
 
@@ -13,3 +13,3 @@ easily create complex multi-column command-line-interfaces.
 ```js
-var ui = require('cliui')()
+const ui = require('cliui')()
 
@@ -20,3 +20,3 @@ ui.div('Usage: $0 [command] [options]')
   text: 'Options:',
-  padding: [2, 0, 2, 0]
+  padding: [2, 0, 1, 0]
 })
@@ -45,2 +45,28 @@
 
+## Deno/ESM Support
+
+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";
+
+const ui = cliui({})
+
+ui.div('Usage: $0 [command] [options]')
+
+ui.div({
+  text: 'Options:',
+  padding: [2, 0, 1, 0]
+})
+
+ui.div({
+  text: "-f, --file",
+  width: 20,
+  padding: [0, 4, 0, 4]
+})
+
+console.log(ui.toString())
+```
+
 <img width="500" src="screenshot.png">
@@ -47,0 +73,0 @@

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

29088

increased by95.58%

Number of package files

8

increased by60%

Lines of code

623

increased by117.83%

Number of lines in readme file

142

increased by22.41%

Is type module

Yes

Worsened metrics

Dev dependency count

17

increased by183.33%

Number of low supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addedwrap-ansi@7.0.0(transitive)

• - Removedwrap-ansi@6.2.0(transitive)

• Updatedwrap-ansi@^7.0.0