search

jantimon / next-yak

a streamlined CSS-in-JS solution tailor-made for Next.js, seamlessly combining the expressive power of styled-components syntax with efficient build-time extraction and minimal runtime footprint, ensuring optimal performance and easy integration with existing atomic CSS frameworks like Tailwind CSS
https://yak.js.org
108 stars 2 forks source link

create next-yak/internal #117

Closed jantimon closed 1 month ago

jantimon commented 1 month ago

this is the very first step for #56

it creates the structure and the adjusts the babel plugin to split the internal and external usage

by now it should work exactly the same (this means pr does not include any improvements for testing)

Summary by CodeRabbit

vercel[bot] commented 1 month ago

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
next-yak-benchmark ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 12, 2024 11:49am
yacijs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Jul 12, 2024 11:49am
coderabbitai[bot] commented 1 month ago

Walkthrough

The changes in the next-yak package improve the module’s internal structure and clarify the separation between public and internal APIs. Imports for CSS functionality are adjusted to reference internal paths. New mock implementations are added for testing, and the build configuration is updated for minification and sourcemap generation. These updates aim to enhance code clarity, maintainability, and testing capabilities.

Changes

File Path Change Summary
packages/.../loaders/__tests__/tsloader.test.ts Updated css import statements from "next-yak" to "next-yak/internal".
packages/.../loaders/babel-yak-plugin.ts Modified node.source.value conditionally from "next-yak" to "next-yak/internal".
packages/.../package.json Added a new entry for "./internal" with paths to ./dist/internal.js and ./dist/internal.cjs.
packages/.../runtime/index.ts Reorganized and updated exports for typings, mocks, and clarified their usage. Removed useTheme and YakThemeProvider exports.
packages/.../runtime/internal.ts Provided internal implementation for core APIs, ensuring separation between public API and internal logic.
packages/.../runtime/mocks/cssLiteral.ts, keyframes.ts, styled.ts Introduced new files exporting everything from their respective .js counterparts.
packages/.../tsup.config.ts Added configuration for internal modules with entry points, formats, minification, sourcemap generation, module resolution, and output settings.
packages/.../runtime/jsx-runtime.ts Updated StaticCSSProp import path to "./mocks/cssLiteral.js".

Poem

In the land of code, changes brew, Internal paths now clear, and new. With mocks and maps, we pave the way, For testing ease, night and day. Next-Yak’s strength, in structure lies, Hopping higher to the skies. 🐇✨

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
codspeed-hq[bot] commented 1 month ago

CodSpeed Performance Report

Merging #117 will degrade performances by 18.37%

Comparing feature/next-yak-internal (30f22b6) with main (5099856)

Summary

❌ 1 (👁 1) regressions ✅ 1 untouched benchmarks

Benchmarks breakdown

Benchmark main feature/next-yak-internal Change
👁 render KanjiLetterComponentYak 124.1 ms 152.1 ms -18.37%
jantimon commented 1 month ago

LGTM But just something that came to my mind: Maybe it makes sense to change the import in jsx-runtime.ts as well. Wdyt?

Yes you are right - the mocks will be the public facing typing and jsx-runtime.ts too.. therefore jsx-runtime must not export the internal types