Skip to content

Comments in package.json: @comment prefix #677

Closed
@rkristelijn

Description

@rkristelijn

What / Why

As a developer you would like to leave comments in the same context as you write code to note down todo's, leave hints for other devs or other reasons. Most of my code allows for this except for package.json, at least, there is no standard. After reading this blog I think this should be a standard, in a way that more people use the same notation and my IDE or VSC highlights comments as a comment.

When

  • at code-time

Where

package.json

How

The proposed standard (for now) is that above a specific property in an array, you note down the same property prefixed with @comment<space>.

Current Behavior

  • @comment is not a common standard
  • if this is done and agreed in this context, I can follow through and talk to IDE's repos
  • n/a

Expected Behavior

  • @comment is not a common standard
  • n/a

Who

  • n/a

References

this blog

  • n/a

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions