feat: allow to set mimeType on field data - #25
fengmk2 merged 3 commits into
Conversation
Sorry, something went wrong.
use on alipay openapi upload file see https://opendocs.alipay.com/open-v3/054oog#%E6%96%87%E4%BB%B6%E4%B8%8A%E4%BC%A0
WalkthroughThe recent updates involve changes to GitHub Actions workflows and enhancements to the formstream.js library. Workflow files were updated to use different repositories and branches for Node.js jobs, and a new Node.js version was added. In the formstream.js library, new features and properties were introduced, and corresponding tests were updated to reflect these changes. Changes
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? Share 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 as PR comments)
Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed. CodeRabbit Configration File (.coderabbit.yaml)
Documentation and Community
|
Sorry, something went wrong.
|
New dependencies detected. Learn more about Socket for GitHub ↗︎
|
Sorry, something went wrong.
There was a problem hiding this comment.
Actionable comments posted: 27
Review DetailsConfiguration used: CodeRabbit UI
Review profile: CHILL
- .github/workflows/ci.yml (1 hunks)
- .github/workflows/release.yml (1 hunks)
- CHANGELOG.md (1 hunks)
- lib/formstream.js (4 hunks)
- test/formstream.test.js (1 hunks)
CHANGELOG.md (3)Additional comments not posted (7)Near line 3: Unpaired symbol: ‘[’ seems to be missing
Context: # Changelog ## [1.3.1](https://github.com/node-modules/formstr...
Near line 10: Unpaired symbol: ‘[’ seems to be missing
Context: ...47b306e87e520341f0499e82b83)) ## [1.3.0](https://github.com/node-modules/formstr...
Near line 17: Unpaired symbol: ‘[’ seems to be missing
Context: ...c1b4d72f5c624e8f4b40fafa942)) ## [1.2.0](https://github.com/node-modules/formstr...
.github/workflows/release.yml (1).github/workflows/ci.yml (2)10-10: Ensure the new uses path is correct.
Verify that node-modules/github-actions/.github/workflows/node-release.yml@master is the correct path for the Node.js release workflow.
lib/formstream.js (3)12-12: Ensure the new uses path is correct.
Verify that node-modules/github-actions/.github/workflows/node-test.yml@master is the correct path for the Node.js test workflow.
15-15: Verify the necessity of adding Node.js version 22.
Ensure that adding Node.js version 22 is necessary and supported by the project.
test/formstream.test.js (1)10-14: The new content section for data in JSON format is correctly formatted.
57-58: The new property isFormStream is correctly added and initialized.
Line range hint 140-149: The modification to the field method to accept an additional mimeType parameter is correctly implemented.
84-91: The new test case for the field method with the mimeType parameter is correctly implemented.
Sorry, something went wrong.
| --- | ||
|
|
||
|
|
||
| 1.2.0 / 2023-03-17 |
There was a problem hiding this comment.
Fix the heading style.
- 1.2.0 / 2023-03-17
+ ## 1.2.0 / 2023-03-17Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| 1.2.0 / 2023-03-17 | |
| ## 1.2.0 / 2023-03-17 |
Sorry, something went wrong.
| * [[`3c09f70`](http://github.com/node-modules/formstream/commit/3c09f700b2440b8f391650c939d91c2d5e4ae9b3)] - test: run on github action (#21) (fengmk2 <<fengmk2@gmail.com>>) | ||
| * [[`2d5ed81`](http://github.com/node-modules/formstream/commit/2d5ed81e95b4fde270b5db2720fff0e19effd2dc)] - test: run test on node 12, 14, 16 (#20) (fengmk2 <<fengmk2@gmail.com>>) | ||
|
|
||
| 1.1.1 / 2021-04-28 |
There was a problem hiding this comment.
Fix the heading style.
- 1.1.1 / 2021-04-28
+ ## 1.1.1 / 2021-04-28Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| 1.1.1 / 2021-04-28 | |
| ## 1.1.1 / 2021-04-28 |
Sorry, something went wrong.
| **others** | ||
| * [[`21918e5`](http://github.com/node-modules/formstream/commit/21918e5fc37a4cea5aae82659d39587f099e805b)] - chore: upgrade devDeps express to latest version (#15) (fengmk2 <<fengmk2@gmail.com>>) | ||
|
|
||
| 1.1.0 / 2016-12-19 |
There was a problem hiding this comment.
Fix the heading style.
- 1.1.0 / 2016-12-19
+ ## 1.1.0 / 2016-12-19Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| 1.1.0 / 2016-12-19 | |
| ## 1.1.0 / 2016-12-19 |
Sorry, something went wrong.
|
|
||
| * deps: upgrade mime to latest version (#9) | ||
|
|
||
| 1.0.0 / 2014-11-04 |
There was a problem hiding this comment.
Fix the heading style.
- 1.0.0 / 2014-11-04
+ ## 1.0.0 / 2014-11-04Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| 1.0.0 / 2014-11-04 | |
| ## 1.0.0 / 2014-11-04 |
Sorry, something went wrong.
| * fixed stream error not catch bug | ||
|
|
There was a problem hiding this comment.
Fix the unordered list indentation.
- * fixed stream error not catch bug
+ * fixed stream error not catch bugCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| * fixed stream error not catch bug | |
| * fixed stream error not catch bug | |
Sorry, something went wrong.
| * fixed #2 support form.buffer() | ||
| * add doc for setTotalStreamSize() |
There was a problem hiding this comment.
Fix the unordered list indentation.
- * fixed #2 support form.buffer()
- * add doc for setTotalStreamSize()
+ * fixed #2 support form.buffer()
+ * add doc for setTotalStreamSize()Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| * fixed #2 support form.buffer() | |
| * add doc for setTotalStreamSize() | |
| * fixed #2 support form.buffer() | |
| * add doc for setTotalStreamSize() |
Sorry, something went wrong.
| * support content-length use form.setTotalStreamSize(size) | ||
| * update readme |
There was a problem hiding this comment.
Fix the unordered list indentation.
- * support content-length use form.setTotalStreamSize(size)
- * update readme
+ * support content-length use form.setTotalStreamSize(size)
+ * update readmeCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| * support content-length use form.setTotalStreamSize(size) | |
| * update readme | |
| * support content-length use form.setTotalStreamSize(size) | |
| * update readme |
Sorry, something went wrong.
| * use buffer-concat support node < 0.8 | ||
|
|
There was a problem hiding this comment.
Fix the unordered list indentation.
- * use buffer-concat support node < 0.8
+ * use buffer-concat support node < 0.8Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| * use buffer-concat support node < 0.8 | |
| * use buffer-concat support node < 0.8 |
Sorry, something went wrong.
| * support multi streams. | ||
| * add one stream support now. | ||
| * Initial commit |
There was a problem hiding this comment.
Fix the unordered list indentation.
- * support multi streams.
- * add one stream support now.
- * Initial commit
+ * support multi streams.
+ * add one stream support now.
+ * Initial commitCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| * support multi streams. | |
| * add one stream support now. | |
| * Initial commit | |
| * support multi streams. | |
| * add one stream support now. | |
| * Initial commit |
Sorry, something went wrong.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files @@ Coverage Diff @@
## master #25 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 1 1
Lines 293 300 +7
Branches 46 46
=========================================
+ Hits 293 300 +7 ☔ View full report in Codecov by Sentry. |
Sorry, something went wrong.
There was a problem hiding this comment.
Actionable comments posted: 6
Out of diff range and nitpick comments (1)types/formstream.test-d.ts (1)Review Details19-19: Add a test case to verify the behavior when mimeType is not provided.
To ensure comprehensive test coverage, consider adding a test case where the mimeType parameter is omitted to verify that the method behaves correctly with default values.
Configuration used: CodeRabbit UI
Review profile: CHILL
- README.md (3 hunks)
- lib/formstream.js (4 hunks)
- package.json (2 hunks)
- types/formstream.d.ts (1 hunks)
- types/formstream.test-d.ts (1 hunks)
- package.json
- lib/formstream.js
README.md (4)Near line 178: If you want to indicate numerical ranges or time ranges, consider using an en dash.
Context: ...e (The MIT License) Copyright (c) 2012 - 2014 fengmk2 fengmk2@gmail.com Copyrig...
Near line 204: Unpaired symbol: ‘]’ seems to be missing
Context: ...:---: | :---: | :---: | :---: | :---: | [<img src="https://avatars.githubusercont...
Near line 207: It appears that a hyphen is missing (if ‘auto’ is not used in the context of ‘cars’).
Context: ...//github.com/xudafeng/git-contributor), auto updated at Wed May 15 2024 00:34:12 GMT+0800....
Near line 207: Commas set off the year in a month-day-year date.
Context: ...afeng/git-contributor), auto updated at Wed May 15 2024 00:34:12 GMT+0800. <!-- GITCONTR...
Sorry, something went wrong.
| * @param value Value of field | ||
| */ | ||
| field(name: string, value: string): this | ||
| field(name: string, value: string, contentType?: string): this |
There was a problem hiding this comment.
Ensure consistency in parameter naming.
Consider renaming contentType to mimeType for consistency with other methods in the codebase that use mimeType as the parameter name.
- field(name: string, value: string, contentType?: string): this
+ field(name: string, value: string, mimeType?: string): thisCommittable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| field(name: string, value: string, contentType?: string): this | |
| field(name: string, value: string, mimeType?: string): this |
Sorry, something went wrong.
| (The MIT License) | ||
|
|
||
| Copyright (c) 2012 - 2014 fengmk2 <fengmk2@gmail.com> | ||
| Copyright (c) 2012 - 2014 fengmk2 <fengmk2@gmail.com> |
There was a problem hiding this comment.
Use an en dash for numerical ranges.
Consider using an en dash (–) instead of a hyphen (-) for numerical ranges to improve readability.
- Copyright (c) 2012 - 2014 fengmk2 <fengmk2@gmail.com>
+ Copyright (c) 2012–2014 fengmk2 <fengmk2@gmail.com>Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| Copyright (c) 2012 - 2014 fengmk2 <fengmk2@gmail.com> | |
| Copyright (c) 2012–2014 fengmk2 <fengmk2@gmail.com> |
Sorry, something went wrong.
| ## Contributors | ||
|
|
||
| |[<img src="https://avatars.githubusercontent.com/u/156269?v=4" width="100px;"/><br/><sub><b>fengmk2</b></sub>](https://github.com/fengmk2)<br/>|[<img src="https://avatars.githubusercontent.com/u/288288?v=4" width="100px;"/><br/><sub><b>xingrz</b></sub>](https://github.com/xingrz)<br/>|[<img src="https://avatars.githubusercontent.com/u/32174276?v=4" width="100px;"/><br/><sub><b>semantic-release-bot</b></sub>](https://github.com/semantic-release-bot)<br/>|[<img src="https://avatars.githubusercontent.com/u/13151189?v=4" width="100px;"/><br/><sub><b>fjc0k</b></sub>](https://github.com/fjc0k)<br/>|[<img src="https://avatars.githubusercontent.com/u/18096247?v=4" width="100px;"/><br/><sub><b>mrspeiser</b></sub>](https://github.com/mrspeiser)<br/>|[<img src="https://avatars.githubusercontent.com/u/985607?v=4" width="100px;"/><br/><sub><b>dead-horse</b></sub>](https://github.com/dead-horse)<br/>| | ||
| | :---: | :---: | :---: | :---: | :---: | :---: | |
There was a problem hiding this comment.
Add missing pipe symbol in the table.
The table row is missing a leading pipe symbol, which can cause formatting issues.
- | :---: | :---: | :---: | :---: | :---: | :---: |
+ | :---: | :---: | :---: | :---: | :---: | :---: |Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| | :---: | :---: | :---: | :---: | :---: | :---: | |
Sorry, something went wrong.
| | :---: | :---: | :---: | :---: | :---: | :---: | | ||
| [<img src="https://avatars.githubusercontent.com/u/7326406?v=4" width="100px;"/><br/><sub><b>shaozj</b></sub>](https://github.com/shaozj)<br/> | ||
|
|
||
| This project follows the git-contributor [spec](https://github.com/xudafeng/git-contributor), auto updated at `Wed May 15 2024 00:34:12 GMT+0800`. |
There was a problem hiding this comment.
Add a hyphen in "auto-updated".
Consider adding a hyphen in "auto-updated" for clarity.
- auto updated at `Wed May 15 2024 00:34:12 GMT+0800`.
+ auto-updated at `Wed May 15 2024 00:34:12 GMT+0800`.Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| This project follows the git-contributor [spec](https://github.com/xudafeng/git-contributor), auto updated at `Wed May 15 2024 00:34:12 GMT+0800`. | |
| This project follows the git-contributor [spec](https://github.com/xudafeng/git-contributor), auto-updated at `Wed May 15 2024 00:34:12 GMT+0800`. |
Add a comma in the date.
Consider adding a comma after the day in the date for better readability.
- Wed May 15 2024 00:34:12 GMT+0800
+ Wed May 15, 2024 00:34:12 GMT+0800Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| This project follows the git-contributor [spec](https://github.com/xudafeng/git-contributor), auto updated at `Wed May 15 2024 00:34:12 GMT+0800`. | |
| This project follows the git-contributor [spec](https://github.com/xudafeng/git-contributor), auto updated at `Wed May 15, 2024 00:34:12 GMT+0800`. |
Sorry, something went wrong.
| |[<img src="https://avatars.githubusercontent.com/u/156269?v=4" width="100px;"/><br/><sub><b>fengmk2</b></sub>](https://github.com/fengmk2)<br/>|[<img src="https://avatars.githubusercontent.com/u/288288?v=4" width="100px;"/><br/><sub><b>xingrz</b></sub>](https://github.com/xingrz)<br/>|[<img src="https://avatars.githubusercontent.com/u/32174276?v=4" width="100px;"/><br/><sub><b>semantic-release-bot</b></sub>](https://github.com/semantic-release-bot)<br/>|[<img src="https://avatars.githubusercontent.com/u/13151189?v=4" width="100px;"/><br/><sub><b>fjc0k</b></sub>](https://github.com/fjc0k)<br/>|[<img src="https://avatars.githubusercontent.com/u/18096247?v=4" width="100px;"/><br/><sub><b>mrspeiser</b></sub>](https://github.com/mrspeiser)<br/>|[<img src="https://avatars.githubusercontent.com/u/985607?v=4" width="100px;"/><br/><sub><b>dead-horse</b></sub>](https://github.com/dead-horse)<br/>| | ||
| | :---: | :---: | :---: | :---: | :---: | :---: | | ||
| [<img src="https://avatars.githubusercontent.com/u/7326406?v=4" width="100px;"/><br/><sub><b>shaozj</b></sub>](https://github.com/shaozj)<br/> |
There was a problem hiding this comment.
Add alt text to images.
Consider adding alt text to the images for better accessibility.
- <br/>
+  <br/><sub><b>fengmk2</b></sub>](https://github.com/fengmk2)<br/>Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation.
| |[<img src="https://avatars.githubusercontent.com/u/156269?v=4" width="100px;"/><br/><sub><b>fengmk2</b></sub>](https://github.com/fengmk2)<br/>|[<img src="https://avatars.githubusercontent.com/u/288288?v=4" width="100px;"/><br/><sub><b>xingrz</b></sub>](https://github.com/xingrz)<br/>|[<img src="https://avatars.githubusercontent.com/u/32174276?v=4" width="100px;"/><br/><sub><b>semantic-release-bot</b></sub>](https://github.com/semantic-release-bot)<br/>|[<img src="https://avatars.githubusercontent.com/u/13151189?v=4" width="100px;"/><br/><sub><b>fjc0k</b></sub>](https://github.com/fjc0k)<br/>|[<img src="https://avatars.githubusercontent.com/u/18096247?v=4" width="100px;"/><br/><sub><b>mrspeiser</b></sub>](https://github.com/mrspeiser)<br/>|[<img src="https://avatars.githubusercontent.com/u/985607?v=4" width="100px;"/><br/><sub><b>dead-horse</b></sub>](https://github.com/dead-horse)<br/>| | |
| | :---: | :---: | :---: | :---: | :---: | :---: | | |
| [<img src="https://avatars.githubusercontent.com/u/7326406?v=4" width="100px;"/><br/><sub><b>shaozj</b></sub>](https://github.com/shaozj)<br/> | |
| |[ <br/><sub><b>fengmk2</b></sub>](https://github.com/fengmk2)<br/>|[<img src="https://avatars.githubusercontent.com/u/288288?v=4" width="100px;"/><br/><sub><b>xingrz</b></sub>](https://github.com/xingrz)<br/>|[<img src="https://avatars.githubusercontent.com/u/32174276?v=4" width="100px;"/><br/><sub><b>semantic-release-bot</b></sub>](https://github.com/semantic-release-bot)<br/>|[<img src="https://avatars.githubusercontent.com/u/13151189?v=4" width="100px;"/><br/><sub><b>fjc0k</b></sub>](https://github.com/fjc0k)<br/>|[<img src="https://avatars.githubusercontent.com/u/18096247?v=4" width="100px;"/><br/><sub><b>mrspeiser</b></sub>](https://github.com/mrspeiser)<br/>|[<img src="https://avatars.githubusercontent.com/u/985607?v=4" width="100px;"/><br/><sub><b>dead-horse</b></sub>](https://github.com/dead-horse)<br/>| | |
| | :---: | :---: | :---: | :---: | :---: | :---: | | |
| [<img src="https://avatars.githubusercontent.com/u/7326406?v=4" width="100px;"/><br/><sub><b>shaozj</b></sub>](https://github.com/shaozj)<br/> |
Sorry, something went wrong.
[skip ci] ## [1.4.0](v1.3.1...v1.4.0) (2024-05-14) ### Features * allow to set mimeType on field data ([#25](#25)) ([f3338f8](f3338f8))
use on alipay openapi upload file
see https://opendocs.alipay.com/open-v3/054oog#%E6%96%87%E4%BB%B6%E4%B8%8A%E4%BC%A0
Summary by CodeRabbit
New Features
Bug Fixes
Documentation
Tests
Chores