Skip to content

Add "type" description to "package.json" documentation #1204

@sdcaulley

Description

@sdcaulley

Many of the fields for the package.json have description, but not type. Type needs at least a description of what are the valid options.

Activity

theengineear

theengineear commented on Nov 6, 2024

@theengineear

I also got caught by this recently. I tried to use https://docs.npmjs.com/cli/v10/configuring-npm/package-json as a source of truth to modernize the format of my package.json file, but now I’m questioning whether that was the right place to look for this information — is there a better place to look to understand the correct keywords to use?

EDIT: Just saw that @kenshanta has a PR open on exactly this keyword. Thanks!!

added a commit that references this issue on Jul 31, 2025
4c574b8
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

      Participants

      @theengineear@sdcaulley

      Issue actions

        Add "type" description to "package.json" documentation · Issue #1204 · npm/documentation