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

feat: add browsers list, linting plugin and Docs section with supported browsers #1956

Open
wants to merge 34 commits into
base: main
Choose a base branch
from

Conversation

oemueller
Copy link
Contributor

@oemueller oemueller commented Oct 14, 2024

Relates to #83

Checklist

  • The added / edited code has been documented with JSDoc
  • A changeset is added with npx changeset add if your changes should be released as npm package (because they affect the library usage)

Copy link

changeset-bot bot commented Oct 14, 2024

🦋 Changeset detected

Latest commit: 701907c

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
docs Minor

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

@oemueller oemueller changed the title feat: add browser list and linting rule feat: add browsers list, linting plugin and Docs section with supported browsers Oct 15, 2024
@oemueller oemueller force-pushed the feat/83-browser-support-linting branch from 543aa77 to 77b06f2 Compare October 15, 2024 17:08
@oemueller oemueller marked this pull request as ready for review October 15, 2024 17:09
@oemueller oemueller requested a review from a team as a code owner October 15, 2024 17:09
@oemueller
Copy link
Contributor Author

oemueller commented Oct 15, 2024

Preview of browser section in Onyx Docs:

Bildschirmfoto 2024-10-15 um 19 10 21

Copy link
Collaborator

@larsrickert larsrickert left a comment

Choose a reason for hiding this comment

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

Thanks for your contribution! I left a few comments, let me know what you think!

.changeset/brave-days-happen.md Outdated Show resolved Hide resolved
.eslintrc.cjs Show resolved Hide resolved
apps/docs/package.json Show resolved Hide resolved
apps/docs/src/.vitepress/browser-loader.data.ts Outdated Show resolved Hide resolved
apps/docs/src/.vitepress/browser-loader.data.ts Outdated Show resolved Hide resolved
apps/docs/src/.vitepress/browser-loader.data.ts Outdated Show resolved Hide resolved
apps/docs/src/.vitepress/browser-loader.data.ts Outdated Show resolved Hide resolved
apps/docs/src/.vitepress/browser-loader.data.ts Outdated Show resolved Hide resolved
apps/docs/vite.config.ts Outdated Show resolved Hide resolved
apps/docs/src/.vitepress/components/OnyxHomePage.vue Outdated Show resolved Hide resolved
@larsrickert larsrickert self-assigned this Oct 16, 2024
@larsrickert
Copy link
Collaborator

With the current approach, only JavaScript features are linted, right? So if we use CSS features that are e.g. not supported in firefox, we will not know

@oemueller
Copy link
Contributor Author

oemueller commented Oct 16, 2024

we could try out https://stylelint.io/ to lint our CSS, will create a follow up ticket for that.

#1970

@oemueller oemueller force-pushed the feat/83-browser-support-linting branch from c570847 to 0850eb6 Compare October 18, 2024 12:58
apps/docs/src/.vitepress/browser-loader.data.ts Outdated Show resolved Hide resolved
apps/docs/src/.vitepress/browser-loader.data.ts Outdated Show resolved Hide resolved
apps/docs/src/.vitepress/components/BrowsersList.vue Outdated Show resolved Hide resolved
apps/docs/src/.vitepress/components/BrowsersList.vue Outdated Show resolved Hide resolved
apps/docs/src/assets/browsers/chrome.svg Outdated Show resolved Hide resolved
apps/docs/src/development/index.md Outdated Show resolved Hide resolved
apps/docs/src/development/index.md Outdated Show resolved Hide resolved
Copy link
Collaborator

Choose a reason for hiding this comment

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

@JoCa96 If we list supported browsers in our docs, we should also make sure that they are actually working, so e.g. use those browsers and versions in our Playwright tests. What do you think?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants