Absolute imports/aliases for local plugins #28674

AustinLeeGordon · 2020-12-17T17:50:37Z

AustinLeeGordon
Dec 17, 2020

Looking for a way to utilize absolute imports/aliases for local plugins like I can with components, pages, etc. May be some documentation out there, but I haven't been able to find anything. Tried using the custom config in gatsby-node.js and also tried babel-plugin-module-resolver.

Use case: I share some utility functions between files in src/ and plugins/. I would like to keep them in a centralized utils/ directory and import them easily with the same syntax.

vladar · 2020-12-18T17:38:58Z

vladar
Dec 18, 2020

Have you tried using webpack aliases? Maybe using a plugin like this: https://www.gatsbyjs.com/plugins/gatsby-plugin-alias-imports/

3 replies

AustinLeeGordon Dec 18, 2020
Author

@vladar Yeah, I tried that as well. I'll see if I can reproduce the issue. May have been an oversight while refactoring haha.

AustinLeeGordon Dec 18, 2020
Author

@vladar Here's a reproduction: https://github.com/AustinLeeGordon/gatsby-local-plugin-aliases-repro. Clone and run gatsby develop to see the error (Cannot find module 'utils'). I added a utils/ directory with an upper function that I use in both my src/ and my plugins/. If you change the import line in plugins/test/gatsby-node.js from const { upper } = require("utils") to const { upper } = require("../../utils"), it works fine.

Full error stack

> [email protected] develop C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro
> gatsby develop

success open and validate gatsby-configs - 0.040s
error Error in "C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\plugins\test\gatsby-node.js": Cannot find module 'utils'
Require stack:
- C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\plugins\test\gatsby-node.js
- C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\node_modules\gatsby\dist\bootstrap\resolve-module-exports.js
- C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\node_modules\gatsby\dist\bootstrap\load-plugins\validate.js
- C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\node_modules\gatsby\dist\bootstrap\load-plugins\load.js
- C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\node_modules\gatsby\dist\bootstrap\load-plugins\index.js
- C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\node_modules\gatsby\dist\services\initialize.js
- C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\node_modules\gatsby\dist\services\index.js
- C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\node_modules\gatsby\dist\state-machines\develop\services.js
- C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\node_modules\gatsby\dist\state-machines\develop\index.js
- C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\node_modules\gatsby\dist\commands\develop-process.js
- C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\.cache\tmp-27056-jNQoK93lTynu


  Error: Cannot find module 'utils'
  Require stack:
  - C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\plugins\test\gatsby-node.js
  - C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\node_modules\gatsby\dist\bootstrap\  resolve-module-exports.js
  - C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\node_modules\gatsby\dist\bootstrap\  load-plugins\validate.js
  - C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\node_modules\gatsby\dist\bootstrap\  load-plugins\load.js
  - C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\node_modules\gatsby\dist\bootstrap\  load-plugins\index.js
  - C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\node_modules\gatsby\dist\services\i  nitialize.js
  - C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\node_modules\gatsby\dist\services\i  ndex.js
  - C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\node_modules\gatsby\dist\state-mach  ines\develop\services.js
  - C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\node_modules\gatsby\dist\state-mach  ines\develop\index.js
  - C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\node_modules\gatsby\dist\commands\d  evelop-process.js
  - C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\.cache\tmp-27056-jNQoK93lTynu

  - loader.js:965 Function.Module._resolveFilename
    internal/modules/cjs/loader.js:965:15

  - loader.js:841 Function.Module._load
    internal/modules/cjs/loader.js:841:27

  - loader.js:1025 Module.require
    internal/modules/cjs/loader.js:1025:19

  - v8-compile-cache.js:159 require
    [gatsby-local-plugin-aliases-repro]/[v8-compile-cache]/v8-compile-cache.js:159:20

  - gatsby-node.js:1 Object.<anonymous>
    C:/Users/agordon/projects/gatsby-local-plugin-aliases-repro/plugins/test/gatsby-node.js:1:81

  - v8-compile-cache.js:178 Module._compile
    [gatsby-local-plugin-aliases-repro]/[v8-compile-cache]/v8-compile-cache.js:178:30

  - loader.js:1157 Object.Module._extensions..js
    internal/modules/cjs/loader.js:1157:10

  - loader.js:985 Module.load
    internal/modules/cjs/loader.js:985:32

  - loader.js:878 Function.Module._load
    internal/modules/cjs/loader.js:878:14

  - loader.js:1025 Module.require
    internal/modules/cjs/loader.js:1025:19

  - v8-compile-cache.js:159 require
    [gatsby-local-plugin-aliases-repro]/[v8-compile-cache]/v8-compile-cache.js:159:20

  - resolve-module-exports.ts:191 resolveModuleExports
    [gatsby-local-plugin-aliases-repro]/[gatsby]/src/bootstrap/resolve-module-exports.ts:191:26

  - validate.ts:348 forEach
    [gatsby-local-plugin-aliases-repro]/[gatsby]/src/bootstrap/load-plugins/validate.ts:348:31

  - Array.forEach

  - validate.ts:340 collatePluginAPIs
    [gatsby-local-plugin-aliases-repro]/[gatsby]/src/bootstrap/load-plugins/validate.ts:340:20

  - index.ts:107 loadPlugins
    [gatsby-local-plugin-aliases-repro]/[gatsby]/src/bootstrap/load-plugins/index.ts:107:13


not finished load plugins - 1.903s
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! [email protected] develop: `gatsby develop`
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the [email protected] develop script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR!     C:\Users\agordon\AppData\Roaming\npm-cache\_logs\2020-12-18T20_14_03_727Z-debug.log

AustinLeeGordon Dec 18, 2020
Author

