|
1 | | -# Process-PSModule Development Guidelines |
2 | | - |
3 | | -Auto-generated from all feature plans. Last updated: 2025-10-01 |
4 | | - |
5 | | -## Active Technologies |
6 | | - |
7 | | -- PowerShell 7.4+ (GitHub Actions composite actions) + PSModule/GitHub-Script@v1, PSModule/Install-PSModuleHelpers@v1 (001-building-on-this) |
8 | | - |
9 | | -## Project Structure |
10 | | - |
11 | | -```plaintext |
12 | | -src/ |
13 | | -tests/ |
14 | | -``` |
15 | | - |
16 | | -## Commands |
17 | | - |
18 | | -Add commands for PowerShell 7.4+ (GitHub Actions composite actions) |
19 | | - |
20 | | -## Code Style |
21 | | - |
22 | | -PowerShell 7.4+ (GitHub Actions composite actions): Follow standard conventions |
23 | | - |
24 | | -## Recent Changes |
25 | | - |
26 | | -- 001-building-on-this: Added PowerShell 7.4+ (GitHub Actions composite actions) + PSModule/GitHub-Script@v1, PSModule/Install-PSModuleHelpers@v1 |
27 | | - |
28 | | -<!-- MANUAL ADDITIONS START --> |
29 | | - |
30 | 1 | ## Terminal Commands |
31 | 2 |
|
32 | 3 | When executing terminal commands (using `run_in_terminal` or similar tools): |
33 | | -- **ALWAYS** prefix shell commands with `pwsh` unless it's a GitHub MCP call |
34 | | -- This applies to all PowerShell scripts, git commands, and other shell operations |
35 | | -- Exception: GitHub MCP Server calls should use their native format without `pwsh` prefix |
36 | 4 |
|
37 | | -Examples: |
38 | | -```bash |
39 | | -# Correct - PowerShell script |
40 | | -pwsh -Command "& './.specify/scripts/powershell/setup-plan.ps1' -Json" |
41 | | - |
42 | | -# Correct - Git command |
43 | | -pwsh -Command "git status" |
44 | | - |
45 | | -# Correct - Any shell command |
46 | | -pwsh -Command "ls -Recurse" |
47 | | - |
48 | | -# Exception - GitHub MCP calls (no pwsh prefix) |
49 | | -gh issue create --title "Feature" --body "Description" |
50 | | -``` |
| 5 | +- Prefer MCP server calls over command-line tools when possible. |
| 6 | +- **ALWAYS** send commands into `pwsh -Command` to ensure proper execution. |
| 7 | + - These commands must be enclosed in single quotes. |
| 8 | + - Escape any single quotes within the command by doubling them (e.g., `It's` becomes `It''s`). |
| 9 | + - Use double quotes for string with variables or expressions inside the single-quoted command. |
51 | 10 |
|
52 | 11 | ## Other instructions |
53 | 12 |
|
54 | 13 | | Tech | Instruction file | |
55 | 14 | |------|------------------| |
56 | 15 | | PowerShell | [pwsh.instructions.md](./instructions/pwsh.instructions.md) | |
57 | 16 | | Markdown | [md.instructions.md](./instructions/md.instructions.md) | |
58 | | - |
59 | | -<!-- MANUAL ADDITIONS END --> |
0 commit comments