Feat update model #79
Conversation
|
Warning Rate limit exceeded@Romakita has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 29 minutes and 42 seconds before requesting another review. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. WalkthroughThe recent updates encompass documentation improvements, configuration additions, and code enhancements. Key changes include new navigation links, refined CSS styles, enhanced router and JSON mapper configurations, and the introduction of custom decorators, middleware, and file upload handling. Additionally, there are comprehensive guides for serverless deployment, dynamic provider imports, and customizing 404 error pages. Changes
Poem
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 7
Outside diff range, codebase verification and nitpick comments (7)
docs/docs/not-found-page.md (1)
13-15: Fix grammatical issue in the warning.Correct the grammar in the warning message.
- `response.render()` require to configure the template engine before. + `response.render()` requires configuring the template engine beforehand.Tools
LanguageTool
[grammar] ~14-~14: Did you mean “configuring”? Or maybe you should add a pronoun? In active voice, ‘require’ + ‘to’ takes an object, usually a pronoun.
Context: ...::: warningresponse.render()require to configure the template engine before. See our pag...(ALLOW_TO)
docs/docs/custom-endpoint-decorators.md (1)
47-52: Consider using a more descriptive adjective.The phrase "really small" can be improved for clarity.
- If your action is really small, + If your action is minimal,Tools
LanguageTool
[style] ~48-~48: Consider using an extreme adjective for ‘small’.
Context: ...out Ts.ED middleware. If your action is really small, you can register a pure express middle...(EXTREME_ADJECTIVES)
docs/docs/providers.md (1)
Line range hint
148-249: Fix unordered list indentation.The unordered list indentation should be corrected to follow Markdownlint rules.
- - [Service](/docs/services.md), - - [Controller](/docs/controllers.md), - - [Middleware](/docs/middlewares.md), - - [Pipes](/docs/pipes.md). + - [Service](/docs/services.md), + - [Controller](/docs/controllers.md), + - [Middleware](/docs/middlewares.md), + - [Pipes](/docs/pipes.md).Tools
LanguageTool
[style] ~254-~254: Consider shortening this phrase to just ‘whether’, unless you mean ‘regardless of whether’.
Context: ...plication loads, so do all the modules, whether or not they are immediately necessary. While t...(WHETHER)
docs/tutorials/serverless.md (4)
4-4: Improve readability by rephrasing.The sentence structure can be improved for better readability.
- content: Guide to deploy your Ts.ED application on Serveless. + content: Guide to deploying your Ts.ED application on Serverless.
72-72: Rephrase for better readability.Consider rephrasing to improve readability.
- By convention, try to not import something from `@tsed/common`. + By convention, try not to import anything from `@tsed/common`.Tools
LanguageTool
[style] ~72-~72: Consider changing the order of words to improve your wording.
Context: ...# Rule ::: warning By convention, try to not import something from@tsed/common. `...(TO_NOT_VB)
[style] ~72-~72: The phrase ‘a lot of’ might be wordy and overused. Consider using an alternative.
Context: ...om@tsed/common.@tsed/commonembed a lot of codes designed for the Full server plat...(A_LOT_OF)
224-224: Improve sentence flow.Rephrase to improve sentence flow.
- For that, we need also to build our code before invoke the lambda. + For that, we also need to build our code before invoking the lambda.Tools
LanguageTool
[style] ~224-~224: To make your writing flow more naturally, try moving ‘also’ before the verb.
Context: ...le to invoke our function. For that, we need also to build our code before invoke the lam...(ALSO_PLACEMENT)
239-239: Specify language in code block.Add a language identifier to the code block for better syntax highlighting.
- ``` + ```bashTools
Markdownlint
239-239: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files ignored due to path filters (4)
docs/public/serverless.pngis excluded by!**/*.pngdocs/public/serverless.svgis excluded by!**/*.svgdocs/public/vike-tsed.pngis excluded by!**/*.pngdocs/public/vike.svgis excluded by!**/*.svg
Files selected for processing (19)
- docs/.vitepress/config.mts (3 hunks)
- docs/.vitepress/theme/molecules/api-anchor/ApiAnchor.css (2 hunks)
- docs/docs/configuration/index.md (2 hunks)
- docs/docs/configuration/snippets/bootstrap-with-node-config.ts (1 hunks)
- docs/docs/custom-endpoint-decorators.md (1 hunks)
- docs/docs/json-mapper.md (2 hunks)
- docs/docs/model.md (3 hunks)
- docs/docs/not-found-page.md (1 hunks)
- docs/docs/providers.md (1 hunks)
- docs/docs/snippets/middlewares/platform-accept-mimes-middleware.ts (1 hunks)
- docs/docs/snippets/multer/configuration.ts (1 hunks)
- docs/docs/snippets/multer/controller.ts (1 hunks)
- docs/docs/snippets/multer/file-array.ts (1 hunks)
- docs/docs/snippets/multer/loading-file.js (1 hunks)
- docs/docs/upload-files.md (1 hunks)
- docs/tutorials/mongoose.md (1 hunks)
- docs/tutorials/passport.md (1 hunks)
- docs/tutorials/serverless.md (1 hunks)
- docs/tutorials/vike.md (1 hunks)
Files skipped from review due to trivial changes (4)
- docs/.vitepress/config.mts
- docs/docs/configuration/snippets/bootstrap-with-node-config.ts
- docs/docs/json-mapper.md
- docs/tutorials/mongoose.md
Additional context used
LanguageTool
docs/docs/not-found-page.md
[grammar] ~14-~14: Did you mean “configuring”? Or maybe you should add a pronoun? In active voice, ‘require’ + ‘to’ takes an object, usually a pronoun.
Context: ...::: warningresponse.render()require to configure the template engine before. See our pag...(ALLOW_TO)
docs/docs/custom-endpoint-decorators.md
[style] ~48-~48: Consider using an extreme adjective for ‘small’.
Context: ...out Ts.ED middleware. If your action is really small, you can register a pure express middle...(EXTREME_ADJECTIVES)
docs/tutorials/vike.md
[uncategorized] ~81-~81: Loose punctuation mark.
Context: ...x) with 2 projects: -packages/server: the backend project - `packages/ser...(UNLIKELY_OPENING_PUNCTUATION)
docs/tutorials/serverless.md
[style] ~15-~15: Three successive sentences begin with the same word. Consider rewording the sentence or use a thesaurus to find a synonym.
Context: ...ce web framework written using Node.js. Serverless is the first framework developed for bu...(ENGLISH_WORD_REPEAT_BEGINNING_RULE)
[style] ~72-~72: Consider changing the order of words to improve your wording.
Context: ...# Rule ::: warning By convention, try to not import something from@tsed/common. `...(TO_NOT_VB)
[style] ~72-~72: The phrase ‘a lot of’ might be wordy and overused. Consider using an alternative.
Context: ...om@tsed/common.@tsed/commonembed a lot of codes designed for the Full server plat...(A_LOT_OF)
[style] ~224-~224: To make your writing flow more naturally, try moving ‘also’ before the verb.
Context: ...le to invoke our function. For that, we need also to build our code before invoke the lam...(ALSO_PLACEMENT)
[uncategorized] ~341-~341: “you” seems less likely than “your” (belonging to you).
Context: ...## Testing Ts.ED provide a way to test you lambda with mocked Aws event and contex...(AI_HYDRA_LEO_CP_YOU_YOUR)
[grammar] ~342-~342: A verb may be missing.
Context: ...g the @@PlatformServerlessTest@@ util. Here an example to test a Lambda controller:...(THERE_MISSING_VERB)
Markdownlint
docs/docs/upload-files.md
40-40: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
41-41: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
42-42: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
43-43: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
44-44: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
45-45: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
46-46: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
docs/tutorials/vike.md
82-82: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
83-83: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
85-85: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
86-86: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
166-166: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
160-160: null
Images should have alternate text (alt text)(MD045, no-alt-text)
docs/tutorials/serverless.md
56-56: Punctuation: '...'
Trailing punctuation in heading(MD026, no-trailing-punctuation)
239-239: null
Fenced code blocks should have a language specified(MD040, fenced-code-language)
Additional comments not posted (35)
docs/docs/snippets/multer/configuration.ts (1)
1-9: Ensure proper configuration of Multer options.The configuration for
multerspecifies the destination directory for uploads. It is important to ensure that this directory is secure and has appropriate permissions to avoid potential security issues.Ensure that the specified directory
./../uploadsis secure and has the correct permissions set.docs/docs/snippets/middlewares/platform-accept-mimes-middleware.ts (3)
1-6: Imports and decorators are correct.The imports and decorators are appropriate for the functionality provided.
7-16: Class definition and properties are correct.The class definition and properties are appropriately set up.
18-25: Logic in theusemethod is correct.The
usemethod correctly handles accepted MIME types and throws an appropriate exception.docs/.vitepress/theme/molecules/api-anchor/ApiAnchor.css (2)
1-8: CSS rules fora[data-name="ApiAnchor"]are correct.The CSS rules are appropriately applied and follow best practices.
Line range hint
10-32:
CSS rules for[data-name="ApiAnchor"]are correct.The CSS rules are appropriately applied and follow best practices.
docs/docs/not-found-page.md (2)
1-7: Introduction and customization instructions are clear and correct.The introduction and customization instructions are well-written and informative.
17-27: Import instructions are clear and correct.The import instructions are well-written and informative.
docs/docs/custom-endpoint-decorators.md (2)
1-17: Introduction and built-in decorators section are clear and correct.The introduction and built-in decorators section are well-written and informative.
19-33: Custom decorator example is clear and correct.The custom decorator example is well-written and informative.
docs/docs/upload-files.md (4)
1-11: LGTM!The metadata section is well-defined and appears to be correct.
13-22: LGTM!The introduction and tip sections are clear and informative.
24-34: LGTM!The configuration and example sections are clear and provide useful information.
50-69: LGTM!The usage sections for single and multiple file uploads are clear and provide useful code snippets.
docs/tutorials/passport.md (5)
26-32: LGTM!The installation section is clear and provides useful information for different package managers.
Line range hint
30-74: LGTM!The configure your server section is clear and provides useful code snippets for configuration.
Line range hint
76-94: LGTM!The create a new protocol section is clear and provides useful code snippets for creating a new protocol.
Line range hint
96-102: LGTM!The protect a route section is clear and provides useful code snippets for protecting routes.
Line range hint
104-118: LGTM!The basic auth and advanced auth sections are clear and provide useful code snippets for configuring the strategies.
docs/tutorials/vike.md (3)
1-14: LGTM!The metadata section is well-defined and appears to be correct.
16-32: LGTM!The introduction and tip sections are clear and informative.
39-87: LGTM!The features and quick start sections are clear and provide useful information.
Tools
LanguageTool
[uncategorized] ~81-~81: Loose punctuation mark.
Context: ...x) with 2 projects: -packages/server: the backend project - `packages/ser...(UNLIKELY_OPENING_PUNCTUATION)
Markdownlint
82-82: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
83-83: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
85-85: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
86-86: Expected: 2; Actual: 4
Unordered list indentation(MD007, ul-indent)
docs/docs/providers.md (4)
Line range hint
1-11: LGTM!The metadata section is well-defined and appears to be correct.
Tools
LanguageTool
[style] ~254-~254: Consider shortening this phrase to just ‘whether’, unless you mean ‘regardless of whether’.
Context: ...plication loads, so do all the modules, whether or not they are immediately necessary. While t...(WHETHER)
Line range hint
13-72: LGTM!The introduction and services sections are clear and provide useful examples.
Tools
LanguageTool
[style] ~254-~254: Consider shortening this phrase to just ‘whether’, unless you mean ‘regardless of whether’.
Context: ...plication loads, so do all the modules, whether or not they are immediately necessary. While t...(WHETHER)
Line range hint
74-94: LGTM!The dependency injection and scopes sections are clear and provide useful information.
Tools
LanguageTool
[style] ~254-~254: Consider shortening this phrase to just ‘whether’, unless you mean ‘regardless of whether’.
Context: ...plication loads, so do all the modules, whether or not they are immediately necessary. While t...(WHETHER)
Line range hint
96-146: LGTM!The binding configuration and custom providers sections are clear and provide useful examples.
Tools
LanguageTool
[style] ~254-~254: Consider shortening this phrase to just ‘whether’, unless you mean ‘regardless of whether’.
Context: ...plication loads, so do all the modules, whether or not they are immediately necessary. While t...(WHETHER)
docs/docs/configuration/index.md (4)
325-333: Well-documented new configuration forrouter.The documentation for
router.appendChildrenRoutesFirstis clear and provides the necessary details.
335-339: Clear explanation ofrouter.appendChildrenRoutesFirst.The description is concise and informative, making it easy to understand the purpose and default value of the configuration.
347-348: New configuration forjsonMapperlooks good.The addition of
strictGroups: falseis well-documented and fits seamlessly into the existing configuration documentation.
372-377: Informative warning aboutjsonMapper.strictGroups.The warning about the default value change in the next major version is helpful for the users.
docs/docs/model.md (5)
99-111: Clear documentation for@Anydecorator.The example and explanation for using
@Anydecorator to allow all types is clear and informative.
188-200: Well-explained new functionality for@Anydecorator.The explanation of combining
@Anywith other decorators is clear and provides a useful example.
296-305: Clarity in@Nullabledecorator usage.The example and explanation for using
@Nullabledecorator with mixed types is clear and informative.
309-319: Well-documented new functionality for@Nullabledecorator.The explanation of combining
@Nullablewith other decorators is clear and provides a useful example.
329-339: Correct JSON Schema example.The JSON Schema example for
@Nullabledecorator usage is correct and informative.
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
|
🎉 This PR is included in version 1.0.0 🎉 The release is available on:
Your semantic-release bot 📦🚀 |
Summary by CodeRabbit
@Anyand@Nullabledecorators.passport.ApiAnchorcomponent.@tsed/mongoose.