Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

run prettier on sdk readme #48905

Merged
merged 3 commits into from
Oct 21, 2024
Merged

run prettier on sdk readme #48905

merged 3 commits into from
Oct 21, 2024

Conversation

npretto
Copy link
Member

@npretto npretto commented Oct 18, 2024

Why

I opened it, changed a file, saved it and it all changed, which makes me sad

The formatting on the code samples were not consistent with formatting, there shouldn't be any downside in having the readme formatted by prettier.

I also added it to the lint-staged rules, so that we don't have to rely on people having prettier on the IDE

Non formatting changes

Due to some snippets being technically not valid code, there are some code changes.
Mostly {...} being modified into

{
  //...
}

I also modified some

```typescript jsx

into

```tsx

To make them consistent

@npretto npretto requested a review from a team October 18, 2024 18:19
Copy link
Contributor

@npretto You have modified embedding SDK code. Please make sure the PR title follows Conventional Commits style.
Here are all the supported types that will be shown in the changelog:

  • feat
  • fix
  • perf

These types docs, style, refactor, test, build, and ci are also encouraged for non-changelog related tasks.

Please also make sure to include sdk scope, otherwise, the changelog will not include this task.

For example, these are valid PR titles:

  • feat(sdk): Add interactive dashboard component
  • feat(sdk): Support theming pie chart
  • fix(sdk): Fix static dashboard crash

@npretto npretto added the backport Automatically create PR on current release branch on merge label Oct 18, 2024
@npretto npretto marked this pull request as draft October 18, 2024 18:25
@npretto npretto removed the request for review from a team October 18, 2024 18:27
@npretto npretto marked this pull request as ready for review October 21, 2024 09:01
@@ -124,11 +124,11 @@ const metabaseConfig = {
### JWT Authentication
Copy link
Member Author

Choose a reason for hiding this comment

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

image

Press the magic button ^
It will show a hugely better diff

@npretto npretto requested a review from a team October 21, 2024 09:08
Copy link
Contributor

@oisincoveney oisincoveney left a comment

Choose a reason for hiding this comment

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

@npretto npretto enabled auto-merge (squash) October 21, 2024 09:41
@npretto npretto merged commit 7be5270 into master Oct 21, 2024
130 of 183 checks passed
@npretto npretto deleted the npretto-sdk-prettier-on-readme branch October 21, 2024 09:43
github-automation-metabase pushed a commit that referenced this pull request Oct 21, 2024
* run prettier on sdk readme

* fix code snippets so that prettier can format them

* put back the empty new line on the package.json
github-automation-metabase added a commit that referenced this pull request Oct 21, 2024
* run prettier on sdk readme

* fix code snippets so that prettier can format them

* put back the empty new line on the package.json

Co-authored-by: Nicolò Pretto <[email protected]>
@github-actions github-actions bot added this to the 0.51 milestone Oct 21, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backport Automatically create PR on current release branch on merge .Team/Embedding
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants