Repository navigation
Expand file tree
/
Copy pathpackage.json
More file actions
66 lines (66 loc) · 3.73 KB
/
Copy pathpackage.json
File metadata and controls
66 lines (66 loc) · 3.73 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
{
"name": "auto-instructions",
"displayName": "auto-instructions",
"description": "Ensures every workspace contains a .github/copilot-instructions.md file, managed from a user-configurable template.",
"version": "2.0.5",
"engines": {
"vscode": "^1.100.0"
},
"categories": [
"Other"
],
"activationEvents": [
"onStartupFinished",
"onCommand:auto-instructions.changeStandardInstructions",
"onCommand:auto-instructions.reinitWorkspace"
],
"main": "./out/extension.js",
"contributes": {
"commands": [
{
"command": "auto-instructions.editUserCopilotTemplate",
"title": "Auto Instructions: Edit User Copilot Template"
},
{
"command": "auto-instructions.replaceCopilotInstructions",
"title": "Auto Instructions: Replace Copilot Instructions File"
}
],
"configuration": {
"type": "object",
"title": "Auto Instructions",
"properties": {
"auto-instructions.copilotTemplate": {
"type": "string",
"scope": "application",
"markdownDescription": "The user-level Copilot instructions template. Use the 'Auto Instructions: Edit User Copilot Template' command to edit. (Do not edit here.)",
"default": "# Copilot Instructions\n\nWelcome to this project! Please follow these best practices to ensure high-quality, maintainable, and collaborative code.\n\n## General Guidelines\n\n- Always write clear, concise, and well-documented code.\n- Use modularization: break code into small, reusable functions and components.\n- Follow the project's coding style and naming conventions.\n- Write meaningful commit messages and keep commits focused.\n- Use version control best practices (feature branches, pull requests, code reviews).\n- **Always resume code changes before editing and always ask for OK before editing the code.**\n\n## Project Structure\n\n- Organize code into logical folders (e.g., `src/`, `test/`, `docs/`, `assets/`).\n- Place documentation in `README.md` and update it as the project evolves.\n- Store configuration and environment files separately from source code.\n\n## Documentation\n\n- Every module, class, and function should have a clear docstring or comment explaining its purpose and usage.\n- Update `README.md` with setup instructions, usage examples, and contribution guidelines.\n- Document any non-obvious design decisions or dependencies.\n\n## Testing\n\n- Write automated tests for all critical functionality.\n- Place tests in a dedicated `test/` folder, mirroring the structure of `src/`.\n- Use descriptive test names and include edge cases.\n\n## Collaboration\n\n- Communicate changes and design decisions with the team.\n- Review and test code before merging.\n- Respect existing code and refactor only with clear justification.\n\n## Automation\n\n- Use scripts or tasks for common workflows (build, test, lint, deploy).\n- Document all automation in a dedicated `automation/` folder.\n\n## Support\n\nFor questions or issues, contact the project maintainer or open an issue in the repository."
}
}
}
},
"scripts": {
"vscode:prepublish": "npm run compile",
"compile": "tsc -p ./",
"watch": "tsc -watch -p ./",
"pretest": "npm run compile && npm run lint",
"lint": "eslint src",
"test": "vscode-test"
},
"devDependencies": {
"@types/vscode": "^1.100.0",
"@types/mocha": "^10.0.10",
"@types/node": "20.x",
"@typescript-eslint/eslint-plugin": "^8.31.1",
"@typescript-eslint/parser": "^8.31.1",
"eslint": "^9.25.1",
"typescript": "^5.8.3",
"@vscode/test-cli": "^0.0.10",
"@vscode/test-electron": "^2.5.2"
},
"repository": {
"type": "git",
"url": "https://github.com/Olioli4/AutoInstructions.git"
},
"publisher": "Olioli4"
}