New config flag: snapshot.prereleaseTemplate, and make snapshot feature stable

.changeset/olive-ducks-camp.md

@@ -0,0 +1,32 @@
+---
+"@changesets/cli": patch
+"@changesets/config": patch
+---
+
+**NOTE: BREAKING CHANGE**
+
+Group snapshot config parameters under a single property called `snapshot`.
+
+To migrate, make sure to update your `config.json`.
+
+Old usage:
+
+```json
+{
+  "___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH": {
+    "useCalculatedVersionForSnapshots": true
+  }
+}
+```
+
+New usage:
+
+```json
+{
+  "___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH": {
+    "snapshot": {
+      "useCalculatedVersion": true
+    }
+  }
+}
+```

.changeset/quick-squids-dance.md

@@ -0,0 +1,5 @@
+---
+"@changesets/cli": minor
+---
+
+Added a new config flag for `changesets version --snapshot` mode: `--snapshot-prerelease-template`

.changeset/short-cats-invent.md

@@ -0,0 +1,5 @@
+---
+"@changesets/git": minor
+---
+
+Added a new helper function: `getCurrentCommitId`

.changeset/strong-geckos-divide.md

@@ -0,0 +1,8 @@
+---
+"@changesets/assemble-release-plan": minor
+"@changesets/cli": minor
+"@changesets/config": minor
+"@changesets/types": minor
+---
+
+Added a new config option: `snapshotPrereleaseTemplate` for customizing the way snapshot release numbers are being composed.

.vscode/settings.json

@@ -1,3 +1,9 @@
 {
-    "typescript.tsdk": "node_modules/typescript/lib"
-}
+  "typescript.tsdk": "node_modules/typescript/lib",
+  "grammarly.selectors": [
+    {
+      "language": "markdown",
+      "scheme": "file"
+    }
+  ]
+}

README.md

@@ -55,6 +55,7 @@ To make releasing easier, you can use [this changesets github action](https://gi
 - [Prereleases](./docs/prereleases.md)
 - [Problems publishing in monorepos](./docs/problems-publishing-in-monorepos.md)
 - [Snapshot releases](./docs/snapshot-releases.md)
+- [Experimental Options](./docs/experimental-options.md)
 
 ## Cool Projects already using Changesets for versioning and changelogs
 

docs/experimental-options.md

@@ -0,0 +1,54 @@
+# Experimental Options
+
+All experimental options are configured in `config.json` under `___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH` flag.
+
+> Please use these experimental flags with caution, and please pay attention to release notes - these config flags might change in patch versions.
+
+## `updateInternalDependents` (type: `'out-of-range' | 'always'`)
+
+Default value: `out-of-range`.
+
+The config flag can be used to add dependent packages to the release (if they are not already a part of it) with patch bumps.
+
+## `onlyUpdatePeerDependentsWhenOutOfRange` (type: `boolean`)
+
+Default value: `false`
+
+When set to `true`, Changesets will only bump peer dependents when `peerDependencies` are leaving the range.
+
+## `snapshot` (type: `object`)
+
+Default value: `undefined`
+
+#### `useCalculatedVersion` (type: `boolean`)
+
+Default value: `false`
+
+When `changesets version --snapshot` is used, the default behavior is to use `0.0.0` as the base version for the snapshot release.
+
+Setting `useCalculatedVersion: true` will change the default behavior and will the planned version, based on the changesets files.
+
+#### `prereleaseTemplate` (type: `string | undefined`)
+
+Default value: `undefined` (see note below)
+
+Configures the suffix for the snapshot releases, using a template with placeholders.
+
+**Available placeholders:**
+
+You can use the following placeholders for customizing the snapshot release version:
+
+- `{tag}` - the name of the snapshot tag, as specified in `--snapshot something`
+- `{commit}` - the Git commit ID
+- `{timestamp}` - Unix timestamp of the time of the release
+- `{datetime}` - date and time of the release (14 characters, for example, `20211213000730`)
+
+> Note: if you are using `--snapshot` with empty tag name, you cannot use `{tag}` as placeholder - this will result in error.
+
+### Integration with `useCalculatedVersion`
+
+You can still use and pass `useCalculatedVersion: boolean` if you wish to have the snapshot releases based on the planned release of changesets, instead of `0.0.0`.
+
+### Default behavior
+
+If you are not specifying `prereleaseTemplate`, the default behavior will fall back to using the following template: `{tag}-{datetime}`, and in cases where the tag is empty (`--snapshot` with no tag name), it will use `{datetime}` only.

packages/apply-release-plan/src/index.test.ts

@@ -52,7 +52,10 @@ class FakeReleasePlan {
       ___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH: {
         onlyUpdatePeerDependentsWhenOutOfRange: false,
         updateInternalDependents: "out-of-range",
-        useCalculatedVersionForSnapshots: false
+        snapshot: {
+          useCalculatedVersion: false,
+          prereleaseTemplate: null
+        }
       },
       ...config
     };
@@ -90,7 +93,10 @@ async function testSetup(
       ___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH: {
         onlyUpdatePeerDependentsWhenOutOfRange: false,
         updateInternalDependents: "out-of-range",
-        useCalculatedVersionForSnapshots: false
+        snapshot: {
+          useCalculatedVersion: false,
+          prereleaseTemplate: null
+        }
       }
     };
   }
@@ -491,7 +497,10 @@ describe("apply release plan", () => {
           ___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH: {
             onlyUpdatePeerDependentsWhenOutOfRange: false,
             updateInternalDependents: "out-of-range",
-            useCalculatedVersionForSnapshots: false
+            snapshot: {
+              useCalculatedVersion: false,
+              prereleaseTemplate: null
+            }
           }
         }
       );
@@ -554,7 +563,10 @@ describe("apply release plan", () => {
           ___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH: {
             onlyUpdatePeerDependentsWhenOutOfRange: false,
             updateInternalDependents: "out-of-range",
-            useCalculatedVersionForSnapshots: false
+            snapshot: {
+              useCalculatedVersion: false,
+              prereleaseTemplate: null
+            }
           }
         }
       );
@@ -744,7 +756,10 @@ describe("apply release plan", () => {
               ___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH: {
                 onlyUpdatePeerDependentsWhenOutOfRange: false,
                 updateInternalDependents: "out-of-range",
-                useCalculatedVersionForSnapshots: false
+                snapshot: {
+                  useCalculatedVersion: false,
+                  prereleaseTemplate: null
+                }
               }
             }
           );
@@ -829,7 +844,10 @@ describe("apply release plan", () => {
               ___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH: {
                 onlyUpdatePeerDependentsWhenOutOfRange: false,
                 updateInternalDependents: "out-of-range",
-                useCalculatedVersionForSnapshots: false
+                snapshot: {
+                  useCalculatedVersion: false,
+                  prereleaseTemplate: null
+                }
               }
             }
           );
@@ -906,7 +924,10 @@ describe("apply release plan", () => {
               ___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH: {
                 onlyUpdatePeerDependentsWhenOutOfRange: false,
                 updateInternalDependents: "out-of-range",
-                useCalculatedVersionForSnapshots: false
+                snapshot: {
+                  useCalculatedVersion: false,
+                  prereleaseTemplate: null
+                }
               }
             }
           );
@@ -983,7 +1004,10 @@ describe("apply release plan", () => {
               ___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH: {
                 onlyUpdatePeerDependentsWhenOutOfRange: false,
                 updateInternalDependents: "out-of-range",
-                useCalculatedVersionForSnapshots: false
+                snapshot: {
+                  useCalculatedVersion: false,
+                  prereleaseTemplate: null
+                }
               }
             }
           );
@@ -1063,7 +1087,10 @@ describe("apply release plan", () => {
               ___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH: {
                 onlyUpdatePeerDependentsWhenOutOfRange: false,
                 updateInternalDependents: "out-of-range",
-                useCalculatedVersionForSnapshots: false
+                snapshot: {
+                  useCalculatedVersion: false,
+                  prereleaseTemplate: null
+                }
               }
             }
           );
