Nuxt•4w ago•

12 replies

Should `moduleDependencies` propagate auto-imports to the dependent module's dev environment

nuxt4🧰modules

Context:

I'm working in a pnpm monorepo with two local packages, both are Nuxt modules:

1.

@scope/core-module

@scope/core-module

(The "Core" Module): Exports composables like

useCoreComposable

useCoreComposable

via

addImportsDir

addImportsDir

.
2.

@scope/feature-module

@scope/feature-module

(The "Dependent" Module): A separate module that depends on the Core module.

Configuration:

In

@scope/feature-module

@scope/feature-module

, I define the dependency in module.ts:

export default defineNuxtModule<ModuleOptions>({
  // ...
  moduleDependencies: {
    '@scope/core-module': {},
  },
  setup(_options, _nuxt) {
    // ...
  }
});

export default defineNuxtModule<ModuleOptions>({
  // ...
  moduleDependencies: {
    '@scope/core-module': {},
  },
  setup(_options, _nuxt) {
    // ...
  }
});

I run

nuxi prepare

nuxi prepare

in the

feature-module

feature-module

package. The

tsconfig.json

tsconfig.json

for my admin code (where I'm trying to use the composables) extends

.nuxt/tsconfig.json

.nuxt/tsconfig.json

.

The Issue:

When writing code inside

@scope/feature-module

@scope/feature-module

, I cannot access

useCoreComposable

useCoreComposable

via auto-import. TypeScript throws "Cannot find name 'useCoreComposable'".

I expected that since I declared the dependency,

nuxi prepare

nuxi prepare

would generate the types including

@scope/core-module

@scope/core-module

's exports in

.nuxt/imports.d.ts

.nuxt/imports.d.ts

, but it seems they are missing or not being picked up by my local TS context.

My Solution (Workaround?):

I ended up converting

@scope/core-module

@scope/core-module

to explicitly export its runtime composables (via a

./runtime

./runtime

entry point) and importing them explicitly in the feature module:

import { useCoreComposable } from '@scope/core-module/runtime';

import { useCoreComposable } from '@scope/core-module/runtime';

The Question:

Is this explicit import pattern the correct/expected way to share composables between modules in a monorepo? Or should

moduleDependencies

moduleDependencies

be sufficient to enable auto-imports (and their types) within the development environment of the dependent module itself?

Nuxt•4w ago•

12 replies

Alan

Should `moduleDependencies` propagate auto-imports to the dependent module's dev environment

nuxt4🧰modules

Context:

I'm working in a pnpm monorepo with two local packages, both are Nuxt modules:

1.

@scope/core-module

@scope/core-module

(The "Core" Module): Exports composables like

useCoreComposable

useCoreComposable

via

addImportsDir

addImportsDir

.
2.

@scope/feature-module

@scope/feature-module

(The "Dependent" Module): A separate module that depends on the Core module.

Configuration:

In

@scope/feature-module

@scope/feature-module

, I define the dependency in module.ts:

export default defineNuxtModule<ModuleOptions>({
  // ...
  moduleDependencies: {
    '@scope/core-module': {},
  },
  setup(_options, _nuxt) {
    // ...
  }
});

export default defineNuxtModule<ModuleOptions>({
  // ...
  moduleDependencies: {
    '@scope/core-module': {},
  },
  setup(_options, _nuxt) {
    // ...
  }
});

I run

nuxi prepare

nuxi prepare

in the

feature-module

feature-module

package. The

tsconfig.json

tsconfig.json

for my admin code (where I'm trying to use the composables) extends

.nuxt/tsconfig.json

.nuxt/tsconfig.json

.

The Issue:

When writing code inside

@scope/feature-module

@scope/feature-module

, I cannot access

useCoreComposable

useCoreComposable

via auto-import. TypeScript throws "Cannot find name 'useCoreComposable'".

I expected that since I declared the dependency,

nuxi prepare

nuxi prepare

would generate the types including

@scope/core-module

@scope/core-module

's exports in

.nuxt/imports.d.ts

.nuxt/imports.d.ts

, but it seems they are missing or not being picked up by my local TS context.

My Solution (Workaround?):

I ended up converting

@scope/core-module

@scope/core-module

to explicitly export its runtime composables (via a

./runtime

./runtime

entry point) and importing them explicitly in the feature module:

import { useCoreComposable } from '@scope/core-module/runtime';

import { useCoreComposable } from '@scope/core-module/runtime';

The Question:

Is this explicit import pattern the correct/expected way to share composables between modules in a monorepo? Or should

moduleDependencies

moduleDependencies

be sufficient to enable auto-imports (and their types) within the development environment of the dependent module itself?

Should `moduleDependencies` propagate auto-imports to the dependent module's dev environment

Should `moduleDependencies` propagate auto-imports to the dependent module's dev environment

Similar Threads

Similar Threads

Similar Threads