Given that Fresh is used by Deno and a very well used and visible package, it would be great if all packages under the @fresh scope on JSR had high scores.
Show current scores 👇
I've created this issue as an umbrella issue to track various adjustments that should be quick to do to help improve scoring for all packages.
JSR Maintainer Actions
Requires admin/member of @fresh to update.
Has provenance ✅
Mark deno as compatible runtime
Add description to the package
Documentation efforts
No slow types ✅
Examples in README.md or module doc
Module docs for all entrypoints
Has docs for most symbols
As this task is much larger than the other steps, this is tracked separately.
Export non-exported public API types
A non-exhaustive list of types that probably should be made public, as they are used in public signatures already.
Types from other dependencies
There are some types in the JSR automated documentation that comes from other packages, e.g. @fresh/plugin-tailwind using a @fresh/core/dev type, or @fresh/core using preact types. What's best practice here? How to make types linked to the correct definition?
Given that Fresh is used by Deno and a very well used and visible package, it would be great if all packages under the
@freshscope on JSR had high scores.Show current scores 👇
I've created this issue as an umbrella issue to track various adjustments that should be quick to do to help improve scoring for all packages.
JSR Maintainer Actions
Requires admin/member of
@freshto update.Has provenance ✅
Mark
denoas compatible runtime@fresh/build-id@fresh/plugin-tailwind-v3Add description to the package
@fresh/build-id@fresh/core@fresh/init@fresh/plugin-tailwind@fresh/plugin-tailwind-v3@fresh/updateDocumentation efforts
No slow types ✅
Examples in
README.mdor module doc@fresh/build-id: docs(build-id): add code block example #3600@fresh/core: docs(core): add small usage & getting started example #3598Module docs for all entrypoints
@fresh/core@fresh/examples: docs(examples): add module and public exports JSDoc for all entrypoints #3603@fresh/plugin-vite: docs(vite-plugin): add JSDoc and export public API #3604Has docs for most symbols
As this task is much larger than the other steps, this is tracked separately.
Export non-exported public API types
A non-exhaustive list of types that probably should be made public, as they are used in public signatures already.
ImportCheck&ImportCheckDiagnostic: docs(vite-plugin): add JSDoc and export public API #3604MaybeLazyMiddlewareRouteComponentRouteVNode,BuildCacheTypes from other dependencies
There are some types in the JSR automated documentation that comes from other packages, e.g.
@fresh/plugin-tailwindusing a@fresh/core/devtype, or@fresh/coreusingpreacttypes. What's best practice here? How to make types linked to the correct definition?OnTransformOptionsComponentType,DeserializedProps, and more