Skip to content
Pure Index

JavaScript API

Pure Index provides a JavaScript API which is usable from Node.js. You only have to use this if the use of Pure Index goes beyond the monorepo.

findUnusedExports

This function lets you find unused package exports by checking imports in different repositories.

Formulae

const result = await findUnusedExports({ entry, location }, repositories);

Arguments

entry

  • Type: string
  • Required: true

Path to the package index file. Relative to the package location.

location

  • Type: string
  • Required: false
  • Default: ''

pkgName

  • Type: string
  • Required: false
  • Default: undefined

Allows you to specify the name of the package to be searched (instead of package.json -> name).

repositories

  • Type: Item[]
  • Required: true

List of repositories where to look for package imports.

Item
type Item = {
  dir: Config['dir']; // full path to the repository
  batch?: Config['batch'];
  exclude?: Config['exclude'];
  extensions?: Config['extensions'];
  parserConfig?: Config['parserConfig'];
};

You can find the description of each field in the configuration section. If you don’t provide values for optional parameters, they will be taken as defaults.

Returns

Promise with a Result object.

type Result =
  | {
      ok: true;
      val: { exports: Set<void> };
    }
  | {
      ok: false;
      err: {
        exports: Set<string>;
        reason: 'no_exports' | 'no_imports' | 'unused_exports';
      };
    };
  • if no unused exports were found, result.ok = true
  • if unused exports were found, result.ok = false

Example

import { findUnusedExports } from 'pure-index';


const result = await findUnusedExports(
  {
    entry: './src/index.ts',
    // location: '../../', // or using `dirname(fileURLToPath(import.meta.url))`
  },
  [
    {
      dir: '/Users/me/my-awesome-repo',
      exclude: ['**/build/**'],
    },
    {
      dir: '/Users/me/my-another-awesome-repo',
    },
  ],
);


if (!result.ok) {
  process.stdout.write(result.err.reason + '\n');


  const exports = JSON.stringify([...result.err.exports], undefined, 2);


  process.stdout.write(exports + '\n');
  process.exit(1);
}


process.exit(0);

collectUsages

This function allows you to collect all package usage in different repositories.

Formulae

const result = await collectUsages(name, repositories);

Arguments

name

  • Type: string
  • Required: true

The name of the package to look for.

repositories

  • Type: Item[]
  • Required: true

List of repositories where to look for package imports.

Item
type Item = {
  dir: Config['dir']; // full path to the repository
  batch?: Config['batch'];
  exclude?: Config['exclude'];
  extensions?: Config['extensions'];
  parserConfig?: Config['parserConfig'];
};

You can find the description of each field in the configuration section. If you don’t provide values for optional parameters, they will be taken as defaults.

Returns

Promise with a Result object.

type Result =
  | {
      ok: true;
      val: { usages: Set<string> };
    }
  | {
      ok: false;
      err: { usages: Set<void> };
    };
  • if imports were found, result.ok = true
  • if no imports were found, result.ok = false

Example

import { collectUsages } from 'pure-index';


const result = await collectUsages('@my/ui-kit', [
  {
    dir: '/Users/me/my-awesome-repo',
    exclude: ['**/build/**'],
  },
  {
    dir: '/Users/me/my-another-awesome-repo',
  },
]);


if (result.ok) {
  const usages = JSON.stringify([...result.val.usages], undefined, 2);


  process.stdout.write(usages + '\n');
  process.exit(0);
}


process.exit(1);