update gpt
This commit is contained in:
103
templates/api.md
Normal file
103
templates/api.md
Normal file
@ -0,0 +1,103 @@
|
||||
# API Documentation
|
||||
|
||||
## Public Functions
|
||||
|
||||
{{#each api.public_functions}}
|
||||
### `{{this.name}}`
|
||||
|
||||
{{#if this.docs}}
|
||||
{{this.docs}}
|
||||
{{/if}}
|
||||
|
||||
**Visibility:** `{{this.visibility}}`
|
||||
{{#if this.is_async}}**Async:** Yes{{/if}}
|
||||
|
||||
{{#if this.parameters}}
|
||||
**Parameters:**
|
||||
{{#each this.parameters}}
|
||||
- `{{this.name}}`: `{{this.param_type}}`{{#if this.is_mutable}} (mutable){{/if}}
|
||||
{{/each}}
|
||||
{{/if}}
|
||||
|
||||
{{#if this.return_type}}
|
||||
**Returns:** `{{this.return_type}}`
|
||||
{{/if}}
|
||||
|
||||
---
|
||||
|
||||
{{/each}}
|
||||
|
||||
## Public Structs
|
||||
|
||||
{{#each api.public_structs}}
|
||||
### `{{this.name}}`
|
||||
|
||||
{{#if this.docs}}
|
||||
{{this.docs}}
|
||||
{{/if}}
|
||||
|
||||
**Visibility:** `{{this.visibility}}`
|
||||
|
||||
{{#if this.fields}}
|
||||
**Fields:**
|
||||
{{#each this.fields}}
|
||||
- `{{this.name}}`: `{{this.field_type}}` ({{this.visibility}})
|
||||
{{#if this.docs}} - {{this.docs}}{{/if}}
|
||||
{{/each}}
|
||||
{{/if}}
|
||||
|
||||
---
|
||||
|
||||
{{/each}}
|
||||
|
||||
## Public Enums
|
||||
|
||||
{{#each api.public_enums}}
|
||||
### `{{this.name}}`
|
||||
|
||||
{{#if this.docs}}
|
||||
{{this.docs}}
|
||||
{{/if}}
|
||||
|
||||
**Visibility:** `{{this.visibility}}`
|
||||
|
||||
{{#if this.variants}}
|
||||
**Variants:**
|
||||
{{#each this.variants}}
|
||||
- `{{this.name}}`
|
||||
{{#if this.docs}} - {{this.docs}}{{/if}}
|
||||
{{#if this.fields}}
|
||||
**Fields:**
|
||||
{{#each this.fields}}
|
||||
- `{{this.name}}`: `{{this.field_type}}`
|
||||
{{/each}}
|
||||
{{/if}}
|
||||
{{/each}}
|
||||
{{/if}}
|
||||
|
||||
---
|
||||
|
||||
{{/each}}
|
||||
|
||||
## Public Traits
|
||||
|
||||
{{#each api.public_traits}}
|
||||
### `{{this.name}}`
|
||||
|
||||
{{#if this.docs}}
|
||||
{{this.docs}}
|
||||
{{/if}}
|
||||
|
||||
**Visibility:** `{{this.visibility}}`
|
||||
|
||||
{{#if this.methods}}
|
||||
**Methods:**
|
||||
{{#each this.methods}}
|
||||
- `{{this.name}}({{#each this.parameters}}{{this.name}}: {{this.param_type}}{{#unless @last}}, {{/unless}}{{/each}}){{#if this.return_type}} -> {{this.return_type}}{{/if}}`
|
||||
{{#if this.docs}} - {{this.docs}}{{/if}}
|
||||
{{/each}}
|
||||
{{/if}}
|
||||
|
||||
---
|
||||
|
||||
{{/each}}
|
19
templates/changelog.md
Normal file
19
templates/changelog.md
Normal file
@ -0,0 +1,19 @@
|
||||
# Changelog
|
||||
|
||||
## Recent Changes
|
||||
|
||||
{{#each commits}}
|
||||
### {{this.date}}
|
||||
|
||||
**{{this.hash}}** by {{this.author}}
|
||||
|
||||
{{this.message}}
|
||||
|
||||
---
|
||||
|
||||
{{/each}}
|
||||
|
||||
## Summary
|
||||
|
||||
- **Total Commits:** {{commits.length}}
|
||||
- **Contributors:** {{#unique commits "author"}}{{this.author}}{{#unless @last}}, {{/unless}}{{/unique}}
|
76
templates/readme.md
Normal file
76
templates/readme.md
Normal file
@ -0,0 +1,76 @@
|
||||
# {{project.name}}
|
||||
|
||||
{{#if project.description}}
|
||||
{{project.description}}
|
||||
{{/if}}
|
||||
|
||||
## Overview
|
||||
|
||||
This project contains {{project.modules.length}} modules with a total of {{project.metrics.total_lines}} lines of code.
|
||||
|
||||
## Installation
|
||||
|
||||
```bash
|
||||
cargo install {{project.name}}
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
```bash
|
||||
{{project.name}} --help
|
||||
```
|
||||
|
||||
## Dependencies
|
||||
|
||||
{{#each project.dependencies}}
|
||||
- `{{@key}}`: {{this}}
|
||||
{{/each}}
|
||||
|
||||
## Project Structure
|
||||
|
||||
```
|
||||
{{#each project.structure.directories}}
|
||||
{{this.name}}/
|
||||
{{/each}}
|
||||
```
|
||||
|
||||
## API Documentation
|
||||
|
||||
{{#each project.modules}}
|
||||
### {{this.name}}
|
||||
|
||||
{{#if this.docs}}
|
||||
{{this.docs}}
|
||||
{{/if}}
|
||||
|
||||
{{#if this.functions}}
|
||||
**Functions:** {{this.functions.length}}
|
||||
{{/if}}
|
||||
|
||||
{{#if this.structs}}
|
||||
**Structs:** {{this.structs.length}}
|
||||
{{/if}}
|
||||
|
||||
{{/each}}
|
||||
|
||||
## Metrics
|
||||
|
||||
- **Lines of Code:** {{project.metrics.total_lines}}
|
||||
- **Total Files:** {{project.metrics.total_files}}
|
||||
- **Test Files:** {{project.metrics.test_files}}
|
||||
- **Dependencies:** {{project.metrics.dependency_count}}
|
||||
- **Complexity Score:** {{project.metrics.complexity_score}}
|
||||
|
||||
## License
|
||||
|
||||
{{#if project.license}}
|
||||
{{project.license}}
|
||||
{{else}}
|
||||
MIT
|
||||
{{/if}}
|
||||
|
||||
## Authors
|
||||
|
||||
{{#each project.authors}}
|
||||
- {{this}}
|
||||
{{/each}}
|
39
templates/structure.md
Normal file
39
templates/structure.md
Normal file
@ -0,0 +1,39 @@
|
||||
# Project Structure
|
||||
|
||||
## Directory Overview
|
||||
|
||||
```
|
||||
{{#each structure.directories}}
|
||||
{{this.name}}/
|
||||
{{#each this.subdirectories}}
|
||||
├── {{this}}/
|
||||
{{/each}}
|
||||
{{#if this.file_count}}
|
||||
└── ({{this.file_count}} files)
|
||||
{{/if}}
|
||||
|
||||
{{/each}}
|
||||
```
|
||||
|
||||
## File Distribution
|
||||
|
||||
{{#each structure.files}}
|
||||
- **{{this.name}}** ({{this.language}}) - {{this.lines_of_code}} lines{{#if this.is_test}} [TEST]{{/if}}
|
||||
{{/each}}
|
||||
|
||||
## Statistics
|
||||
|
||||
- **Total Directories:** {{structure.directories.length}}
|
||||
- **Total Files:** {{structure.files.length}}
|
||||
- **Languages Used:**
|
||||
{{#group structure.files by="language"}}
|
||||
- {{@key}}: {{this.length}} files
|
||||
{{/group}}
|
||||
|
||||
{{#if structure.dependency_graph}}
|
||||
## Dependencies
|
||||
|
||||
{{#each structure.dependency_graph}}
|
||||
- **{{@key}}** depends on: {{#each this}}{{this}}{{#unless @last}}, {{/unless}}{{/each}}
|
||||
{{/each}}
|
||||
{{/if}}
|
Reference in New Issue
Block a user