@jttc/projen-project-types 1.0.0-beta.0 → 1.0.0-beta.10

package/AGENTS.md

@@ -0,0 +1,132 @@
+# Coding Agents Guide
+
+This file contains essential information about how this repository works for coding agents like GitHub Copilot.
+
+## Repository Overview
+
+This is the **projen-project-types** project, which uses [Projen](https://projen.io/) for project configuration management.
+
+## What is Projen?
+
+Projen is a tool that allows managing project configuration through TypeScript code instead of static configuration files.
+
+### Key Features:
+- **Configuration as Code**: Everything is defined in `.projenrc.ts`
+- **Automatic Management**: Automatically regenerates configuration files
+- **Extensible**: Allows creating reusable components
+- **Consistency**: Keeps configuration synchronized
+
+## TypeScript Project
+
+This is a TypeScript project managed by Projen.
+
+### TypeScript Features:
+- **Type Safety**: Compile-time type checking
+- **Modern JavaScript**: Latest ECMAScript features
+- **Build Tools**: Automated compilation and bundling
+- **Testing**: Comprehensive test framework integration
+
+## Important Commands
+
+```bash
+# Regenerate configuration files from .projenrc.ts
+npx projen
+
+# Build the project
+npx projen build
+
+# Run tests
+npx projen test
+
+# Run tests in watch mode
+npx projen test:watch
+
+# Lint the code
+npx projen eslint
+
+# Package the project
+npx projen package
+
+# Clean generated files
+npx projen clobber
+
+# Upgrade dependencies
+npx projen upgrade
+```
+
+
+## Dependency Management
+
+### Adding Dependencies:
+```typescript
+// In the project or component constructor
+project.deps.addDependency("package-name", DependencyType.BUILD);
+project.deps.addDependency("package-name", DependencyType.RUNTIME);
+project.deps.addDependency("package-name", DependencyType.PEER);
+```
+
+### Dependency Types:
+- `RUNTIME`: Runtime dependencies (dependencies)
+- `BUILD`: Build dependencies (devDependencies)
+- `PEER`: Peer dependencies (peerDependencies)
+
+## Project Structure
+
+```
+src/                 # Source code
+├── index.ts         # Main entry point
+└── lib/             # Library code
+
+test/                # Unit tests
+lib/                 # Compiled TypeScript (generated)
+dist/                # Distribution files (generated)
+```
+
+
+## Common Configuration
+
+- **CommonOptionsConfig**: Manages default configurations
+- **Prettier**: Automatic code formatting
+- **ESLint**: Automatic linting
+- **VSCode**: Configuration and recommended extensions
+- **Commitzent**: Conventional commits
+- **Agents**: This documentation for coding agents
+
+## Important Files
+
+- `.projenrc.ts`: Main project configuration
+- `package.json`: Generated automatically by Projen
+- `tsconfig.json`: TypeScript configuration
+- `.gitignore`: Files ignored by Git
+
+## Best Practices
+
+1. **Never edit generated files**: Always modify the source in `.projenrc.ts`
+2. **Run `npx projen`** after configuration changes
+3. **Use components** for reusable functionality
+4. **Follow naming conventions** established in the project
+5. **Document changes** in tests and README
+
+## Troubleshooting
+
+### Error: "File is read-only"
+- Files generated by Projen are read-only
+- Modify the configuration in `.projenrc.ts` instead
+
+### Dependencies not found
+- Run `npx projen` to install dependencies
+- Verify dependencies are in `.projenrc.ts`
+
+### Tests fail
+- Run `npx projen build` to compile changes
+- Verify snapshots are updated
+
+## Useful Resources
+
+- [Projen Documentation](https://projen.io/)
+- [Projen API Reference](https://github.com/projen/projen/blob/main/API.md)
+
+---
+
+> This file is automatically generated by the `Agents` component.
+> To modify it, edit the component in `src/components/agents/agents.ts`.