Internal improvements, add more tests #689

tommy-mitchell · 2023-04-08T02:35:29Z

Fixes #29
Fixes #383

Sorry for the big diff. Besides adding lots of tests, a lot of changes are pretty connected.

Summary:

Adds tests for almost every file
- Utilities: npm/*, git-util.js, util.js
- Mocks inquirer to test prompts in ui.js
- Basic tests for cli.js and index.js
- Uses esmock extensively to make tests concurrent
  - e.g. for stubbing execa with command outputs, or in combination with tempy for integration tests
Reworks the API of the Version class to be more minimal
- Incorporates pretty-version-diff.js into Version's formatting
- Updates source files with the new usage
Updates many dependencies
Misc. bugs/style fixes discovered while adding tests

More tests with the CLI are sorely needed.

New `Version` API

new Version('0.0.0').toString()
//=> '0.0.0'

new Version('0.0.0', 'major')
//=> {toString: '1.0.0', #diff: 'major'}

new Version('0.0.0').setFrom('minor').isPrerelease()
//=> false

new Version('2.0.0').satisfies('>=1.0.0')
//=> true

new Version('1.2.3', 'patch').format()
//=> '{dim 1.2.{cyan 4}}'

new Version('1.2.3-1').format({previousVersion: '1.2.3-0'})
//=> '{dim 1.2.3-{cyan 1}}'

new Version(123)
//=> throws 'Version `123` should be a valid `SemVer` version.'

new Version('1.2.3', '1.2.4')
//=> throws 'Increment `1.2.4` should be one of `major`, `minor`, `patch`, `premajor`, `preminor`, `prepatch`, `prerelease`.'

new Version('1.2.3').setFrom(124)
//=> throws 'New version `124` should either be one of `major`, `minor`, `patch`, `premajor`, `preminor`, `prepatch`, `prerelease`, or a valid `SemVer` version.'

new Version('1.2.3').setFrom('1.2.2')
//=> throws 'New version `1.2.2` should be higher than current version `1.2.3`.'

IssueHunt Summary

Referenced issues

This pull request has been submitted to:

test/npm/util/stub.js

test/git/stub.js

tommy-mitchell · 2023-04-08T03:04:46Z

#684 can be done now as well, but I think we should wait until the tests are more robust first.

tommy-mitchell · 2023-04-08T19:33:04Z

I think that should be everything covered in util.js as well. I also found a bug in readPkg where packagePath wasn't being properly passed to pkg-dir, which probably happened in the move to ESM with the dependency update.

source/pretty-version-diff.js

…sks/prompts, style/grammar fixes

source/version.js

…vements

tommy-mitchell · 2023-08-31T16:25:35Z

@sindresorhus do you want to try a test publish again? Think I've fixed the issues

tommy-mitchell · 2023-09-01T04:02:11Z

I’ve been able to publish https://github.com/tommy-mitchell/gfm-lang-cli, https://github.com/tommy-mitchell/cli-template, and https://github.com/tommy-mitchell/lib-template using this branch.

sindresorhus · 2023-09-01T19:28:19Z

~/dev/oss/sindre-playground main ⇡
❯ np

Publish a new version of sindre-playground (current: 1.7.4)

? No commits found since previous release, continue? Yes
? Select SemVer increment or specify new version major 	2.0.0

  ❯ Prerequisite check
    ✔ Ping npm registry
    ✔ Check npm version
    ✔ Check yarn version
    ✔ Verify user is authenticated
    ✔ Check git version
    ✔ Check git remote
    ✖ Validate version
      → New version `2.0.0` should either be one of `major`, `minor`, `patch`, `premajor`, `preminor`, `prepatch`, `prerelease`, or a valid `SemVer` version.
      Check for pre-release version
      Check git tag existence
    Git
    Installing dependencies using Yarn
    Running tests using Yarn
    Bumping version using Yarn
    Publishing package using Yarn
    Pushing tags
    Creating release draft on GitHub

✖ Error: New version `2.0.0` should either be one of `major`, `minor`, `patch`, `premajor`, `preminor`, `prepatch`, `prerelease`, or a valid `SemVer` version.
    at Version.setFrom (file:///Users/sindresorhus/dev/oss/np/source/version.js:93:11)
    at Task.task (file:///Users/sindresorhus/dev/oss/np/source/prerequisite-tasks.js:62:43)
    at /Users/sindresorhus/dev/oss/np/node_modules/listr/lib/task.js:167:30
    at process.processTicksAndRejections (node:internal/process/task_queues:95:5)

Aborted!

tommy-mitchell · 2023-09-01T20:16:03Z

Fixed 🙃 some e2e tests would be nice.

sindresorhus · 2023-09-01T20:57:24Z

A couple of minor things I noticed:

If I press Control+C (to exit) while it's running (for example, "Installing dependencies"), the text cursor is not restored.
It now presents in this order: major, minor, patch, while previously (and correctly), it presented: patch, minor, major.

source/ui.js

tommy-mitchell · 2023-09-01T21:57:50Z

It now presents in this order: major, minor, patch, while previously (and correctly), it presented: patch, minor, major.

Where is the correct order listed? semver lists them in this order:

const RELEASE_TYPES = [
  'major',
  'premajor',
  'minor',
  'preminor',
  'patch',
  'prepatch',
  'prerelease',
]

sindresorhus · 2023-09-01T22:05:39Z

I don't think there's any "correct" order, but for np, it should maintain the existing order. Also because having the most used type first (path) is useful.

Existing order:

❯ patch 	5.3.1
  minor 	5.4.0
  major 	6.0.0
  prepatch 	5.3.1-0
  preminor 	5.4.0-0
  premajor 	6.0.0-0
  prerelease 	5.3.1-0
  ──────────────
  Other (specify)

sindresorhus · 2023-09-01T22:05:44Z

One more thing, when running in non-node project, it crashes:

~/Downloads
❯ np
file:///opt/homebrew/lib/node_modules/np/source/version.js:4
const {packageJson: pkg} = await readPackageUp();
                    ^

TypeError: Cannot destructure property 'packageJson' of '(intermediate value)' as it is undefined.
    at file:///opt/homebrew/lib/node_modules/np/source/version.js:4:21

Node.js v18.17.1

tommy-mitchell · 2023-09-01T22:56:49Z

I've reverted the order and the backticks for the Version class.

when running in non-node project, it crashes

I don't think that's this branch of np, source/version.js doesn't have that line anymore.

tommy-mitchell · 2023-09-01T23:53:21Z

If I press Control+C (to exit) while it's running (for example, "Installing dependencies"), the text cursor is not restored.

I'm not sure what's causing this. I updated to the latest version exit-hook, maybe that?

sindresorhus · 2023-09-02T08:06:33Z

I don't think that's this branch of np, source/version.js doesn't have that line anymore.

Yeah. My mistake. Too much switching back and forth between the versions.

sindresorhus · 2023-09-02T08:15:50Z

I'm not sure what's causing this. I updated to the latest version exit-hook, maybe that?

That update simply renames an option though. So not sure why that would cause this.

The thing that is supposed to restore the cursor is called restore-cursor:

yarn why v1.22.19
[1/4] 🤔  Why do we have the module "restore-cursor"...?
[2/4] 🚚  Initialising dependency graph...
[3/4] 🔍  Finding dependency...
[4/4] 🚡  Calculating file sizes...
=> Found "[email protected]"
info Reasons this module exists
   - "cli-cursor" depends on it
   - Hoisted from "cli-cursor#restore-cursor"
info Disk size without dependencies: "60KB"
info Disk size with unique dependencies: "104KB"
info Disk size with transitive dependencies: "124KB"
info Number of shared dependencies: 3
=> Found "inquirer#[email protected]"
info Reasons this module exists
   - "inquirer#cli-cursor" depends on it
   - Hoisted from "inquirer#cli-cursor#restore-cursor"
info Disk size without dependencies: "20KB"
info Disk size with unique dependencies: "64KB"
info Disk size with transitive dependencies: "84KB"
info Number of shared dependencies: 3
=> Found "listr-input#[email protected]"
info Reasons this module exists
   - "listr-input#inquirer#cli-cursor" depends on it
   - Hoisted from "listr-input#inquirer#cli-cursor#restore-cursor"
info Disk size without dependencies: "20KB"
info Disk size with unique dependencies: "64KB"
info Disk size with transitive dependencies: "84KB"
info Number of shared dependencies: 3
=> Found "ora#[email protected]"
info Reasons this module exists
   - "inquirer#ora#cli-cursor" depends on it
   - Hoisted from "inquirer#ora#cli-cursor#restore-cursor"
info Disk size without dependencies: "20KB"
info Disk size with unique dependencies: "64KB"
info Disk size with transitive dependencies: "84KB"
info Number of shared dependencies: 3
✨  Done in 0.15s.

sindresorhus · 2023-09-02T08:16:29Z

I'm gonna merge this as it will unblock other things, but I don't think we can release it until we figure out why the cursor is not restored as it will affect usage after using np.

sindresorhus · 2023-09-02T08:16:59Z

Nice work on all this by the way. It's great to get more tests so we can make changes more confidently. 👍

tommy-mitchell · 2023-09-02T19:46:31Z

The thing that is supposed to restore the cursor is called restore-cursor

Seems it might've been updating inquirer, the newest version downgraded restore-cursor: SBoudrias/Inquirer.js@c51e33d#diff-b4c1d5e0907543f5ddd59a94a2ccdd1c3c790d0187d693c97e5d1bb86d55ab3b

tommy-mitchell · 2023-09-03T01:45:23Z

@sindresorhus is there a reason we're using ow for validation? It's only used in a couple of places, and it seems like we could just do the checks without adding another dependency:

np/source/util.js

Lines 63 to 75 in 1cb22e0

    
           export const getTagVersionPrefix = pMemoize(async options => { 
        
           	ow(options, ow.object.hasKeys('yarn')); 
        
           	try { 
        
           		const {stdout} = options.yarn 
        
           			? await execa('yarn', ['config', 'get', 'version-tag-prefix']) 
        
           			: await execa('npm', ['config', 'get', 'tag-version-prefix']); 
        
           		return stdout; 
        
           	} catch { 
        
           		return 'v'; 
        
           	} 
        
           });

sindresorhus · 2023-09-03T06:33:11Z

is there a reason we're using ow for validation?

Feel free to remove it.

sindresorhus · 2023-11-04T08:41:24Z

@tommy-mitchell I'm still seeing the SemVer issue in the main branch:

Publish a new version of sindre-playground (current: 3.0.3)

? No commits found since previous release, continue? Yes
? Select SemVer increment or specify new version patch 	3.0.4

  ✔ Prerequisite check
  ✔ Git
  ✔ Installing dependencies using Yarn
  ✔ Running tests using Yarn
  ✔ Bumping version using Yarn
  ✔ Publishing package using Yarn
  ✔ Pushing tags
  ✖ Creating release draft on GitHub
    → New version 3.0.4 should either be one of patch, minor, major, prepatch, preminor, premajor, prerelease, or a valid SemVer version.

✖ Error: New version 3.0.4 should either be one of patch, minor, major, prepatch, preminor, premajor, prerelease, or a valid SemVer version.
    at Version.setFrom (file:///Users/sindresorhus/dev/oss/np/source/version.js:93:11)
    at releaseTaskHelper (file:///Users/sindresorhus/dev/oss/np/source/release-task-helper.js:9:30)
    at process.processTicksAndRejections (node:internal/process/task_queues:95:5)

tommy-mitchell added 4 commits April 6, 2023 16:55

chore: start separating tests

d3df4f8

tests(git): add tests for git-util.js

636eb0b

further separate tests, add npm tests, style

e822ae9

fix(git): move tests to integration, fix defaultBranch tests

22cac30

tommy-mitchell commented Apr 8, 2023

View reviewed changes

test/npm/util/stub.js Outdated Show resolved Hide resolved

tommy-mitchell commented Apr 8, 2023

View reviewed changes

test/git/stub.js Outdated Show resolved Hide resolved

tests(util): add more tests

796595d

feat(pretty-version-diff): simplify and add tests

af48c4e

tommy-mitchell commented Apr 9, 2023

View reviewed changes

source/pretty-version-diff.js Outdated Show resolved Hide resolved

tommy-mitchell changed the title ~~Improve/add tests, fix some style issues~~ Internal improvements, add more tests Apr 9, 2023

update Version API, remove pretty-version-diff.js, consolidate ta…

dce03f5

…sks/prompts, style/grammar fixes

tommy-mitchell commented Apr 11, 2023

View reviewed changes

source/version.js Show resolved Hide resolved

tommy-mitchell added 15 commits April 10, 2023 22:06

fix(test/index): incorrect message expectation

49378f4

fix(version): passing test marked as failing

993a53e

chore(version): rename setNewVersionFrom to setFrom

f6b988e

chore: bump semver

76dd173

fix(version): get correct diff

75a2156

chore(version): use new semver.RELEASE_TYPES

722370b

fix(packed-files): don't rename .gitignore

9097485

feat(version): improved prerelease diffs, more docs

68997f1

feat(version): update/document API

280c66e

tests(prerequisite-tasks): test is passing now?

21eeab1

tests: add more git and npm tests

d234532

fix: comment out unused imports

d258504

docs: update old info on readme

7a39e51

add ui/cli tests, improve customVersion validation, style impro…

12a3650

…vements

update CI to Node.js 20

ef1d2e9

tommy-mitchell force-pushed the improve-tests branch from 759ac4e to 6c76518 Compare April 18, 2023 23:54

tommy-mitchell added 3 commits August 31, 2023 11:13

update deps

cd16b94

fix: lint

c92873c

fix: missing option in test

361b609

tommy-mitchell marked this pull request as ready for review August 31, 2023 16:24

fix: ignore some checks when --release-draft-only

e3c5e5c

fix(prerequisite-tasks): don't double parse version

f98b85d

sindresorhus reviewed Sep 1, 2023

View reviewed changes

source/ui.js Outdated Show resolved Hide resolved

tommy-mitchell added 2 commits September 1, 2023 17:11

version style tweaks

c6249a2

semver order

a682b51

sindresorhus merged commit 1cb22e0 into sindresorhus:main Sep 2, 2023

tommy-mitchell mentioned this pull request Sep 2, 2023

Ctrl-c-ing out of checkbox prompt leaves terminal in broken state SBoudrias/Inquirer.js#1286

Closed

tommy-mitchell mentioned this pull request Feb 29, 2024

Update dependencies #734

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Internal improvements, add more tests #689

Internal improvements, add more tests #689

tommy-mitchell commented Apr 8, 2023 •

edited by issuehunt-oss bot

Loading

tommy-mitchell commented Apr 8, 2023

tommy-mitchell commented Apr 8, 2023

tommy-mitchell commented Aug 31, 2023

tommy-mitchell commented Sep 1, 2023

sindresorhus commented Sep 1, 2023

tommy-mitchell commented Sep 1, 2023

sindresorhus commented Sep 1, 2023

tommy-mitchell commented Sep 1, 2023 •

edited

Loading

sindresorhus commented Sep 1, 2023

sindresorhus commented Sep 1, 2023

tommy-mitchell commented Sep 1, 2023

tommy-mitchell commented Sep 1, 2023

sindresorhus commented Sep 2, 2023

sindresorhus commented Sep 2, 2023

sindresorhus commented Sep 2, 2023

sindresorhus commented Sep 2, 2023

tommy-mitchell commented Sep 2, 2023

tommy-mitchell commented Sep 3, 2023

sindresorhus commented Sep 3, 2023

sindresorhus commented Nov 4, 2023

Internal improvements, add more tests #689

Internal improvements, add more tests #689

Conversation

tommy-mitchell commented Apr 8, 2023 • edited by issuehunt-oss bot Loading

New Version API

Referenced issues

tommy-mitchell commented Apr 8, 2023

tommy-mitchell commented Apr 8, 2023

tommy-mitchell commented Aug 31, 2023

tommy-mitchell commented Sep 1, 2023

sindresorhus commented Sep 1, 2023

tommy-mitchell commented Sep 1, 2023

sindresorhus commented Sep 1, 2023

tommy-mitchell commented Sep 1, 2023 • edited Loading

sindresorhus commented Sep 1, 2023

sindresorhus commented Sep 1, 2023

tommy-mitchell commented Sep 1, 2023

tommy-mitchell commented Sep 1, 2023

sindresorhus commented Sep 2, 2023

sindresorhus commented Sep 2, 2023

sindresorhus commented Sep 2, 2023

sindresorhus commented Sep 2, 2023

tommy-mitchell commented Sep 2, 2023

tommy-mitchell commented Sep 3, 2023

sindresorhus commented Sep 3, 2023

sindresorhus commented Nov 4, 2023

tommy-mitchell commented Apr 8, 2023 •

edited by issuehunt-oss bot

Loading

New `Version` API

tommy-mitchell commented Sep 1, 2023 •

edited

Loading