@guanghechen/npm-helper

A collection of utility functions for npm packages.

Install

• npm

  npm install --save-dev @guanghechen/npm-helper

• yarn

  yarn add --dev @guanghechen/npm-helper

Usage

• detectMonorepo: Check whether if it is a monorepo under the currentDir.

  function detectMonorepo(currentDir: string): boolean

• detectPackageAuthor: Detect package author.

  function detectPackageAuthor(currentDir: string): string | null

• createDependencyFields: Return default dependency field names.

  function createDependencyFields(): ReadonlyArray<
    |'dependencies'
    |'optionalDependencies'
    |'peerDependencies'
  >

• collectAllDependencies: Collect all dependencies declared in the package.json and the dependencies of them and so on.

  function collectAllDependencies(
    packageJsonPath: string | null,
    dependenciesFields?: ReadonlyArray<string>,
    additionalDependencies?: ReadonlyArray<string> | null,
    isAbsentAllowed?: ((moduleName: string) => boolean) | null,
  ): string[]

  • packageJsonPath: Filepath of package.json
  • dependenciesFields: Package dependency field names. (such as ['dependencies', 'devDependencies'])
  • additionalDependencies: Additional dependency names appended to the results.
  • isAbsentAllowed: Determine whether if a given moduleName can miss. (called on MODULE_NOT_FOUND error thrown)

Related