haraps 1.0.7 → 1.0.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (3) hide show
  1. package/bin/index.js +26 -4
  2. package/package.json +1 -1
  3. package/SKILL.md +0 -45
package/bin/index.js CHANGED
@@ -1255,17 +1255,39 @@ writeFile('AGENTS.md', `
1255
1255
  18. **Environment Variable Validation**: Fail fast at startup if required \`.env\` variables are missing.
1256
1256
  19. **Kill AI Slop**: Remove aesthetic clichés (indigo gradients, glowing cards, excessive emojis) that serve no functional purpose.
1257
1257
  20. **Security First Principle**: Treat all external input as malicious; leverage the Security Review skill for all external-facing endpoints.
1258
+ 21. **Standardized Work Delivery**: When completing a task, always provide:
1259
+ - Links or Routes for the work done (clickable URLs/paths).
1260
+ - Manual steps for the user to verify the work.
1261
+ - 3 Things to improve (technical debt, minor issues, or polish).
1262
+ - Future roadmap (what can be done next for the work currently completed).
1263
+ 22. **Scratch Files**: Any temporary, one-off, or scratch scripts (like \`fix_css.js\`, testing scripts, or data dumps) MUST be placed in a dedicated \`scratch/\` folder at the root. Never clutter the project root directory with these files.
1258
1264
 
1259
1265
  # Start Project Protocol
1260
1266
  When the user says "start project", you MUST immediately:
1261
1267
  1. Ask the user for the name of the project and a brief description of what they want to build.
1262
1268
  2. Wait for their response.
1263
- 3. Once they respond, it is YOUR strict responsibility to initialize the standard project skeleton:
1269
+ 3. Once they respond, it is YOUR strict responsibility to initialize the standard project skeleton and apply contextual modifications:
1264
1270
  a. Generate the Next.js frontend and Rust Cloudflare Worker backend in their respective directories (\`frontend/\` and \`backend/\`).
1265
- b. Carefully modify the generated files to align with the project guidelines.
1266
- c. **CRITICAL: Dev and Deploy Scripts**: The generated \`dev.ps1\`, \`dev.sh\`, \`deploy.ps1\`, and \`deploy.sh\` files are highly optimized custom runners (with clipboard integration, aggressive process cleanup, and error reporting). **Never** overwrite them with generic start/build scripts. If modifications are needed, surgically edit them to preserve their robust functionality.
1271
+ b. **Contextualize Files**: Open the scaffolded \`dev.ps1\`, \`dev.sh\`, \`deploy.ps1\`, \`deploy.sh\`, and the UI Sniper Telegram configuration (including the webhook route), and **modify them** to precisely match the project name and description.
1272
+ c. **Telegram Feedback Customization**: Ensure the Telegram message for UI feedback exactly matches the project context (updating names, tags, or message format as needed).
1273
+ d. **Rust Instructions**: Ensure dev and deploy scripts are surgically modified to correctly support the required Rust compilation/cargo instructions for the backend. **Never** overwrite the entire scripts with generic versions; preserve their robust functionality.
1267
1274
  4. Initialize a new git repository in the root directory (\`git init\`) and create an initial commit.
1268
- 5. Notify the user that the project has been successfully scaffolded and all the lazy senior dev standards, security reviews, UI sniper setups, and AI slop removers are in place. Remind them to use \`./dev.ps1\` or \`./dev.sh\` once their \`frontend/\` and \`backend/\` directories are initialized.
1275
+ 5. Notify the user that the project has been contextualized, customized, and scaffolded. Remind them to run \`./dev.ps1\` or \`./dev.sh\`.
1276
+
1277
+ # Continuous Documentation Protocol
1278
+ As we develop the project, you MUST maintain living user and developer documentation.
1279
+ 1. **Always Document**: Every new feature, API route, or major change must be documented immediately.
1280
+ 2. **Types of Docs**: Include API specifications, how-to guides, architectural overviews, and user instructions.
1281
+ 3. **Index Everything**: Maintain a well-organized and updated index of all documentation files in the section below.
1282
+
1283
+ # Project Documentation Index
1284
+ *Keep this section constantly updated as new documentation is written.*
1285
+
1286
+ ### Frontend Documentation
1287
+ - [Developer & User Guide](file:///frontend/src/app/docs/page.tsx) - The primary documentation route for users.
1288
+
1289
+ ### Backend Documentation
1290
+ *(No backend documentation yet. Add API guides and architecture notes here.)*
1269
1291
  `);
