player-ui / player

https://player-ui.github.io
MIT License
73 stars 47 forks source link

Docs refresh with Astro #506

Closed adierkens closed 1 month ago

adierkens commented 2 months ago

Updating our docs site to use astro.

TODO

Published prerelease version: 0.10.0-next.1

Changelog ### Release Notes #### ios: enhance tapable logger to handle variadic args from the JS log ([#524](https://github.com/player-ui/player/pull/524)) Prefixing message with the format `[Player] [\(logLevel)]:` moved out of the Tapable logger and moved to PrintLoggerPlugin. Any consumers using their own LoggerPlugin will need to append the logLevel if they want to print it Before ```swift public class CustomLoggingPlugin: NativePlugin { public let pluginName = "CustomLoggingPlugin" public func apply

(player: P) where P: HeadlessPlayer { guard let player = player as? SwiftUIPlayer else { return } player.logger.logLevel = .trace player.logger.hooks.trace.tap(name: pluginName, { print("Custom message")\(($0))" ) }) ... } ``` After ```swift public class CustomLoggingPlugin: NativePlugin { public let pluginName = "CustomLoggingPlugin" public func apply

(player: P) where P: HeadlessPlayer { guard let player = player as? SwiftUIPlayer else { return } player.logger.logLevel = .trace let prefixedMessage = "[Player] [trace]: " player.logger.hooks.trace.tap(name: pluginName, { print("\(prefixedMessage) Custom message \(($0))" ) }) ... } ``` ## Breaking Changes Any usage of the `player.logger.hooks` taps will have breaking changes in the callback because the calls have been changed to provide a `[Any]` type instead of `String` so it can be returned in the form of messages instead of a single message. Unless nothing is done in the callback to access the value but just to print it, there should be breaking changes Example: ```swift // this should be no breaking change player.logger.hooks.trace.tap(name: "log", { print("\(($0))" ) }) // if `values` should be accessed in anyway, i.e want the first value, or want to seperate the values player.logger.hooks.debug.tap(name: "log") { values in // values is of type [Any], if you want to print only the first value print("\((message as? [String])?.first))" ) } ``` --- #### 🚀 Enhancement - ios: enhance tapable logger to handle variadic args from the JS log [#524](https://github.com/player-ui/player/pull/524) ([@nancywu1](https://github.com/nancywu1)) #### 🐛 Bug Fix - Fix CJS support for React Player [#525](https://github.com/player-ui/player/pull/525) ([@KetanReddy](https://github.com/KetanReddy)) - iOS: Expand AnyType to handle deeply nested AnyType for beacon encoding [#519](https://github.com/player-ui/player/pull/519) ([@hborawski](https://github.com/hborawski)) - Updating Main Page Content [#508](https://github.com/player-ui/player/pull/508) ([@KetanReddy](https://github.com/KetanReddy) [@adierkens](https://github.com/adierkens)) #### 🏠 Internal - Fix circleci badge in README [#480](https://github.com/player-ui/player/pull/480) ([@adierkens](https://github.com/adierkens) [@KetanReddy](https://github.com/KetanReddy)) #### 📝 Documentation - Docs refresh with Astro [#506](https://github.com/player-ui/player/pull/506) ([@adierkens](https://github.com/adierkens) [@KetanReddy](https://github.com/KetanReddy)) #### Authors: 4 - [@nancywu1](https://github.com/nancywu1) - Adam Dierkens ([@adierkens](https://github.com/adierkens)) - Harris Borawski ([@hborawski](https://github.com/hborawski)) - Ketan Reddy ([@KetanReddy](https://github.com/KetanReddy))

codecov[bot] commented 2 months ago

Codecov Report

Attention: Patch coverage is 22.22222% with 63 lines in your changes missing coverage. Please review.

Project coverage is 91.88%. Comparing base (47aa811) to head (c9500a3). Report is 33 commits behind head on main.

Files with missing lines Patch % Lines
plugins/reference-assets/react/tailwind.config.js 0.00% 34 Missing :warning:
...ns/reference-assets/react/src/assets/info/Info.tsx 0.00% 8 Missing :warning:
.../reference-assets/react/src/assets/image/Image.tsx 0.00% 7 Missing :warning:
plugins/reference-assets/react/postcss.config.js 0.00% 4 Missing :warning:
...eference-assets/react/src/components/Separator.tsx 0.00% 4 Missing :warning:
...eference-assets/react/src/assets/choice/Choice.tsx 50.00% 2 Missing :warning:
.../reference-assets/react/src/assets/input/Input.tsx 33.33% 2 Missing :warning:
...-assets/react/src/assets/collection/Collection.tsx 0.00% 1 Missing :warning:
...ns/reference-assets/react/src/assets/text/Text.tsx 0.00% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #506 +/- ## ========================================== - Coverage 91.92% 91.88% -0.05% ========================================== Files 341 341 Lines 27290 27303 +13 Branches 1944 1944 ========================================== Hits 25087 25087 - Misses 2189 2202 +13 Partials 14 14 ```

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

KetanReddy commented 2 months ago

We might want to redo the PlatformTabs component to use the Starlight Synced tabs component because that should automatically retain preference

adierkens commented 2 months ago

The only downside was not persisting that to the URL for sharing (not sure if that's a big deal or not)

KetanReddy commented 1 month ago

From whats left, I think we can defer styling and most content updates to post rollout tasks just so we can get this new version out. Only requirement left is probably the version selector and verifying stamping and mobile which I don't think we can really do until we put it out at least on next