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

Improve playgrounds #1839

Merged
merged 8 commits into from
Jan 29, 2025
Merged

Conversation

flevi29
Copy link
Collaborator

@flevi29 flevi29 commented Jan 27, 2025

Pull Request

What does this PR do?

  • refactor playgrounds, so that it uses the base package.json Vite dependency, modernize it according to https://vite.new/vanilla

PR checklist

Please check if your PR fulfills the following requirements:

  • Does this PR fix an existing issue, or have you listed the changes applied in the PR description (and why they are needed)?
  • Have you read the contributing guidelines?
  • Have you made sure that the title is accurate and descriptive of the changes?

Thank you so much for contributing to Meilisearch!

@flevi29 flevi29 added the maintenance Issue about maintenance (CI, tests, refacto...) label Jan 27, 2025
@flevi29 flevi29 requested a review from Strift January 27, 2025 08:16
Copy link

codecov bot commented Jan 27, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.84%. Comparing base (7b6698f) to head (4b36fec).
Report is 9 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1839   +/-   ##
=======================================
  Coverage   98.84%   98.84%           
=======================================
  Files          17       17           
  Lines        1565     1565           
  Branches      338      338           
=======================================
  Hits         1547     1547           
  Misses         18       18           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Collaborator

@Strift Strift left a comment

Choose a reason for hiding this comment

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

Hey @flevi29, thanks for the PR.

Can you add the following files, please?

package.json with the following scripts:

    "dev": "vite",
    "build": "vite build",
    "preview": "vite preview"

README.md with the initial Vite instructions

@flevi29
Copy link
Collaborator Author

flevi29 commented Jan 27, 2025

Whoops, forgot to add the script.

I'm keeping the playground:javascript script name instead of dev for now.
As for build and preview, there's really no point in them, because this playground isn't meant to be built for anything, it's just a local demonstration.

@flevi29 flevi29 requested a review from Strift January 28, 2025 07:50
Copy link
Collaborator

@Strift Strift left a comment

Choose a reason for hiding this comment

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

It's best for the playgrounds to be as beginner-friendly as possible. In that regard, we want them to be pretty much copy-pastable, as is.

So we want the playground/javascript to look like a real Vite project. This needs to include:

  • a minimal README.md (to explain how to install deps & run dev server)
  • a minimal package.json so they can install deps & npm run dev

The rest is good for me. 👌

@flevi29 flevi29 requested a review from Strift January 29, 2025 08:47
Copy link
Collaborator

@Strift Strift left a comment

Choose a reason for hiding this comment

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

bors merge

Copy link
Contributor

meili-bors bot commented Jan 29, 2025

@meili-bors meili-bors bot merged commit 792ce67 into meilisearch:main Jan 29, 2025
8 checks passed
@flevi29 flevi29 deleted the improve-playgrounds branch January 29, 2025 09:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
maintenance Issue about maintenance (CI, tests, refacto...)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants