my-project-public

repository

loading code, commits, and activity

repositories

loading repo index

#1	---
#2	description:
#3	globs:
#4	alwaysApply: false
#5	---
#6	# Development Workflow Guide
#7
#8	This project uses pnpm for package management and has a structured set of scripts for different development tasks.
#9
#10	## 🔧 NPM Scripts
#11
#12	### Core Commands
#13	Located in [package.json](mdc:package.json):
#14
#15	```bash
#16	# Build and format agents
#17	pnpm run build # Build all Agent files
#18	pnpm run format # Format Agent configurations (triggers translation)
#19
#20	# Validation and testing
#21	pnpm run test # Run validation tests
#22	pnpm run test:locale # Test multi-language files
#23	pnpm run type-check # TypeScript type checking
#24
#25	# Language validation
#26	pnpm run validate:lang # Validate all translation files
#27	pnpm run validate:lang --delete # Validate and clean invalid files
#28	pnpm run clean:lang # Shorthand for validate with delete
#29
#30	# Maintenance
#31	pnpm run update:awesome # Update README file
#32	```
#33
#34	### Translation Workflow
#35	The main translation process is triggered by:
#36	```bash
#37	pnpm run format
#38	```
#39
#40	This command:
#41	1. Calls [scripts/commands/format.ts](mdc:scripts/commands/format.ts)
#42	2. Executes `formatAgents()` function
#43	3. Processes each agent through [scripts/formatters/agent-formatter.ts](mdc:scripts/formatters/agent-formatter.ts)
#44	4. Performs incremental translation detection
#45	5. Validates language accuracy
#46	6. Saves formatted and translated files
#47
#48	## 🚀 Development Best Practices
#49
#50	### Before Making Changes
#51	1. Run `pnpm run type-check` to ensure TypeScript correctness
#52	2. Test changes with a small subset of agents first
#53	3. Use incremental translation to avoid unnecessary API calls
#54
#55	### Code Quality Checks
#56	- TypeScript: Use strict type checking
#57	- ESLint: Follow project linting rules
#58	- Prettier: Code formatting is handled automatically
#59
#60	### Testing Translation Changes
#61	```bash
#62	# Test specific language
#63	pnpm run test:locale
#64
#65	# Validate a single file
#66	pnpm run validate:lang path/to/agent.en-US.json
#67
#68	# Clean up invalid translations
#69	pnpm run clean:lang
#70	```
#71
#72	## 📁 File Structure Patterns
#73
#74	### Agent Configuration Files
#75	- Source files: `src/agent-name.json`
#76	- Translations: `locales/agent-name/agent-name.locale.json`
#77
#78	### Script Organization
#79	- Commands in `scripts/commands/` - executable entry points
#80	- Core logic in processors, validators, builders
#81	- Utilities in `scripts/utils/`
#82	- Schemas in `scripts/schema/`
#83
#84	## 🛠️ Debugging and Troubleshooting
#85
#86	### Common Issues
#87	1. Translation API Errors: Check OpenAI API key and rate limits
#88	2. Language Validation Failures: Review [scripts/validators/language-validator.ts](mdc:scripts/validators/language-validator.ts) mapping
#89	3. Type Errors: Run `pnpm run type-check` for detailed error messages
#90
#91	### Debug Mode
#92	Set `DEBUG=true` environment variable for verbose logging:
#93	```bash
#94	DEBUG=true pnpm run validate:lang
#95	```
#96
#97	### Log Analysis
#98	All operations use [scripts/utils/logger.ts](mdc:scripts/utils/logger.ts) for structured logging:
#99	- Progress bars show operation status
#100	- Statistics summaries provide overview
#101	- Error messages include context and suggestions
#102
#103	## 🔄 Continuous Integration
#104
#105	### Pre-commit Checks
#106	- Type checking with TypeScript
#107	- Linting with ESLint
#108	- Language validation for translations
#109
#110	### Automated Workflows
#111	- [scripts/commands/auto-submit.ts](mdc:scripts/commands/auto-submit.ts) handles GitHub automation
#112	- Batch processing with controlled concurrency
#113	- Error handling and recovery mechanisms
#114
#115
#116
#117

z6Mkq5mY3JWtxoxUobWcfNHm7AkRubgSWEZTkBVqZXJviFZ5/my-project-public