Skip to content
This repository has been archived by the owner on Feb 3, 2021. It is now read-only.

Do not display package section for version-less private packages #193

Open
matchai opened this issue May 21, 2019 · 0 comments
Open

Do not display package section for version-less private packages #193

matchai opened this issue May 21, 2019 · 0 comments
Labels
Good First Issue Good for newcomers Type: Bug Fix an existing bug

Comments

@matchai
Copy link
Owner

matchai commented May 21, 2019

Bug Report

Current Behavior
Shows a ⚠️ symbol when the package version is not defined.

Expected Behavior
Does not show the package section if no version is defined.

Possible Solution

Remove the ⚠️ symbol for version, as was done in spaceship-prompt/spaceship-prompt#441.

🐟 spacefish-bot — Issue copied from: spaceship-prompt/spaceship-prompt#655.

Is your feature request related to a problem? Please describe.

Many applications will use package.json to track dependencies and scripts but have no intentions of publishing to a package repository. A package version probably does not mean much either in those contexts. It is recommended that such projects set private: true.

For such projects, seeing a warning symbol in the prompt leads to think something is misconfigured.

Describe the solution you'd like

If package.json does not contain a version but is marked private, do not display the `package section.

Describe alternatives you've considered

Add a configuration option to opt into this behaviour. I think this should be the default behaviour but could be convinced that it needs an opt in.

Documentation, adoption

Recommend setting private: true for version-less packages.

@matchai matchai added the Type: Bug Fix an existing bug label May 21, 2019
@spacefish-bot spacefish-bot bot changed the title #655 Do not display package section for version-less private packages May 21, 2019
@matchai matchai added the Good First Issue Good for newcomers label May 21, 2019
@good-first-pin good-first-pin bot pinned this issue May 21, 2019
@matchai matchai unpinned this issue Jun 23, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
Good First Issue Good for newcomers Type: Bug Fix an existing bug
Projects
None yet
Development

No branches or pull requests

1 participant