coze-studio/frontend/infra/idl/idl2ts-plugin/README.md

68 lines
956 B
Markdown

# @coze-arch/idl2ts-plugin
@coze-arch/idl2ts-plugin
## Overview
This package is part of the Coze Studio monorepo and provides architecture functionality. It includes hook.
## Getting Started
### Installation
Add this package to your `package.json`:
```json
{
"dependencies": {
"@coze-arch/idl2ts-plugin": "workspace:*"
}
}
```
Then run:
```bash
rush update
```
### Usage
```typescript
import { /* exported functions/components */ } from '@coze-arch/idl2ts-plugin';
// Example usage
// TODO: Add specific usage examples
```
## Features
- Hook
## API Reference
### Exports
- `*`
- `*`
For detailed API documentation, please refer to the TypeScript definitions.
## Development
This package is built with:
- TypeScript
- Modern JavaScript
- Vitest for testing
- ESLint for code quality
## Contributing
This package is part of the Coze Studio monorepo. Please follow the monorepo contribution guidelines.
## License
Apache-2.0