Perf: skills and types - #16
Merged
Merged
Conversation
…ter generics, and file upload examples
- export types in index.d.ts for better TypeScript support; - update documentation for KoaContext and file upload examples;
- Deleted the gen.js file, which was responsible for generating TypeScript files from JSON schema files, as part of a cleanup process.
…controller patterns, middleware patterns, and project structure - Introduced new markdown files detailing application setup, CLI command usage, controller conventions, middleware patterns, and overall project structure for the koapp framework. - Enhanced developer experience by providing clear guidelines and examples for each aspect of the framework.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Note
Medium Risk
Removing
commands/gen.jsis a breaking CLI change for anyone usingkoapp gen; theexportadditions inindex.d.tsare additive for TypeScript consumers.Overview
Adds agent guidance and TypeScript documentation for koapp, and makes framework types importable from
@axiosleo/koapp.New
.agents/rulestemplates cover Conventional Commits + TaskID (git-commit.mdc.tmpl) andapps/servicesbackend layout (router/controller/model,/openapivs/api, health check). A newkoapp-typescriptskill (plusexamples.md) documents typed contexts, Router generics, multer uploads, module augmentation, and config types; koapp, koapp-apps, koapp-router, and http-server now point readers to that skill, including a TS upload snippet inhttp-server.md.index.d.tsexports previously internal symbols (KoaContext,ContextHandler,RouterInfo, config types,StatusCode, SSE types, etc.) so consumers canimport type { ... } from '@axiosleo/koapp'as described in the new skill.commands/gen.jsis removed, dropping the CLIkoapp gen/generateflow that scaffolded model/controller/router from JSON Schema.Reviewed by Cursor Bugbot for commit 2a48e2b. Bugbot is set up for automated code reviews on this repo. Configure here.