@artsy/changelog 0.1.0

package/README.md

@@ -0,0 +1,52 @@
+# @artsy/changelog
+
+Shared parser for Artsy's PR-description changelog convention. A single source of truth used by
+both [eigen](https://github.com/artsy/eigen) (Danger + `generate-changelog`) and
+[release-lookout](https://github.com/artsy/release-lookout) (release-candidate PR descriptions).
+
+Artsy PRs declare release notes in four `####`-headed sections inside the PR body:
+
+```
+#### Cross-platform user-facing changes
+#### iOS user-facing changes
+#### Android user-facing changes
+#### Dev changes
+```
+
+This package parses a raw PR body into a structured result. It is intentionally **I/O-free** —
+fetching PRs / determining ranges is left to each consumer.
+
+## Usage
+
+```ts
+import { parsePRDescription, changelogTemplateSections } from "@artsy/changelog"
+
+const result = parsePRDescription(pr.body)
+
+switch (result.type) {
+  case "no_changes": // PR contains `#nochangelog`
+    break
+  case "error": // no changelog sections found / all empty
+    break
+  case "changes":
+    result.crossPlatformUserFacingChanges // string[]
+    result.iOSUserFacingChanges
+    result.androidUserFacingChanges
+    result.devChanges
+    break
+}
+```
+
+## API
+
+- `parsePRDescription(body: string): ParseResult` — parse a PR body.
+- `ParseResult` — `{ type: "no_changes" } | { type: "error" } | ({ type: "changes" } & ParseResultChanges)`.
+- `changelogTemplateSections` — the section-key → section-title map.
+
+## Development
+
+```sh
+yarn        # install
+yarn test   # jest
+yarn build  # tsc → dist
+```

package/dist/changelogTemplateSections.d.ts

@@ -0,0 +1,6 @@
+export declare const changelogTemplateSections: {
+    androidUserFacingChanges: string;
+    crossPlatformUserFacingChanges: string;
+    devChanges: string;
+    iOSUserFacingChanges: string;
+};

package/dist/changelogTemplateSections.js

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.changelogTemplateSections = void 0;
+exports.changelogTemplateSections = {
+    androidUserFacingChanges: "Android user-facing changes",
+    crossPlatformUserFacingChanges: "Cross-platform user-facing changes",
+    devChanges: "Dev changes",
+    iOSUserFacingChanges: "iOS user-facing changes",
+};

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { parsePRDescription } from "./parsePRDescription";
+export type { ParseResult, ParseResultChanges } from "./parsePRDescription";
+export { changelogTemplateSections } from "./changelogTemplateSections";

package/dist/index.js

@@ -0,0 +1,7 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.changelogTemplateSections = exports.parsePRDescription = void 0;
+var parsePRDescription_1 = require("./parsePRDescription");
+Object.defineProperty(exports, "parsePRDescription", { enumerable: true, get: function () { return parsePRDescription_1.parsePRDescription; } });
+var changelogTemplateSections_1 = require("./changelogTemplateSections");
+Object.defineProperty(exports, "changelogTemplateSections", { enumerable: true, get: function () { return changelogTemplateSections_1.changelogTemplateSections; } });

package/dist/parsePRDescription.d.ts

@@ -0,0 +1,14 @@
+export declare const parsePRDescription: (description: string) => ParseResult;
+export declare type ParseResult = {
+    type: "error";
+} | {
+    type: "no_changes";
+} | ({
+    type: "changes";
+} & ParseResultChanges);
+export interface ParseResultChanges {
+    crossPlatformUserFacingChanges: string[];
+    iOSUserFacingChanges: string[];
+    androidUserFacingChanges: string[];
+    devChanges: string[];
+}

package/dist/parsePRDescription.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parsePRDescription = void 0;
+const changelogTemplateSections_1 = require("./changelogTemplateSections");
+const parsePRDescription = (description) => {
+    description = stripComments(description);
+    if (description.includes("#nochangelog")) {
+        return { type: "no_changes" };
+    }
+    const lines = description.split("\n").map((line) => line.trim());
+    const result = {
+        androidUserFacingChanges: [],
+        crossPlatformUserFacingChanges: [],
+        devChanges: [],
+        iOSUserFacingChanges: [],
+        type: "changes",
+    };
+    for (const [sectionKey, sectionTitle] of Object.entries(changelogTemplateSections_1.changelogTemplateSections)) {
+        let i = lines.indexOf("#### " + sectionTitle);
+        if (i === -1) {
+            continue;
+        }
+        i++;
+        // either a single text paragraph or a list.
+        const sectionLines = [];
+        while (i < lines.length && lines[i].match(/^( *\w|-[\w ]|\*[\w ]|\s*$)/)) {
+            sectionLines.push(lines[i]);
+            i++;
+        }
+        // @ts-expect-error
+        result[sectionKey] = groupItems(sectionLines);
+    }
+    if (result.androidUserFacingChanges.length === 0 &&
+        result.crossPlatformUserFacingChanges.length === 0 &&
+        result.devChanges.length === 0 &&
+        result.iOSUserFacingChanges.length === 0) {
+        return { type: "error" };
+    }
+    return result;
+};
+exports.parsePRDescription = parsePRDescription;
+function stripComments(text) {
+    return text.replace(/<!--.*?-->/g, "");
+}
+function groupItems(lines) {
+    const result = [];
+    let group = [];
+    for (const line of lines) {
+        if (line.startsWith("-") || line.startsWith("*")) {
+            if (group.length) {
+                result.push(group.join("\n"));
+            }
+            group = [line.slice(1).trim()];
+        }
+        else if (line.match(/^\s*$/)) {
+            // paragraph
+            if (group.length) {
+                result.push(group.join("\n"));
+            }
+            group = [];
+        }
+        else {
+            group.push(line.trim());
+        }
+    }
+    if (group.length) {
+        result.push(group.join("\n"));
+    }
+    return result;
+}

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@artsy/changelog",
+  "version": "0.1.0",
+  "description": "Shared parser for Artsy PR-description changelog sections (used by eigen and release-lookout).",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "clean": "rm -rf dist",
+    "build": "npm run clean && tsc -p .",
+    "prepublishOnly": "npm run build",
+    "watch": "tsc -w -p .",
+    "test": "jest",
+    "type-check": "tsc --noEmit --pretty",
+    "release": "auto shipit"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/artsy/artsy-changelog.git"
+  },
+  "keywords": [
+    "artsy",
+    "changelog",
+    "release"
+  ],
+  "author": "Mounir Dhahri <mounir.dhahri@artsymail.com>",
+  "contributors": [
+    "Art.sy Inc <it@artsymail.com>"
+  ],
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/artsy/artsy-changelog/issues"
+  },
+  "homepage": "https://github.com/artsy/artsy-changelog#readme",
+  "devDependencies": {
+    "@types/jest": "^29.5.13",
+    "jest": "^29.7.0",
+    "ts-jest": "^29.2.5",
+    "typescript": "4.8.4"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  }
+}