@@ -1148,7 +1175,10 @@ describe("apply release plan", () => {
               ___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH: {
                 onlyUpdatePeerDependentsWhenOutOfRange: false,
                 updateInternalDependents: "out-of-range",
-                useCalculatedVersionForSnapshots: false
+                snapshot: {
+                  useCalculatedVersion: false,
+                  prereleaseTemplate: null
+                }
               }
             }
           );
@@ -1225,7 +1255,10 @@ describe("apply release plan", () => {
               ___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH: {
                 onlyUpdatePeerDependentsWhenOutOfRange: false,
                 updateInternalDependents: "out-of-range",
-                useCalculatedVersionForSnapshots: false
+                snapshot: {
+                  useCalculatedVersion: false,
+                  prereleaseTemplate: null
+                }
               }
             }
           );
@@ -1302,7 +1335,10 @@ describe("apply release plan", () => {
               ___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH: {
                 onlyUpdatePeerDependentsWhenOutOfRange: false,
                 updateInternalDependents: "out-of-range",
-                useCalculatedVersionForSnapshots: false
+                snapshot: {
+                  useCalculatedVersion: false,
+                  prereleaseTemplate: null
+                }
               }
             }
           );
@@ -1383,7 +1419,10 @@ describe("apply release plan", () => {
             ___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH: {
               onlyUpdatePeerDependentsWhenOutOfRange: true,
               updateInternalDependents: "out-of-range",
-              useCalculatedVersionForSnapshots: false
+              snapshot: {
+                useCalculatedVersion: false,
+                prereleaseTemplate: null
+              }
             }
           }
         );
@@ -1545,7 +1584,10 @@ describe("apply release plan", () => {
           ___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH: {
             onlyUpdatePeerDependentsWhenOutOfRange: false,
             updateInternalDependents: "out-of-range",
-            useCalculatedVersionForSnapshots: false
+            snapshot: {
+              useCalculatedVersion: false,
+              prereleaseTemplate: null
+            }
           }
         }
       );
@@ -1650,7 +1692,10 @@ describe("apply release plan", () => {
           ___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH: {
             onlyUpdatePeerDependentsWhenOutOfRange: false,
             updateInternalDependents: "out-of-range",
-            useCalculatedVersionForSnapshots: false
+            snapshot: {
+              useCalculatedVersion: false,
+              prereleaseTemplate: null
+            }
           }
         }
       );
@@ -1735,7 +1780,10 @@ describe("apply release plan", () => {
           ___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH: {
             onlyUpdatePeerDependentsWhenOutOfRange: false,
             updateInternalDependents: "out-of-range",
-            useCalculatedVersionForSnapshots: false
+            snapshot: {
+              useCalculatedVersion: false,
+              prereleaseTemplate: null
+            }
           }
         }
       );
@@ -1824,7 +1872,10 @@ describe("apply release plan", () => {
           ___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH: {
             onlyUpdatePeerDependentsWhenOutOfRange: false,
             updateInternalDependents: "out-of-range",
-            useCalculatedVersionForSnapshots: false
+            snapshot: {
+              useCalculatedVersion: false,
+              prereleaseTemplate: null
+            }
           }
         }
       );
@@ -1927,7 +1978,10 @@ describe("apply release plan", () => {
           ___experimentalUnsafeOptions_WILL_CHANGE_IN_PATCH: {
             onlyUpdatePeerDependentsWhenOutOfRange: false,
             updateInternalDependents: "out-of-range",
-            useCalculatedVersionForSnapshots: false
+            snapshot: {
+              useCalculatedVersion: false,
+              prereleaseTemplate: null
+            }
           }
         }
       );

packages/assemble-release-plan/src/index.test.ts

@@ -37,7 +37,9 @@ describe("assemble-release-plan", () => {
       setup.packages,
       defaultConfig,
       undefined,
-      true
+      {
+        tag: undefined
+      }
     );
 
     expect(releases.length).toBe(1);
@@ -50,7 +52,9 @@ describe("assemble-release-plan", () => {
       setup.packages,
       defaultConfig,
       undefined,
-      "foo"
+      {
+        tag: "foo"
+      }
     );
 
     expect(releases.length).toBe(1);