Add CLI package for html-to-text (WIP)

Author: KillyMXI

.eslintrc.cjs

@@ -162,6 +162,14 @@ module.exports = {
     'filenames/match-exported': 'error'
   },
   overrides: [
+    {
+      'files': ['packages/html-to-text-cli/**/*.js'],
+      'rules': {
+        'sort-keys': 'off',
+        'import/extensions': [ 'error', 'never', { 'json': 'always' } ],
+        'import/no-nodejs-modules': [ 'error', { 'allow': ['node:process'] }]
+      }
+    },
     {
       'files': ['example/*.js'],
       'rules': { 'import/no-nodejs-modules': 'off' }

.gitignore

@@ -4,5 +4,6 @@
 coverage
 node_modules
 lib
+bin
 __*.*
 packages/*/LICENSE

.node-version

@@ -1 +1 @@
-14.17
+14.21

README.md

@@ -14,6 +14,14 @@ This is a monorepo.
 
     Docs: [README.md](/packages/html-to-text/README.md), [CHANGELOG.md](/packages/html-to-text/CHANGELOG.md)
 
+- **@html-to/text-cli**
+
+    CLI for html to text converter.
+
+    Folder: [/packages/html-to-text-cli](/packages/html-to-text-cli)
+
+    Docs: [README.md](/packages/html-to-text-cli/README.md), [CHANGELOG.md](/packages/html-to-text-cli/CHANGELOG.md)
+
 - **@html-to/md**
 
     Advanced html to markdown converter.

package.json

@@ -12,6 +12,7 @@
   "type": "module",
   "scripts": {
     "build:html-to-text": "cd ./packages/html-to-text/ && npm run build",
+    "build:html-to-text-cli": "cd ./packages/html-to-text-cli/ && npm run build",
     "build:html-to-md": "cd ./packages/html-to-md/ && npm run build",
     "build": "concurrently npm:build:*",
     "cover:html-to-text": "cd ./packages/html-to-text/ && npm run cover",
@@ -21,6 +22,7 @@
     "example:text": "node --experimental-specifier-resolution=node ./example/html-to-text.js",
     "install:base": "cd ./packages/base/ && npm i",
     "install:html-to-text": "cd ./packages/html-to-text/ && npm i",
+    "install:html-to-text-cli": "cd ./packages/html-to-text-cli/ && npm i",
     "install:html-to-md": "cd ./packages/html-to-md/ && npm i",
     "lint": "eslint .",
     "postinstall": "concurrently npm:install:*",

packages/html-to-text-cli/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+
+## Version 0.5.0
+
+- Initial release
+- Requires Node.js version >= 14.13.1
+- Based on `html-to-text` version 9.0.0-preview2

packages/html-to-text-cli/README.md

@@ -0,0 +1,38 @@
+# @html-to/text-cli
+
+Command line interface for `html-to-text` Node.js package
+
+
+## Features
+
+
+## Changelog
+
+Available here: [CHANGELOG.md](https://github.com/html-to-text/node-html-to-text/blob/master/packages/html-to-text-cli/CHANGELOG.md)
+
+
+## Installation
+
+```
+npm i -g @html-to/text-cli
+```
+
+### Name collisions
+
+- old versions of `html-to-text` package expose a command with the same name. Make sure that package is not installed globally anymore.
+- there is an old abandoned CLI package that exposes a command with the same name and actually has nothing to do with `html-to-text` package. Make sure to only use namespaced package `@html-to/text-cli`.
+
+
+## Usage
+
+- Use `html-to-text` command;
+- Pipe HTML to `stdin`;
+- Get plain text from `stdout`;
+- Pass converter options as command arguments.
+
+TODO
+
+
+## License
+
+[MIT License](https://github.com/html-to-text/node-html-to-text/blob/master/LICENSE)

packages/html-to-text-cli/package-lock.json

@@ -0,0 +1,47 @@
+{
+  "name": "@html-to/text-cli",
+  "version": "0.5.0",
+  "description": "CLI html to plain text converter",
+  "keywords": [
+    "html",
+    "node",
+    "text",
+    "converter",
+    "html-to-text",
+    "cli-wrapper"
+  ],
+  "license": "MIT",
+  "author": "KillyMXI <[email protected]>",
+  "homepage": "https://github.com/html-to-text/node-html-to-text",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/html-to-text/node-html-to-text.git"
+  },
+  "bugs": {
+    "url": "https://github.com/html-to-text/node-html-to-text/issues"
+  },
+  "type": "module",
+  "bin": {
+    "html-to-text": "./bin/cli.js"
+  },
+  "files": [
+    "bin",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": ">=14.13.1"
+  },
+  "scripts": {
+    "build:rollup": "rollup -c",
+    "build": "npm run clean && npm run build:rollup",
+    "clean": "rimraf bin",
+    "copy:license": "copyfiles -f ../../LICENSE .",
+    "prepublishOnly": "npm run copy:license"
+  },
+  "dependencies": {
+    "deepmerge": "^4.2.2",
+    "aspargvs": "^0.5.0"
+  }
+}

packages/html-to-text-cli/package.json

@@ -0,0 +1,21 @@
+
+// const json = require('@rollup/plugin-json');
+const { nodeResolve } = require('@rollup/plugin-node-resolve');
+
+/**
+ * @type {import('rollup').RollupOptions}
+ */
+module.exports = {
+  input: 'src/cli.js',
+  output: [
+    {
+      // banner: '#!/usr/bin/env node\n',
+      file: 'bin/cli.js',
+      format: 'es',
+    }
+  ],
+  plugins: [
+    // json(),
+    nodeResolve({ resolveOnly: ['@html-to-text/html-to-text'] })
+  ],
+};