close
Skip to content

Give explicit example of importing JS runtime#3178

Merged
leaanthony merged 4 commits into
wailsapp:masterfrom
danawoodman:patch-1
Jan 17, 2024
Merged

Give explicit example of importing JS runtime#3178
leaanthony merged 4 commits into
wailsapp:masterfrom
danawoodman:patch-1

Conversation

@danawoodman

@danawoodman danawoodman commented Jan 7, 2024 •
edited by coderabbitai Bot
Loading

Copy link
Copy Markdown
Contributor

Description

No where in the docs, google, github issues or discussions could I find an example of importing the runtime JS but after some experimentation I figured it out.

I think it would help future users if a simple example was shown like this so they have a clear reference of how to import the runtime.

Type of change

docs

How Has This Been Tested?

n/a

Test Configuration

n/a

Checklist:

n/a

Summary by CodeRabbit

  • Documentation
    • Updated the runtime documentation to include an example of how to import the EventsOn function in a Svelte application with TypeScript support.

@danawoodman
Give explicity example of importing JS runtime
88178c2 
No where in the docs, google, github issues or discussions could I find an example of importing the runtime JS but after some experimentation I figured it out.

I think it would help future users if a simple example was shown like this so they have a clear reference of how to import the runtime.
@coderabbitai

coderabbitai Bot commented Jan 7, 2024 •
edited
Loading

Copy link
Copy Markdown
Contributor

Summary of changes

website/versioned_docs/version-v2.7.0/reference/runtime/intro.mdx: The change introduces an example of importing the EventsOn function in a Svelte app using TypeScript declarations for the runtime.
website/src/pages/changelog.mdx: ## Short summary

The change introduces documentation on explicitly importing the JS runtime. This addition was made by @danawoodman in PR.

Walkthrough

The recent update introduces documentation for explicitly importing the JS runtime and provides an example of importing the EventsOn function in a Svelte app using TypeScript declarations for the runtime.

Changes

File Path Change Summary
.../versioned_docs/version-v2.7.0/reference/runtime/intro.mdx
website/src/pages/changelog.mdx		 Added documentation for explicitly importing JS runtime and an example of importing EventsOn in a Svelte app using TypeScript declarations.

🐇✨
In the realm of code where the Svelte rabbits hop,
A new example sprouts, from the TypeScript crop.
EventsOn now joins the Svelte town's script,
With declarations in place, no type is slipped. 🌱📜

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
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
  • 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 tests 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 from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @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.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

coderabbitai[bot]
coderabbitai Bot reviewed Jan 7, 2024
View reviewed changes

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between f7c1946 and 88178c2.
Files selected for processing (1)
  • website/versioned_docs/version-v2.7.0/reference/runtime/intro.mdx (1 hunks)
Additional comments: 1
website/versioned_docs/version-v2.7.0/reference/runtime/intro.mdx (1)
  • 37-42: The example provided for importing the EventsOn function in a Svelte application is clear and concise. It's good to see TypeScript being used, as it can help with type safety and autocompletion in supported IDEs.

coderabbitai[bot]
coderabbitai Bot reviewed Jan 7, 2024
View reviewed changes

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 88178c2 and 0acb1df.
Files selected for processing (1)
  • website/versioned_docs/version-v2.7.0/reference/runtime/intro.mdx (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • website/versioned_docs/version-v2.7.0/reference/runtime/intro.mdx

@leaanthony

leaanthony commented Jan 7, 2024

Copy link
Copy Markdown
Member

Thanks for this🙏 Please could you add an entry to the changelog located at website/src/pages/changelog.mdx?

coderabbitai[bot]
coderabbitai Bot reviewed Jan 8, 2024
View reviewed changes

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 0acb1df and 0e72244.
Files selected for processing (1)
  • website/src/pages/changelog.mdx (1 hunks)
Files skipped from review due to trivial changes (1)
  • website/src/pages/changelog.mdx

@danawoodman

danawoodman commented Jan 8, 2024

Copy link
Copy Markdown
Contributor Author

done!

coderabbitai[bot]
coderabbitai Bot reviewed Jan 17, 2024
View reviewed changes

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 0e72244 and 6523097.
Files selected for processing (1)
  • website/src/pages/changelog.mdx (1 hunks)
Additional comments: 1
website/src/pages/changelog.mdx (1)
  • 23-23: The changelog entry for the documentation addition is correctly formatted and follows the established pattern of previous entries.

@leaanthony

leaanthony commented Jan 17, 2024

Copy link
Copy Markdown
Member

Thanks for this @danawoodman 🙏

@leaanthony
leaanthony merged commit f9aa4d3 into wailsapp:master Jan 17, 2024
@danawoodman
danawoodman deleted the patch-1 branch January 24, 2024 23:32
@danawoodman danawoodman changed the title Give explicity example of importing JS runtime Give explicit example of importing JS runtime Jan 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments
@leaanthony leaanthony leaanthony approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@danawoodman @leaanthony