The `groupBy` feature

[AlexandrHoroshih]

Summary

This PR adds the first part for "grouped graph" feature, as discussed in #125 :

• Optional groupBy configuration is added - it is a function of (path: string) => string | undefined type
• If groupBy is provided, then groupedGraph will be emitted on getStructure call

Example

const instance = await skott({
 groupBy: (path) => {
          if (path.includes("src/core")) return "core";
          if (path.includes("src/features/feature-a")) return "feature-a";

          return undefined;
      }
  }
});

const {groupedGraph} = instance.getStructure();

groupedGraph.core // { id: "core", adjacentTo, body: { size, files, ... } }
groupedGraph["feature-a"] // { id: "feature-a", adjacentTo, body: { size, files, ... } }

Implementation

As was discussed in the issue, there is a single groupBy function, which assigns module to a group based on its node.id (which is the path of the module location).

Under the hood it is the separate graph, which is built in the moment of getStructure call, using the original graph of project structure as a source of truth.

Testing

Integration tests in the integration/api.spec.ts

Impacted documentation

The changeset is generated and the JSDoc comment is added to the groupBy field, also documentation is added into skott/README.md

• [x] Changesets were generated using pnpm changeset at the root of the workspace, affected packages are being bumped (either patch/minor) and a clear description for each of the affected packages was added.

[antoine-coulon]

@all-contributors please add @AlexandrHoroshih for code

[allcontributors[bot]]

@antoine-coulon

I've put up a pull request to add @AlexandrHoroshih! :tada: