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

contentext

v0.1.1

Published

A tool for extracting the file structure and file content from web development projects. Useful for copying the context for analysis by other tools, like ChatGPT or GPT4.

Downloads

12

Readme

ContentExt - Content Extraction Tool

ContentExt is a Node.js tool for extracting content from files in the project folder of a web app or website. It creates a text file as an output with a readable file structure and the content of the included files.

API Usage:

  1. Install ContentExt as a dependency in your project:

    npm install contentext
  2. Import ContentExt in your code:

    const contentext = require("contentext");`
  3. Configure the options and call the desired functions:

    const config = {
      rootPath: ".",               // Set the root path of the project
      fileTypes: [],               // Set the file types to process
      excludeDirs: [],             // Set the directories to exclude
      excludeFiles: [],            // Set the files to exclude
      includeFiles: [],            // Set the specific files to include
      ignoreVcs: true,             // Ignore version control system directories
      outputFilePath: "content_snapshot.txt", // Set the output file path
      minify: false,               // Minify the extracted content
    };
    
    // Extract content and generate output
    const extractedContent = contentext.extractContent(config);
    contentext.generateOutput(extractedContent, "", config.outputFilePath, config.minify);

CLI Usage:

  1. Install ContentExt globally:

    npm install -g contentext
  2. Use the 'contentext' command with the available options:

    contentext [options]

    Options:
    -r, --root Set the root path of the project (default: ".")
    -t, --types Set the file types to process, comma-separated (default: "js,css")
    -x, --exclude-dirs Set the directories to exclude, comma-separated (default: "")
    -f, --exclude-files Set the files to exclude, comma-separated (default: "")
    -i, --include-files Set the specific files to include, comma-separated (default: "")
    -v, --no-ignore-vcs Include version control system directories (default: ignore)
    -o, --output Set the output file path (default: "content_snapshot.txt")
    -m, --minify Minify the extracted content (default: false)

    Examples:

    contentext -r "./my-project" -t "js,css" -x "node_modules" -o "snapshot.txt" -m
    contentext -t "html,css" -x "assets,node_modules" -f "main.css" -i "specific.html" -v -o "content_extract.txt"