Merge pull request #14 from hildjj/ansi

Allow ANSI escapes

Author: hildjj

.github/workflows/publish.yml

@@ -6,7 +6,7 @@ jobs:
   build:
     runs-on: ubuntu-latest
     permissions:
-      contents: read
+      contents: write
       id-token: write
     steps:
       - uses: actions/checkout@v4
@@ -18,6 +18,12 @@ jobs:
           cache: pnpm
       - run: pnpm i -r
       - run: npm run build
+      - name: Deploy
+        uses: peaceiris/actions-gh-pages@v4
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: docs
+          publish_branch: gh-pages
       - run: npm publish --access public --provenance
         env:
           NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

.gitignore

@@ -2,3 +2,4 @@
 coverage/
 lib/
 node_modules/
+docs/

.npmignore

@@ -10,3 +10,5 @@ eslint.config.js
 src/
 test/
 tsconfig.json
+docs/
+typedoc.config.cjs

package.json

@@ -5,12 +5,13 @@
   "main": "lib/index.js",
   "type": "module",
   "scripts": {
+    "docs": "typedoc",
     "pretest": "tsc",
     "test": "c8 mocha",
     "preci": "tsc --inlineSourceMap",
     "ci": "c8 mocha",
     "lint": "eslint .",
-    "build": "npm test && npm run lint && npm pack --dry-run"
+    "build": "npm test && npm run lint && npm run docs && npm pack --dry-run"
   },
   "keywords": [
     "parseArgs",
@@ -28,28 +29,19 @@
     "url": "git+https://github.com/hildjj/minus-h.git"
   },
   "dependencies": {
-    "@cto.af/linewrap": "2.0.0"
+    "@cto.af/linewrap": "2.1.0"
   },
   "devDependencies": {
-    "@cto.af/eslint-config": "4.1.1",
-    "@types/node": "20.14.9",
+    "@cto.af/eslint-config": "4.1.5",
+    "@types/node": "22.1.0",
     "c8": "10.1.2",
-    "eslint": "9.5.0",
-    "mocha": "10.5.1",
-    "typescript": "5.5.2",
-    "typescript-eslint": "8.0.0-alpha.33"
+    "eslint": "9.8.0",
+    "mocha": "10.7.0",
+    "typedoc": "0.26.5",
+    "typescript": "5.5.4",
+    "typescript-eslint": "8.0.1"
   },
-  "overrides": {
-    "@typescript-eslint/utils": "8.0.0-alpha.33",
-    "@typescript-eslint/parser": "8.0.0-alpha.33"
-  },
-  "pnpm": {
-    "overrides": {
-      "@typescript-eslint/utils": "8.0.0-alpha.33",
-      "@typescript-eslint/parser": "8.0.0-alpha.33"
-    }
-  },
-  "packageManager": "[email protected]",
+  "packageManager": "[email protected]",
   "engines": {
     "node": ">=20"
   }