feat: runOnSave feature

Author: zardoy

package.json

@@ -183,7 +183,7 @@
         "@types/jsonfile": "^6.0.1",
         "@types/node": "^16.11.22",
         "@zardoy/utils": "^0.0.4",
-        "@zardoy/vscode-utils": "^0.0.2",
+        "@zardoy/vscode-utils": "^0.0.6",
         "algoliasearch": "^4.12.1",
         "change-case": "^4.1.2",
         "cross-env": "^7.0.3",

pnpm-lock.yaml

@@ -4,6 +4,24 @@
 //     "title": "Open package.json from..."
 // },
 // enforcePackageManagerUse
+
+type RunOnSaveRule = {
+    relativePathGlob: string
+    command: string,
+    deps?: Array<string | {dep: string, type: string}>
+    /**
+     * Note for `packageJson`: it will fallback to file if closest package.json cannot be find
+     *  @default file */
+    cwd?: 'file' | 'packageJson' | 'workspace'
+    // TODO!
+    /** Checks against locally installed version from node_modules. Raises a warning by default, if  */
+    // semverRange?: string
+    /** Only when `semverRange` is specified */
+    // noInstalledWarning?: boolean
+    /** Kill previous command execution @default true */
+    killPrev: boolean,
+}
+
 export type Configuration = {
     // TOOD describe difference between builtin setting
     /**
@@ -158,6 +176,12 @@ export type Configuration = {
      * @default true
      */
     'codeAction.resolveBranchName': boolean
+    'runOnSave': RunOnSaveRule[]
+    /**
+     * It won't run on after delay auto save type anyway
+     * @default false
+     */
+    'runOnSave.runOnAutoSave': ''
     /** @default true */
     // scriptsCompletion: boolean
     /** @default true */

src/configurationType.ts

@@ -1,5 +1,5 @@
 // GENERATED. DON'T EDIT MANUALLY
-// md5hash: 1d693afb4e91b66ba5c09b32da9e9502
+// md5hash: 853b6cfde74a5b1738b7b1e7c62e5e9d
 {
     "type": "object",
     "properties": {
@@ -189,6 +189,72 @@
             "description": "Disable if action open repository takes a lot of time, in this case it would use `master` branch in url",
             "default": true,
             "type": "boolean"
+        },
+        "runOnSave": {
+            "type": "array",
+            "items": {
+                "type": "object",
+                "properties": {
+                    "relativePathGlob": {
+                        "type": "string"
+                    },
+                    "command": {
+                        "type": "string"
+                    },
+                    "deps": {
+                        "type": "array",
+                        "items": {
+                            "anyOf": [
+                                {
+                                    "type": "object",
+                                    "properties": {
+                                        "dep": {
+                                            "type": "string"
+                                        },
+                                        "type": {
+                                            "type": "string"
+                                        }
+                                    },
+                                    "required": [
+                                        "dep",
+                                        "type"
+                                    ]
+                                },
+                                {
+                                    "type": "string"
+                                }
+                            ]
+                        }
+                    },
+                    "cwd": {
+                        "description": "Note for `packageJson`: it will fallback to file if closest package.json cannot be find",
+                        "default": "file",
+                        "enum": [
+                            "file",
+                            "packageJson",
+                            "workspace"
+                        ],
+                        "type": "string"
+                    },
+                    "killPrev": {
+                        "description": "Kill previous command execution @default true",
+                        "type": "boolean"
+                    }
+                },
+                "required": [
+                    "command",
+                    "killPrev",
+                    "relativePathGlob"
+                ]
+            }
+        },
+        "runOnSave.runOnAutoSave": {
+            "description": "It won't run on after delay auto save type anyway",
+            "default": false,
+            "type": "string",
+            "enum": [
+                ""
+            ]
         }
     },
     "required": [
@@ -204,6 +270,8 @@
         "leadingPackageManager",
         "packageManagerAllowedEnv",
         "runBinCommand.searchLocation",
+        "runOnSave",
+        "runOnSave.runOnAutoSave",
         "scripts.mainScripts",
         "scripts.matchContents",
         "scripts.restartDelay",

src/configurationTypeCache.jsonc

@@ -17,6 +17,7 @@ import { registerClipboardDetection } from './core/clipboardDetection'
 import { activateStatusbar } from './features/statusbar'
 import { registerPackageJsonAutoComplete } from './packageJsonAutoComplete'
 import { startSpecialCommand } from './commands/startSpecialCommand'
+import { registerRunOnSave } from './features/runOnSave'
 
 // TODO command for package diff
 
@@ -49,6 +50,7 @@ export const activate = () => {
     registerClipboardDetection()
     registerPackageJsonAutoComplete()
     activateStatusbar()
+    registerRunOnSave()
 
     if (vscode.workspace.workspaceFolders?.length === 1) void workspaceOpened(vscode.workspace.workspaceFolders[0]!.uri)