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.
Maintainers
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:
Install ContentExt as a dependency in your project:
npm install contentextImport ContentExt in your code:
const contentext = require("contentext");`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:
Install ContentExt globally:
npm install -g contentextUse the 'contentext' command with the available options:
contentext [options]
Options:
-r,--rootSet the root path of the project (default: ".")-t,--typesSet the file types to process, comma-separated (default: "js,css")-x,--exclude-dirsSet the directories to exclude, comma-separated (default: "")-f,--exclude-filesSet the files to exclude, comma-separated (default: "")-i,--include-filesSet the specific files to include, comma-separated (default: "")-v,--no-ignore-vcsInclude version control system directories (default: ignore)-o,--outputSet the output file path (default: "content_snapshot.txt")-m,--minifyMinify the extracted content (default: false)Examples:
contentext -r "./my-project" -t "js,css" -x "node_modules" -o "snapshot.txt" -mcontentext -t "html,css" -x "assets,node_modules" -f "main.css" -i "specific.html" -v -o "content_extract.txt"
