feat: echo what is being fetched to stderr

Author: jedwards1211

pnpm-lock.yaml

@@ -5,7 +5,7 @@ import yargs from 'yargs/yargs'
 import path from 'path'
 import fs from 'fs-extra'
 import semver from 'semver'
-import { fetchChangelog } from '../index'
+import { describeFilter, fetchChangelog } from '../index'
 import { debug } from '../util/debug'
 
 /* eslint-env node */
@@ -94,13 +94,22 @@ async function go() {
   }
 
   try {
+    const include = {
+      range,
+      prerelease: argv.pre,
+      minor: argv.pre || !argv.major,
+      patch: argv.pre || (!argv.major && !argv.minor),
+    }
+    // eslint-disable-next-line no-console
+    console.error(
+      `fetching ${describeFilter({
+        pkg,
+        include,
+        highlight: !process.env.CI && process.stdout.isTTY,
+      })}...`
+    )
     const changelog = await fetchChangelog(pkg, {
-      include: {
-        range,
-        prerelease: argv.pre,
-        minor: argv.pre || !argv.major,
-        patch: argv.pre || (!argv.major && !argv.minor),
-      },
+      include,
     })
     if (json) {
       process.stdout.write(JSON.stringify(changelog, null, 2))

src/cli/npm-fetch-changelog.ts

@@ -7,6 +7,7 @@ import { Octokit } from 'octokit'
 import memoize from './util/memoize'
 import once from './util/once'
 import { debug } from './util/debug'
+import chalk from 'chalk'
 
 const getOctokit = once(async (): Promise<Octokit> => {
   const { githubToken } = await getConfig()
@@ -91,14 +92,14 @@ function parseRepositoryUrl(url: string): { owner: string; repo: string } {
   return { owner, repo: repo.replace(/\.git$/, '') }
 }
 
-export type IncludeOption =
-  | ((version: string) => boolean)
-  | {
-      range?: string | null
-      prerelease?: boolean | null
-      minor?: boolean | null
-      patch?: boolean | null
-    }
+export type IncludeOptionObject = {
+  range?: string | null
+  prerelease?: boolean | null
+  minor?: boolean | null
+  patch?: boolean | null
+}
+
+export type IncludeOption = ((version: string) => boolean) | IncludeOptionObject
 
 export function includeFilter(
   include?: IncludeOption | null
@@ -115,6 +116,43 @@ export function includeFilter(
   }
 }
 
+export function describeFilter({
+  pkg,
+  include,
+  highlight,
+}: {
+  pkg?: string
+  include?: IncludeOption | null
+  highlight?: boolean
+}) {
+  if (typeof include === 'function') {
+    return `versions matching custom function`
+  }
+  const { range, prerelease, minor, patch } =
+    include || ({} as IncludeOptionObject)
+
+  const types: string[] = [
+    ...(prerelease ? ['prerelease'] : []),
+    'major',
+    ...(minor === false ? [] : ['minor']),
+    ...(patch === false ? [] : ['patch']),
+  ]
+  return [
+    ...(range ? [] : [highlight ? chalk.greenBright('all') : 'all']),
+    types.slice(0, Math.max(1, types.length - 1)).join(', '),
+    ...(types.length > 1 ? [`and ${types[types.length - 1]}`] : []),
+    'versions',
+    ...(pkg ? [`of ${highlight ? chalk.bold(pkg) : pkg}`] : []),
+    ...(range
+      ? [
+          /^[<>]/.test(range)
+            ? `${highlight ? chalk.greenBright(range) : range}`
+            : `satisfying ${highlight ? chalk.greenBright(range) : range}`,
+        ]
+      : []),
+  ].join(' ')
+}
+
 export type Options = {
   include?: IncludeOption | null
 }

src/index.ts

@@ -0,0 +1,54 @@
+import { describe, it } from 'mocha'
+import { expect } from 'chai'
+import { describeFilter } from '../src'
+import chalk from 'chalk'
+
+describe(`describeFilter`, function () {
+  for (const [input, expected] of [
+    [{}, 'all major, minor and patch versions'],
+    [
+      { highlight: true },
+      chalk`{greenBright all} major, minor and patch versions`,
+    ],
+    [{ pkg: 'foo' }, 'all major, minor and patch versions of foo'],
+    [
+      { pkg: 'foo', highlight: true },
+      chalk`{greenBright all} major, minor and patch versions of {bold foo}`,
+    ],
+    [{ include: { range: '>5' } }, 'major, minor and patch versions >5'],
+    [
+      { pkg: 'foo', include: { range: '>5' } },
+      'major, minor and patch versions of foo >5',
+    ],
+    [
+      { pkg: 'foo', include: { range: '>5' }, highlight: true },
+      chalk`major, minor and patch versions of {bold foo} {greenBright >5}`,
+    ],
+    [{ include: { range: '>=5' } }, 'major, minor and patch versions >=5'],
+    [{ include: { range: '<5' } }, 'major, minor and patch versions <5'],
+    [{ include: { range: '<=5' } }, 'major, minor and patch versions <=5'],
+    [
+      { include: { range: '^5.3' } },
+      'major, minor and patch versions satisfying ^5.3',
+    ],
+    [
+      { pkg: 'foo', include: { range: '^5.3' } },
+      'major, minor and patch versions of foo satisfying ^5.3',
+    ],
+    [
+      { include: { range: '~5.3' } },
+      'major, minor and patch versions satisfying ~5.3',
+    ],
+    [{ include: { minor: false } }, 'all major and patch versions'],
+    [{ include: { patch: false } }, 'all major and minor versions'],
+    [{ include: { minor: false, patch: false } }, 'all major versions'],
+    [
+      { include: { patch: false, prerelease: true } },
+      'all prerelease, major and minor versions',
+    ],
+  ] as const) {
+    it(`${JSON.stringify(input)} -> ${expected}`, function () {
+      expect(describeFilter(input)).to.equal(expected)
+    })
+  }
+})

test/describeFilter.test.ts

@@ -1,6 +1,6 @@
 {
   "extends": "./node_modules/@jcoreio/toolchain-typescript/tsconfig.json",
-  "include": ["./src"],
+  "include": ["./src", "./test"],
   "exclude": ["node_modules"],
   "compilerOptions": {
     "lib": ["es2019"]