feat(update): add option to apply breaking changes during update

Author: djcsdy

cli/index.ts

@@ -24,7 +24,10 @@ export default function cli(): void {
         .option("--webapp")
         .action((destination, options) => cliInit(destination ?? cwd(), options));
 
-    program.command("update [path]").action((path, options) => cliUpdate(path ?? cwd(), options));
+    program
+        .command("update [path]")
+        .option("--breaking")
+        .action((path, options) => cliUpdate(path ?? cwd(), options));
 
     program.parse(argv);
 }

cli/update.ts

@@ -6,10 +6,16 @@ import {bindAsyncResultFn, bindFailureFn} from "../result/result";
 import {UpdateFailureReason, updateProject} from "../project/update";
 import {Project} from "../project/project";
 
-export function cliUpdate(path: string, options: object): void {
+export interface UpdateOptions {
+    readonly breaking?: boolean;
+}
+
+export function cliUpdate(path: string, {breaking}: UpdateOptions): void {
     readProject(path)
         .then(
-            bindAsyncResultFn<ReadProjectFailureReason, UpdateFailureReason, Project>(updateProject)
+            bindAsyncResultFn<ReadProjectFailureReason, UpdateFailureReason, Project>(
+                async project => updateProject({project, breaking})
+            )
         )
         .then(
             bindFailureFn(reasons => {

package.json

@@ -50,6 +50,7 @@
     "@types/recursive-readdir": "2.2.0",
     "@types/semver": "7.3.6",
     "@types/spdx-correct": "2.0.0",
+    "@types/wordwrap": "1.0.1",
     "commander": "8.0.0",
     "empty-dir": "2.0.0",
     "escodegen": "2.0.0",
@@ -66,6 +67,7 @@
     "spdx-license-list": "6.4.0",
     "tslib": "2.3.0",
     "typescript": "4.3.5",
+    "wordwrap": "1.0.0",
     "xml-formatter": "2.4.0",
     "yarn": "1.22.10"
   },

project/update.ts

@@ -1,6 +1,7 @@
 import simpleGit, {SimpleGit} from "simple-git";
 import chain from "@softwareventures/chain";
-import {concat} from "@softwareventures/array";
+import {concat, map} from "@softwareventures/array";
+import wrap = require("wordwrap");
 import {mapFn as mapAsyncFn} from "../collections/async-iterable";
 import {FsStage, InsertResult} from "../fs-stage/fs-stage";
 import {
@@ -30,12 +31,14 @@ export type Update = FsStageUpdate | DirectUpdate;
 export interface FsStageUpdate {
     readonly type: "fs-stage-update";
     readonly log: string;
+    readonly breaking?: readonly string[];
     readonly apply: (stage: FsStage) => Promise<InsertResult>;
 }
 
 export interface DirectUpdate {
     readonly type: "direct-update";
     readonly log: string;
+    readonly breaking?: readonly string[];
     readonly apply: () => Promise<Result<UpdateStepFailureReason>>;
 }
 
@@ -45,8 +48,13 @@ export type UpdateFailureReason = GitNotClean | CommitFailureReason | UpdateStep
 
 export type UpdateStepFailureReason = YarnFixFailureReason | PrettierFixFailureReason;
 
-export async function updateProject(project: Project): Promise<UpdateResult> {
-    const git = simpleGit(project.path);
+export interface UpdateProjectOptions {
+    readonly project: Project;
+    readonly breaking?: boolean;
+}
+
+export async function updateProject(options: UpdateProjectOptions): Promise<UpdateResult> {
+    const git = simpleGit(options.project.path);
 
     return chain([
         updateLintScript,
@@ -56,7 +64,7 @@ export async function updateProject(project: Project): Promise<UpdateResult> {
         addMissingLicense,
         addNewNodeVersionsToPackageJson
     ])
-        .map(mapAsyncFn(step(project, git)))
+        .map(mapAsyncFn(step(options, git)))
         .map(combineAsyncResults).value;
 }
 
@@ -70,14 +78,19 @@ export function gitNotClean(path: string): GitNotClean {
 }
 
 function step(
-    project: Project,
+    {project, breaking}: UpdateProjectOptions,
     git: SimpleGit
 ): (update: (project: Project) => Promise<Update | null>) => Promise<UpdateResult> {
     return async update =>
         git
             .status()
             .then(status => (status.isClean() ? success() : failure([gitNotClean(project.path)])))
             .then(mapAsyncResultFn(async () => update(project)))
+            .then(
+                mapAsyncResultFn(async update =>
+                    breaking || (update?.breaking?.length ?? 0) === 0 ? update : null
+                )
+            )
             .then(bindAsyncResultFn(async update => commitUpdate(project, git, update)));
 }
 
@@ -102,7 +115,7 @@ async function commitUpdate(
             mapAsyncResultFn(async files =>
                 files.length === 0
                     ? undefined
-                    : git.add(files).then(async () => git.commit(update.log))
+                    : git.add(files).then(async () => git.commit(generateCommitLog(update)))
             )
         )
         .then(
@@ -114,6 +127,15 @@ async function commitUpdate(
         );
 }
 
+function generateCommitLog(update: Update): string {
+    return (
+        update.log +
+        map(update.breaking ?? [], breaking => wrap(62)(`\n\nBREAKING CHANGE: ${breaking}`)).join(
+            ""
+        )
+    );
+}
+
 async function writeUpdate(project: Project, update: Update): Promise<UpdateResult> {
     switch (update.type) {
         case "fs-stage-update":

yarn.lock

@@ -701,6 +701,11 @@
   resolved "https://registry.yarnpkg.com/@types/tough-cookie/-/tough-cookie-4.0.0.tgz#fef1904e4668b6e5ecee60c52cc6a078ffa6697d"
   integrity sha512-I99sngh224D0M7XgW1s120zxCt3VYQ3IQsuw3P3jbq5GG4yc79+ZjyKznyOGIQrflfylLgcfekeZW/vk0yng6A==
 
+"@types/wordwrap@1.0.1":
+  version "1.0.1"
+  resolved "https://registry.yarnpkg.com/@types/wordwrap/-/wordwrap-1.0.1.tgz#6cfbe1e2ea03a30831453389e5fdec8be40fd178"
+  integrity sha512-xe+rWyom8xn0laMWH3M7elOpWj2rDQk+3f13RAur89GKsf4FO5qmBNtXXtwepFo2XNgQI0nePdCEStoHFnNvWg==
+
 "@typescript-eslint/eslint-plugin-tslint@^2.31.0 || ^3.0.0 || ^4.0.0 || ^4.21.0":
   version "4.28.0"
   resolved "https://registry.yarnpkg.com/@typescript-eslint/eslint-plugin-tslint/-/eslint-plugin-tslint-4.28.0.tgz#f555425ee8b7dc3de1f5941df51c2c6edf19e891"
@@ -6346,7 +6351,7 @@ word-wrap@^1.0.3, word-wrap@^1.2.3, word-wrap@~1.2.3:
   resolved "https://registry.yarnpkg.com/word-wrap/-/word-wrap-1.2.3.tgz#610636f6b1f703891bd34771ccb17fb93b47079c"
   integrity sha512-Hz/mrNwitNRh/HUAtM/VT/5VH+ygD6DV7mYKZAtHOrbs8U7lvPS6xf7EJKMF0uW1KJCl0H701g3ZGus+muE5vQ==
 
-wordwrap@^1.0.0:
+wordwrap@1.0.0, wordwrap@^1.0.0:
   version "1.0.0"
   resolved "https://registry.yarnpkg.com/wordwrap/-/wordwrap-1.0.0.tgz#27584810891456a4171c8d0226441ade90cbcaeb"
   integrity sha1-J1hIEIkUVqQXHI0CJkQa3pDLyus=