nuxt / nuxt/modules

Move `ModuleCompatibility` Type to `@nuxt/kit`

Open
#1,096 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
TypeScript
Stars
1.1k
Forks
354
Avg merge
10h 18m
Merged PRs (30d)
12

Description

Description

The lib/types.ts file contains a // TODO: Move to @nuxt/kit comment for the ModuleCompatibility type.
Moving this type to @nuxt/kit would improve modularity and make it easier to reuse across modules.

https://github.com/nuxt/modules/blob/5346488a2d061c6508cf0df2ad08fe9d9813a9ae/lib/types.ts#L3-L12

Proposed Solution
  1. Move ModuleCompatibility type definition to @nuxt/kit.
  2. Update any references in the codebase to import ModuleCompatibility from @nuxt/kit.
Additional Context

Guidance on the preferred location within @nuxt/kit for this type would be appreciated.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with lib/types.ts and locate every reference to ModuleCompatibility in the repository. Inspect @nuxt/kit's existing type exports to determine the appropriate location, then verify that the type is available there and all references import it from @nuxt/kit.

Written by the indexing model from the issue text.

Assessment

Tech stack
nuxt, typescript
Domain
tooling
Issue type
Refactor
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.