Skip to content
Sand Software Solutions

Keeping our open source and npm packages maintained

Published · 2 min read

Alongside ShiftOps we maintain a growing set of open source tools and small npm packages. Publishing something is the easy part. This post is about the less exciting part: keeping it good after the first release.

What we maintain

  • Foundry is a command-line tool that creates new projects from reusable templates. It is a single binary for Linux, macOS and Windows, with installers for Windows and a Debian package.
  • Assay seals a folder once and later tells you exactly what changed: modified, added, removed or renamed files. One static binary, no daemon, no dependencies.
  • @sandsoftwaresolutions/* on npm is a collection of small packages that each do one job: retrying requests, pagination, rate limiting, signed links, safe CSV export, Dutch validation and more. They are meant to be read in an afternoon, not trusted blindly.

How we try to keep them dependable

Small and without dependencies. Every dependency is something that can break or be compromised later. Our packages avoid them wherever the platform already offers what is needed.

Tests and a README with each package. A package without tests is a guess. Each one has its own tests, type definitions and CI workflow, and a README that says what it does and what it deliberately does not do.

Real changelogs and semantic versions. We follow Keep a Changelog and Semantic Versioning, so you can see what changed before you update, and a patch release is only a patch.

Careful defaults. Several packages exist because the obvious solution has a classic mistake in it: a JWT library that accepts alg: none, a CSV export that allows formula injection, a retry that makes an outage worse. We would rather refuse the unsafe thing than allow it silently.

Articles that actually run. The code in our engineering articles is executed against the published package versions before we publish. When a version changes, we run the examples again.

A security contact. Our tools list [email protected] for security reports, and we keep dependencies and CI actions up to date.

What this costs, and why we do it

Maintenance is slow and unglamorous: fixing an edge case, updating a dependency, answering an issue. But these tools are what we use ourselves, including in ShiftOps, so every fix improves our own product too. And a small tool that stays maintained is worth more than ten that were published once and forgotten.

If you use one of our packages and something is wrong or missing, tell us. That is the most useful kind of feedback we can get.

← All posts

A question or an idea?

Send us an email. You talk directly to the people who build the software and get an answer within 2 working days.