8000 wv import paths by eluce2 · Pull Request #47 · proofgeist/proofkit · GitHub
[go: up one dir, main page]
More Web Proxy on the site http://driver.im/
Skip to content

wv import paths #47

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Jun 26, 2025
Merged

wv import paths #47

merged 1 commit into from
Jun 26, 2025

Conversation

eluce2
Copy link
Collaborator
@eluce2 eluce2 commented Jun 26, 2025 •
edited by coderabbitai bot
Loading

Summary by CodeRabbit

  • Bug Fixes

    • Fixed import paths within the package to improve reliability.

  • Chores

    • Added a strict linting step to the build process for enhanced code quality.
    • Updated build configuration to support multiple entry points and external dependencies.

@vercel Vercel
Copy link
vercel bot commented Jun 26, 2025 •
edited
Loading

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

Name Status Preview Updated (UTC)
proofkit-docs ✅ Ready (Inspect) Visit Preview Jun 26, 2025 3:08am

@eluce2 eluce2 marked this pull request as ready for review June 26, 2025 03:02
@eluce2 Graphite App
Copy link
Collaborator Author
eluce2 commented Jun 26, 2025

This stack of pull requests is managed by Graphite. Learn more about stacking.

@coderabbitai coderabbitai
Copy link
coderabbitai bot commented Jun 26, 2025

Walkthrough

The changes update the @proofkit/webviewer package by fixing import paths to use a namespace import from @proofkit/fmdapi, updating type annotations accordingly, and expanding the Vite build configuration to include multiple entry points and mark @proofkit/fmdapi as external. A new development dependency, publint, is added for strict linting during builds.

Changes

File(s) Change Summary
.changeset/violet-tools-divide.md Added a changeset describing a patch update to fix import paths in @proofkit/webviewer.
packages/webviewer/package.json Added publint as a dev dependency; updated build script to run publint --strict after build steps.
packages/webviewer/src/adapter.ts Replaced direct type imports from @proofkit/fmdapi/dist/esm/client-types.js with namespace import from @proofkit/fmdapi; updated all type annotations and method signatures to use clientTypes.
packages/webviewer/vite.config.ts Modified Vite config to use multiple entry points (main.ts, adapter.ts) and mark @proofkit/fmdapi as external.

Sequence Diagram(s)

sequenceDiagram
    participant BuildScript
    participant TypeScript
    participant Vite
    participant Publint

    BuildScript->>TypeScript: tsc (compile sources)
    BuildScript->>Vite: vite build (bundle entry points)
    BuildScript->>Publint: publint --strict (lint package)
Loading 
sequenceDiagram
    participant WebViewerAdapter
    participant clientTypes (@proofkit/fmdapi)

    WebViewerAdapter->>clientTypes: Import response types as clientTypes.*
    WebViewerAdapter->>clientTypes: Use clientTypes.* in method signatures and type annotations
Loading

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

packages/webviewer/vite.config.ts

Oops! Something went wrong! :(

ESLint: 9.27.0

ESLint couldn't find an eslint.config.(js|mjs|cjs) file.

From ESLint v9.0.0, the default configuration file is now eslint.config.js.
If you are using a .eslintrc.* file, please follow the migration guide
to update your configuration file to the new format:

https://eslint.org/docs/latest/use/configure/migration-guide

If you still have problems after following the migration guide, please stop by
https://eslint.org/chat/help to chat with the team.

packages/webviewer/src/adapter.ts

Oops! Something went wrong! :(

ESLint: 9.27.0

ESLint couldn't find an eslint.config.(js|mjs|cjs) file.

From ESLint v9.0.0, the default configuration file is now eslint.config.js.
If you are using a .eslintrc.* file, please follow the migration guide
to update your configuration file to the new format:

https://eslint.org/docs/latest/use/configure/migration-guide

If you still have problems after following the migration guide, please stop by
https://eslint.org/chat/help to chat with the team.

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between e0b490a and eb7594a.

⛔ Files ignored due to path filters (1)
  • pnpm-lock.yaml is excluded by !**/pnpm-lock.yaml
📒 Files selected for processing (4)
  • .changeset/violet-tools-divide.md (1 hunks)
  • packages/webviewer/package.json (2 hunks)
  • packages/webviewer/src/adapter.ts (3 hunks)
  • packages/webviewer/vite.config.ts (1 hunks)
🧰 Additional context used
🧬 Code Graph Analysis (1)
packages/webviewer/src/adapter.ts (1)
packages/fmdapi/src/client-types.ts (6)
  • RawFMResponse (284-287)
  • GetResponse (146-152)
  • CreateResponse (82-85)
  • UpdateResponse (92-94)
  • DeleteResponse (98-98)
  • LayoutMetadataResponse (174-178)
🔇 Additional comments (6)
.changeset/violet-tools-divide.md (1)

1-6: LGTM: Standard changeset documentation.

The changeset correctly documents the patch update for import path fixes, following proper changeset conventions.

packages/webviewer/package.json (2)

44-44: Good addition: publint for package validation.

Adding publint as a dev dependency helps ensure the package is properly configured for publishing and distribution.

53-53: Excellent: Integrated strict linting into build process.

The addition of publint --strict to the build script ensures package validation runs automatically, helping catch publishing issues early.

packages/webviewer/vite.config.ts (1)

10-14: Well-configured: Multi-entry build with external dependencies.

The configuration changes properly support:

  • Multiple entry points for main and adapter modules
  • External dependency marking for @proofkit/fmdapi to prevent bundling
  • Alignment with package.json exports configuration

This ensures proper module separation and dependency management.

packages/webviewer/src/adapter.ts (2)

1-1: Excellent refactoring: Namespace import improves maintainability.

The switch from individual imports to namespace import from @proofkit/fmdapi is a significant improvement:

  • Removes dependency on internal package structure
  • Provides cleaner, more maintainable import statements
  • Aligns with modern TypeScript best practices

51-51: Consistent type annotation updates throughout.

All type references have been correctly updated to use the clientTypes namespace:

  • RawFMResponse, GetResponse, CreateResponse, UpdateResponse, DeleteResponse, and LayoutMetadataResponse are all properly namespaced
  • Type annotations are consistent across all method signatures and return statements
  • Changes align with the type definitions in the relevant code snippets

The refactoring maintains full type safety while improving code organization.

Also applies to: 70-70, 76-76, 79-79, 85-85, 88-88, 94-94, 99-99, 106-106, 111-111, 118-118, 123-123, 130-130, 135-135, 140-140

✨ Finishing Touches
  • 📝 Generate Docstrings
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • 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 explain this code block.
    • @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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @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.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

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 using 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 generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this 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.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

@eluce2 eluce2 merged commit 181e675 into main Jun 26, 2025
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@eluce2
0