Skip to content

Fix TypeScript augmentation file inclusion in the Nuxt npm package#481

Merged
brionmario merged 3 commits intoasgardeo:mainfrom
kavindadimuthu:fix-nuxt-release
Apr 28, 2026
Merged

Fix TypeScript augmentation file inclusion in the Nuxt npm package#481
brionmario merged 3 commits intoasgardeo:mainfrom
kavindadimuthu:fix-nuxt-release

Conversation

@kavindadimuthu
Copy link
Copy Markdown
Contributor

@kavindadimuthu kavindadimuthu commented Apr 28, 2026

Purpose

This pull request makes a minor update to the Nuxt package by excluding the augments.d.ts TypeScript augmentation file from being published and processed by consuming applications. This helps prevent unnecessary type processing and potential conflicts for users of the package.

  • Packaging improvements:
    • Updated .npmignore to exclude dist/runtime/types/augments.d.ts and other development/source files from the published Nuxt npm package.
    • Added a changeset note documenting the exclusion of augments.d.ts from the published package.

Related Issues

  • N/A

Related PRs

  • N/A

Checklist

  • Followed the CONTRIBUTING guidelines.
  • Manual test round performed and verified.
  • Documentation provided. (Add links if there are any)
  • Unit tests provided. (Add links if there are any)

Security checks

Summary by CodeRabbit

Chores

  • Updated package configuration for the @asgardeo/nuxt package, excluding development files and type augmentation files from npm distribution to streamline the published package.

… errors

The augments.d.ts file is a TypeScript module augmentation file that should not be processed by consuming apps' build tools. Adding .npmignore prevents it from being included in the published npm package while keeping it available for type checking.

This resolves the RollupError when using @asgardeo/nuxt in consuming Nuxt applications.
@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 28, 2026

Warning

Rate limit exceeded

@kavindadimuthu has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 45 minutes and 53 seconds before requesting another review.

To keep reviews running without waiting, you can enable usage-based add-on for your organization. This allows additional reviews beyond the hourly cap. Account admins can enable it under billing.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

🚦 How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.

Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.

Please see our FAQ for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 11c2a9a1-0300-4a81-b3f3-483cc2acdde3

📥 Commits

Reviewing files that changed from the base of the PR and between 0d11c55 and a57edf6.

📒 Files selected for processing (1)
  • packages/nuxt/.npmignore
📝 Walkthrough

Walkthrough

This PR adds release metadata and npm packaging configuration for the @asgardeo/nuxt package. A changeset file declares a patch version bump, while a new .npmignore file excludes TypeScript augments declarations, development files, and source code from the npm published package.

Changes

Cohort / File(s) Summary
Release and Packaging Configuration
.changeset/five-games-strive.md, packages/nuxt/.npmignore
Introduces patch version bump metadata for @asgardeo/nuxt and adds npm ignore rules to exclude dist/runtime/types/augments.d.ts, source code, and development configuration from npm distribution.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

Suggested reviewers

  • DonOmalVindula

Poem

📦 A rabbit hops through npm's gleaming store,
With augments hidden and configs galore,
Changesets whisper of patches to come,
No source shall ship—only builds, every one! 🐰✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Title check ✅ Passed The title clearly and specifically identifies the main change: excluding the TypeScript augmentation file from the Nuxt npm package.
Description check ✅ Passed The description covers all template sections with appropriate detail: purpose explains the packaging change, checklists are included (though unchecked), and security checks are present.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@asgardeo-github-bot
Copy link
Copy Markdown

🦋 Changeset detected

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

Not sure what this means? Click here to learn what changesets are.

@brionmario brionmario merged commit 6dde605 into asgardeo:main Apr 28, 2026
7 of 9 checks passed
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.

3 participants