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

codeflattener

v1.2.0

Published

CodeFlattener is a versatile Node.js command-line tool that consolidates the structure and code of a repository, including JavaScript and TypeScript files, into a single flat file. It resolves import statements, handles TypeScript transpilation, supports

Downloads

10

Vulnerabilities

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

Links

Git

Maintainers

bchr02bchr02

Keywords

codeflattenercodeflattenrepositoryexportsingle fileJavaScriptTypeScriptES moduletroubleshootingAI toolsChatGPTcode advicecode analysismultifileprojectnode.jsnpm

Readme

CodeFlattener

CodeFlattener is a Node.js tool designed to consolidate your codebase into a single JavaScript or TypeScript file. This single file can then be used to obtain advice from AI tools like ChatGPT. The generated file is not meant to be run as an application but rather to provide a comprehensive view of your codebase for analysis and guidance.

Purpose

The primary purpose of CodeFlattener is to facilitate obtaining advice from AI tools like ChatGPT. By consolidating your codebase into a single file, you can more easily and quickly provide context to AI tools, allowing them to offer more accurate and comprehensive feedback. This tool is especially useful for large projects where understanding the code requires looking at multiple interconnected files.

Features

  • Consolidates all JavaScript and TypeScript files into a single file.
  • Supports ES modules.
  • Resolves and includes imported files.
  • Handles aliases specified in package.json.
  • Transpiles TypeScript files to JavaScript when outputting as JavaScript.
  • Allows excluding specific file types and folders.
  • Option to output either a single JavaScript or TypeScript file.

Installation

To install CodeFlattener globally, run:

npm install -g codeflattener

Usage

To use CodeFlattener, navigate to your project directory and run:

npx codeflattener --repo path/to/repo --output path/to/output.js

Options

  • --repo: The path to the repository. Defaults to the current directory.
  • --output: The path to the output file. Defaults to ./flattened-code.js.
  • --entry: The entry point file. Defaults to the main file specified in package.json or ./index.js.
  • --include: Comma-separated list of file extensions to include. Defaults to .js,.mjs,.ts,.tsx.
  • --exclude: Comma-separated list of file extensions to exclude.
  • --excludeFolders: Comma-separated list of folders to exclude.
  • --outputType: The type of the output file, either js for JavaScript or ts for TypeScript. Defaults to js.

Example

npx codeflattener --repo ./my-project --output ./flattened-code.js --include .js,.mjs,.ts,.tsx --exclude .test.js --excludeFolders node_modules,dist --outputType js

Important Note

The generated file is not meant to be run as an application. It is intended to provide a comprehensive view of your codebase for analysis and obtaining advice from AI tools like ChatGPT. Running the generated file as an application will not work as expected.

License

This project is licensed under the MIT License.