diff --git a/.github/workflows/publish.yaml b/.github/workflows/publish.yaml new file mode 100644 index 0000000..f44d298 --- /dev/null +++ b/.github/workflows/publish.yaml @@ -0,0 +1,79 @@ +name: generate and publish manifest + +on: + push: + tags: [ 'v*' ] + +permissions: + contents: write + +jobs: + generate-manifest-json: + runs-on: ubuntu-latest + steps: + - name: Set repo name + run: | + echo "REPO_NAME=$(echo ${{ github.repository }} | cut -d'/' -f2)" >> $GITHUB_ENV + echo "VERSION=$(echo ${{ github.ref }} | cut -d'/' -f3 | cut -c2-)" >> $GITHUB_ENV + - uses: actions/checkout@v2 + + - name: Set up Lua + uses: leafo/gh-actions-lua@v8 + with: + luaVersion: '5.3.5' + + - name: Install dependencies + run: | + sudo apt-get install luarocks + sudo luarocks install dkjson + + - name: Generate manifest + run: | + sudo lua -e ' + require("metadata"); + local dkjson = require("dkjson"); + PLUGIN.downloadUrl = "https://github.com/${{ github.repository }}/releases/download/v${{ env.VERSION }}/${{ env.REPO_NAME }}-${{ env.VERSION }}.zip"; + local str = dkjson.encode(PLUGIN); + print(str)' > manifest.json + cat manifest.json + - name: Upload JSON file + uses: actions/upload-artifact@v2 + with: + name: manifest + path: manifest.json + release-plugin-and-manifest: + needs: generate-manifest-json + runs-on: ubuntu-latest + steps: + - name: Set repo name + run: | + echo "REPO_NAME=$(echo ${{ github.repository }} | cut -d'/' -f2)" >> $GITHUB_ENV + echo "VERSION=$(echo ${{ github.ref }} | cut -d'/' -f3 | cut -c2-)" >> $GITHUB_ENV + - name: Checkout code + uses: actions/checkout@v2 + - name: Download JSON file + uses: actions/download-artifact@v2 + with: + name: manifest + - name: Compress build files + uses: thedoctor0/zip-release@0.7.6 + with: + type: "zip" + directory: "./" + filename: "${{ env.REPO_NAME }}-${{ env.VERSION }}.zip" + exclusions: "*.git* manifest.json" + - name: Publish release + uses: svenstaro/upload-release-action@v2 + with: + repo_token: ${{ secrets.GITHUB_TOKEN }} + file: ./${{ env.REPO_NAME }}-${{ env.VERSION }}.zip + tag: v${{ env.VERSION }} + file_glob: true + - name: Publish manifest + uses: svenstaro/upload-release-action@v2 + with: + repo_token: ${{ secrets.GITHUB_TOKEN }} + file: ./manifest.json + tag: "manifest" + overwrite: true + file_glob: true \ No newline at end of file diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..723ef36 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.idea \ No newline at end of file diff --git a/.tool-versions b/.tool-versions new file mode 100644 index 0000000..e69de29 diff --git a/Injection.lua b/Injection.lua new file mode 100644 index 0000000..798d95a --- /dev/null +++ b/Injection.lua @@ -0,0 +1,15 @@ +--[[ +Do not change any thing in the current file, +it's just there to show what objects are injected by vfox and what they do. + +It's just handy when developing plugins, IDE can use this object for code hints! + --]] +RUNTIME = { + --- Operating system type at runtime (Windows, Linux, Darwin) + osType = "", + --- Operating system architecture at runtime (amd64, arm64, etc.) + archType = "", + --- vfox runtime version + version = "", +} + diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..ed00f56 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright 2024 Han Li and contributors + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. diff --git a/README.md b/README.md new file mode 100644 index 0000000..5f50b89 --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +# vfox-plugin-template + +This is a [vfox plugin](https://vfox.lhan.me/plugins/create/howto.html) template with CI that package and publish the plugin. + +## Usage + +1. [Generate](https://github.com/version-fox/vfox-plugin-template/generate) a new repository based on this template. +2. Configure [metadata](https://github.com/version-fox/vfox-plugin-template/blob/main/metadata.lua) information +3. To develop your plugin further, please read [the plugins create section of the docs](https://vfox.lhan.me/plugins/create/howto.html). + + +## How to publish? + +1. Push a new tag to the repository which name is `vX.Y.Z` (X.Y.Z is the version number). +2. The CI will automatically package, then publish [release](https://github.com/version-fox/vfox-plugin-template/releases/tag/v0.0.1) and publish [manifest](https://github.com/version-fox/vfox-plugin-template/releases/tag/manifest). diff --git a/hooks/available.lua b/hooks/available.lua new file mode 100644 index 0000000..a5e6e3b --- /dev/null +++ b/hooks/available.lua @@ -0,0 +1,20 @@ +local util = require("util") + +--- Return all available versions provided by this plugin +--- @param ctx table Empty table used as context, for future extension +--- @return table Descriptions of available versions and accompanying tool descriptions +function PLUGIN:Available(ctx) + util:DoSomeThing() + return { + { + version = "xxxx", + note = "LTS", + addition = { + { + name = "npm", + version = "8.8.8", + } + } + } + } +end \ No newline at end of file diff --git a/hooks/env_keys.lua b/hooks/env_keys.lua new file mode 100644 index 0000000..aa80ad2 --- /dev/null +++ b/hooks/env_keys.lua @@ -0,0 +1,33 @@ +--- Each SDK may have different environment variable configurations. +--- This allows plugins to define custom environment variables (including PATH settings) +--- Note: Be sure to distinguish between environment variable settings for different platforms! +--- @param ctx table Context information +--- @field ctx.path string SDK installation directory +function PLUGIN:EnvKeys(ctx) + --- this variable is same as ctx.sdkInfo['plugin-name'].path + local mainPath = ctx.path + local mainSdkInfo = ctx.main + local mpath = mainSdkInfo.path + local mversion = mainSdkInfo.version + local mname = mainSdkInfo.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 + }, + { + key = "PATH", + value = mainPath .. "/bin" + }, + { + key = "PATH", + value = mainPath .. "/bin2" + }, + + } + +end \ No newline at end of file diff --git a/hooks/post_install.lua b/hooks/post_install.lua new file mode 100644 index 0000000..4bf262a --- /dev/null +++ b/hooks/post_install.lua @@ -0,0 +1,12 @@ +--- Extension point, called after PreInstall, can perform additional operations, +--- such as file operations for the SDK installation directory or compile source code +--- Currently can be left unimplemented! +function PLUGIN:PostInstall(ctx) + --- ctx.rootPath SDK installation directory + local rootPath = ctx.rootPath + local sdkInfo = ctx.sdkInfo['sdk-name'] + local path = sdkInfo.path + local version = sdkInfo.version + local name = sdkInfo.name + local note = sdkInfo.note +end \ No newline at end of file diff --git a/hooks/pre_install.lua b/hooks/pre_install.lua new file mode 100644 index 0000000..1a9c34c --- /dev/null +++ b/hooks/pre_install.lua @@ -0,0 +1,39 @@ +--- Returns some pre-installed information, such as version number, download address, local files, etc. +--- If checksum is provided, vfox will automatically check it for you. +--- @param ctx table +--- @field ctx.version string User-input version +--- @return table Version information +function PLUGIN:PreInstall(ctx) + local version = ctx.version + return { + --- Version number + version = "xxx", + --- remote URL or local file path [optional] + url = "xxx", + --- SHA256 checksum [optional] + sha256 = "xxx", + --- md5 checksum [optional] + md5 = "xxx", + --- sha1 checksum [optional] + sha1 = "xxx", + --- sha512 checksum [optional] + sha512 = "xx", + --- additional need files [optional] + addition = { + { + --- additional file name ! + name = "xxx", + --- remote URL or local file path [optional] + url = "xxx", + --- SHA256 checksum [optional] + sha256 = "xxx", + --- md5 checksum [optional] + md5 = "xxx", + --- sha1 checksum [optional] + sha1 = "xxx", + --- sha512 checksum [optional] + sha512 = "xx", + } + } + } +end \ No newline at end of file diff --git a/hooks/pre_use.lua b/hooks/pre_use.lua new file mode 100644 index 0000000..daf6d36 --- /dev/null +++ b/hooks/pre_use.lua @@ -0,0 +1,27 @@ +--- When user invoke `use` command, this function will be called to get the +--- valid version information. +--- @param ctx table Context information +function PLUGIN:PreUse(ctx) + --- user input version + local version = ctx.version + --- user current used version + local previousVersion = ctx.previousVersion + + --- installed sdks + local sdkInfo = ctx.installedSdks['version'] + local path = sdkInfo.path + local name = sdkInfo.name + local version = sdkInfo.version + + --- working directory + local cwd = ctx.cwd + + --- user input scope + --- could be one of global/project/session + local scope = ctx.scope + + --- return the version information + return { + version = version, + } +end \ No newline at end of file diff --git a/lib/util.lua b/lib/util.lua new file mode 100644 index 0000000..7a7f8d9 --- /dev/null +++ b/lib/util.lua @@ -0,0 +1,8 @@ + +local util = {} + +function util:DoSomeThing() + print("Do some thing") +end + +return util \ No newline at end of file diff --git a/metadata.lua b/metadata.lua new file mode 100644 index 0000000..d221628 --- /dev/null +++ b/metadata.lua @@ -0,0 +1,40 @@ +--- !!! DO NOT EDIT OR RENAME !!! +PLUGIN = {} + +--- !!! MUST BE SET !!! +--- Plugin name +PLUGIN.name = "your plugin name" +--- Plugin version +PLUGIN.version = "0.0.1" +--- Plugin homepage +PLUGIN.homepage = "https://github.com/version-fox/vfox-plugin-template" +--- Plugin license, please choose a correct license according to your needs. +PLUGIN.license = "Apache 2.0" +--- Plugin description +PLUGIN.description = "your plugin description" + + +--- !!! OPTIONAL !!! +--[[ +NOTE: + Minimum compatible vfox version. + If the plugin is not compatible with the current vfox version, + vfox will not load the plugin and prompt the user to upgrade vfox. + --]] +PLUGIN.minRuntimeVersion = "0.3.0" +--[[ +NOTE: + If configured, vfox will check for updates to the plugin at this address, + otherwise it will check for updates at the global registry. + + If you want use the global registry to distribute your plugin, you can remove this field. + + If you develop a plugin based on the template, which will automatically generate a manifest file by CI, + you can set this address to the manifest file address, so that the plugin can be updated automatically. + + --]] +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 = { + "", +}