1.0.1 • Published 1 year ago

contrail-code-assistant v1.0.1

Weekly downloads
-
License
ISC
Repository
github
Last release
1 year ago

Contrail Code Assistant

This script automates the process of watching for changes in your Node.js project and applying a patch file when it's detected. When a patch is detected and applied, the script saves the project contents to a specified file and copies the file contents to the clipboard.

Features

  • Watches for changes in the designated project patch file.
  • Applies patch file using git apply when changes are detected.
  • Saves the project contents to a file after the patch is applied.

Set up the script

  1. Install the package:
npm install contrail-code-assistant --save
  1. Update the scripts section in your package.json file:
{
  "scripts": {
    "contrail": "node node_modules/contrail-code-assistant/dist/index.js"
    // ...
  }
}

Run the script

You can run the script using the following command:

npm run contrail

You can also provide custom values for the project folder path, patch file path, output file name, and output file path using environment variables or command line arguments:

  1. Using environment variables:
PROJECT_FOLDER_PATH="./" PATCH_FILE_PATH=".contrail/contrail.patch" OUTPUT_FILE_NAME="contrail_prepared_response.txt" OUTPUT_FILE=".contrail/contrail_prepared_response.txt"
  1. Using command line arguments:
npm run watch-and-apply -- --projectFolderPath="src" --patchFilePath=".contrail/contrail.patch" --outputFileName="contrail_prepared_response.txt" --outputFile=".contrail/contrail_prepared_response.txt"

You can use a combination of environment variables and command line arguments, with command line arguments taking precedence over environment variables.

Contributing

If you'd like to contribute to this project, please feel free to submit a pull request or open an issue for discussion.