Skip to content

Add guidelines for dependencies #5336

Open
@mcmire

Description

@mcmire
  • When to use dependencies, devDependencies, and peerDependencies for controllers
    • If your controller is talking to another controller via the messenger, you should place that controller in both devDependencies and peerDependencies. (Explain why.) This trumps all other rules.
      • Furthermore, the version range in peerDependencies should be set to the major to reduce the coupling between packages and makes upgrades in clients easier.
    • If you are importing a controller in production code, then you should place that controller in dependencies. Yes, this even includes types (because types show up in the published version of the package.)
    • If you are importing a controller in tests only, then you should place that controller in devDependencies.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions