npm - @heroku-cli/plugin-devcenter - Versions diffs - 0.0.1 → 2.0.0 - Mend

@heroku-cli/plugin-devcenter 0.0.1 → 2.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (64) hide show

package/LICENSE.txt +22 -0
package/README.md +132 -17
package/dist/commands/devcenter/open.d.ts +9 -0
package/dist/commands/devcenter/open.d.ts.map +1 -0
package/dist/commands/devcenter/open.js +33 -0
package/dist/commands/devcenter/open.js.map +1 -0
package/dist/commands/devcenter/preview.d.ts +14 -0
package/dist/commands/devcenter/preview.d.ts.map +1 -0
package/dist/commands/devcenter/preview.js +40 -0
package/dist/commands/devcenter/preview.js.map +1 -0
package/dist/commands/devcenter/pull.d.ts +12 -0
package/dist/commands/devcenter/pull.d.ts.map +1 -0
package/dist/commands/devcenter/pull.js +52 -0
package/dist/commands/devcenter/pull.js.map +1 -0
package/dist/commands/devcenter/push.d.ts +9 -0
package/dist/commands/devcenter/push.d.ts.map +1 -0
package/dist/commands/devcenter/push.js +105 -0
package/dist/commands/devcenter/push.js.map +1 -0
package/dist/index.d.ts +2 -0
package/dist/index.d.ts.map +1 -0
package/dist/index.js +2 -0
package/dist/index.js.map +1 -0
package/dist/lib/article-file.d.ts +21 -0
package/dist/lib/article-file.d.ts.map +1 -0
package/dist/lib/article-file.js +48 -0
package/dist/lib/article-file.js.map +1 -0
package/dist/lib/article-not-found.d.ts +3 -0
package/dist/lib/article-not-found.d.ts.map +1 -0
package/dist/lib/article-not-found.js +16 -0
package/dist/lib/article-not-found.js.map +1 -0
package/dist/lib/article-resolve.d.ts +23 -0
package/dist/lib/article-resolve.d.ts.map +1 -0
package/dist/lib/article-resolve.js +61 -0
package/dist/lib/article-resolve.js.map +1 -0
package/dist/lib/article-split.d.ts +9 -0
package/dist/lib/article-split.d.ts.map +1 -0
package/dist/lib/article-split.js +15 -0
package/dist/lib/article-split.js.map +1 -0
package/dist/lib/devcenter-client.d.ts +39 -0
package/dist/lib/devcenter-client.d.ts.map +1 -0
package/dist/lib/devcenter-client.js +119 -0
package/dist/lib/devcenter-client.js.map +1 -0
package/dist/lib/heroku-api-auth.d.ts +7 -0
package/dist/lib/heroku-api-auth.d.ts.map +1 -0
package/dist/lib/heroku-api-auth.js +12 -0
package/dist/lib/heroku-api-auth.js.map +1 -0
package/dist/lib/paths.d.ts +18 -0
package/dist/lib/paths.d.ts.map +1 -0
package/dist/lib/paths.js +48 -0
package/dist/lib/paths.js.map +1 -0
package/dist/lib/preview-server.d.ts +17 -0
package/dist/lib/preview-server.d.ts.map +1 -0
package/dist/lib/preview-server.js +94 -0
package/dist/lib/preview-server.js.map +1 -0
package/dist/lib/preview-templates.d.ts +7 -0
package/dist/lib/preview-templates.d.ts.map +1 -0
package/dist/lib/preview-templates.js +93 -0
package/dist/lib/preview-templates.js.map +1 -0
package/oclif.manifest.json +172 -1
package/package.json +86 -47
package/lib/commands/docs.d.ts +0 -25
package/lib/commands/docs.js +0 -29
package/lib/index.d.ts +0 -2
package/lib/index.js +0 -3

package/dist/lib/preview-templates.js ADDED Viewed

