feat(publishable): add the registry_uri query param when a custom registry is defined

Author: travi

src/project-type/cli/lifter.js

@@ -1,5 +1,5 @@
 import {lift as liftPublishable} from '../publishable/index.js';
 
-export default function liftCli({projectRoot, packageDetails}) {
-  return liftPublishable({projectRoot, packageDetails});
+export default function liftCli({projectRoot, packageDetails, registry}) {
+  return liftPublishable({projectRoot, packageDetails, registry});
 }

src/project-type/cli/lifter.test.js

@@ -1,4 +1,4 @@
-import {afterEach, describe, expect, it, vi} from 'vitest';
+import {describe, expect, it, vi} from 'vitest';
 import any from '@travi/any';
 import {when} from 'vitest-when';
 
@@ -8,16 +8,13 @@ import lift from './lifter.js';
 vi.mock('../publishable/lifter');
 
 describe('cli project-type lifter', () => {
-  afterEach(() => {
-    vi.clearAllMocks();
-  });
-
   it('should leverage the publishable lifter', async () => {
     const projectRoot = any.string();
     const packageDetails = any.simpleObject();
+    const registry = any.url();
     const publishableResults = any.simpleObject();
-    when(liftPublishable).calledWith({projectRoot, packageDetails}).thenResolve(publishableResults);
+    when(liftPublishable).calledWith({projectRoot, packageDetails, registry}).thenResolve(publishableResults);
 
-    expect(await lift({projectRoot, packageDetails})).toEqual(publishableResults);
+    expect(await lift({projectRoot, packageDetails, registry})).toEqual(publishableResults);
   });
 });

src/project-type/lifter.js

@@ -7,9 +7,11 @@ function vcsRepositoryHostedOnGithub(vcs) {
   return vcs && 'github' === vcs.host;
 }
 
-export default async function liftProjectType({projectRoot, packageDetails, vcs}) {
-  if (await isPackage({projectRoot, packageDetails})) return liftPackage({projectRoot, packageDetails});
-  if (await isCli({projectRoot, packageDetails})) return liftCli({projectRoot, packageDetails});
+export default async function liftProjectType({projectRoot, packageDetails, vcs, configs}) {
+  const registry = configs?.registries?.registry;
+
+  if (await isPackage({projectRoot, packageDetails})) return liftPackage({projectRoot, packageDetails, registry});
+  if (await isCli({projectRoot, packageDetails})) return liftCli({projectRoot, packageDetails, registry});
 
   let homepage;
 

src/project-type/lifter.test.js

@@ -19,20 +19,22 @@ describe('lift project-type', () => {
   });
 
   it('should lift a package project-type', async () => {
+    const registry = any.url();
     const liftPackageResults = any.simpleObject();
     when(packagePredicate).calledWith({projectRoot, packageDetails}).thenResolve(true);
-    when(liftPackage).calledWith({projectRoot, packageDetails}).thenResolve(liftPackageResults);
+    when(liftPackage).calledWith({projectRoot, packageDetails, registry}).thenResolve(liftPackageResults);
 
-    expect(await lift({projectRoot, packageDetails})).toEqual(liftPackageResults);
+    expect(await lift({projectRoot, packageDetails, configs: {registries: {registry}}})).toEqual(liftPackageResults);
   });
 
   it('should lift a cli project-type', async () => {
+    const registry = any.url();
     const liftCliResults = any.simpleObject();
     when(cliPredicate).calledWith({projectRoot, packageDetails}).thenResolve(true);
     when(packagePredicate).calledWith({projectRoot, packageDetails}).thenResolve(false);
-    when(liftCli).calledWith({projectRoot, packageDetails}).thenResolve(liftCliResults);
+    when(liftCli).calledWith({projectRoot, packageDetails, registry}).thenResolve(liftCliResults);
 
-    expect(await lift({projectRoot, packageDetails})).toEqual(liftCliResults);
+    expect(await lift({projectRoot, packageDetails, configs: {registries: {registry}}})).toEqual(liftCliResults);
   });
 
   it('should define the repository as the homepage if the available project-type lifters do not apply', async () => {

src/project-type/package/lifter.js

@@ -1,5 +1,5 @@
 import {lift as liftPublishable} from '../publishable/index.js';
 
-export default function liftPackage({projectRoot, packageDetails}) {
-  return liftPublishable({projectRoot, packageDetails});
+export default function liftPackage({projectRoot, packageDetails, registry}) {
+  return liftPublishable({projectRoot, packageDetails, registry});
 }

src/project-type/package/lifter.test.js

@@ -1,4 +1,4 @@
-import {afterEach, describe, expect, it, vi} from 'vitest';
+import {describe, expect, it, vi} from 'vitest';
 import any from '@travi/any';
 import {when} from 'vitest-when';
 
@@ -8,16 +8,13 @@ import lift from './lifter.js';
 vi.mock('../publishable/lifter');
 
 describe('package project-type lifter', () => {
-  afterEach(() => {
-    vi.clearAllMocks();
-  });
-
   it('should leverage the publishable lifter', async () => {
     const projectRoot = any.string();
     const packageDetails = any.simpleObject();
+    const registry = any.url();
     const publishableResults = any.simpleObject();
-    when(liftPublishable).calledWith({projectRoot, packageDetails}).thenResolve(publishableResults);
+    when(liftPublishable).calledWith({projectRoot, packageDetails, registry}).thenResolve(publishableResults);
 
-    expect(await lift({projectRoot, packageDetails})).toEqual(publishableResults);
+    expect(await lift({projectRoot, packageDetails, registry})).toEqual(publishableResults);
   });
 });

src/project-type/publishable/badges.js

@@ -1,9 +1,15 @@
-export default function scaffoldPublishableBadges(packageName, accessLevel) {
+function buildNpmBadgeImageUrl(packageName, registry) {
+  const params = new URLSearchParams({logo: 'npm', ...registry && {registry_uri: registry}});
+
+  return `https://img.shields.io/npm/v/${packageName}?${params}`;
+}
+
+export default function scaffoldPublishableBadges(packageName, accessLevel, registry) {
   return {
     consumer: {
       ...'public' === accessLevel && {
         npm: {
-          img: `https://img.shields.io/npm/v/${packageName}?logo=npm`,
+          img: buildNpmBadgeImageUrl(packageName, registry),
           text: 'npm',
           link: `https://www.npmjs.com/package/${packageName}`
         }

src/project-type/publishable/badges.test.js

@@ -18,4 +18,12 @@ describe('badges for publishable project types', async () => {
   it('should return the npm badge for packages with a public access level', () => {
     expect(defineBadges(packageName, 'public').consumer).toEqual({npm: npmBadgeDetails});
   });
+
+  it('should include the registry_uri in the npm badge when a custom registry is provided', () => {
+    const registry = any.url();
+
+    const {searchParams} = new URL(defineBadges(packageName, 'public', registry).consumer.npm.img);
+
+    expect(searchParams.get('registry_uri')).toEqual(registry);
+  });
 });

src/project-type/publishable/lifter.js

@@ -4,7 +4,7 @@ import {mergeIntoExistingPackageJson} from '@form8ion/javascript-core';
 import defineBadges from './badges.js';
 import {lift as liftProvenance} from './provenance/index.js';
 
-export default async function liftPublishable({projectRoot, packageDetails}) {
+export default async function liftPublishable({projectRoot, packageDetails, registry}) {
   const {name: packageName, publishConfig: {access: packageAccessLevel}} = packageDetails;
   const homepage = `https://npm.im/${packageName}`;
 
@@ -16,7 +16,7 @@ export default async function liftPublishable({projectRoot, packageDetails}) {
       homepage,
       dependencies: {javascript: {development: ['publint']}},
       scripts: {'lint:publish': 'publint --strict'},
-      badges: defineBadges(packageName, packageAccessLevel)
+      badges: defineBadges(packageName, packageAccessLevel, registry)
     }
   );
 }

src/project-type/publishable/lifter.test.js

@@ -1,7 +1,7 @@
 import deepmerge from 'deepmerge';
 import {mergeIntoExistingPackageJson} from '@form8ion/javascript-core';
 
-import {afterEach, describe, expect, it, vi} from 'vitest';
+import {describe, expect, it, vi} from 'vitest';
 import any from '@travi/any';
 import {when} from 'vitest-when';
 
@@ -15,21 +15,18 @@ vi.mock('./provenance');
 vi.mock('./badges');
 
 describe('publishable project-type lifter', () => {
-  afterEach(() => {
-    vi.clearAllMocks();
-  });
-
   it('should lift the details of the package project', async () => {
     const projectRoot = any.string();
     const packageName = any.word();
     const packageAccessLevel = any.word();
+    const registry = any.url();
     const packageDetails = {...any.simpleObject(), name: packageName, publishConfig: {access: packageAccessLevel}};
     const provenanceResults = any.simpleObject();
     const mergedResults = any.simpleObject();
     const badgesResults = any.simpleObject();
     const homepage = `https://npm.im/${packageName}`;
     when(liftProvenance).calledWith({packageDetails, projectRoot}).thenResolve(provenanceResults);
-    when(defineBadges).calledWith(packageName, packageAccessLevel).thenReturn(badgesResults);
+    when(defineBadges).calledWith(packageName, packageAccessLevel, registry).thenReturn(badgesResults);
     when(deepmerge).calledWith(
       provenanceResults,
       {
@@ -40,7 +37,7 @@ describe('publishable project-type lifter', () => {
       }
     ).thenReturn(mergedResults);
 
-    expect(await lift({projectRoot, packageDetails})).toEqual(mergedResults);
+    expect(await lift({projectRoot, packageDetails, registry})).toEqual(mergedResults);
     expect(mergeIntoExistingPackageJson).toHaveBeenCalledWith({projectRoot, config: {homepage}});
   });
 });