1270
1292
 
1271
1293
  // 4. Workflows
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "haraps",
3
- "version": "1.0.7",
3
+ "version": "1.0.9",
4
4
  "description": "NPM package to scaffold standard development environment, deployment scripts, AGENTS.md guidelines, and core workflows for a Next.js frontend + Rust Cloudflare Worker backend.",
5
5
  "main": "bin/index.js",
6
6
  "bin": {
package/SKILL.md DELETED
@@ -1,45 +0,0 @@
1
- ---
2
- name: scaffold-project-env
3
- description: Scaffolds the standard development environment, deployment scripts, AGENTS.md guidelines, and core workflows for a Next.js frontend + Rust Cloudflare Worker backend.
4
- ---
5
-
6
- # Scaffold Project Environment Skill (Rust + Next.js)
7
-
8
- This skill automatically sets up a new repository with standard `dev` and `deploy` scripts tailored for a Rust backend (Cloudflare Workers) and a standard Next.js frontend (Vercel/Node deployment, not Pages), along with preferred agent guidelines and workflows.
9
-
10
- ## Instructions for the Agent
11
-
12
- When the user runs this skill, execute the following steps precisely:
13
-
14
- ### Step 1: Run the Scaffolder CLI
15
-
16
- Execute the following command in the terminal to automatically generate the project scaffolding (dev scripts, deploy scripts, AGENTS.md, workflows, and skills):
17
-
18
- ```bash
19
- npx --yes haraps
20
- ```
21
-
22
- ### Step 2: Verification
23
-
24
- Verify that the following files were successfully created in the root directory:
25
- - `dev.sh` / `dev.ps1`
26
- - `deploy.sh` / `deploy.ps1`
27
- - `AGENTS.md`
28
- - `.agents/workflows/git-it.md`
29
- - `.agents/workflows/deploy-and-talk.md`
30
- - `.agents/skills/ponytail/SKILL.md`
31
- - `.agents/skills/ui-sniper-telegram/SKILL.md`
32
- - `.agents/skills/kill-ai-slop/SKILL.md`
33
- - `.agents/skills/security-review/SKILL.md`
34
-
35
- ### Step 3: Project Skeleton Initialization (First Run)
36
-
37
- It is your strict responsibility as the agent to carefully initialize the standard project skeleton if this is the first run (i.e. if the project is empty). You must:
38
- 1. Generate the Next.js frontend and Rust Cloudflare Worker backend in their respective directories (`frontend/` and `backend/`).
39
- 2. Carefully modify the generated files to align with the project guidelines.
40
- 3. **CRITICAL: Dev and Deploy Scripts**: The generated `dev.ps1`, `dev.sh`, `deploy.ps1`, and `deploy.sh` files are highly optimized custom runners (with clipboard integration, aggressive process cleanup, and error reporting). **Never** overwrite them with generic start/build scripts. If modifications are needed, surgically edit them to preserve their robust functionality.
41
- 4. Initialize the Git repository (`git init`) and create the initial commit.
42
-
43
- ### Step 4: Inform the User
44
-
45
- Notify the user that the project has been successfully scaffolded and all the lazy senior dev standards, security reviews, UI sniper setups, and AI slop removers are in place. Remind them to use `./dev.ps1` or `./dev.sh` once their `frontend/` and `backend/` directories are initialized.