Skip to content

Clarify description in readme #107

Open
@rauschma

Description

@rauschma

I’m not sure if I completely understand this text:

Verifies that installed modules comply with the requirements specified in package.json.

By default checks engine ranges, peer dependency ranges and installed versions and, in mono-repos using workspaces, by default checks all workspaces as well as the workspace root.

It may make sense to state requirements separately. Is this correct?

  • What are the requirements? The version range specified in package.json > engines > node (details)

  • Where are the requirements checked?

    • "peerDependencies"
    • "dependencies"
    • "devDependencies"
    • Monorepos via workspaces: all workspaces and workspace root

Questions:

  • What exactly does “complying with the requirements” mean?
  • Do the modules really have to be installed or could you also check package-lock.json?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions