feat: add commentWithDev option (#436)

Author: btea

README.md

@@ -213,6 +213,20 @@ Without `--commentWithSha`:
 npm i https://pkg.pr.new/tinybench@123
 ```
 
+> `--commentWithDev` specify whether the generated link includes the `-D` parameter.
+
+With `--commentWithDev`:
+
+```sh
+npm i https://pkg.pr.new/tinybench@123 -D
+```
+
+Without `--commentWithDev`:
+
+```sh
+npm i https://pkg.pr.new/tinybench@123
+```
+
 To customize which package manager is reflected in the comments, use the `--packageManager=XYZ` flag. XYZ can be one of the following: npm (default), pnpm, yarn, or bun. Multiple valid values ​​can also be configured at the same time, such as `--packageManager=ABC,XYZ`.
 
 For repositories with many packages, comments might get too long. In that case, you can use `--only-templates` to only show templates.

packages/app/server/routes/publish.post.ts

@@ -22,6 +22,7 @@ export default eventHandler(async (event) => {
       "sb-package-manager": packageManagerHeader,
       "sb-only-templates": onlyTemplatesHeader,
       "sb-comment-with-sha": commentWithShaHeader,
+      "sb-comment-with-dev": commentWithDevHeader,
     } = getHeaders(event);
     const compact = compactHeader === "true";
     const onlyTemplates = onlyTemplatesHeader === "true";
@@ -30,6 +31,7 @@ export default eventHandler(async (event) => {
     const packageManager: PackageManager =
       (packageManagerHeader as PackageManager) || "npm";
     const commentWithSha = commentWithShaHeader === "true";
+    const commentWithDev = commentWithDevHeader === "true";
 
     if (!key || !runIdHeader || !shasumsHeader) {
       throw createError({
@@ -232,6 +234,7 @@ export default eventHandler(async (event) => {
             compact,
             packageManager,
             bin,
+            commentWithDev,
           ),
         },
         conclusion: "success",
@@ -294,6 +297,7 @@ export default eventHandler(async (event) => {
                   packageManager,
                   commentWithSha ? "sha" : "ref",
                   bin,
+                  commentWithDev,
                 ),
               },
             );
@@ -315,6 +319,7 @@ export default eventHandler(async (event) => {
                   packageManager,
                   comment === "update" ? "ref" : "sha",
                   bin,
+                  commentWithDev,
                 ),
               },
             );

packages/app/server/utils/markdown.ts

@@ -28,6 +28,7 @@ export function generateCommitPublishMessage(
   compact: boolean,
   packageManager: PackageManager,
   bin: boolean,
+  commentWithDev: boolean,
 ) {
   const isMoreThanFour = isMoreThanFourPackages(packages, packageManager);
   const shaMessages = packages
@@ -46,7 +47,7 @@ export function generateCommitPublishMessage(
             shaUrl = `${shaUrl}.tgz`;
           }
 
-          const descriptor = `${pm === "yarn" ? `${packageName}@` : ""}${shaUrl}`;
+          const descriptor = `${pm === "yarn" ? `${packageName}@` : ""}${shaUrl + (commentWithDev ? " -D" : "")}`;
 
           return `
   \`\`\`
@@ -83,6 +84,7 @@ export function generatePullRequestPublishMessage(
   packageManager: PackageManager,
   base: "sha" | "ref",
   bin: boolean,
+  commentWithDev: boolean,
 ) {
   const isMoreThanFour = isMoreThanFourPackages(packages, packageManager);
   const refMessages = packages
@@ -103,7 +105,7 @@ export function generatePullRequestPublishMessage(
 
           return `
   \`\`\`
-  ${bin ? binCommands[pm as PackageManager] : installCommands[pm as PackageManager]} ${refUrl}
+  ${bin ? binCommands[pm as PackageManager] : installCommands[pm as PackageManager]} ${refUrl + (commentWithDev ? " -D" : "")}
   \`\`\`
   `;
         })

packages/cli/index.ts

@@ -94,6 +94,12 @@ const main = defineCommand({
               "use commit sha instead of the pr number in the comment links",
             default: false,
           },
+          commentWithDev: {
+            type: "boolean",
+            description:
+              "should install the packages with the 'dev' tag in the comment links",
+            default: false,
+          },
           "only-templates": {
             type: "boolean",
             description: `generate only stackblitz templates`,
@@ -149,6 +155,7 @@ const main = defineCommand({
           const isOnlyTemplates = !!args["only-templates"];
           const isBinaryApplication = !!args.bin;
           const isCommentWithSha = !!args.commentWithSha;
+          const isCommentWithDev = !!args.commentWithDev;
           const comment: Comment = args.comment as Comment;
           const selectedPackageManager = [
             ...new Set(
@@ -551,6 +558,7 @@ const main = defineCommand({
               "sb-package-manager": selectedPackageManager.join(","),
               "sb-only-templates": `${isOnlyTemplates}`,
               "sb-comment-with-sha": `${isCommentWithSha}`,
+              "sb-comment-with-dev": `${isCommentWithDev}`,
             },
             body: formData,
           });