@khatastroffik/treefolder 1.2.0 → 1.3.0

package/README.md

@@ -38,9 +38,11 @@ This is the recommanded and easiest approach.
 1. [Auto "root folder"](#auto-root-folder)
 1. [Auto "ignore paths"](#auto-ignore-paths)
 1. [Sort leaves "folders first"](#sort-leaves-folders-first)
+1. [List output](#list-output)
 1. [Styled output](#styled-output)
 1. [Version information](#version-information)
 1. [Verbose output](#verbose-output)
+1. [Debug Output](#debug-output)
 
 ### Auto "root folder"
 
@@ -89,6 +91,10 @@ Use the command line argument `--version` or `-v` to display the version informa
 
 When the flag i.e. command line argument `--verbose` is defined/set, then a few more information will be displayed together with the tree representation.
 
+### Debug output
+
+Use the flag `--debug` (short `-d`) to display additional information about the used tool configuration.
+
 ## Development
 
 ### Manually install as a globally available CLI tool `tfold`

package/dist/index.js

@@ -1,2 +1,40 @@
 #! /usr/bin/env node
-"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,o,t,n){void 0===n&&(n=t);var r=Object.getOwnPropertyDescriptor(o,t);r&&!("get"in r?!o.__esModule:r.writable||r.configurable)||(r={enumerable:!0,get:function(){return o[t]}}),Object.defineProperty(e,n,r)}:function(e,o,t,n){void 0===n&&(n=t),e[n]=o[t]}),__setModuleDefault=this&&this.__setModuleDefault||(Object.create?function(e,o){Object.defineProperty(e,"default",{enumerable:!0,value:o})}:function(e,o){e.default=o}),__importStar=this&&this.__importStar||function(){var e=function(o){return e=Object.getOwnPropertyNames||function(e){var o=[];for(var t in e)Object.prototype.hasOwnProperty.call(e,t)&&(o[o.length]=t);return o},e(o)};return function(o){if(o&&o.__esModule)return o;var t={};if(null!=o)for(var n=e(o),r=0;r<n.length;r++)"default"!==n[r]&&__createBinding(t,o,n[r]);return __setModuleDefault(t,o),t}}(),__importDefault=this&&this.__importDefault||function(e){return e&&e.__esModule?e:{default:e}};Object.defineProperty(exports,"__esModule",{value:!0});const node_fs_1=__importDefault(require("node:fs")),node_path_1=__importDefault(require("node:path")),node_process_1=require("node:process"),node_util_1=__importStar(require("node:util")),package_json_1=require("../package.json"),readdirPromise=node_util_1.default.promisify(node_fs_1.default.readdir),space=" ";var Style;!function(e){e.none="none",e.wireframe="wireframe",e.black="black",e.colored="colored"}(Style||(Style={}));const symbolStyles={none:{closed:"",open:"",file:""},wireframe:{closed:"🗀  ",open:"🗁  ",file:"🗋"},black:{closed:"🖿 ",open:"🖿 ",file:"🗎"},colored:{closed:"📁 ",open:"📂 ",file:"📄"}},parseArgsOptionsConfig={style:{type:"string",default:"none",short:"s"},verbose:{type:"boolean",default:!1},unsorted:{type:"boolean",default:!1,short:"u"},version:{type:"boolean",default:!1,short:"v"},list:{type:"boolean",default:!1,short:"l"}},config={style:Style.none,symbols:symbolStyles.none,root:".",ignores:["node_modules","dist","build",".git",".husky\\_","logs",".angular","coverage"],verbose:!1,unsorted:!1,formatAsList:!1};let folderCount=0,fileCount=0,ignoredCount=0,cliArgs={};function formatFolderLeaf(e,o,t,n){return`${e+o+t+node_path_1.default.basename(n)}\n`}function formatFileLeaf(e,o,t,n){return`${e+o+t+n.name}\n`}function formatFolderListItem(e,o,t,n){let r=n+node_path_1.default.sep;return config.style===Style.colored&&(r=(0,node_util_1.styleText)("blueBright",r)),`${r}\n`}function formatFileListItem(e,o,t,n){return`${node_path_1.default.join(n.parentPath,n.name)}\n`}let formatFolder=formatFolderLeaf,formatFile=formatFileLeaf;function colorText(e){return(0,node_util_1.styleText)("number"==typeof e?"yellow":"blueBright",`${e}`)}async function getLatestVersion(){const e=await fetch("https://registry.npmjs.org/@khatastroffik/treefolder");await new Promise(e=>setTimeout(e,100));return(await e.json())["dist-tags"].latest}function compareFolderContentItems(e,o){return e.isDirectory()?o.isFile()?-1:e.name.localeCompare(o.name):o.isDirectory()?1:e.name.localeCompare(o.name)}function isIgnored(e,o){const t=config.ignores.includes(node_path_1.default.join(e,o));return t&&ignoredCount++,t}async function getFolderContent(e){const o=(await readdirPromise(e,{withFileTypes:!0})).filter(o=>!isIgnored(e,o.name));return config.unsorted?o:o.sort(compareFolderContentItems)}async function buildTree(e,o,t,n){const r=await getFolderContent(e),i=r.length<1?config.symbols.closed:config.symbols.open,s=t?"":(n?"└─":"├─")+(config.symbols.open?"":" ");let l=formatFolder(o,s,i,e);const a=t?"":n?"   ":"│  ",f=r.length-1;for(let t=0;t<r.length;t++){const n=r[t];if(n.isDirectory()&&(l+=await buildTree(node_path_1.default.join(e,n.name),o+a,!1,t===f)),n.isFile()){fileCount++;const e=t===f?`└─${config.symbols.file} `:`├─${config.symbols.file} `;l+=formatFile(o,a,e,n)}}return folderCount++,l}async function configure(){let e;try{e=(0,node_util_1.parseArgs)({options:parseArgsOptionsConfig,allowPositionals:!0,strict:!0})}catch(e){const o=e;return console.error(`[${(0,node_util_1.styleText)("red",o.name)}]: ${o.message}`),(0,node_process_1.exit)(1)}const{values:o,positionals:t}=e;if(o.version)return await version(),(0,node_process_1.exit)(0);config.formatAsList=Boolean(o.list),config.formatAsList&&(formatFolder=formatFolderListItem,formatFile=formatFileListItem),config.style=Style[o.style]??config.style,config.symbols=symbolStyles[config.style],config.root=node_path_1.default.resolve(t.length>0?t[0]:config.root),config.ignores=config.ignores.map(e=>node_path_1.default.join(config.root,e)),config.unsorted=Boolean(o.unsorted),config.verbose=Boolean(o.verbose),cliArgs={...o,root:t[0]??"n/a"}}async function version(){let e;const o=await getLatestVersion();o&&o!==package_json_1.version&&(e=(0,node_util_1.styleText)("yellow",`\n┌─────────────────────────────────────────────────────┐\n|        A new version of Treefolder is available:    |\n|          current: ${package_json_1.version}  ->  latest: ${o}          |\n|                                                     |\n|          Install the latest version with:           |\n|   "npm update -g @khatastroffik/treefolder@latest"  |\n└─────────────────────────────────────────────────────┘\n`)),console.info(colorText(`\n              Treefolder  aka  "tfold"\n                   Version ${package_json_1.version}\n               \n      https://npmjs.com/@khatastroffik/treefolder\n${e??'\n    ┌─────────────────────────────────────────────┐\n    |                                             |\n       ╭━┳━╭━╭━╮╮\n       ┃┈┈┈┣▄╋▄┫\n       ┃┈┃┈╰━╰━━━━━━╮            "K11K"\n       ╰┳╯┈┈┈┈┈┈┈┈ ◢█◣    a very pragmatic dog\n        ┃┈┈┈┈┈┈┈┈┈┈████\n        ┃┈┈┈┈┈┈┈┈┈┈◥█◤\n        ┃┈┈┈┈╭━┳━━━━╯\n        ┣━━━━━━┫\n    |                                             |\n    └──────────── made by khatastroffik ──────────┘\n  '}`))}async function verbose(){config.verbose&&(console.info(colorText("\nCommand line arguments:")),console.info(cliArgs),console.info(colorText("\nTreefolder configuration:")),console.info(config,"\n"),console.info(colorText(`Scanned ${colorText(folderCount)} folders and ${colorText(fileCount)} files.`)),console.info(colorText(`Filtered out ${colorText(ignoredCount)} items (folders or files).`)))}async function main(){await configure();const e=await buildTree(config.root,"",!0,!0);console.info(e),await verbose()}main();
+"use strict";var S=Object.create;var $=Object.defineProperty;var M=Object.getOwnPropertyDescriptor;var O=Object.getOwnPropertyNames;var K=Object.getPrototypeOf,R=Object.prototype.hasOwnProperty;var _=(e,t,n,l)=>{if(t&&typeof t=="object"||typeof t=="function")for(let i of O(t))!R.call(e,i)&&i!==n&&$(e,i,{get:()=>t[i],enumerable:!(l=M(t,i))||l.enumerable});return e};var u=(e,t,n)=>(n=e!=null?S(K(e)):{},_(t||!e||!e.__esModule?$(n,"default",{value:e,enumerable:!0}):n,e));var h=u(require("node:path"));var r=class{static folderCount=1;static fileCount=0;static ignoredCount=0;static commandLineArgs={}};var b=require("node:process"),f=require("node:util");var p="1.2.1";function s(e){return(0,f.styleText)(typeof e=="number"?"yellow":"blueBright",`${e}`)}async function G(){let e=await fetch("https://registry.npmjs.org/@khatastroffik/treefolder");return await new Promise(l=>setTimeout(l,100)),(await e.json())["dist-tags"].latest}async function C(){if(o.version){let e=`
+    \u250C\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510
+    |                                             |
+       \u256D\u2501\u2533\u2501\u256D\u2501\u256D\u2501\u256E\u256E
+       \u2503\u2508\u2508\u2508\u2523\u2584\u254B\u2584\u252B
+       \u2503\u2508\u2503\u2508\u2570\u2501\u2570\u2501\u2501\u2501\u2501\u2501\u2501\u256E            "K11K"
+       \u2570\u2533\u256F\u2508\u2508\u2508\u2508\u2508\u2508\u2508\u2508 \u25E2\u2588\u25E3    a very pragmatic dog
+        \u2503\u2508\u2508\u2508\u2508\u2508\u2508\u2508\u2508\u2508\u2508\u2588\u2588\u2588\u2588
+        \u2503\u2508\u2508\u2508\u2508\u2508\u2508\u2508\u2508\u2508\u2508\u25E5\u2588\u25E4
+        \u2503\u2508\u2508\u2508\u2508\u256D\u2501\u2533\u2501\u2501\u2501\u2501\u256F
+        \u2523\u2501\u2501\u2501\u2501\u2501\u2501\u252B
+    |                                             |
+    \u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500 made by khatastroffik \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518
+  `,t,n=await G();return n&&n!==p&&(t=(0,f.styleText)("yellow",`
+\u250C\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2510
+|        A new version of Treefolder is available:    |
+|          current: ${p}  ->  latest: ${n}          |
+|                                                     |
+|          Install the latest version with:           |
+|   "npm update -g @khatastroffik/treefolder@latest"  |
+\u2514\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2518
+`)),console.info(s(`
+              Treefolder  aka  "tfold"
+                   Version ${p}
+               
+      https://npmjs.com/@khatastroffik/treefolder
+${t??e}`)),(0,b.exit)(0)}}async function P(){o.debug&&(console.info(s(`${"+".repeat(26)} DEBUG ${"+".repeat(27)}`)),console.info(s("Command line arguments:")),console.info(r.commandLineArgs),console.info(s("Treefolder configuration:")),console.info(o),console.info(s("FolderCount:"),s(r.folderCount)),console.info(s("FileCount:"),s(r.fileCount)),console.info(s("IgnoredCount:"),s(r.ignoredCount)),console.info(s("+".repeat(60))))}async function j(){o.verbose&&(console.info(s(`
+Scanned ${s(r.folderCount)} folders and ${s(r.fileCount)} files.`)),console.info(s(`Filtered out ${s(r.ignoredCount)} items (folders or files).`)))}var U={style:{type:"string",default:"none",short:"s"},verbose:{type:"boolean",default:!1},unsorted:{type:"boolean",default:!1,short:"u"},version:{type:"boolean",default:!1,short:"v"},list:{type:"boolean",default:!1,short:"l"},debug:{type:"boolean",default:!1,short:"d"}};function I(){try{return(0,f.parseArgs)({options:U,allowPositionals:!0,strict:!0})}catch(e){let t=e;return console.error(`[${(0,f.styleText)("red",t.name)}]: ${t.message}`),(0,b.exit)(1)}}var a=" ",x=(i=>(i.none="none",i.wireframe="wireframe",i.black="black",i.colored="colored",i))(x||{}),T={none:{closed:"",open:"",file:""},wireframe:{closed:"\u{1F5C0}  ",open:"\u{1F5C1}  ",file:"\u{1F5CB}"},black:{closed:"\u{1F5BF} ",open:"\u{1F5BF} ",file:"\u{1F5CE}"},colored:{closed:"\u{1F4C1} ",open:"\u{1F4C2} ",file:"\u{1F4C4}"}},o={style:"none",symbols:T.none,root:".",ignores:["node_modules","dist","build",".git",".husky\\_","logs",".angular","coverage"],verbose:!1,unsorted:!1,formatAsList:!1,version:!1,debug:!1};async function D(){let{values:e,positionals:t}=I();o.version=e.version,o.formatAsList=e.list,o.style=x[e.style]??o.style,o.symbols=T[o.style],o.root=h.default.resolve(t[0]??o.root),o.ignores=o.ignores.map(n=>h.default.join(o.root,n)),o.unsorted=e.unsorted,o.verbose=e.verbose,o.debug=e.debug,r.commandLineArgs={...e,root:t[0]??"n/a"}}var L=u(require("node:fs")),c=u(require("node:path")),g=u(require("node:util"));var W=g.default.promisify(L.default.readdir),w,k;function q(e){return`${e.indent+e.folderPrefix+e.foldersymbol+c.default.basename(e.folderName)}
+`}function J(e){return`${e.indent+e.contentItemPrefix+e.entityPrefix+e.contentItem.name}
+`}function Q(e){let t=e.folderName+c.default.sep;return o.style==="colored"&&(t=(0,g.styleText)("blueBright",t)),`${t}
+`}function X(e){return`${c.default.join(e.contentItem.parentPath,e.contentItem.name)}
+`}function Y(e,t){return e.isDirectory()?t.isFile()?-1:e.name.localeCompare(t.name):t.isDirectory()?1:e.name.localeCompare(t.name)}function Z(e,t){let n=o.ignores.includes(c.default.join(e,t));return n&&r.ignoredCount++,n}async function H(e){let t=(await W(e,{withFileTypes:!0})).filter(n=>!Z(e,n.name));return o.unsorted?t:t.sort(Y)}async function A(e,t,n,l){let i=await H(e),N=i.length<1?o.symbols.closed:o.symbols.open,B=n?"":(l?"\u2514\u2500":"\u251C\u2500")+(o.symbols.open?"":a),y=w({indent:t,folderPrefix:B,foldersymbol:N,folderName:e}),v=n?"":l?`${a}${a}${a}`:`\u2502${a}${a}`,F=i.length-1;for(let d=0;d<i.length;d++){let m=i[d];if(m.isDirectory()&&(y+=await A(c.default.join(e,m.name),t+v,!1,d===F)),m.isFile()){r.fileCount++;let E=d===F?`\u2514\u2500${o.symbols.file}${a}`:`\u251C\u2500${o.symbols.file}${a}`;y+=k({indent:t,contentItemPrefix:v,entityPrefix:E,contentItem:m})}}return r.folderCount++,y}async function V(){w=q,k=J,o.formatAsList&&(w=Q,k=X);let e=await A(o.root,"",!0,!0);console.info(e)}async function ee(){await D(),await C(),await V(),await P(),await j()}ee();
+/*!
+ * @khatastroffik/treefolder
+ *
+ * License: MIT
+ * Copyright (c) 2026, Loïs Bégué
+ *
+ */

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@khatastroffik/treefolder",
-  "version": "1.2.0",
+  "version": "1.3.0",
   "devEngines": {
     "packageManager": [
       {
@@ -55,6 +55,7 @@
     "@eslint/markdown": "^7.5.1",
     "@types/jest": "^30.0.0",
     "@types/node": "^25.0.3",
+    "esbuild": "^0.27.2",
     "eslint": "^9.39.2",
     "eslint-plugin-format": "^1.1.0",
     "eslint-plugin-jest": "^29.12.1",
@@ -63,7 +64,6 @@
     "jest": "^30.2.0",
     "lint-staged": "^16.2.7",
     "rimraf": "^6.1.2",
-    "terser": "^5.46.0",
     "ts-jest": "^29.4.6",
     "tsx": "^4.21.0",
     "typescript": "^5.9.3",
@@ -72,21 +72,76 @@
   "lint-staged": {
     "*.ts": "pnpm lintix"
   },
+  "commit-and-tag-version": {
+    "types": [
+      {
+        "type": "feat",
+        "section": "Features",
+        "hidden": false
+      },
+      {
+        "type": "chore",
+        "section": "Chore",
+        "hidden": false
+      },
+      {
+        "type": "ci",
+        "section": "CI/CD",
+        "hidden": false
+      },
+      {
+        "type": "improve",
+        "section": "Improvements / Addendum",
+        "hidden": false
+      },
+      {
+        "type": "fix",
+        "section": "Bug Fixes / Corrigendum",
+        "hidden": false
+      },
+      {
+        "type": "perf",
+        "section": "Performance / Optimization",
+        "hidden": false
+      },
+      {
+        "type": "test",
+        "section": "Code Quality",
+        "hidden": false
+      },
+      {
+        "type": "refactor",
+        "section": "Refactors",
+        "hidden": false
+      },
+      {
+        "type": "docs",
+        "section": "Documentation",
+        "hidden": false
+      },
+      {
+        "type": "build",
+        "section": "Build System / Dependencies",
+        "hidden": false
+      }
+    ]
+  },
   "scripts": {
     "test": "jest --passWithNoTests",
     "lint": "eslint .",
     "lintix": "eslint . --fix",
     "clean": "rimraf ./dist",
-    "dev": "tsx watch src/index.ts",
+    "dev": "tsx watch --include \"src/**/*\" src/index.ts",
     "typecheck": "tsc --noEmit",
-    "build": "pnpm clean && tsc",
-    "build2prod": "pnpm build && terser dist/index.js -o dist/index.js -c -m",
+    "build": "pnpm clean && esbuild --bundle --minify --platform=node --outdir=dist ./src/index.ts",
+    "buildwatch": "pnpm build --watch --watch-delay=500",
+    "build2prod": "pnpm build --tree-shaking=true --analyze",
     "start": "node .",
     "pushtags": "git push --follow-tags origin main",
     "try-commit": "git hook run pre-commit",
     "tsx": "tsx",
-    "release": "pnpm dlx commit-and-tag-version",
-    "release:test": "pnpm dlx commit-and-tag-version --dry-run",
+    "release": "pnpx commit-and-tag-version",
+    "release:test": "pnpx commit-and-tag-version --dry-run",
     "pub": "pnpm pushtags && pnpm publish",
     "pub:test": "pnpm publish --dry-run --force --no-git-checks"
   }