Update README and package.json #856
Conversation
🦋 Changeset detectedLatest commit: 7942c54 The changes in this PR will be included in the next version bump. Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
|
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 as PR comments)
Additionally, you can add CodeRabbit Configration File (
|
|
/snapshot-release |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
Outside diff range and nitpick comments (2)
README.md (2)
Line range hint
91-91: Consider adding a comma for better readability.- Default: `latest`, Example: `8.14.0` + Default: `latest`, Example: `8.14.0`,
Line range hint
123-123: The excessive use of exclamation marks might be perceived as overly enthusiastic.Consider reducing the number of exclamation marks in the "Contributions of any kind welcome!" sentence to maintain a professional tone.
Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Files selected for processing (3)
- .changeset/small-chairs-cheat.md (1 hunks)
- README.md (3 hunks)
- package.json (1 hunks)
Files skipped from review due to trivial changes (2)
- .changeset/small-chairs-cheat.md
- package.json
Additional context used
LanguageTool
README.md
[typographical] ~91-~91: It seems that a comma is missing. (THANKS_COMMA)
Context: ...t, Example:8.14.0` ## Contributors Thanks goes to these wonderful people ([emoji ...
[style] ~123-~123: Using many exclamation marks might seem excessive (in this case: 12 exclamation marks for a text that’s 2330 characters long) (EN_EXCESSIVE_EXCLAMATION)
Context: ...ation. Contributions of any kind welcome! ## License This software is released ...
Additional comments not posted (7)
README.md (7)
4-4: Badge added to show the node version supported by the package.
5-5: Badge added for npm downloads, useful for users to see the popularity of the package.
8-8: Badge added to encourage community contributions.
9-9: Updated the contributors badge to show the number directly from GitHub, enhancing transparency.
10-12: Added badges for the formatting, testing, and building tools used in the project.
31-37: New section added in the README to explain how to include the plugin in thetypedoc.json. This is crucial for correct plugin usage.
70-70: Added a new example image link. Ensure the URL is correct and the image is accessible.Verification successful
The image URL is accessible and returns a 200 OK status after following the redirection.
Scripts executed
The following scripts were executed for the analysis:
Script:
#!/bin/bash # Description: Verify the accessibility of the newly added image link. # Test: Check the HTTP status code of the image URL. Expect: 200 OK. curl -o /dev/null --silent --head --write-out '%{http_code}' https://github.com/kamiazya/typedoc-plugin-mermaid/raw/main/media/example.pngLength of output: 144
Script:
#!/bin/bash # Description: Verify the accessibility of the newly added image link by following redirections. # Test: Follow the redirection and check the HTTP status code of the final URL. Expect: 200 OK. curl -o /dev/null --silent --head --write-out '%{http_code}' -L https://github.com/kamiazya/typedoc-plugin-mermaid/raw/main/media/example.pngLength of output: 147
This pull request includes updates to the README file to reflect changes in TypeDoc versions 0.24 and 0.25. Additionally, the "dist" folder has been added to the "files" field in the package.json file and the .gitignore file has been removed.