@psm14/semantic-release-path-filter 1.0.1 → 1.1.0

package/README.md

@@ -0,0 +1,50 @@
+# semantic-release-path-filter
+
+A plugin for semantic-release that filters commits based on file paths before passing them to other semantic-release plugins.
+
+## Installation
+
+```bash
+npm install --save-dev @psm14/semantic-release-path-filter
+```
+
+## Usage
+
+This plugin wraps around other semantic-release plugins and filters the commits they receive based on file paths.
+
+```json
+{
+  "plugins": [
+    [
+      "@psm14/semantic-release-path-filter",
+      {
+        "path": "plugin",
+        "plugin": "@semantic-release/commit-analyzer"
+      }
+    ],
+    [
+      "@psm14/semantic-release-path-filter",
+      {
+        "path": "plugin",
+        "plugin": "@semantic-release/release-notes-generator"
+      }
+    ],
+    [
+      "@psm14/semantic-release-path-filter",
+      {
+        "path": "plugin",
+        "plugin": "@semantic-release/git"
+      }
+    ],
+    [
+      "@psm14/semantic-release-path-filter",
+      {
+        "path": "plugin",
+        "plugin": "@semantic-release/github"
+      }
+    ]
+  ]
+}
+```
+
+The `plugin` option may be a string or an array consisting of the name and a configuration object.

package/index.js

@@ -1,21 +1,38 @@
 import { execSync } from "child_process";
 
-function filterCommits(commits, path) {
+function filterCommits({ commits, logger }, path) {
   return commits.filter((commit) => {
     const changedFiles = getChangedFiles(commit.hash);
-    return changedFiles.some((file) => file.startsWith(path));
+    const isRelevant = changedFiles.some((file) => file.startsWith(path));
+    if (!isRelevant) {
+      logger.info(
+        `Filtered out commit ${commit.hash.slice(
+          0,
+          7
+        )} as it doesn't affect '${path}'`
+      );
+    }
+    return isRelevant;
   });
 }
 
+const CHANGED_FILES_MEMO = new Map();
+
 function getChangedFiles(commitHash) {
+  if (CHANGED_FILES_MEMO.has(commitHash)) {
+    return CHANGED_FILES_MEMO.get(commitHash);
+  }
+
   try {
     const result = execSync(
       `git diff-tree --no-commit-id --name-only -r ${commitHash}`,
       { encoding: "utf-8" }
     );
-    return result.trim().split("\n");
+    const changedFiles = result.trim().split("\n");
+    CHANGED_FILES_MEMO.set(commitHash, changedFiles);
+    return changedFiles;
   } catch (error) {
-    console.error(
+    logger.error(
       `Error getting changed files for commit ${commitHash}:`,
       error
     );
@@ -37,13 +54,22 @@ function makePlugin(name) {
       return;
     }
 
+    const scopedLogger = context.logger.scope(
+      ...context.logger.scopeName,
+      originalPluginName
+    );
     const filteredContext =
       "commits" in context
         ? {
             ...context,
-            commits: filterCommits(context.commits, path),
+            commits: filterCommits(context, path),
+            logger: scopedLogger,
           }
-        : context;
+        : {
+            ...context,
+            logger: scopedLogger,
+          };
+
     return pluginModule[name](originalPluginConfig, filteredContext);
   };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@psm14/semantic-release-path-filter",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "main": "index.js",
   "type": "module",
   "scripts": {