Skip to content
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.

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

feat(core): better module not found handling #7079

Merged
merged 3 commits into from
Mar 13, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 26 additions & 1 deletion packages/core/src/module.js
Original file line number Diff line number Diff line change
Expand Up @@ -143,7 +143,32 @@ export default class ModuleContainer {

// Resolve handler
if (!handler) {
handler = this.nuxt.resolver.requireModule(src, { useESM: true })
try {
handler = this.nuxt.resolver.requireModule(src, { useESM: true })
} catch (error) {
if (error.code !== 'MODULE_NOT_FOUND') {
throw error
}

let message = 'Module `{name}` not found.'

if (this.options.buildModules.includes(src)) {
message += ' Please ensure `{name}` is in `devDependencies` and installed. HINT: During build step, for npm/yarn, `NODE_ENV=production` or `--production` should NOT be used.'.replace('{name}', src)
} else if (this.options.modules.includes(src)) {
message += ' Please ensure `{name}` is in `dependencies` and installed.'
}

message = message.replace(/{name}/g, src)

if (this.options._cli) {
throw new Error(message)
} else {
// TODO: Remove in next major version
message += ' Silently ignoring module as programatic usage detected.'
consola.warn(message)
return
}
}
}

// Validate handler
Expand Down
21 changes: 21 additions & 0 deletions packages/core/test/module.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -454,4 +454,25 @@ describe('core: module', () => {
expect(handler).toBeCalledTimes(1)
expect(module.requiredModules.moduleTest).toBeDefined()
})

test('should prevent adding not installed buildModules', async () => {
const module = new ModuleContainer({
resolver: { requireModule },
options: {
...defaultOptions,
buildModules: ['test-build-module']
}
})

requireModule.mockImplementationOnce(() => {
const moduleNotFound = new Error()
moduleNotFound.code = 'MODULE_NOT_FOUND'
throw moduleNotFound
})

const result = await module.addModule('test-build-module', true)

expect(result).toBeUndefined()
expect(consola.warn).toBeCalledWith('Module `test-build-module` not found. Please ensure `test-build-module` is in `devDependencies` and installed. HINT: During build step, for npm/yarn, `NODE_ENV=production` or `--production` should NOT be used. Silently ignoring module as programatic usage detected.')
})
})