feat: cleaner config options

psm14 · Sep 7, 2024 · 9fba6bf · 9fba6bf
1 parent c170d62
commit 9fba6bf
Show file tree

Hide file tree

Showing 4 changed files with 59 additions and 9 deletions.
diff --git a/README.md b/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.
diff --git a/plugin/.releaserc.json b/plugin/.releaserc.json
@@ -4,28 +4,28 @@
       "@psm14/semantic-release-path-filter",
       {
         "path": "plugin",
-        "originalPlugin": "@semantic-release/commit-analyzer"
+        "plugin": "@semantic-release/commit-analyzer"
       }
     ],
     [
       "@psm14/semantic-release-path-filter",
       {
         "path": "plugin",
-        "originalPlugin": "@semantic-release/release-notes-generator"
+        "plugin": "@semantic-release/release-notes-generator"
       }
     ],
     [
       "@psm14/semantic-release-path-filter",
       {
         "path": "plugin",
-        "originalPlugin": "@semantic-release/git"
+        "plugin": "@semantic-release/git"
       }
     ],
     [
       "@psm14/semantic-release-path-filter",
       {
         "path": "plugin",
-        "originalPlugin": "@semantic-release/github"
+        "plugin": "@semantic-release/github"
       }
     ]
   ]

diff --git a/plugin/index.js b/plugin/index.js
@@ -25,16 +25,16 @@ function getChangedFiles(commitHash) {
 
 function makePlugin(name) {
   return async function (pluginConfig, context) {
-    const { path, originalPlugin, ...remainingConfig } = pluginConfig;
+    const { path, plugin, ...remainingConfig } = pluginConfig;
 
     const originalPluginName =
       typeof originalPlugin === "string" ? originalPlugin : originalPlugin[0];
     const originalPluginConfig = Array.isArray(originalPlugin)
       ? { ...remainingConfig, ...originalPlugin[1] }
       : remainingConfig;
 
-    const plugin = await import(originalPluginName);
-    if (!(name in plugin)) {
+    const pluginModule = await import(originalPluginName);
+    if (!(name in pluginModule)) {
       return;
     }
 
@@ -45,7 +45,7 @@ function makePlugin(name) {
             commits: filterCommits(context.commits, path),
           }
         : context;
-    return plugin[name](originalPluginConfig, filteredContext);
+    return pluginModule[name](originalPluginConfig, filteredContext);
   };
 }
 

diff --git a/test/.releaserc.json b/test/.releaserc.json
@@ -5,7 +5,7 @@
       "@psm14/semantic-release-path-filter",
       {
         "path": "test",
-        "originalPlugin": "@semantic-release/commit-analyzer"
+        "plugin": "@semantic-release/commit-analyzer"
       }
     ]
   ]