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

summarize-folder

v4.0.0

Published

Easy access to files

Downloads

6

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Maintainers

karsenskarsens

Keywords

Readme

summarize-folder

summarize-folder is a powerful Node.js CLI tool designed to analyze and manipulate folder structures and file contents. It offers three main functionalities: summarizing folder structures, reading file hierarchies, and writing file hierarchies.

Features

  • Folder Summarization: Scan folders recursively and generate a YAML file containing file sizes.
  • File Hierarchy Reading: Retrieve and prune file contents based on a given structure.
  • File Hierarchy Writing: Write file contents to a specified structure.
  • Gitignore Support: Respects .gitignore and .genignore files for excluding files/folders.
  • UTF-8 Compatibility: Ignores non-UTF-8 encoded files.

Installation

npm install -g summarize-folder

Usage

Summarize Folder Sizes

summarize-folder size [path]

Scans the current folder or specified path recursively and generates a summary-filesizes.yaml file containing the character count for each file.

Read File Hierarchy

summarize-folder read <input_path> <output_path> [maxDepth]

Retrieves the content for a pruned file list based on the structure defined in the input YAML file.

Write File Hierarchy

summarize-folder write <path-to-yaml-file>

Writes file contents to the file system based on the structure and content defined in the input YAML file.

Configuration

  • .gitignore: Standard Git ignore file, respected by the tool.
  • .genignore: Additional ignore file specific to this tool.

Dependencies

  • yaml: Used for parsing and stringifying YAML content.

License

ISC

Contributing

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

Support

If you encounter any problems or have any questions, please open an issue in the GitHub repository.