feature: @putout/plugin-github: set-message-of-commit-fixes

Author: coderaiser

packages/plugin-github/README.md

@@ -24,6 +24,7 @@ npm i @putout/plugin-github -D
 - ✅ [insert-rust](#insert-rust);
 - ✅ [install-bun](#install-bun);
 - ✅ [set-node-versions](#set-node-versions);
+- ✅ [set-message-of-commit-fixes](#set-message-of-commit-fixes);
 - ✅ [update-actions](#update-actions);
 
 ## Config
@@ -34,6 +35,7 @@ npm i @putout/plugin-github -D
         "github/add-continue-on-error-to-coveralls": "on",
         "github/add-continue-on-error-to-add-and-commit": "on",
         "github/set-node-versions": "on",
+        "github/set-message-of-commit-fixes": "on",
         "github/install-bun": "on",
         "github/install-rust": "on",
         "github/convert-npm-to-bun": "on",
@@ -69,6 +71,30 @@ Add ability to continue when cannot submit coverage to Coveralls using [`continu
 +   continue-on-error: true
 ```
 
+## set-message-of-commit-fixes
+
+Checkout in 🐊[**Putout Editor**](https://putout.cloudcmd.io/#/gist/0379415220b31bbbab2d29c155b5b7eb/08839962bed379f7169e05a30ae5e082d9731c75).
+
+```diff
+  uses: EndBug/add-and-commit@v9
+         continue-on-error: true
+         with:
+-          message: chore(${{ env.NAME }}) lint using actions
++          message: "chore: ${{ env.NAME }}: actions: lint ☘️"
+```
+
+You can override message with:
+
+```json
+{
+    "rules": {
+        "github/set-message-of-commit-fixes": ["on", {
+            "message": "✅ fixed with github actions"
+        }]
+    }
+}
+```
+
 ## set-node-versions
 
 ```diff

packages/plugin-github/lib/index.js

@@ -1,3 +1,4 @@
+import * as setMessageOfCommitFixes from './set-message-of-commit-fixes/index.js';
 import * as insertRust from './insert-rust/index.js';
 import * as convertNpmToBun from './convert-npm-to-bun/index.js';
 import * as installBun from './install-bun/index.js';
@@ -14,4 +15,5 @@ export const rules = {
     'install-bun': installBun,
     'convert-npm-to-bun': convertNpmToBun,
     'insert-rust': insertRust,
+    'set-message-of-commit-fixes': setMessageOfCommitFixes,
 };

packages/plugin-github/lib/set-message-of-commit-fixes/fixture/set-message-of-commit-fixes-fix.js

@@ -0,0 +1,16 @@
+__putout_processor_yaml({
+    "name": "Node CI",
+    "on": ["push", "pull_request"],
+    "jobs": {
+        "build": {
+            "steps": [{
+                "name": "Commit fixes",
+                "uses": "EndBug/add-and-commit@v9",
+                "continue-on-error": true,
+                "with": {
+                    "message": "chore: ${{ env.NAME }}: actions: lint ☘️"
+                }
+            }]
+        }
+    }
+});

packages/plugin-github/lib/set-message-of-commit-fixes/fixture/set-message-of-commit-fixes.js

@@ -0,0 +1,21 @@
+__putout_processor_yaml({
+  "name": "Node CI",
+  "on": [
+    "push",
+    "pull_request"
+  ],
+  "jobs": {
+    "build": {
+      "steps": [
+        {
+          "name": "Commit fixes",
+          "uses": "EndBug/add-and-commit@v9",
+          "continue-on-error": true,
+          "with": {
+              "message": "chore(${{ env.NAME }}) lint using actions"
+          }
+        },
+      ]
+    }
+  }
+});

packages/plugin-github/lib/set-message-of-commit-fixes/index.js

@@ -0,0 +1,35 @@
+import {operator} from 'putout';
+
+const {
+    traverseProperties,
+    getTemplateValues,
+    __yaml,
+    setLiteralValue,
+} = operator;
+
+export const report = () => `Set 'message' of 'Commit fixes'`;
+
+export const fix = ({path, message}) => {
+    setLiteralValue(path, message);
+};
+
+export const traverse = ({push, options}) => ({
+    [__yaml](path) {
+        const {message = 'chore: ${{ env.NAME }}: actions: lint ☘️'} = options;
+        
+        const {__object} = getTemplateValues(path, __yaml);
+        
+        for (const messagePath of traverseProperties(__object, 'message')) {
+            const valuePath = messagePath.get('value');
+            const {value} = valuePath.node;
+            
+            if (value === message)
+                break;
+            
+            push({
+                path: valuePath,
+                message,
+            });
+        }
+    },
+});

packages/plugin-github/lib/set-message-of-commit-fixes/index.spec.js

@@ -0,0 +1,23 @@
+import {createTest} from '@putout/test';
+import * as plugin from './index.js';
+
+const test = createTest(import.meta.url, {
+    plugins: [
+        ['set-message-of-commit-fixes', plugin],
+    ],
+});
+
+test('github: set-message-of-commit-fixes: report', (t) => {
+    t.report('set-message-of-commit-fixes', `Set 'message' of 'Commit fixes'`);
+    t.end();
+});
+
+test('github: set-message-of-commit-fixes: no report after transform', (t) => {
+    t.noReportAfterTransform('set-message-of-commit-fixes');
+    t.end();
+});
+
+test('github: set-message-of-commit-fixes: transform', (t) => {
+    t.transform('set-message-of-commit-fixes');
+    t.end();
+});

packages/plugin-github/test/fixture/set-message-of-commit-fixes-fix.js

@@ -0,0 +1,16 @@
+__putout_processor_yaml({
+    "name": "Node CI",
+    "on": ["push", "pull_request"],
+    "jobs": {
+        "build": {
+            "steps": [{
+                "name": "Commit fixes",
+                "uses": "EndBug/add-and-commit@v9",
+                "continue-on-error": true,
+                "with": {
+                    "message": "chore: ${{ env.NAME }}: actions: lint ☘️"
+                }
+            }]
+        }
+    }
+});

packages/plugin-github/test/fixture/set-message-of-commit-fixes.js

@@ -0,0 +1,21 @@
+__putout_processor_yaml({
+  "name": "Node CI",
+  "on": [
+    "push",
+    "pull_request"
+  ],
+  "jobs": {
+    "build": {
+      "steps": [
+        {
+          "name": "Commit fixes",
+          "uses": "EndBug/add-and-commit@v9",
+          "continue-on-error": true,
+          "with": {
+              "message": "chore(${{ env.NAME }}) lint using actions"
+          }
+        },
+      ]
+    }
+  }
+});

packages/plugin-github/test/github.js

@@ -71,3 +71,8 @@ test('plugin-github: transform: set-docker-setup-buildx-version', (t) => {
     t.transform('set-docker-setup-buildx-version');
     t.end();
 });
+
+test('plugin-github: transform: set-message-of-commit-fixes', (t) => {
+    t.transform('set-message-of-commit-fixes');
+    t.end();
+});