https://github.com/rightcapitalhq/verdaccio-package-diff

A package diff plugin for Verdaccio
https://github.com/rightcapitalhq/verdaccio-package-diff

npm package package-diff package-difference plugin pnpm verdaccio verdaccio-plugin yarn

Last synced: 2 months ago
JSON representation

A package diff plugin for Verdaccio

• Host: GitHub
• URL: https://github.com/rightcapitalhq/verdaccio-package-diff
• Owner: RightCapitalHQ
• License: mit
• Created: 2024-01-10T09:25:38.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2024-10-24T01:55:42.000Z (3 months ago)
• Last Synced: 2024-10-24T18:14:40.433Z (3 months ago)
• Topics: npm, package, package-diff, package-difference, plugin, pnpm, verdaccio, verdaccio-plugin, yarn
• Language: TypeScript
• Homepage: https://opensource.rightcapital.com
• Size: 166 KB
• Stars: 3
• Watchers: 7
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.json
  • License: LICENSE

Awesome Lists containing this project

README

        
# Verdaccio Package Diff Plugin

[![made by RightCapital](https://img.shields.io/badge/made_by-RightCapital-5070e6)](https://rightcapital.com)

![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/RightCapitalHQ/verdaccio-package-diff/ci.yml)

[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-%23FE5196?logo=conventionalcommits&logoColor=white)](https://conventionalcommits.org)

[![RightCapital frontend style guide](https://img.shields.io/badge/code_style-RightCapital-5c4c64?labelColor=f0ede8)](https://github.com/RightCapitalHQ/frontend-style-guide)

## Introduce

If you want to know what has changed between the two versions in the package, this plugin can tell you.

## How to use

To view the diffs between two versions of a package, go to:

```text

{YOUR_VERDACCIO_SITE}/-/npm/package-diff/viewer?name={PACKAGE_NAME}&from={PACKAGE_VERSION_A}&to={PACKAGE_VERSION_B}

```

This will display the file differences between the two versions.

## How to install

### Build your own docker image

To install this plugin in your own Verdaccio docker image:

[Refer to the Verdaccio documentation on creating custom Dockerfile](https://verdaccio.org/docs/docker/#creating-your-own-dockerfile-using-verdaccioverdacciotag-as-base)

Create a Dockerfile:

```dockerfile

FROM node:lts-alpine as builder

RUN mkdir -p /verdaccio/plugins \

  && cd /verdaccio/plugins \

  && npm install --global-style --no-bin-links --omit=optional @rightcapital/verdaccio-package-diff

FROM verdaccio/verdaccio:5

COPY --from=builder --chown=$VERDACCIO_USER_UID:root \

  /verdaccio/plugins/node_modules/@rightcapital/verdaccio-package-diff \

  /verdaccio/plugins/@rightcapital/verdaccio-package-diff

USER root

RUN mkdir -p /opt/verdaccio/.npm

RUN chown -R  $VERDACCIO_USER_UID:root /opt/verdaccio/.npm

USER $VERDACCIO_USER_UID

```

### Config plugin

Enable the plugin in your `config.yaml`:

```yaml

middlewares:

  '@rightcapital/verdaccio-package-diff':

    enabled: true

```

### Set plugin permissions

Create a `.npmrc` file for your container, this will allow the plugin to access private packages.

```yaml

volumes:

  - './.npmrc:/opt/verdaccio/.npmrc'

```

#### About permissions

You can use Verdaccio [packages](https://verdaccio.org/docs/configuration/#packages) configuration to control which packages can be access by package diff plugin.