Merge pull request #8 from fryorcraken/pull-origin

fryorcraken · Oct 31, 2022 · 5e77857 · 5e77857
2 parents d3044be + 9cbaa09
commit 5e77857
Show file tree

Hide file tree

Showing 5 changed files with 52 additions and 17 deletions.
diff --git a/README.md b/README.md
@@ -98,6 +98,19 @@ with:
   directory: client/
 ```
 
+### Customizing the Package Manager
+
+By default, the action will attempt to autodetect which package manager to use, but in some cases
+like those who are using a monorepo and the directory option, this may not detect the correct
+manager. You can manually specify the package manager with the `package_manager` option.
+
+```yaml
+with:
+  github_token: ${{ secrets.GITHUB_TOKEN }}
+  directory: packages/client/
+  package_manager: yarn
+```
+
 ## Feedback
 
 Pull requests, feature ideas and bug reports are very welcome. We highly appreciate any feedback.
diff --git a/action.yml b/action.yml
@@ -34,6 +34,9 @@ inputs:
     required: false
     default: "npx size-limit --json"
     description: "The script used to generate size-limit results"
+  package_manager:
+    required: false
+    description: "The package manager used to run the build and install commands. If not provided, the manager will be auto detected. Example values: `yarn`, `npm`, `pnpm`."
 runs:
   using: 'node16'
   main: 'dist/index.js'
diff --git a/dist/index.js b/dist/index.js
@@ -10430,13 +10430,19 @@ const exec_1 = __nccwpck_require__(1514);
 const has_yarn_1 = __importDefault(__nccwpck_require__(3472));
 const has_pnpm_1 = __importDefault(__nccwpck_require__(3974));
 class Term {
-    execSizeLimit(script, buildScript, skipInstall, skipBuild, windowsVerbatimArguments, branch, cleanScript, directory) {
+    /**
+     * Autodetects and gets the current package manager for the current directory, either yarn, pnpm,
+     * or npm. Default is `npm`.
+     *
+     * @param directory The current directory
+     * @returns The detected package manager in use, one of `yarn`, `pnpm`, `npm`
+     */
+    getPackageManager(directory) {
+        return (0, has_yarn_1.default)(directory) ? "yarn" : (0, has_pnpm_1.default)(directory) ? "pnpm" : "npm";
+    }
+    execSizeLimit(script, buildScript, skipInstall, skipBuild, windowsVerbatimArguments, branch, cleanScript, directory, packageManager) {
         return __awaiter(this, void 0, void 0, function* () {
-            const manager = (0, has_yarn_1.default)(directory)
-                ? "yarn"
-                : (0, has_pnpm_1.default)(directory)
-                    ? "pnpm"
-                    : "npm";
+            const manager = packageManager || this.getPackageManager(directory);
             let output = "";
             if (branch) {
                 try {
@@ -10534,11 +10540,12 @@ function run() {
             const cleanScript = (0, core_1.getInput)("clean_script");
             const directory = (0, core_1.getInput)("directory") || process.cwd();
             const windowsVerbatimArguments = (0, core_1.getInput)("windows_verbatim_arguments") === "true";
+            const packageManager = (0, core_1.getInput)("package_manager");
             const octokit = (0, github_1.getOctokit)(token);
             const term = new Term_1.default();
             const limit = new SizeLimit_1.default();
-            const { status, output } = yield term.execSizeLimit(script, buildScript, skipInstall, skipBuild, windowsVerbatimArguments, null, cleanScript, directory);
-            const { output: baseOutput } = yield term.execSizeLimit(script, buildScript, skipInstall, skipBuild, windowsVerbatimArguments, pr.base.ref, cleanScript, directory);
+            const { status, output } = yield term.execSizeLimit(script, buildScript, skipInstall, skipBuild, windowsVerbatimArguments, null, cleanScript, directory, packageManager);
+            const { output: baseOutput } = yield term.execSizeLimit(script, buildScript, skipInstall, skipBuild, windowsVerbatimArguments, pr.base.ref, cleanScript, directory, packageManager);
             let base;
             let current;
             try {

diff --git a/src/Term.ts b/src/Term.ts
@@ -3,21 +3,29 @@ import hasYarn from "has-yarn";
 import hasPNPM from "has-pnpm";
 
 class Term {
+  /**
+   * Autodetects and gets the current package manager for the current directory, either yarn, pnpm,
+   * or npm. Default is `npm`.
+   *
+   * @param directory The current directory
+   * @returns The detected package manager in use, one of `yarn`, `pnpm`, `npm`
+   */
+  getPackageManager(directory?: string): string {
+    return hasYarn(directory) ? "yarn" : hasPNPM(directory) ? "pnpm" : "npm";
+  }
+
   async execSizeLimit(
     script: string,
     buildScript: string,
     skipInstall: boolean,
     skipBuild: boolean,
-    windowsVerbatimArguments: boolean,
+    windowsVerbatimArguments?: boolean,
     branch?: string,
     cleanScript?: string,
-    directory?: string
+    directory?: string,
+    packageManager?: string
   ): Promise<{ status: number; output: string }> {
-    const manager = hasYarn(directory)
-      ? "yarn"
-      : hasPNPM(directory)
-      ? "pnpm"
-      : "npm";
+    const manager = packageManager || this.getPackageManager(directory);
     let output = "";
 
     if (branch) {

diff --git a/src/main.ts b/src/main.ts
@@ -43,6 +43,8 @@ async function run() {
     const directory = getInput("directory") || process.cwd();
     const windowsVerbatimArguments =
       getInput("windows_verbatim_arguments") === "true";
+    const packageManager = getInput("package_manager");
+
     const octokit = getOctokit(token);
     const term = new Term();
     const limit = new SizeLimit();
@@ -55,7 +57,8 @@ async function run() {
       windowsVerbatimArguments,
       null,
       cleanScript,
-      directory
+      directory,
+      packageManager
     );
     const { output: baseOutput } = await term.execSizeLimit(
       script,
@@ -65,7 +68,8 @@ async function run() {
       windowsVerbatimArguments,
       pr.base.ref,
       cleanScript,
-      directory
+      directory,
+      packageManager
     );
 
     let base;