@@ -0,0 +1,93 @@
+function esc(s) {
+    return s
+        .replaceAll('&', '&amp;')
+        .replaceAll('<', '&lt;')
+        .replaceAll('>', '&gt;')
+        .replaceAll('"', '&quot;');
+}
+const PREVIEW_CSS = `
+body { font-family: system-ui, -apple-system, sans-serif; margin: 0; line-height: 1.5; color: #1b1b1b; }
+.page-wrapper { min-height: 100vh; display: flex; flex-direction: column; }
+header { background: linear-gradient(135deg, #79589f 0%, #4b2866 100%); color: #fff; padding: 0.75rem 0; }
+.heroku-header .container { max-width: 1200px; margin: 0 auto; padding: 0 1rem; display: flex; align-items: center; gap: 1rem; }
+.heroku-brand { color: #fff; font-weight: 600; text-decoration: none; }
+.nav { list-style: none; margin: 0; padding: 0; display: flex; gap: 1rem; }
+.nav a { color: #e8e0f0; text-decoration: none; }
+.container { max-width: 1200px; margin: 0 auto; padding: 1rem; }
+.content { max-width: 48rem; }
+footer { margin-top: auto; border-top: 1px solid #e5e5e5; padding: 1rem 0; font-size: 0.875rem; }
+footer ul { list-style: none; margin: 0; padding: 0; display: flex; gap: 1rem; }
+.warning { background: #fff3cd; border: 1px solid #ffc107; padding: 1rem; border-radius: 4px; }
+#table-of-contents { margin-bottom: 1.5rem; }
+pre { background: #f5f5f5; padding: 1rem; overflow: auto; border-radius: 4px; }
+code { background: #f5f5f5; padding: 0.15em 0.35em; border-radius: 3px; font-size: 0.9em; }
+.last-updated { color: #666; font-size: 0.9rem; }
+`;
+export function renderPreviewPage(article, slug) {
+    const title = article.metadata.title || slug;
+    let inner;
+    if (article.html) {
+        const tocItems = article.toc
+            .map(s => `<li><a href="#${esc(s.id)}">${esc(s.text)}</a></li>`)
+            .join('');
+        const tocBlock = tocItems.length > 0
+            ? `<div id="table-of-contents"><h3>Table of Contents</h3><ul>${tocItems}</ul></div>`
+            : '';
+        inner = `
+<article class="js-autolink">
+  <h1>${esc(article.metadata.title)}</h1>
+  <p class="last-updated">Last updated (local preview)</p>
+  ${tocBlock}
+  ${article.html}
+</article>`;
+    }
+    else if (article.parsingError) {
+        inner = `<article><div class="warning"><p>Parsing error: ${esc(article.parsingError)}</p></div></article>`;
+    }
+    else {
+        inner = '<article><p>No content.</p></article>';
+    }
+    const html = `<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title>Preview: ${esc(title)}</title>
+  <style>${PREVIEW_CSS}</style>
+  <script>
+  try {
+    var es = new EventSource('/stream');
+    es.onmessage = function() { document.location.reload(); };
+    es.onerror = function() { es.close(); };
+  } catch (e) { console.error(e); }
+  </script>
+</head>
+<body>
+  <div class="page-wrapper">
+    <header><div class="heroku-header"><div class="container">
+      <span class="heroku-brand">Heroku Dev Center</span>
+      <ul class="nav"><li><a href="#">Local Preview</a></li></ul>
+    </div></div></header>
+    <div class="container"><div class="content">${inner}</div></div>
+    <footer><div class="container"><ul>
+      <li><a href="https://www.heroku.com/home">heroku.com</a></li>
+      <li><a href="https://www.heroku.com/policy/privacy">Privacy Policy</a></li>
+    </ul></div></footer>
+  </div>
+</body>
+</html>`;
+    return { html, title };
+}
+export function renderNotFoundPage(referrerUrl) {
+    const back = referrerUrl
+        ? `<a href="${esc(referrerUrl)}">Return to your article</a>.`
+        : '';
+    return `<!DOCTYPE html>
+<html lang="en"><head><meta charset="utf-8"><title>Not found</title><style>${PREVIEW_CSS}</style></head>
+<body><div class="container content">
+<article><h1>Ooops</h1><div class="warning"><p>
+You clicked a relative link for a URL not available locally. ${back}
+</p></div></article>
+</div></body></html>`;
+}
+//# sourceMappingURL=preview-templates.js.map

package/dist/lib/preview-templates.js.map ADDED Viewed

@@ -0,0 +1 @@

