Missing Peer Dependency

[hahanein]

Version 2.10.2 of @swaggerexpert/json-pointer is missing the declaration of the peer dependency @swagger-api/apidom-core.

This creates problems when using pnpm with hoist=false or any other non-flat node_modules setup.

Please declare the peer dependency.

[char0n]

Hi @hahanein,

It was omitted explicitly to avoid installing all the possible peer deps for various realms. The theory was that when specific realm is needed, it is expected to have a underlying dependency already installed. It is aligned with the usage instruction with every realm:

---

Having said that it doesn't really help you, as I'm assuming it's going to be an integrity issue with pnpm. So we have two options here - either define all peer/optional deps inside package.json or change the architecture of this repo to a monorepo and making the realms additional packages.

@hahanein do you have a workaround for now?

[hahanein]

Yes, you can work around this problem easily with pnpm. It is just an inconvenience.

[char0n]

I'll probably go for a monorepo setup, it doesn't really make sense to install many peer deps just for JSON Pointer evaluation.

[mikhuang]

@hahanein any chance you could note down the workaround for others running into this? Thank you

[hahanein]

@mikhuang There are various methods.

We used pnpmfile. Something along the lines of..

module.exports = {
  hooks: {
    readPackage(pkg) {
      if (pkg.name === '@swaggerexpert/json-pointer') {
        pkg.peerDependencies['@swagger-api/apidom-core'] = 'latest';
      }
      return pkg;
    }
  }
};

I think you can also override it in your package.json

[char0n]

I could also use following:

"peerDependencies": {...}, 
"peerDependenciesMeta": {
  "tree-sitter": {
    "optional": true
  }
}

Would that help in pnpm case?

[hahanein]

I looked for a while but I cannot recover the project so will not be able to test this.

If I do happen to come across it again I will check back here.

[char0n]

If there are no better ideas I must just go for a #65 (comment). It will fix the problem and only side effect is that it will install peer-deps, which should be just fine. I don't have capacity/time to invest into transforming this into monorepo.

[char0n]

The issue has been addressed in #186.