@yetanothertool/directory-scanner

Directory/File tree to JSON

Report Bug · Request Feature

---

Table of Contents

1. About
   • Technologies
2. Getting Started
   • Prerequisites
   • Installation
3. Usage
4. Contributing
5. License
6. Contact

---

---

About

Simple NodeJS script to scan the current directory and extract the tree into a hierarchy.json file.

Technologies

This section covers the tools and packages used for the project,

• NodeJS

Getting Started

Prerequisites

• NodeJS

Installation

npm install -g @yetanothertool/directory-scanner

Usage

yat-dir-scanner

Then open the hierarchy.json to see your file/directory tree.

---

Contributing

1. Create a Feature Branch
2. Commit your changes
3. Push your changes
4. Create a PR

Working with your local branch

Branch Checkout:

git checkout -b <feature|fix|release|chore|hotfix>/prefix-name

Your branch name must starts with [feature|fix|release|chore|hotfix] and use a / before the name; Use hyphens as separator; The prefix correspond to your Kanban tool id (e.g. abc-123)

Keep your branch synced:

git fetch origin
git rebase origin/master

Commit your changes:

git add .
git commit -m "<feat|ci|test|docs|build|chore|style|refactor|perf|BREAKING CHANGE>: commit message"

Follow this convention commitlint for your commit message structure

Push your changes:

git push origin <feature|fix|release|chore|hotfix>/prefix-name

Examples:

git checkout -b release/v1.15.5
git checkout -b feature/abc-123-something-awesome
git checkout -b hotfix/abc-432-something-bad-to-fix

git commit -m "docs: added awesome documentation"
git commit -m "feat: added new feature"
git commit -m "test: added tests"

License

Distributed under the MIT License. See LICENSE for more information.

Contact

• Tommy Gingras @ [e-mail]