@simpler-development/project-tools
Version:
This package provides a suite of scripts and utilities to support development, automation, and maintenance tasks across the monorepo.
37 lines (23 loc) • 1.19 kB
Markdown
# Project Tools
This package provides a suite of scripts and utilities to support development, automation, and maintenance tasks across the monorepo.
## Overview
- **Purpose:** Centralizes scripts for project data extraction, feedback collection, and prompt-driven workflows.
## Features
- **Project Dumping:** Generate structured JSON dumps of project data for analysis or migration.
- **Prompt Workflows:** Run prompt-based scripts for interactive or automated tasks.
- **Feedback Collection:** Log and process developer or user feedback.
## Directory Structure
- `src/` – Main source code for scripts and utilities
- `tests/` – Test suite for validating tool functionality
- `feedback.jsonl` / `feedback.log` – Feedback data and logs
- `dump-project.js` – Script for generating project dumps
## Usage
- `yarn dump` – Run the project dump script
- `yarn prompt` – Execute prompt-based workflows
- `yarn test` – Run all tests
- `yarn commit` - will add changed files to git staging and generate a commit message.
## Setup
1. Set required environment variables (see `.env.example` if available).
2. Install dependencies: `yarn install`
## Documentation
Coming Soon.