Created another using babel-plugin-module-resolver instead of webpack aliases. Check out branch babel in the reproduction repo and run gatsby develop. Same error (Cannot find module 'utils'). Can also be fixed to a relative require to fix.

Full error stack

> [email protected] develop C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro
> gatsby develop

success open and validate gatsby-configs - 0.037s
error Error in "C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\plugins\test\gatsby-node.js": Cannot find module 'utils'
Require stack:
- C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\plugins\test\gatsby-node.js
- C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\node_modules\gatsby\dist\bootstrap\resolve-module-exports.js
- C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\node_modules\gatsby\dist\bootstrap\load-plugins\validate.js
- C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\node_modules\gatsby\dist\bootstrap\load-plugins\load.js
- C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\node_modules\gatsby\dist\bootstrap\load-plugins\index.js
- C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\node_modules\gatsby\dist\services\initialize.js
- C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\node_modules\gatsby\dist\services\index.js
- C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\node_modules\gatsby\dist\state-machines\develop\services.js
- C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\node_modules\gatsby\dist\state-machines\develop\index.js
- C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\node_modules\gatsby\dist\commands\develop-process.js
- C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\.cache\tmp-28504-y22DQfm0onYG


  Error: Cannot find module 'utils'
  Require stack:
  - C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\plugins\test\gatsby-node.js
  - C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\node_modules\gatsby\dist\bootstrap\  resolve-module-exports.js
  - C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\node_modules\gatsby\dist\bootstrap\  load-plugins\validate.js
  - C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\node_modules\gatsby\dist\bootstrap\  load-plugins\load.js
  - C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\node_modules\gatsby\dist\bootstrap\  load-plugins\index.js
  - C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\node_modules\gatsby\dist\services\i  nitialize.js
  - C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\node_modules\gatsby\dist\services\i  ndex.js
  - C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\node_modules\gatsby\dist\state-mach  ines\develop\services.js
  - C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\node_modules\gatsby\dist\state-mach  ines\develop\index.js
  - C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\node_modules\gatsby\dist\commands\d  evelop-process.js
  - C:\Users\agordon\projects\gatsby-local-plugin-aliases-repro\.cache\tmp-28504-y22DQfm0onYG

  - loader.js:965 Function.Module._resolveFilename
    internal/modules/cjs/loader.js:965:15

  - loader.js:841 Function.Module._load
    internal/modules/cjs/loader.js:841:27

  - loader.js:1025 Module.require
    internal/modules/cjs/loader.js:1025:19

  - v8-compile-cache.js:159 require
    [gatsby-local-plugin-aliases-repro]/[v8-compile-cache]/v8-compile-cache.js:159:20

  - gatsby-node.js:1 Object.<anonymous>
    C:/Users/agordon/projects/gatsby-local-plugin-aliases-repro/plugins/test/gatsby-node.js:1:81

  - v8-compile-cache.js:178 Module._compile
    [gatsby-local-plugin-aliases-repro]/[v8-compile-cache]/v8-compile-cache.js:178:30

  - loader.js:1157 Object.Module._extensions..js
    internal/modules/cjs/loader.js:1157:10

  - loader.js:985 Module.load
    internal/modules/cjs/loader.js:985:32

  - loader.js:878 Function.Module._load
    internal/modules/cjs/loader.js:878:14

  - loader.js:1025 Module.require
    internal/modules/cjs/loader.js:1025:19

  - v8-compile-cache.js:159 require
    [gatsby-local-plugin-aliases-repro]/[v8-compile-cache]/v8-compile-cache.js:159:20

  - resolve-module-exports.ts:191 resolveModuleExports
    [gatsby-local-plugin-aliases-repro]/[gatsby]/src/bootstrap/resolve-module-exports.ts:191:26

  - validate.ts:348 forEach
    [gatsby-local-plugin-aliases-repro]/[gatsby]/src/bootstrap/load-plugins/validate.ts:348:31

  - Array.forEach

  - validate.ts:340 collatePluginAPIs
    [gatsby-local-plugin-aliases-repro]/[gatsby]/src/bootstrap/load-plugins/validate.ts:340:20

  - index.ts:107 loadPlugins
    [gatsby-local-plugin-aliases-repro]/[gatsby]/src/bootstrap/load-plugins/index.ts:107:13


not finished load plugins - 1.526s
npm ERR! code ELIFECYCLE
npm ERR! errno 1
npm ERR! [email protected] develop: `gatsby develop`
npm ERR! Exit status 1
npm ERR!
npm ERR! Failed at the [email protected] develop script.
npm ERR! This is probably not a problem with npm. There is likely additional logging output above.

npm ERR! A complete log of this run can be found in:
npm ERR!     C:\Users\agordon\AppData\Roaming\npm-cache\_logs\2020-12-18T20_35_40_464Z-debug.log

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Absolute imports/aliases for local plugins #28674

Uh oh!

{{title}}

Uh oh!

Replies: 1 comment 3 replies

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{editor}}'s edit

{{editor}}'s edit

Uh oh!

Select a reply

Uh oh!

Absolute imports/aliases for local plugins #28674

Uh oh!

AustinLeeGordon Dec 17, 2020

Replies: 1 comment · 3 replies

Uh oh!

vladar Dec 18, 2020

Uh oh!

AustinLeeGordon Dec 18, 2020 Author

Uh oh!

AustinLeeGordon Dec 18, 2020 Author

Uh oh!

Uh oh!

AustinLeeGordon Dec 18, 2020 Author

AustinLeeGordon
Dec 17, 2020

Replies: 1 comment 3 replies

vladar
Dec 18, 2020

AustinLeeGordon Dec 18, 2020
Author

AustinLeeGordon Dec 18, 2020
Author

AustinLeeGordon Dec 18, 2020
Author