@khatastroffik/treefolder 1.0.0 → 1.2.0

package/README.md

@@ -59,9 +59,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 +76,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,2 @@
 #! /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 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;console.error(`[${(0,node_util_1.styleText)("red",o.name)}]: ${o.message}`),(0,node_process_1.exit)(1)}const{values:o,positionals:n}=e;o.version&&(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"}}function t(e){return(0,node_util_1.styleText)("number"==typeof e?"yellow":"blueBright",`${e}`)}async function version(){console.info(t(`\n            Treefolder  aka  "tfold"\n                 Version ${package_json_1.version}\n                 \n    https://npmjs.com/@khatastroffik/treefolder\n\n  ┌─────────────────────────────────────────────┐\n  |                                             |\n     ╭━┳━╭━╭━╮╮\n     ┃┈┈┈┣▄╋▄┫\n     ┃┈┃┈╰━╰━━━━━━╮            "K11K"\n     ╰┳╯┈┈┈┈┈┈┈┈ ◢█◣    a very pragmatic dog\n      ┃┈┈┈┈┈┈┈┈┈┈████\n      ┃┈┈┈┈┈┈┈┈┈┈◥█◤\n      ┃┈┈┈┈╭━┳━━━━╯\n      ┣━━━━━━┫\n  |                                             |\n  └──────────── made by khatastroffik ──────────┘\n  `))}async function main(){await configure(),console.info(await buildTree(config.root,"",!0,!0)),config.verbose&&(console.info(t("\nCommand line arguments:")),console.info(cliArgs),console.info(t("\nTreefolder configuration:")),console.info(config,"\n"),console.info(t(`Scanned ${t(folderCount)} folders and ${t(fileCount)} files.`)),console.info(t(`Filtered out ${t(ignoredCount)} items (folders or files).`)))}main();
+"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();

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
@@ -113,4 +185,4 @@ treefolder
 
 ### Other topics
 
-- https://github.com/absolute-version/commit-and-tag-version
+- <https://github.com/absolute-version/commit-and-tag-version>

package/package.json

@@ -1,11 +1,16 @@
 {
   "name": "@khatastroffik/treefolder",
-  "version": "1.0.0",
+  "version": "1.2.0",
   "devEngines": {
-    "packageManager": {
-      "name": "pnpm",
-      "version": "10.28.2"
-    }
+    "packageManager": [
+      {
+        "name": "pnpm",
+        "version": "10.28.2"
+      },
+      {
+        "name": "npm"
+      }
+    ]
   },
   "description": "A node.js CLI utility generating a tree representation (treeview) of a folder structure including its contained files and subfolders.",
   "author": "khatastroffik",