Skip to main content

Adding new packages

From version 3, the source code of sigma.js is structured as a monorepo. We use Preconstruct to build the packages for development and production, and Lerna to manage versions lifecycle. Finally, on NPM, sigma is split into the core sigma package, and various @sigma/xxx feature packages.

This approach allows to maintain multiple features, that are too specialized to be included in the main repository, without the cost of creating and managing multiple Git/GitHub repositories.

As of now, the features are prefixed by their general purpose:

  • @sigma/node-xxx and @sigma/edge-xxx refer to node and edge renderer
  • @sigma/layer-xxx refers to additional layers that can be added to sigma instances
  • @sigma/export-xxx refers to packages that allow exporting somehow a sigma instance
  • @sigma/utils stores various small specific helpers

Creating a new package​

To create a new package, you first need to get a clean local instance of sigma, with up-to-date versions of Git, Node.js and NPM. Then, go to the root of the repository, and run npm run createPackage. You will be prompted for the new package name (excluding the @sigma/ namespace), after which a fresh, empty package will be created and referenced wherever necessary.

Adding stories​

All stories are in the packages/storybook package. The Storybook is primarily a playground for testing features while developing, but it ultimately becomes the public showcase and documentation of new packages. It helps new users understand what each package can do and how.

Each package can provide stories in the packages/storybook/stories/3-additional-packages folder. The easiest way to get started is to review the stories from some similar existing package.

Adding tests​

Since most additional packages only handle rendering, unit-testing them is too challenging. In the future, we plan to include all Storybook stories in our end-to-end tests to detect rendering regressions.

However, some packages might export unit-testable helpers (such as @sigma/utils). In that case, you can add a package-name folder in packages/test/unit, with tests suites in it.