yargs / yargs/cliui

Should npm run script `check` run after `test`?

Open
#141 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
395
Forks
44
Avg merge
6m
Merged PRs (30d)
3

Description

There are some minor benefits to having the lint check separate from the runtime tests, so that more of the GitHub Action checks complete and aren't blocked by lint issues. However, makes it easy to open a PR and push code that will fail on the lint check.

I noticed there is postest run script, which should presumably be posttest! Leaning towards enabling that as I tend to only fix one breakage at a time anyway.

https://github.com/yargs/cliui/blob/af3145da0ea31738c4715865a6da0ee388a94c74/package.json#L23

Fixing that would render this line obsolete:

https://github.com/yargs/cliui/blob/af3145da0ea31738c4715865a6da0ee388a94c74/.github/workflows/ci.yaml#L24

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read the npm scripts in package.json and the workflow step around the linked line in .github/workflows/ci.yaml. Compare how test and check currently run, then verify the selected ordering and that the obsolete workflow step is no longer needed by running the relevant npm checks.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
build-system, ci-cd
Issue type
Feature
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.