app: AGENTS.md: docs: Add app/ development documentation and linting/formatting scripts#4365
Conversation
There was a problem hiding this comment.
Pull request overview
This PR adds developer documentation and npm script wrappers for the desktop app to improve the contributor experience, particularly for AI agents working in the app folder. It provides consistent linting, formatting, and testing commands similar to frontend and backend workflows.
Changes:
- Added npm script wrappers in root and app package.json for format, lint, and lint-fix operations
- Updated ESLint and Prettier ignore files to exclude compiled JavaScript files from the app folder
- Created comprehensive app development documentation at
docs/development/app.md
Reviewed changes
Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| package.json | Added app:format, app:lint, and app:lint:fix scripts; integrated app linting into root lint commands |
| app/package.json | Added format, lint, and lint-fix scripts that delegate to frontend scripts |
| frontend/.eslintignore | Simplified to use wildcard pattern for app electron .js files |
| frontend/.prettierignore | Added ignore pattern for compiled app JavaScript files |
| docs/development/app.md | New comprehensive development guide covering build, lint, format, test, and packaging workflows |
| AGENTS.md | Updated with app development documentation references and new example workflow |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Agents were getting lost when app/ folder changes were being made.
|
/lgtm Thanks @illume ! |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: illume, joaquimrocha The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
Thanks for the review @joaquimrocha |
Summary
Adds developer documentation and npm script wrappers for the desktop app to improve contributor experience and align with existing frontend/backend patterns.
Helps agents that get stuck when doing stuff in the app folder because they don't know how to lint/format/etc.
Changes
Steps to Test
npm run app:lint- should lint app TypeScript without errorsnpm run app:format- should format app TypeScript filesnpm run app:lint:fix- should fix auto-fixable issuesnpm run lint- should include backend, frontend, and appgit statusafternpm run app:buildand it should not show any files.npm run app:lintafternpm run app:buildand it should not show any errors.