+ {"version":3,"file":"preview-templates.js","sourceRoot":"","sources":["../../src/lib/preview-templates.ts"],"names":[],"mappings":"AAEA,SAAS,GAAG,CAAC,CAAS;IACpB,OAAO,CAAC;SACL,UAAU,CAAC,GAAG,EAAE,OAAO,CAAC;SACxB,UAAU,CAAC,GAAG,EAAE,MAAM,CAAC;SACvB,UAAU,CAAC,GAAG,EAAE,MAAM,CAAC;SACvB,UAAU,CAAC,GAAG,EAAE,QAAQ,CAAC,CAAA;AAC9B,CAAC;AAED,MAAM,WAAW,GAAG;;;;;;;;;;;;;;;;;CAiBnB,CAAA;AAED,MAAM,UAAU,iBAAiB,CAAC,OAAoB,EAAE,IAAY;IAClE,MAAM,KAAK,GAAG,OAAO,CAAC,QAAQ,CAAC,KAAK,IAAI,IAAI,CAAA;IAC5C,IAAI,KAAa,CAAA;IACjB,IAAI,OAAO,CAAC,IAAI,EAAE,CAAC;QACjB,MAAM,QAAQ,GAAG,OAAO,CAAC,GAAG;aACzB,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,iBAAiB,GAAG,CAAC,CAAC,CAAC,EAAE,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC;aAC/D,IAAI,CAAC,EAAE,CAAC,CAAA;QACX,MAAM,QAAQ,GACV,QAAQ,CAAC,MAAM,GAAG,CAAC;YACnB,CAAC,CAAC,6DAA6D,QAAQ,aAAa;YACpF,CAAC,CAAC,EAAE,CAAA;QACR,KAAK,GAAG;;QAEJ,GAAG,CAAC,OAAO,CAAC,QAAQ,CAAC,KAAK,CAAC;;IAE/B,QAAQ;IACR,OAAO,CAAC,IAAI;WACL,CAAA;IACT,CAAC;SAAM,IAAI,OAAO,CAAC,YAAY,EAAE,CAAC;QAChC,KAAK,GAAG,mDAAmD,GAAG,CAAC,OAAO,CAAC,YAAY,CAAC,sBAAsB,CAAA;IAC5G,CAAC;SAAM,CAAC;QACN,KAAK,GAAG,uCAAuC,CAAA;IACjD,CAAC;IAED,MAAM,IAAI,GAAG;;;;;oBAKK,GAAG,CAAC,KAAK,CAAC;WACnB,WAAW;;;;;;;;;;;;;;;kDAe4B,KAAK;;;;;;;QAO/C,CAAA;IACN,OAAO,EAAC,IAAI,EAAE,KAAK,EAAC,CAAA;AACtB,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,WAAoB;IACrD,MAAM,IAAI,GACN,WAAW;QACX,CAAC,CAAC,YAAY,GAAG,CAAC,WAAW,CAAC,+BAA+B;QAC7D,CAAC,CAAC,EAAE,CAAA;IACR,OAAO;6EACoE,WAAW;;;+DAGzB,IAAI;;qBAE9C,CAAA;AACrB,CAAC"}

package/oclif.manifest.json CHANGED Viewed

