beachball - npm Package Compare versions

Comparing version 2.33.2 to 2.33.3

lib/bump/bumpInPlace.d.ts

@@ -8,3 +8,3 @@ import { BumpInfo } from '../types/BumpInfo';
  */
-export declare function bumpInPlace(bumpInfo: BumpInfo, options: BeachballOptions): BumpInfo;
+export declare function bumpInPlace(bumpInfo: BumpInfo, options: BeachballOptions): void;
 //# sourceMappingURL=bumpInPlace.d.ts.map

lib/bump/bumpInPlace.js

@@ -44,5 +44,4 @@ "use strict";
     Object.keys(bumpInfo.dependentChangedBy).forEach(pkg => modifiedPackages.add(pkg));
-    return bumpInfo;
 }
 exports.bumpInPlace = bumpInPlace;
 //# sourceMappingURL=bumpInPlace.js.map

lib/bump/performBump.js

@@ -75,2 +75,3 @@ "use strict";
     await callHook('postbump', bumpInfo, options);
+    // This is returned from bump() for testing
     return bumpInfo;
@@ -77,0 +78,0 @@ }

lib/changefile/writeChangeFiles.d.ts

@@ -6,3 +6,3 @@ import { ChangeFileInfo } from '../types/ChangeInfo';
  */
