js-waku icon indicating copy to clipboard operation
js-waku copied to clipboard

take steps to avoid/debug breaking circular deps

Open danisharora099 opened this issue 1 year ago • 1 comments

This is a feature request

Problem

There have been times where circular dependencies have creeped in to our codebase - one of these times was recently with https://github.com/waku-org/js-waku/pull/1520/commits/c421732c09d689070626ec40f2c0711392cb20e8 where the tests were failing because of a circular dependency introduced earlier which was not caught until now.

Proposed Solutions

Introduce a check for circular deps.

I used madge: https://www.npmjs.com/package/madge to debug

danisharora099 avatar Sep 02 '23 10:09 danisharora099

TODO:

  • [ ] perhaps add a README to include steps we can take when the build fails for breaking circular deps
  • [ ] research codeclimate to see if it can help

danisharora099 avatar Sep 07 '23 11:09 danisharora099