generator-project-info

1.2.3 • Public • Published

Project Info Generator

project-info-generator is a Node.js utility for generating information about your project structure, including a directory tree and readable file contents. This script can be used to facilitate project exploration by AI or internal documentation.

Features

  • Generates a project directory tree.
  • Reads and includes the contents of files with specified extensions.
  • Honors .gitignore rules or patterns you specify.
  • Saves output to a project-info.txt file.

Installation

You can install this package via npm:

npm install -g project-info-generator

Usage

After installation, run the following command in your project directory:

project-info

or

project-info /path/to/your/project

Or use it programmatically in your Node.js code:

const generateProjectInfo = require('project-info-generator');

generateProjectInfo('/path/to/your/project');

Options

Project Folder: Run the utility in any project directory.

Configure Readable Files: The file extensions that can be read can be set directly in the script.

Output

The output will be saved in the project-info.txt file in the scanned project directory.

Donate

Donasi Coffee 🍕 Donasi Pizza

/generator-project-info/

    Package Sidebar

    Install

    npm i generator-project-info

    Weekly Downloads

    7

    Version

    1.2.3

    License

    ISC

    Unpacked Size

    12 kB

    Total Files

    5

    Last publish

    Collaborators

    • ariska138