https://github.com/sidiqovabbos/diryzer

A sleek tool for analyzing directory contents with visual file type distribution.
https://github.com/sidiqovabbos/diryzer

analyzer dir files

Last synced: 7 months ago
JSON representation

A sleek tool for analyzing directory contents with visual file type distribution.

• Host: GitHub
• URL: https://github.com/sidiqovabbos/diryzer
• Owner: SidiqovAbbos
• License: mit
• Created: 2025-01-18T10:45:02.000Z (12 months ago)
• Default Branch: main
• Last Pushed: 2025-01-21T09:33:31.000Z (12 months ago)
• Last Synced: 2025-06-03T11:37:56.337Z (8 months ago)
• Topics: analyzer, dir, files
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/diryzer
• Size: 113 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          


# 🔍 Diryzer

A sleek command-line tool for analyzing directory contents with visual file type distribution.

[![npm version](https://img.shields.io/npm/v/diryzer.svg)](https://www.npmjs.com/package/diryzer)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)

[![GitHub issues](https://img.shields.io/github/issues/SidiqovAbbos/diryzer)](https://github.com/SidiqovAbbos/diryzer/issues)

[![GitHub stars](https://img.shields.io/github/stars/SidiqovAbbos/diryzer)](https://github.com/SidiqovAbbos/diryzer/stargazers)



## ✨ Features

- 📊 Visual progress bar showing file type distribution

- 🎨 Color-coded output for different file types

- 🔄 Customizable directory depth scanning

- 🚫 Pattern-based directory exclusion

- 📈 Optional percentage display

## 🌟 Inspired By

GitHub's repository languages section - A visual representation of language distribution in repositories:

![GitHub Languages](images/gh-languages.png)

## 💻 Global Usage

```bash

npm install -g diryzer

```

### Basic Command

```bash

diryzer 

```

### Options

```bash

Options:

  -V, --version              output the version number

  -e, --exclude    patterns to exclude from analysis

  -d, --depth        depth of subdirectories to analyze (default: "5")

  -h, --help                 display help for command

```

### 📝 Examples

Analyze current directory:

```bash

diryzer .

```

Exclude specific directories:

```bash

diryzer --exclude 'node_modules/**' '.git' .

```

Set scan depth:

```bash

diryzer --depth 3 .

```

### 🖥️ Example Output

![Output](images/example.png)

## 🔧 Programmatic Usage

To install `diryzer` as a development dependency in your project, run:

```bash

npm install diryzer --save-dev

```

You can then use it in your project scripts or directly in your code.

```typescript

import { DirectoryAnalyzer } from 'diryzer';

const diryzer = new DirectoryAnalyzer({

  directoryPath: './my-project',

  depth: 5,

  excludePatterns: ['node_modules/**']

});

const result = diryzer.analyze();

/* result is Record

  {

    ".js": {

      extension: ".js";

      count: 2; 

      percentage: 25; 

    }

    ... others

  }

*/

```

## 🤝 Contributing

1. Fork the repository

2. Create your feature branch (`git checkout -b feature/amazing-feature`)

3. Commit your changes (`git commit -m 'Add amazing feature'`)

4. Push to the branch (`git push origin feature/amazing-feature`)

5. Open a Pull Request

## 📄 License

This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

## 🙏 Acknowledgments

- Built with TypeScript and Node.js

- Uses Commander.js for CLI interface

- Chalk for colorful terminal output

## 🌐 Links

- [GitHub Repository](https://github.com/SidiqovAbbos/diryzer)

- [Bug Reports](https://github.com/SidiqovAbbos/diryzer/issues)

- [npm Package](https://www.npmjs.com/package/diryzer)

---



Made with ❤️ by developers for developers