-export declare function writeChangeFiles({ changes, cwd, commitChangeFiles, groupChanges, }: {
+export declare function writeChangeFiles(params: {
     changes: ChangeFileInfo[];
@@ -9,0 +9,0 @@ cwd: string;

lib/changefile/writeChangeFiles.js

@@ -16,3 +16,4 @@ "use strict";
  */
-function writeChangeFiles({ changes, cwd, commitChangeFiles = true, groupChanges = false, }) {
+function writeChangeFiles(params) {
+    const { changes, cwd, commitChangeFiles = true, groupChanges = false } = params;
     const changePath = paths_1.getChangePath(cwd);
@@ -19,0 +20,0 @@ const branchName = workspace_tools_1.getBranchName(cwd);

lib/changelog/getPackageChangelogs.js

@@ -12,2 +12,3 @@ "use strict";
 function getPackageChangelogs(changeFileChangeInfos, calculatedChangeTypes, dependentChangedBy, packageInfos, cwd) {
+    var _a, _b, _c, _d;
     const changelogs = {};
@@ -24,4 +25,4 @@ const changeFileCommits = {};
         }
-        changelogs[packageName].comments = changelogs[packageName].comments || {};
-        changelogs[packageName].comments[changeType] = changelogs[packageName].comments[changeType] || [];
+        (_a = changelogs[packageName]).comments ?? (_a.comments = {});
+        (_b = changelogs[packageName].comments)[changeType] ?? (_b[changeType] = []);
         changelogs[packageName].comments[changeType].push({
@@ -47,4 +48,4 @@ author: change.email,
         const changeType = calculatedChangeTypes[dependent];
-        changelogs[dependent].comments = changelogs[dependent].comments || {};
-        changelogs[dependent].comments[changeType] = changelogs[dependent].comments[changeType] || [];
+        (_c = changelogs[dependent]).comments ?? (_c.comments = {});
+        (_d = changelogs[dependent].comments)[changeType] ?? (_d[changeType] = []);
         for (const dep of changedBy) {
@@ -51,0 +52,0 @@ if (dep !== dependent) {

lib/changelog/renderChangelog.js

@@ -33,3 +33,4 @@ "use strict";
         return ([
-            renderChangelogHeader(newVersionChangelog),
+            `# Change Log - ${newVersionChangelog.name}`,
+            `This log was last generated on ${newVersionChangelog.date.toUTCString()} and should not be manually modified.`,
             exports.markerComment,
@@ -48,6 +49,2 @@ await (customRenderPackageChangelog || renderPackageChangelog_1.renderPackageChangelog)(renderInfo),
 exports.renderChangelog = renderChangelog;
-function renderChangelogHeader(changelog) {
-    return (`# Change Log - ${changelog.name}\n\n` +
-        `This log was last generated on ${changelog.date.toUTCString()} and should not be manually modified.`);
-}
 //# sourceMappingURL=renderChangelog.js.map

lib/changelog/renderPackageChangelog.js

@@ -46,3 +46,3 @@ "use strict";
 }
-async function _renderChangeTypeHeader(changeType, renderInfo) {
+async function _renderChangeTypeHeader(changeType) {
     return `### ${groupNames[changeType]}`;
@@ -49,0 +49,0 @@ }

lib/changelog/writeChangelog.d.ts

@@ -1,8 +0,6 @@
-import { PackageInfo } from '../types/PackageInfo';
+import { PackageInfos } from '../types/PackageInfo';
 import { BeachballOptions } from '../types/BeachballOptions';
 import { BumpInfo } from '../types/BumpInfo';
 import { ChangeSet } from '../types/ChangeInfo';
-export declare function writeChangelog(options: BeachballOptions, changeFileChangeInfos: ChangeSet, calculatedChangeTypes: BumpInfo['calculatedChangeTypes'], dependentChangedBy: BumpInfo['dependentChangedBy'], packageInfos: {
-    [pkg: string]: PackageInfo;
-}): Promise<void>;
+export declare function writeChangelog(options: BeachballOptions, changeFileChangeInfos: ChangeSet, calculatedChangeTypes: BumpInfo['calculatedChangeTypes'], dependentChangedBy: BumpInfo['dependentChangedBy'], packageInfos: PackageInfos): Promise<void>;
 //# sourceMappingURL=writeChangelog.d.ts.map

lib/changelog/writeChangelog.js

@@ -58,8 +58,6 @@ "use strict";
             if (isInGroup) {
-                if (!groupedChangelogs[changelogPath]) {
-                    groupedChangelogs[changelogPath] = {
-                        changelogs: [],
-                        masterPackage,
-                    };
-                }
+                groupedChangelogs[changelogPath] ?? (groupedChangelogs[changelogPath] = {
+                    changelogs: [],
+                    masterPackage,
+                });
                 groupedChangelogs[changelogPath].changelogs.push(changelogs[pkg]);
@@ -66,0 +64,0 @@ }

lib/commands/bump.d.ts

 import { BeachballOptions } from '../types/BeachballOptions';
-export declare function bump(options: BeachballOptions): Promise<import("../types/BumpInfo").BumpInfo>;
+import { BumpInfo } from '../types/BumpInfo';
+export declare function bump(options: BeachballOptions): Promise<BumpInfo>;
 //# sourceMappingURL=bump.d.ts.map

lib/commands/bump.js

@@ -9,5 +9,6 @@ "use strict";
     const bumpInfo = gatherBumpInfo_1.gatherBumpInfo(options, getPackageInfos_1.getPackageInfos(options.path));
-    return await performBump_1.performBump(bumpInfo, options);
+    // The bumpInfo is returned for testing
+    return performBump_1.performBump(bumpInfo, options);
 }
 exports.bump = bump;
 //# sourceMappingURL=bump.js.map

lib/options/getDefaultOptions.d.ts

 import { BeachballOptions } from '../types/BeachballOptions';
+/**
+ * Default options.
+ * Note that as of writing, this does not actually set values for all "required" BeachballOptions.
+ */
 export declare function getDefaultOptions(): BeachballOptions;
 //# sourceMappingURL=getDefaultOptions.d.ts.map

lib/options/getDefaultOptions.js

@@ -5,2 +5,6 @@ "use strict";
 const env_1 = require("../env");
+/**
+ * Default options.
+ * Note that as of writing, this does not actually set values for all "required" BeachballOptions.
+ */
 function getDefaultOptions() {
@@ -7,0 +11,0 @@ return {

lib/packageManager/listPackageVersions.d.ts

 import { PackageInfo } from '../types/PackageInfo';
 import { NpmOptions } from '../types/NpmOptions';
-export declare function _clearPackageVersionsCache(): Promise<void>;
+export declare function _clearPackageVersionsCache(): void;
 export declare function listPackageVersionsByTag(packageInfos: PackageInfo[], tag: string | undefined, options: NpmOptions): Promise<{
@@ -5,0 +5,0 @@ [pkg: string]: string | undefined;

lib/packageManager/listPackageVersions.js

@@ -12,3 +12,3 @@ "use strict";
 const NPM_CONCURRENCY = env_1.env.isJest ? 2 : 5;
-async function _clearPackageVersionsCache() {
+function _clearPackageVersionsCache() {
     packageVersionsCache = {};
@@ -15,0 +15,0 @@ }

lib/packageManager/packagePublish.d.ts

 import { PackageInfo } from '../types/PackageInfo';
+import { npmAsync } from './npm';
 import { NpmOptions } from '../types/NpmOptions';
-export declare function packagePublish(packageInfo: PackageInfo, options: NpmOptions): Promise<import("execa").ExecaReturnValue<string> & {
-    success: boolean;
-}>;
+export declare function packagePublish(packageInfo: PackageInfo, options: NpmOptions): ReturnType<typeof npmAsync>;
 //# sourceMappingURL=packagePublish.d.ts.map

lib/publish/tagPackages.js

@@ -22,3 +22,3 @@ "use strict";
         if (changeType === 'none' || packageInfo.private || !packageInfo.combinedOptions.gitTags) {
-            return;
+            continue;
         }
@@ -25,0 +25,0 @@ console.log(`Tagging - ${packageInfo.name}@${packageInfo.version}`);

lib/validation/isValidGroupOptions.d.ts

 import { VersionGroupOptions } from '../types/BeachballOptions';
 import { PackageGroups, PackageInfos } from '../types/PackageInfo';
-export declare function isValidGroupOptions(groups: VersionGroupOptions[]): false | undefined;
+export declare function isValidGroupOptions(groups: VersionGroupOptions[]): boolean;
 /** Validate per-package beachball options are valid for packages in groups */
 export declare function isValidGroupedPackageOptions(packageInfos: PackageInfos, packageGroups: PackageGroups): boolean;
 //# sourceMappingURL=isValidGroupOptions.d.ts.map

lib/validation/isValidGroupOptions.js

@@ -17,2 +17,3 @@ "use strict";
     }
+    return true;
 }
@@ -19,0 +20,0 @@ exports.isValidGroupOptions = isValidGroupOptions;

package.json

 {
   "name": "beachball",
-  "version": "2.33.2",
+  "version": "2.33.3",
   "description": "The Sunniest Semantic Version Bumper",
@@ -5,0 +5,0 @@ "repository": {

Fixed alerts

Deprecated

Maintenance

The maintainer of the package marked it as deprecated. This could indicate that a single version should not be used, or that the package is no longer maintained and any new vulnerabilities will not be fixed.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

348009

increased by0.26%

Lines of code

4379

increased by0.11%

Number of medium maintenance alerts

0

decreased by-100%

No dependency changes