Code Monkey home page Code Monkey logo

node-promptgen's Introduction

node-promptgen

Generate prompts for AI analysis of your JS projects.

Description

node-promptgen is a command-line tool that extracts code, project structure, and dependencies from your Node.js projects. It creates a comprehensive prompt that can be used with AI language models (like ChatGPT) to gain insights into your project's purpose, structure, potential improvements, and more.

Feel free to contribute to this project by adding more features or improving the existing ones.

Features

  • Extracts code snippets from supported file types, which can be customized in the SUPPORTED_FILE_TYPES array.
  • Ignores the node_modules and .git directories. You can also add more, tool will ask for it.
  • Extracts project folder structure and includes it in the prompt.
  • Lists dependencies from package.json.
  • Optionally adds a basic boilerplate explainer prompt.

Usage

  1. Run the following command in your terminal:
git clone https://github.com/mkkurt/node-promptgen.git
cd node-promptgen
npm install
npm start
  1. Follow the prompts to enter your project directory, add custom ignore list and choose whether to include the boilerplate analysis prompt.

  2. The tool will generate a project_prompt.txt file in your target project directory.

  3. Use the generated prompt with your preferred AI language model to get a detailed analysis and ask questions about your project.

node-promptgen's People

Contributors

mkkurt avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.