Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Feature request: Check of README should be part of package maturity test

See original GitHub issue

README is just one aspect of package maturity.

When README is missing, the package maturity check step should be marked with a warning sign. This way, we save one line of output which saves the user valuable time.


npq install jq
  ✔ Checking package maturity
  ✔ Identifying package author...
  ✔ Checking package download popularity
  ✔ Checking availability of a README
  ✖ Identifying package repository...
  ✔ Checking package for pre/post install scripts
  ✖ Checking for known vulnerabilities
Detected possible issues with the following packages:
  [jq]
    - the repository associated with the package (git://github.com/logicalparadox/jq.git) does not exist or is unreachable at the moment.
  [*]
    - Unable to query for known vulnerabilities. Install snyk and authenticate or provide a SNYK_TOKEN env variable (https://snyk.io)

? Would you like to continue installing package(s)? (y/N)

Issue Analytics

State:
Created 4 years ago
Reactions:1
Comments:5 (3 by maintainers)

Top GitHub Comments

1reaction

CodingSpiderFoxcommented, Jan 17, 2020

I’m not sure whether I worded it properly. What I mean is that with each line, the user needs to spend additional time reading through the text with his own eyes.

I agree on your categorization. Repository could be part of maturity test.

1reaction

CodingSpiderFoxcommented, Jan 17, 2020

The time it takes npq to run is not the problem. The problem is having to spend additional time for reading each line of the output. With my suggestion, we would save at least one line of output

Download popularity could also be considered to be an aspect of package maturity

Top Results From Across the Web

Metrics/README.md at master - GitHub

A Maturity Indicator Test is a Web API that has the following features: It is described in YAML using a smartAPI interface annotation...

Essential Sections for Better Documentation of a README ...

Modern README files have access to all HTML5 features, ...

Feature Requests - ReadMe Documentation

Have an idea for a new feature? Let us know by submitting to our planning board. Share your email address when you create...

How can I test what my readme.md file will look like before ...

To switch between views, press Ctrl+Shift+V in the editor. You can view the preview side-by-side (Ctrl+K V) with the file you are editing...

Shell scripting standards and style guidelines | GitLab

This section describes the tools that should be made a mandatory part of a project's ... shell check: image: koalaman/shellcheck-alpine:stable stage: test ......