@changesets/types - npm Package Compare versions

Comparing version 4.1.0 to 5.0.0

CHANGELOG.md

 # @changesets/types
 
+## 5.0.0
+
+### Major Changes
+
+- [#768](https://github.com/changesets/changesets/pull/768) [`c87eba6`](https://github.com/changesets/changesets/commit/c87eba6f80a34563b7382f87472c29f6dafb546c) Thanks [@rohit-gohri](https://github.com/rohit-gohri)! - `commit` properties of config types were adjusted to account for this option potentially pointing to a module path.
+
 ## 4.1.0
@@ -4,0 +10,0 @@

dist/declarations/src/index.d.ts

@@ -58,3 +58,3 @@ declare const DEPENDENCY_TYPES: readonly ["dependencies", "devDependencies", "peerDependencies", "optionalDependencies"];
     changelog: false | readonly [string, any];
-    commit: boolean;
+    commit: false | readonly [string, any];
     fixed: Fixed;
@@ -73,3 +73,3 @@ linked: Linked;
     changelog?: false | readonly [string, any] | string;
-    commit?: boolean;
+    commit?: boolean | readonly [string, any] | string;
     fixed?: Fixed;
@@ -103,2 +103,8 @@ linked?: Linked;
 };
+export declare type GetAddMessage = (changeset: Changeset, commitOptions: any) => Promise<string>;
+export declare type GetVersionMessage = (releasePlan: ReleasePlan, commitOptions: any) => Promise<string>;
+export declare type CommitFunctions = {
+    getAddMessage?: GetAddMessage;
+    getVersionMessage?: GetVersionMessage;
+};
 export declare type PreState = {
@@ -105,0 +111,0 @@ mode: "pre" | "exit";

package.json

 {
   "name": "@changesets/types",
-  "version": "4.1.0",
+  "version": "5.0.0",
   "description": "Common types shared between changeset packages",
@@ -5,0 +5,0 @@ "main": "dist/types.cjs.js",

src/index.ts

@@ -66,3 +66,3 @@ // NB: Bolt check uses a different dependnecy set to every other package.
   changelog: false | readonly [string, any];
-  commit: boolean;
+  commit: false | readonly [string, any];
   fixed: Fixed;
@@ -84,3 +84,3 @@ linked: Linked;
   changelog?: false | readonly [string, any] | string;
-  commit?: boolean;
+  commit?: boolean | readonly [string, any] | string;
   fixed?: Fixed;
@@ -127,2 +127,17 @@ linked?: Linked;
 
+export type GetAddMessage = (
+  changeset: Changeset,
+  commitOptions: any
+) => Promise<string>;
+
+export type GetVersionMessage = (
+  releasePlan: ReleasePlan,
+  commitOptions: any
+) => Promise<string>;
+
+export type CommitFunctions = {
+  getAddMessage?: GetAddMessage;
+  getVersionMessage?: GetVersionMessage;
+};
+
 export type PreState = {
@@ -129,0 +144,0 @@ mode: "pre" | "exit";

No alert changes

Improved metrics

Total package byte prevSize

18840

increased by6.36%

Lines of code

248

increased by7.83%

No dependency changes