style: provide a Lua 5.1 formatting baseline

Injection.lua

@@ -14,4 +14,3 @@ RUNTIME = {
     --- Plugin directory
     pluginDirPath = "",
 }
-

README.md

@@ -17,6 +17,22 @@ Keep runtime resources under `lib/`. Shared checks validate metadata, required h
 files and Lua syntax and build the same package used for publishing. They do not
 run lifecycle hooks or install SDKs. See the [package contract](https://github.com/version-fox/plugin-manifest-action#插件包与检查范围).
 
+## Lua checks and formatting
+
+Use [StyLua 2.5.2](https://github.com/JohnnyMorganz/StyLua/releases/tag/v2.5.2)
+with the included `stylua.toml` configuration:
+
+```shell
+stylua .
+stylua --check .
+```
+
+The shared PR check validates metadata, required hooks and Lua 5.1 syntax.
+Repositories with `stylua.toml` also receive a read-only format check after the
+shared tool release containing that check is published. Existing plugins can opt
+in by adding this configuration and formatting their Lua files together.
+Plugin behavior tests remain separate from syntax and style checks.
+
 ## Publish a plugin
 
 Merge your changes into the default branch, then open **Actions → Plugin → Run

hooks/available.lua

@@ -13,8 +13,8 @@ function PLUGIN:Available(ctx)
                 {
                     name = "npm",
                     version = "8.8.8",
-                }
-            }
-        }
+                },
+            },
+        },
     }
-end
+end

hooks/env_keys.lua

@@ -10,24 +10,22 @@ function PLUGIN:EnvKeys(ctx)
     local mpath = mainSdkInfo.path
     local mversion = mainSdkInfo.version
     local mname = mainSdkInfo.name
-    local sdkInfo = ctx.sdkInfo['sdk-name']
+    local sdkInfo = ctx.sdkInfo["sdk-name"]
     local path = sdkInfo.path
     local version = sdkInfo.version
     local name = sdkInfo.name
     return {
         {
             key = "JAVA_HOME",
-            value = mainPath
+            value = mainPath,
         },
         {
             key = "PATH",
-            value = mainPath .. "/bin"
+            value = mainPath .. "/bin",
         },
         {
             key = "PATH",
-            value = mainPath .. "/bin2"
+            value = mainPath .. "/bin2",
         },
-
     }
-
-end
+end

hooks/parse_legacy_file.lua

@@ -7,6 +7,6 @@ function PLUGIN:ParseLegacyFile(ctx)
     local versions = ctx:getInstalledVersions()
 
     return {
-        version = "xxx"
+        version = "xxx",
     }
-end
+end

hooks/post_install.lua

@@ -4,9 +4,9 @@
 function PLUGIN:PostInstall(ctx)
     --- ctx.rootPath SDK installation directory
     local rootPath = ctx.rootPath
-    local sdkInfo = ctx.sdkInfo['sdk-name']
+    local sdkInfo = ctx.sdkInfo["sdk-name"]
     local path = sdkInfo.path
     local version = sdkInfo.version
     local name = sdkInfo.name
     local note = sdkInfo.note
-end
+end

hooks/pre_install.lua

@@ -33,7 +33,7 @@ function PLUGIN:PreInstall(ctx)
                 sha1 = "xxx",
                 --- sha512 checksum [optional]
                 sha512 = "xx",
-            }
-        }
+            },
+        },
     }
-end
+end

hooks/pre_uninstall.lua

@@ -1,9 +1,8 @@
-
 --- This is called before the SDK is uninstalled.
 --- @param ctx table Context information
 function PLUGIN:PreUninstall(ctx)
     local mainSdkInfo = ctx.main
     local mpath = mainSdkInfo.path
     local mversion = mainSdkInfo.version
     local mname = mainSdkInfo.name
-end
+end

hooks/pre_use.lua

@@ -8,7 +8,7 @@ function PLUGIN:PreUse(ctx)
     local previousVersion = ctx.previousVersion
 
     --- installed sdks
-    local sdkInfo = ctx.installedSdks['version']
+    local sdkInfo = ctx.installedSdks["version"]
     local path = sdkInfo.path
     local name = sdkInfo.name
     local version = sdkInfo.version
@@ -24,4 +24,4 @@ function PLUGIN:PreUse(ctx)
     return {
         version = version,
     }
-end
+end

lib/util.lua

@@ -1,8 +1,7 @@
-
 local util = {}
 
 function util:DoSomeThing()
     print("Do some thing")
 end
 
-return util
+return util

metadata.lua

@@ -13,7 +13,6 @@ PLUGIN.license = "Apache 2.0"
 --- Plugin description
 PLUGIN.description = "your plugin description"
 
-
 --- !!! OPTIONAL !!!
 --[[
 NOTE:
@@ -35,10 +34,8 @@ NOTE:
  --]]
 PLUGIN.manifestUrl = "https://github.com/version-fox/vfox-plugin-template/releases/download/manifest/manifest.json"
 -- Some things that need user to be attention!
-PLUGIN.notes = {
-}
+PLUGIN.notes = {}
 
 --- List legacy configuration filenames for determining the specified version of the tool.
 --- such as ".node-version", ".nvmrc", etc.
-PLUGIN.legacyFilenames = {
-}
+PLUGIN.legacyFilenames = {}

stylua.toml

@@ -0,0 +1,11 @@
+syntax = "Lua51"
+column_width = 120
+line_endings = "Unix"
+indent_type = "Spaces"
+indent_width = 4
+quote_style = "AutoPreferDouble"
+call_parentheses = "Always"
+collapse_simple_statement = "Never"
+
+[sort_requires]
+enabled = false