@@ -1 +1,172 @@
-{"version":"0.0.1","commands":{"docs":{"id":"docs","description":"opens the Heroku Dev Center","pluginName":"@heroku-cli/plugin-devcenter","pluginType":"core","aliases":[],"examples":["$ heroku docs\nOpening Dev Center in your default browser...\n"],"flags":{"help":{"name":"help","type":"boolean","char":"h","description":"show CLI help"}},"args":[{"name":"query"}]}}}
+{
+  "commands": {
+    "devcenter:open": {
+      "aliases": [],
+      "args": {
+        "slug": {
+          "description": "article slug (e.g. ps for https://devcenter.heroku.com/articles/ps)",
+          "name": "slug",
+          "required": true
+        }
+      },
+      "description": "open a Dev Center article in the browser (uses Heroku credentials for private or draft content when available)",
+      "flags": {
+        "prompt": {
+          "description": "interactively prompt for command arguments and flags",
+          "helpGroup": "GLOBAL",
+          "name": "prompt",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "devcenter:open",
+      "pluginAlias": "@heroku-cli/plugin-devcenter",
+      "pluginName": "@heroku-cli/plugin-devcenter",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "promptFlagActive": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "devcenter",
+        "open.js"
+      ]
+    },
+    "devcenter:preview": {
+      "aliases": [],
+      "args": {
+        "slug": {
+          "description": "article slug (local <slug>.md file)",
+          "name": "slug",
+          "required": true
+        }
+      },
+      "description": "preview a local Dev Center article in the browser with live reload",
+      "flags": {
+        "prompt": {
+          "description": "interactively prompt for command arguments and flags",
+          "helpGroup": "GLOBAL",
+          "name": "prompt",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "host": {
+          "description": "bind host for the preview server",
+          "name": "host",
+          "default": "127.0.0.1",
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "port": {
+          "description": "port for the preview server",
+          "name": "port",
+          "default": 3000,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "devcenter:preview",
+      "pluginAlias": "@heroku-cli/plugin-devcenter",
+      "pluginName": "@heroku-cli/plugin-devcenter",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "promptFlagActive": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "devcenter",
+        "preview.js"
+      ]
+    },
+    "devcenter:pull": {
+      "aliases": [],
+      "args": {
+        "slugOrUrl": {
+          "description": "article slug or full Dev Center article URL",
+          "name": "slugOrUrl",
+          "required": true
+        }
+      },
+      "description": "save a local copy of a Dev Center article",
+      "flags": {
+        "prompt": {
+          "description": "interactively prompt for command arguments and flags",
+          "helpGroup": "GLOBAL",
+          "name": "prompt",
+          "allowNo": false,
+          "type": "boolean"
+        },
+        "force": {
+          "char": "f",
+          "description": "overwrite an existing local file without prompting",
+          "name": "force",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "devcenter:pull",
+      "pluginAlias": "@heroku-cli/plugin-devcenter",
+      "pluginName": "@heroku-cli/plugin-devcenter",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "promptFlagActive": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "devcenter",
+        "pull.js"
+      ]
+    },
+    "devcenter:push": {
+      "aliases": [],
+      "args": {
+        "slug": {
+          "description": "article slug (optional .md suffix is ignored)",
+          "name": "slug",
+          "required": true
+        }
+      },
+      "description": "update a Dev Center article from a local markdown file",
+      "flags": {
+        "prompt": {
+          "description": "interactively prompt for command arguments and flags",
+          "helpGroup": "GLOBAL",
+          "name": "prompt",
+          "allowNo": false,
+          "type": "boolean"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "devcenter:push",
+      "pluginAlias": "@heroku-cli/plugin-devcenter",
+      "pluginName": "@heroku-cli/plugin-devcenter",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "promptFlagActive": true,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "devcenter",
+        "push.js"
+      ]
+    }
+  },
+  "version": "2.0.0"
+}

package/package.json CHANGED Viewed

@@ -1,60 +1,99 @@
 {
   "name": "@heroku-cli/plugin-devcenter",
-  "description": "open the Heroku Dev Center",
-  "version": "0.0.1",
-  "author": "Stephen Barlow @StephenBarlow",
-  "bugs": "https://github.com/heroku/heroku-devcenter-plugin/issues",
-  "dependencies": {
-    "@oclif/command": "^1",
-    "@oclif/config": "^1",
-    "heroku-cli-util": "^8.0.9",
-    "opn": "^5.3.0",
-    "tslib": "^1"
-  },
-  "devDependencies": {
-    "@oclif/dev-cli": "^1",
-    "@oclif/plugin-help": "^1",
-    "@oclif/test": "^1",
-    "@oclif/tslint": "^1",
-    "@types/chai": "^4",
-    "@types/mocha": "^5",
-    "@types/node": "^10",
-    "chai": "^4",
-    "globby": "^8",
-    "mocha": "^5",
-    "nyc": "^11",
-    "ts-node": "^6",
-    "tslint": "^5",
-    "typescript": "^2.8"
-  },
-  "engines": {
-    "node": ">=8.0.0"
+  "description": "Heroku CLI plugin to interact with Heroku Dev Center",
+  "version": "2.0.0",
+  "author": "Heroku",
+  "type": "module",
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/heroku/devcenter-cli.git"
   },
-  "files": [
-    "/lib",
-    "/oclif.manifest.json"
-  ],
-  "homepage": "https://github.com/heroku/heroku-devcenter-plugin",
+  "bugs": "https://github.com/heroku/devcenter-cli/issues",
+  "homepage": "https://github.com/heroku/devcenter-cli",
   "keywords": [
-    "oclif-plugin"
+    "heroku-plugin",
+    "oclif"
+  ],
+  "files": [
+    "dist",
+    "oclif.manifest.json"
   ],
-  "license": "MIT",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
   "oclif": {
-    "commands": "./lib/commands",
-    "bin": "oclif-example",
+    "bin": "heroku",
+    "commands": "./dist/commands",
     "devPlugins": [
       "@oclif/plugin-help"
-    ]
+    ],
+    "topics": {
+      "devcenter": {
+        "description": "interact with Heroku Dev Center"
+      }
+    }
   },
-  "repository": {
-    "type": "git",
-    "url": "https://github.com/heroku/heroku-devcenter-plugin"
+  "engines": {
+    "node": ">=22"
   },
   "scripts": {
-    "postpack": "rm -f oclif.manifest.json",
-    "posttest": "tsc -p test --noEmit && tslint -p test -t stylish",
-    "prepack": "rm -rf lib && tsc && oclif-dev manifest && oclif-dev readme",
-    "test": "nyc mocha --forbid-only \"test/**/*.test.ts\"",
-    "version": "oclif-dev readme && git add README.md"
+    "build": "npm run clean && tsc && oclif manifest && oclif readme",
+    "clean": "rm -rf dist",
+    "lint": "eslint .",
+    "lint:fix": "eslint . --fix",
+    "prepare": "npm run build",
+    "posttest": "npm run lint",
+    "pretest": "npm run build",
+    "readme": "oclif readme",
+    "test": "c8 --all --check-coverage --reporter=lcov --reporter=text-summary mocha --forbid-only \"test/**/*.test.ts\"",
+    "version": "oclif readme && git add README.md"
+  },
+  "dependencies": {
+    "@heroku-cli/command": "^13.0.0-beta.1",
+    "@heroku/heroku-cli-util": "^10.8.0",
+    "@oclif/core": "^4.3.0",
+    "@oclif/plugin-help": "^6.2.36",
+    "cheerio": "^1.2.0",
+    "chokidar": "^5.0.0",
+    "debug": "^4.4.3",
+    "express": "^5.2.1",
+    "markdown-it": "^14.1.1",
+    "markdown-it-anchor": "^9.2.0",
+    "open": "^11.0.0",
+    "yaml": "^2.8.3"
+  },
+  "overrides": {
+    "mocha": {
+      "serialize-javascript": "^7.0.5"
+    }
+  },
+  "devDependencies": {
+    "@heroku-cli/test-utils": "^0.2.0",
+    "@types/chai": "^5.2.3",
+    "@types/debug": "^4.1.12",
+    "@types/express": "^5.0.6",
+    "@types/markdown-it": "^14.1.2",
+    "@types/mocha": "^10.0.10",
+    "@types/node": "^22.15.3",
+    "@types/supertest": "^7.2.0",
+    "ansis": "^3.17.0",
+    "c8": "^11.0.0",
+    "chai": "^6.2.2",
+    "eslint": "^9.39.4",
+    "eslint-config-oclif": "^6.0.156",
+    "eslint-plugin-mocha": "^11.2.0",
+    "mocha": "^11.7.5",
+    "nock": "^14.0.12",
+    "oclif": "^4.22.81",
+    "sinon": "^21.0.3",
+    "supertest": "^7.2.2",
+    "tsx": "^4.21.0",
+    "typescript": "^5.4.0"
   }
 }

package/lib/commands/docs.d.ts DELETED Viewed

@@ -1,25 +0,0 @@
-import { Command } from '@oclif/command';
-export default class Docs extends Command {
-    static description: string;
-    static examples: string[];
-    static flags: {
-        help: {
-            name: string;
-            char?: "a" | "b" | "i" | "p" | "q" | "s" | "u" | "g" | "c" | "d" | "e" | "f" | "h" | "j" | "k" | "l" | "m" | "n" | "o" | "r" | "t" | "v" | "x" | "y" | "z" | "A" | "B" | "C" | "D" | "E" | "F" | "G" | "H" | "I" | "J" | "K" | "L" | "M" | "N" | "O" | "P" | "Q" | "R" | "S" | "T" | "U" | "V" | "X" | "Y" | "Z" | undefined;
-            description?: string | undefined;
-            hidden?: boolean | undefined;
-            required?: boolean | undefined;
-            dependsOn?: string[] | undefined;
-            exclusive?: string[] | undefined;
-            env?: string | undefined;
-            parse(input: boolean, context: any): void;
-        } & {
-            type: "boolean";
-            allowNo: boolean;
-        };
-    };
-    static args: {
-        name: string;
-    }[];
-    run(): Promise<void>;
-}

package/lib/commands/docs.js DELETED Viewed

@@ -1,29 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-const command_1 = require("@oclif/command");
-const cli = require('heroku-cli-util');
-const opn = require('opn');
-class Docs extends command_1.Command {
-    async run() {
-        const { args, flags } = this.parse(Docs);
-        if (args.query) {
-            this.log(`Searching Dev Center for ${cli.color.magenta(args.query)}...`);
-            opn(`https://devcenter.heroku.com/search?q=${args.query}`);
-        }
-        else {
-            this.log('Opening Dev Center...');
-            opn('https://devcenter.heroku.com');
-        }
-    }
-}
-Docs.description = 'opens the Heroku Dev Center';
-Docs.examples = [
-    `$ heroku docs
-Opening Dev Center in your default browser...
-`,
-];
-Docs.flags = {
-    help: command_1.flags.help({ char: 'h' }),
-};
-Docs.args = [{ name: 'query' }];
-exports.default = Docs;

package/lib/index.d.ts DELETED Viewed

	@@ -1,2 +0,0 @@
1	- declare const _default: {};
2	- export default _default;

package/lib/index.js DELETED Viewed

@@ -1,3 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = {};