Giter Club home page Giter Club logo

Comments (2)

renatobenks avatar renatobenks commented on May 24, 2024 1

Hey, thank you for opening this issue, we appreciate it! Just a quick introduction about how docz actually works underneath, we use gatsby behind the scenes to run and build your documentation output, but before doing it, we oversearch for your mdx files into your source folder (default /src) to parse them into HTML through gatsby, but unfortunately, we still don't have any good workaround when any of these files are not found, which it currently results in a misconception error. So, it probably goes away once you start adding mdx files to your /src folder. Try to do that and let us know if you're still struggling with gatsby building problems. I'll be closing it for now as we already have a specific issue to fix that!

from docz.

waynevanson avatar waynevanson commented on May 24, 2024

Thanks for sharing how it works!

Unfortunately the problem persists even when there is an .mdx file present in /src.

$ pnpm exec docz dev

Building app
node:events:368
      throw er; // Unhandled 'error' event
      ^

Error: spawn /home/wayne/code/issue-docz-pnpm-compat/node_modules/.bin/gatsby ENOENT
    at Process.ChildProcess._handle.onexit (node:internal/child_process:282:19)
    at onErrorNT (node:internal/child_process:477:16)
    at processTicksAndRejections (node:internal/process/task_queues:83:21)
Emitted 'error' event on ChildProcess instance at:
    at Process.ChildProcess._handle.onexit (node:internal/child_process:288:12)
    at onErrorNT (node:internal/child_process:477:16)
    at processTicksAndRejections (node:internal/process/task_queues:83:21) {
  errno: -2,
  code: 'ENOENT',
  syscall: 'spawn /home/wayne/code/issue-docz-pnpm-compat/node_modules/.bin/gatsby',
  path: '/home/wayne/code/issue-docz-pnpm-compat/node_modules/.bin/gatsby',
  spawnargs: [ 'develop', '--host', 'localhost', '--port', '3000' ]
}

I've tried to figure it out and so far it looks like it's due to non-flat node_modules folder.
Removing node_modules and running npm i allows gatsby to run.

https://pnpm.io/motivation#creating-a-non-flat-node_modules-directory
Adding node-linker=hoisted to .npmrc helps relieve that problem for pnpm and mimics the behaviour expected by npm.

Looking at Gastby docs, it seem it doesn't support pnpm by default: https://www.gatsbyjs.com/docs/reference/gatsby-cli/#how-to-change-your-default-package-manager-for-your-next-project
This can be addressed with a webpack plugin: https://www.gatsbyjs.com/plugins/gatsby-plugin-pnpm/

Off topic of pnpm, I think an idea is to install dependencies into /.docz to isolate the project, and symlink /src to /.docz/src for resolution rather than copying it.

from docz.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.