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

project-scraper

v1.0.2

Published

A script to generate a project structure report and collect file contents.

Downloads

5

Vulnerabilities

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

Links

Git

Maintainers

right5leftright5left

Keywords

projectscraperstructurereport

Readme

Project Scraper

A script to generate a project structure report and collect file contents.

Project Overview

This project aims to automate the process of generating a structured report of your project directory, including the contents of specified files. This can be useful for LLMs.

Installation

To install the package, run:

npm install --save-dev project-scraper

Usage

To generate the project report, use the following command:

project-scraper

Configuration

The configuration for the script is specified in the .project-scraper.json file. Below is an example configuration:

{
    "treeCliPrompt": "npx tree --ignore node_modules/, .git/, .gitignore -l 3",
    "outputFile": "_generated/project-scraper-report.txt",
    "platform": "linux",
    "paths": [
        ".project-scraper.json",
        "package.json",
        "bin"
    ]
}

Configuration Fields

treeCliPrompt: Command to generate the project tree structure.
outputFile: Path to the output file where the report will be saved.
platform: The operating system platform [linux | windows] (default is "linux").
paths: An array of file and directory paths to include in the report.

License

This project is licensed under the MIT License. See the LICENSE file for more details.

Author

Martin Dedik