npm.io
1.3.5 • Published 2 weeks ago

@pierre/diffs

Licence
apache-2.0
Version
1.3.5
Deps
7
Size
6.6 MB
Vulns
0
Weekly
0

Diffs, from Pierre

@pierre/diffs is an open source diff and file rendering library built on Shiki. It's super customizable and packed with the features you need. Made with love by The Pierre Computer Company. Available as vanilla JavaScript and React components.

View examples and read documentation on Diffs.com.

Features

  • Diff file versions, patches, and arbitrary files
  • Split or stacked layout
  • Automatically adapts to Shiki themes
  • Supports light and dark mode
  • Options for diff highlight styles, in-line highlighting, wrapping, line numbers, and more
  • Supports custom fonts and font-feature-settings
  • Flexible annotation framework for injecting comments, annotations, and more
  • Add your own accept/reject changes UI
  • Select and highlight lines

Install

pnpm add @pierre/diffs

Agent skill

Install the agent skill for this package with the Skills CLI:

npx skills add pierrecomputer/pierre --skill diffs

Development

We use pnpm for workspace package management and Bun for tests.

# From the root of the monorepo: setup dependencies
pnpm install

# Start the demo vite test server
moonx demo:dev

# To run the docs (diffs site)
moonx docs:dev-diffs
Testing
# Run tests and related command from within the package directory
bun test

# Update snapshots
bun test --update-snapshots

# Type checking
moonx diffs:typecheck

Tests are located in the test/ folder and use Bun's native testing framework with snapshot support.

Publishing

Applicable to the Pierre team only.

# You may need to login first:
pnpm login

# Always run publish from within the package directory.
cd packages/diffs
pnpm publish
# In a CI-marked shell: CI= pnpm publish

Building the sprite

The diff UI uses an SVG sprite built from @pierre/icons. From the monorepo root:

moonx root:icons

This reads SVGs from node_modules/@pierre/icons/svg and writes packages/diffs/src/sprite.ts. Run after updating @pierre/icons or changing sprite.config.js.