comparing-dependencies v0.4.1

comparing-dependencies

This is a npm library that imports multiple package.json files and outputs the comparison results of depending libraries as a CSV format string.

How to use

$ yarn add comparing-dependencies

API

createCsv(packageJsons: PackageJson[]): string

Note: PackageJson type is declared in type-fest.

Usage

import { createCsv } from 'comparing-dependencies'

const csv = createCsv([
  {
    name: 'prj_01',
    dependencies: {
      react: '^17.0.2',
      dayjs: '^1.10.3',
    },
    devDependencies: {
      webpack: '^5.51.1',
    },
  },
  {
    name: 'prj_02',
    dependencies: {
      react: '^17.0.2',
      dayjs: '^1.10.2',
      react-redux: '^7.2.4',
    },
    devDependencies: {
      webpack: '^5.47.1',
    },
  },
  {
    name: 'prj_03',
    dependencies: {
      moment: '^2.29.1',
      webpack: '^4.46.0',
    },
  },
])

console.log(csv)

// "library","prj_01","prj_02","prj_03"
// "dayjs","^1.10.3","^1.10.2",""
// "moment","","","^2.29.1"
// "react","^17.0.2","^17.0.2",""
// "react-redux","","^7.2.4",""
// "webpack","^5.51.1","^5.47.1","^4.46.0"

Example codes

• Examples for comparing-dependencies

Replacing package.json files

Place the package.json files that you want to compare under the ./examples/inputs directory. Then, the name field in each package.json will be output as a column name in the CSV.

examples/inputs/
  |- example_package_01.json
  |- example_package_02.json
  |- example_package_03.json

These file names can be anything you want.

Running

$ yarn run-example

Checking the result

The result.csv will be output at the ./examples.

$ open ./examples/result.csv