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

vomitorium

v2.0.0

Published

Traverse project structure and write file contents to a single output file

Downloads

45

Readme

image

Vomitorium is a command-line tool designed to easily load an entire project into a single text file. It recursively scans directories, processes files, and compiles their contents into a single output file. Useful for working with LLMs.

Features

  • Recursively scan directories
  • Include/exclude specific directories and files
  • Filter files by extension
  • Customizable output file
  • Configurable via command-line options or configuration file

Installation

npm install -g vomitorium

Usage

vomitorium [options]

Options

  • --scan <dir>: Directory to scan (default: current working directory)
  • --include <dirs>: Comma-separated list of directories to include
  • --exclude <patterns>: Comma-separated list of directories or files to exclude
  • --extensions <exts>: Comma-separated list of file extensions to include
  • --show-excluded: Show excluded files in the output
  • --show-skipped: Show skipped files without listing their contents
  • --output <file>: Specify the output file name

Examples

vomitorium --scan ./myproject --include src,tests
vomitorium --exclude node_modules,dist,package.json --extensions .js,.ts
vomitorium --scan /path/to/project --show-excluded --show-skipped
vomitorium --output my-custom-output.txt

Configuration

Vomitorium uses cosmiconfig for configuration file support. You can create a configuration file named .vomitoriumrc, .vomitoriumrc.json, .vomitoriumrc.yaml, vomitorium.config.js, or add a "vomitorium" key to your package.json file.

Default configuration:

{
  "scan": ".",
  "include": [],
  "exclude": ["node_modules", ".git", "dist", "build"],
  "excludeFiles": ["package.json", "package-lock.json"],
  "extensions": [".js", ".ts", ".json"],
  "showExcluded": true,
  "showSkipped": true,
  "outputFile": "output.sick"
}

Output

The tool generates a single output file (default: output.sick) containing the contents of all processed files, separated by file headers.

Contributing

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

License

MIT License