Publish to registory - Githubissues

shogo82148 commented 4 months ago

Summary by CodeRabbit

New Features
- Added usage examples for parsing and generating A1 Notation in the README.md.
- Introduced a parse method to convert A1 notation strings into objects.
- Introduced a toString method to convert objects back to A1 notation strings.
Documentation
- Enhanced JSDoc comments for properties and methods in the A1Notation class.
Chores
- Added @shogo82148/a1notation library to deno.json.
- Added a new job in GitHub Actions to run a dry run of deno publish.

coderabbitai[bot] commented 4 months ago

[!WARNING]

Review failed

The pull request is closed.

Walkthrough

This update introduces significant enhancements to the codebase and documentation. A new job jsr-dry-run has been added for validation purposes, examples of usage have been updated in the README, dependencies in deno.json adjusted, and the A1Notation class in mod.ts received structure, documentation, and functionality improvements.

Changes

File	Summary
.github/.../test.yaml	Added a new job `jsr-dry-run` to check the code validity for JSR by setting up Deno and running a dry run of `deno publish`.
README.md	Added usage examples for parsing and generating A1 Notation using the `@shogo82148/a1notation` library for spreadsheets.
deno.json	Updated to include a new package named `@shogo82148/a1notation` with version `0.1.0`, exporting `./mod.ts` and importing `@deno/dnt` at version `^0.41.2`.
mod.ts	Enhanced `A1Notation` class with detailed JSDoc comments, reordered constructor properties, and added `parse` and `toString` methods.

Sequence Diagram(s)

sequenceDiagram
    participant Developer as Developer
    participant GitHub as GitHub Action
    participant Deno as Deno CLI
    participant Codebase as Codebase

    Developer->>GitHub: Push code changes
    GitHub->>Deno: Setup Deno environment
    GitHub->>Deno: Run deno publish dry run
    Deno->>GitHub: Return validation results
    GitHub->>Developer: Notify results

Poem

In a realm of code and light,
A1Notation takes its flight.
With new methods in the fray,
Parsing strings the modern way.
Docs and checks to keep us sound,
GitHub’s pipeline keeps it bound.
Let’s celebrate this path so bright,
With Deno in our coding night! 🌙

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` 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) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

codecov[bot] commented 4 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 96.80%. Comparing base (7bd030c) to head (3d3b62d).

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #4 +/- ## ========================================== + Coverage 96.62% 96.80% +0.17% ========================================== Files 1 1 Lines 267 282 +15 Branches 74 74 ========================================== + Hits 258 273 +15 Misses 9 9 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

shogo82148 / a1notation

Publish to registory #4