Merge pull request #56

Add support for `packageDev` parameter to enable dev package installations

Author: andrey-helldar

README.md

@@ -108,6 +108,11 @@ image:
         # the `packageManager` parameter.
         packageGlobal: false
 
+        # Add a prefix for dev installation (`composer require --dev`, `npm install --save-dev`)
+        # The parameter will be ignored when a non-standard package manager name is specified in
+        # the `packageManager` parameter
+        packageDev: false
+
         # By default, the repository name will be used.
         # For example, for https://github.com/TheDragonCode/github-preview-updater, it will take `preview-updater`
         # and convert it to `Preview Updater`.

resources/schema.json

@@ -72,6 +72,11 @@
                             "description": "Add prefix for global installation",
                             "default": false
                         },
+                        "packageDev": {
+                            "type": "boolean",
+                            "description": "Add a prefix for dev installation",
+                            "default": false
+                        },
                         "title": {
                             "type": "string",
                             "description": "Banner title. The repository name is used by default"

src/types/config.ts

@@ -7,6 +7,7 @@ export interface ImageParameters {
     packageManager: "composer" | "npm" | "yarn" | "auto" | "none" | string;
     packageName?: string;
     packageGlobal: boolean;
+    packageDev: boolean;
 
     title?: string;
     description?: string;
@@ -73,6 +74,7 @@ export const defaultConfig: Config = {
 
             packageManager: "auto",
             packageGlobal: false,
+            packageDev: false,
             packageName: undefined,
 
             title: undefined,

src/utils/image.ts

@@ -4,39 +4,53 @@ import { encodeUri } from "./strings";
 import type { Package } from "../types/package";
 import { detectIcon } from "./icons";
 
-const detectPackageManager = (config: Config, visibility: string): string => {
+const command = (manager: string, dev: boolean, global: boolean): string => {
+    switch (manager) {
+        case "composer":
+            return `composer${global ? " global" : ""} require${dev ? " --dev" : ""}`;
+        case "npm":
+            return `npm install${global ? " -g" : ""}${dev ? " -D" : ""}`;
+        case "yarn":
+            return `yarn${global ? " global" : ""} add${dev ? " -D" : ""}`;
+        default:
+            return manager;
+    }
+};
+
+const detectPackageManager = (config: Config): string => {
     if (hasComposer(config)) {
-        return `composer${visibility} require`;
+        return "composer";
     }
 
     if (hasNpm(config)) {
-        return `npm${visibility} install`;
+        return "npm";
     }
 
     if (hasYarn(config)) {
-        return `yarn${visibility} add`;
+        return "yarn";
     }
 
-    return "";
+    return "none";
 };
 
 const packageManager = (config: Config): string => {
-    const visibility = config.image.parameters.packageGlobal ? " global" : "";
+    const global: boolean = config.image.parameters.packageGlobal;
+    const dev: boolean = config.image.parameters.packageDev;
+    let name: string = config.image.parameters.packageManager;
 
-    switch (config.image.parameters.packageManager) {
-        case "composer":
-            return `composer${visibility} require`;
-        case "npm":
-            return `npm${visibility} install`;
-        case "yarn":
-            return `yarn${visibility} add`;
-        case "auto":
-            return detectPackageManager(config, visibility);
-        case "none":
-            return "";
-        default:
-            return config.image.parameters.packageManager;
+    if (name === "none") {
+        return "";
+    }
+
+    if (name === "auto") {
+        name = detectPackageManager(config);
+    }
+
+    if (["composer", "npm", "yarn"].includes(name)) {
+        return command(name, dev, global);
     }
+
+    return config.image.parameters.packageManager.trim();
 };
 
 const packageName = (image: ImageParameters): string => {

tests/fixtures/configs/composer-dev.yml

@@ -0,0 +1,4 @@
+image:
+    parameters:
+        packageManager: composer
+        packageDev: true

tests/fixtures/configs/composer-global-dev.yml

@@ -0,0 +1,5 @@
+image:
+    parameters:
+        packageManager: composer
+        packageGlobal: true
+        packageDev: true

tests/fixtures/configs/custom-dev.yml

@@ -0,0 +1,4 @@
+image:
+    parameters:
+        packageManager: foo
+        packageDev: true

tests/fixtures/configs/custom-global-dev.yml

@@ -0,0 +1,5 @@
+image:
+    parameters:
+        packageManager: foo
+        packageGlobal: true
+        packageDev: true

tests/fixtures/configs/npm-dev.yml

@@ -0,0 +1,4 @@
+image:
+    parameters:
+        packageManager: npm
+        packageDev: true

tests/fixtures/configs/npm-global-dev.yml

@@ -0,0 +1,5 @@
+image:
+    parameters:
+        packageManager: npm
+        packageGlobal: true
+        packageDev: true