semrel-extra/topo

Helpers to assist monorepo dependencies traversals

@semrel-extra/topo

Helpers to assist monorepo dependencies traversals

Install

yarn add @semrel-extra/topo

Usage

import { topo } from '@semrel-extra/topo'

const graph = topo({
  workspaces: ['packages/*'],
  cwd: '/path/to/project/root'
})

{
  queue: ['pkg-a', 'pkg-b', 'pkg-z', 'pkg-y', 'pkg-x'],
  nodes: ['pkg-a', 'pkg-b', 'pkg-x', 'pkg-y', 'pkg-z'],
  edges: [
    ['pkg-a', 'pkg-b'],
    ['pkg-z', 'pkg-y'],
    ['pkg-y', 'pkg-x'],
  ],
  // packages entries map
  packages: {
    'pkg-a': {
      manifest: {
        name: 'pkg-a',
        dependencies: {}
      },
      manifestPath: '/path/to/project/root/packages/a/package.json',
      path: 'packages/a', // legacy
      relPath: 'packages/a',
      absPath: '/path/to/project/root/packages/a'
    },
    'pkg-b': {...},
    ...
  }
}

pkgFilter() / filter()

Filter option is a function: gets IPackageEntry as argument, returns boolean

const graph = topo({
  workspaces: ['packages/*'],
  cwd: '/path/to/project/root',
  filter: ({manifest}) => !manifest.private // to omit private packages from graph
})

depFilter()

Applies filter to any kind of pkg dependencies to omit them from the graph.

const gpaph = topo({
  workspaces: ['packages/*'],
  cwd: '/path/to/project/root',
  depFilter: ({version}) => version.startsWith('workspace:') // include only workspace deps
})

workspacesExtra

Injects extra pattern to the resolved workspaces value from package.json / pnpm-workspace.yaml

const gpaph = topo({
  workspacesExtra: ['!packages/foo'],
  cwd: '/path/to/project/root'
})

traverseDeps()

Iterates up to the pkg deps graph.

import {topo, traverseDeps} from '@semrel-extra/topo'

const {packages} = topo({
  workspaces: ['packages/*'],
  cwd: '/path/to/project/root'
})
const pkg = packages['pkg-a']
const cb = async ({name, pkg}: IDepEntry) => {
  await traverseDeps({pkg, packages, cb})
}

await traverseDeps({packages, pkg, cb})

traverseQueue()

Iterates over the queue of packages in the order of their dependencies.

import {topo, traverseQueue} from '@semrel-extra/topo'

const {queue, prev} = await topo({
  workspaces: ['packages/*'],
  cwd: '/path/to/project/root'
})
const cb = async (name: string) => {
  // some async action
}
await traverseQueue({ queue, prev, cb })

iterateDeps()

Walks through the package dependencies and applies the cb() for each.

const results: any[] = []
const manifest = {
  name: 'foo',
  version: '0.0.0',
  dependencies: {
    bar: '1.0.0'
  },
  devDependencies: {
    baz: '2.0.0'
  }
}

iterateDeps(manifest, ({ name, version, scope, deps }) => {
  results.push({ name, version, scope, deps })
})

License

MIT

topo's Issues

Provide support for mvn projects

Issue type

• bug report
• idea
• question
• other

feat: provide `filter` option to skip packages by condition

Issue type

• feat request

Expected behavior

const ctx = topo({
   workspaces: ['packages/*'],
   filter: ({manifest: {private}, path}) => !private
})

• I've read the docs. This case is not mentioned
• Similar issue does not exist

Dependency Dashboard

This issue lists Renovate updates and detected dependencies. Read the Dependency Dashboard docs to learn more.

Pending Approval

These branches will be created by Renovate only once you click their checkbox below.

• chore(deps): update actions/checkout action to v4
• chore(deps): update actions/setup-node action to v4
• chore(deps): update dependency c8 to v10
• chore(deps): update paambaati/codeclimate-action action to v8
• 🔐 Create all pending approval PRs at once 🔐

Detected dependencies

github-actions

.github/workflows/ci.yaml

• actions/checkout v3
• actions/setup-node v3
• actions/checkout v3
• actions/setup-node v3
• actions/checkout v3
• actions/setup-node v3
• paambaati/codeclimate-action v3.2.0
• ubuntu 22.04
• ubuntu 22.04

npm

package.json

• fast-glob ^3.3.2
• js-yaml ^4.1.0
• toposource ^1.2.0
• @types/js-yaml ^4.0.9
• @types/micromatch ^4.0.6
• @types/node ^20.10.5
• c8 ^8.0.1
• esbuild ^0.21.0
• esbuild-node-externals ^1.11.0
• loadr ^0.1.1
• micromatch ^4.0.5
• prettier ^3.1.1
• tsm ^2.3.0
• typescript ^5.3.3
• uvu ^0.5.6
• concurrently ^8.2.2

---

• Check this box to trigger a request for Renovate to run again on this repository

Type declarations are not exposed

Issue type

• bug report

Expected behavior

Typings exposed

Actual behavior

Typings are not exposed, which leads to no-unsafe-assignment eslint errors

Steps to reproduce

Check package.json, it does not contain types, typings, but index.d.ts exists in dist/tarball.

Specifications

• version: 1.4.2