@khatastroffik/treefolder 1.1.0 → 1.2.1

package/README.md

@@ -38,6 +38,7 @@ 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)
@@ -59,9 +60,15 @@ Notes:
 
 ### Sort leaves "folders first"
 
-By default, the list i.e. the leaves of the treeview are sorted following the _"folders first" principle_: All the folders are listed first, then all the files. All items are alphabetically sorted. This apply at any depth within the tree structure.
+By default, the list or the leaves of the treeview are sorted following the _"folders first" principle_: All the folders are listed first, then all the files. All items are alphabetically sorted. This apply at any depth within the tree structure.
 
-This behavior can be _disabled_ using the command line argument `--unsorted`. In this case, all items are sorted the way the operating system does e.g. sorted by their names, regardless of their type (directory or file).
+This behavior can be _disabled_ using the command line argument `--unsorted`. In this case, all items are sorted the way the operating system does by default e.g. sorted by their names, regardless of their type (directory or file).
+
+### List output
+
+When the command line argument `--list` (short: `-l`) is used, all the folders and files will be displayed as a flat list instead of as a treeview.
+
+Note: the command line arguments `--unsorted` and `--style colored` may also be applied to refine i.e. adapt the list output. See the [List output examples](docs/readme.md#list-output-examples)
 
 ### Styled output
 
@@ -70,7 +77,10 @@ The style can be defined using the command line argument `--style`or `-s` like s
 
 → Examples of styled output can be found in the additional documentation: [Styled output examples](docs/readme.md#styled-output-examples)
 
-Note: some environments i.e. shells may not display the symbols (which are represented using specific unicode code points like `U+1F5BF` or `U+1F5C1`) properly. Try to change the _font_ used in the shell in order to display the correct unicode symbols.
+Notes:
+
+- some shell environments may not display the symbols (which are represented using specific unicode code points like `U+1F5BF` or `U+1F5C1`) properly. Try to change the _font_ used in the shell or to change the code page used by your shell in the background to interpret the chars, in order to display the unicode symbols properly.
+- On some shell environments e.g. under Windows OS, the output may still be faulty due to the OS automatically pre-formating the output in an inadequate way. Try to use another shell environment then.
 
 ### Version information
 

package/dist/index.js

@@ -1,2 +1,42 @@
 #! /usr/bin/env node
-"use strict";var __createBinding=this&&this.__createBinding||(Object.create?function(e,o,n,t){void 0===t&&(t=n);var r=Object.getOwnPropertyDescriptor(o,n);r&&!("get"in r?!o.__esModule:r.writable||r.configurable)||(r={enumerable:!0,get:function(){return o[n]}}),Object.defineProperty(e,t,r)}:function(e,o,n,t){void 0===t&&(t=n),e[t]=o[n]}),__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 n in e)Object.prototype.hasOwnProperty.call(e,n)&&(o[o.length]=n);return o},e(o)};return function(o){if(o&&o.__esModule)return o;var n={};if(null!=o)for(var t=e(o),r=0;r<t.length;r++)"default"!==t[r]&&__createBinding(n,o,t[r]);return __setModuleDefault(n,o),n}}(),__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"}},config={style:Style.none,symbols:symbolStyles.none,root:".",ignores:["node_modules","dist","build",".git",".husky\\_","logs",".angular","coverage"],verbose:!1,unsorted:!1};let folderCount=0,fileCount=0,ignoredCount=0,cliArgs={};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 n=config.ignores.includes(node_path_1.default.join(e,o));return n&&ignoredCount++,n}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,n,t){const r=await getFolderContent(e),i=r.length<1?config.symbols.closed:config.symbols.open;let s=`${o+(n?"":t?`└─${i} `:`├─${i} `)}${n&&config.symbols.open?`${i} ${node_path_1.default.basename(e)}`:node_path_1.default.basename(e)}\n`;const l=n?"":t?"   ":"│  ",a=r.length-1;for(let n=0;n<r.length;n++){const t=r[n];if(t.isDirectory()&&(s+=await buildTree(node_path_1.default.join(e,t.name),o+l,!1,n===a)),t.isFile()){fileCount++;s+=`${o+l+(n===a?`└─${config.symbols.file} `:`├─${config.symbols.file} `)+t.name}\n`}}return folderCount++,s}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:n}=e;if(o.version)return await version(),(0,node_process_1.exit)(0);config.style=Style[o.style]??config.style,config.symbols=symbolStyles[config.style],config.root=node_path_1.default.resolve(n.length>0?n[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:n[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 E=Object.create;var $=Object.defineProperty;var M=Object.getOwnPropertyDescriptor;var O=Object.getOwnPropertyNames;var S=Object.getPrototypeOf,K=Object.prototype.hasOwnProperty;var _=(e,t,n,l)=>{if(t&&typeof t=="object"||typeof t=="function")for(let r of O(t))!K.call(e,r)&&r!==n&&$(e,r,{get:()=>t[r],enumerable:!(l=M(t,r))||l.enumerable});return e};var u=(e,t,n)=>(n=e!=null?E(S(e)):{},_(t||!e||!e.__esModule?$(n,"default",{value:e,enumerable:!0}):n,e));var h=u(require("node:path"));var s=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.0";function a(e){return(0,f.styleText)(typeof e=="number"?"yellow":"blueBright",`${e}`)}async function R(){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 P(){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 R();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(a(`
+              Treefolder  aka  "tfold"
+                   Version ${p}
+               
+      https://npmjs.com/@khatastroffik/treefolder
+${t??e}`)),(0,b.exit)(0)}}async function j(){o.verbose&&(console.info(a(`
+Command line arguments:`)),console.info(s.commandLineArgs),console.info(a(`
+Treefolder configuration:`)),console.info(o,`
+`),console.info(a(`Scanned ${a(s.folderCount)} folders and ${a(s.fileCount)} files.`)),console.info(a(`Filtered out ${a(s.ignoredCount)} items (folders or files).`)))}var W={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"}};function C(){try{return(0,f.parseArgs)({options:W,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 i=" ",x=(r=>(r.none="none",r.wireframe="wireframe",r.black="black",r.colored="colored",r))(x||{}),I={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:I.none,root:".",ignores:["node_modules","dist","build",".git",".husky\\_","logs",".angular","coverage"],verbose:!1,unsorted:!1,formatAsList:!1,version:!1};async function T(){let{values:e,positionals:t}=C();o.version=e.version,o.formatAsList=e.list,o.style=x[e.style]??o.style,o.symbols=I[o.style],o.root=h.default.resolve(t.length>0?t[0]:o.root),o.ignores=o.ignores.map(n=>h.default.join(o.root,n)),o.unsorted=!!e.unsorted,o.verbose=!!e.verbose,s.commandLineArgs={...e,root:t[0]??"n/a"}}var L=u(require("node:fs")),c=u(require("node:path")),g=u(require("node:util"));var q=g.default.promisify(L.default.readdir),k,w;function G(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 U(e){return`${c.default.join(e.contentItem.parentPath,e.contentItem.name)}
+`}function X(e,t){return e.isDirectory()?t.isFile()?-1:e.name.localeCompare(t.name):t.isDirectory()?1:e.name.localeCompare(t.name)}function Y(e,t){let n=o.ignores.includes(c.default.join(e,t));return n&&s.ignoredCount++,n}async function Z(e){let t=(await q(e,{withFileTypes:!0})).filter(n=>!Y(e,n.name));return o.unsorted?t:t.sort(X)}async function A(e,t,n,l){let r=await Z(e),V=r.length<1?o.symbols.closed:o.symbols.open,N=n?"":(l?"\u2514\u2500":"\u251C\u2500")+(o.symbols.open?"":i),y=k({indent:t,folderPrefix:N,foldersymbol:V,folderName:e}),v=n?"":l?`${i}${i}${i}`:`\u2502${i}${i}`,F=r.length-1;for(let m=0;m<r.length;m++){let d=r[m];if(d.isDirectory()&&(y+=await A(c.default.join(e,d.name),t+v,!1,m===F)),d.isFile()){s.fileCount++;let B=m===F?`\u2514\u2500${o.symbols.file}${i}`:`\u251C\u2500${o.symbols.file}${i}`;y+=w({indent:t,contentItemPrefix:v,entityPrefix:B,contentItem:d})}}return s.folderCount++,y}async function D(){k=G,w=J,o.formatAsList&&(k=Q,w=U);let e=await A(o.root,"",!0,!0);console.info(e)}async function H(){await T(),await P(),await D(),await j()}H();
+/*!
+ * @khatastroffik/treefolder
+ *
+ * License: MIT
+ * Copyright (c) 2026, Loïs Bégué
+ *
+ */

package/docs/readme.md

@@ -1,5 +1,11 @@
 # Additional documentation
 
+## Table of Content
+
+- [Styled output examples](#styled-output-examples)
+- [List output examples](#list-output-examples)
+- [Sources & stories](#sources--stories)
+
 ## Styled output examples
 
 ### "none" Style → `--style=none`
@@ -96,6 +102,72 @@ treefolder
 └─🗋 tsconfig.json
 ```
 
+## List output examples
+
+### Simple list output → `--list`
+
+This is the **default** format of the list output: it displays the full path of the items and all items are sorted using the _"folder first" principle_.
+
+```shell
+C:\development\treefolder\
+C:\development\treefolder\.husky\
+C:\development\treefolder\.husky\pre-commit
+C:\development\treefolder\.vscode\
+C:\development\treefolder\.vscode\settings.json
+C:\development\treefolder\docs\
+C:\development\treefolder\docs\commit-messages-guideline.md
+C:\development\treefolder\docs\readme.md
+C:\development\treefolder\docs\tfold.jpg
+C:\development\treefolder\src\
+C:\development\treefolder\src\index.ts
+C:\development\treefolder\.gitattributes
+C:\development\treefolder\.gitignore
+C:\development\treefolder\CHANGELOG.md
+C:\development\treefolder\eslint.config.mjs
+C:\development\treefolder\jest.config.js
+C:\development\treefolder\LICENSE
+C:\development\treefolder\package.json
+C:\development\treefolder\pnpm-lock.yaml
+C:\development\treefolder\pnpm-workspace.yaml
+C:\development\treefolder\README.md
+C:\development\treefolder\tsconfig.json
+```
+
+### Unsorted list output → `--list --unsorted`
+
+In this use case, the list items are sorted the way the operating system does by default e.g. sorted by their names, regardless of their type (directory or file).
+
+```shell
+C:\development\treefolder\
+C:\development\treefolder\.gitattributes
+C:\development\treefolder\.gitignore
+C:\development\treefolder\.husky\
+C:\development\treefolder\.husky\pre-commit
+C:\development\treefolder\.vscode\
+C:\development\treefolder\.vscode\settings.json
+C:\development\treefolder\CHANGELOG.md
+C:\development\treefolder\docs\
+C:\development\treefolder\docs\commit-messages-guideline.md
+C:\development\treefolder\docs\readme.md
+C:\development\treefolder\docs\tfold.jpg
+C:\development\treefolder\eslint.config.mjs
+C:\development\treefolder\jest.config.js
+C:\development\treefolder\LICENSE
+C:\development\treefolder\package.json
+C:\development\treefolder\pnpm-lock.yaml
+C:\development\treefolder\pnpm-workspace.yaml
+C:\development\treefolder\README.md
+C:\development\treefolder\src\
+C:\development\treefolder\src\index.ts
+C:\development\treefolder\tsconfig.json
+```
+
+### Colored list output → `--list --style colored`
+
+In this use case, the list output highlights i.e. colors the _directoy_ items in _bright blue_.
+
+There's no _preview_ of such a generated output at the moment, though.
+
 ## Sources & stories
 
 ### From trees and leaves

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@khatastroffik/treefolder",
-  "version": "1.1.0",
+  "version": "1.2.1",
   "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,15 +72,35 @@
   "lint-staged": {
     "*.ts": "pnpm lintix"
   },
+  "commit-and-tag-version": {
+    "types": [
+      {
+        "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",