npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

file-tree-export

v1.0.0

Published

Generate and export file structure from local folder

Downloads

11

Readme

file-tree-export

A flexible and powerful tool to generate and export file structure representations from local folders. This tool supports multiple output formats and respects ignore files like .gitignore.

Table of Contents

  1. Installation
  2. Usage
  3. Options
  4. Output Formats
  5. Examples
  6. Contributing
  7. License

Installation

You can install file-tree-export globally via npm:

npm install -g file-tree-export

Or run it directly from GitHub:

curl -s https://raw.githubusercontent.com/yourusername/file-tree-export/main/run-file-tree-export.sh | bash -s -- [options]

Usage

CLI Usage

After installation, you can use the tool from the command line:

file-tree-export [options]

API Usage

You can also use file-tree-export in your Node.js projects:

const { generateFileStructure } = require('file-tree-export');

const options = {
  root: '/path/to/directory',
  output: 'json',
  maxFiles: 1000,
  maxDepth: 10,
  ignoreFile: '.gitignore'
};

const result = generateFileStructure(options);
console.log(result);

Options

  • --root: The root directory to start from (default: current working directory)
  • --output: Output format - 'tree', 'json', 'yaml', or 'xml' (default: 'tree')
  • --maxFiles: Maximum number of files to process (default: 2000)
  • --maxDepth: Maximum depth to traverse (default: 32)
  • --ignoreFile: Name of the ignore file to use (default: '.gitignore')

Output Formats

  1. Tree: ASCII tree representation
  2. JSON: Structured JSON output
  3. YAML: YAML representation of the file structure
  4. XML: XML representation of the file structure

Examples

  1. Generate a tree structure for the current directory:
file-tree-export
  1. Generate JSON output for a specific directory with a depth limit:
file-tree-export --root /path/to/directory --output json --maxDepth 5
  1. Generate YAML output ignoring files specified in .npmignore:
file-tree-export --output yaml --ignoreFile .npmignore

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

This project is licensed under the MIT License.