diff --git a/.github/workflows/fireback-build.yml b/.github/workflows/fireback-build.yml index 0c41c564..e52c7bc0 100644 --- a/.github/workflows/fireback-build.yml +++ b/.github/workflows/fireback-build.yml @@ -40,6 +40,11 @@ on: required: false default: false type: boolean + deploy_vscode_market: + description: "Publish vscode marketplace" + required: false + default: false + type: boolean jobs: deploy_github_release: @@ -557,6 +562,21 @@ jobs: with: folder: ./docs/build # The folder the action should deploy. + deploy_vscode: + needs: + - vscode-extension + + if: ${{ inputs.deploy_vscode_market == true }} + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - name: Publish to Visual Studio Marketplace + uses: HaaLeo/publish-vscode-extension@v1 + with: + pat: ${{ secrets.FIREBACK_VSCODE_MARKETPLACE }} + extensionFile: artifacts/fireback-vscode/fireback-tools.vsix + registryUrl: https://marketplace.visualstudio.com + vscode-extension: runs-on: ubuntu-latest diff --git a/clients/fireback-tools-vs-code-extension/README.md b/clients/fireback-tools-vs-code-extension/README.md index a204529c..cf40a2f9 100644 --- a/clients/fireback-tools-vs-code-extension/README.md +++ b/clients/fireback-tools-vs-code-extension/README.md @@ -1,6 +1,32 @@ # Fireback tools This plugin is a language server connector for fireback and vscode. +You can find guidelines how to install it on: https://torabi.io/fireback/docs/download-and-install-fireback + +**Plugin requires that `fireback` binary to be installed already on your computer.** +If you have installed it in a different place, go to your `.vscode/settings.json` of project +and add the following settings: + +``` +{ + "fireback.serverPath": "/var/apps/exactplaceoffirebackbinary", + ... other configs +} +``` + +and then restart the extension to get access to language server. + +## Code completion + +This extension offers a code completion feature. For any file which would end on `Module3.yml`, it provides +intelisense to some extension. + +## Module3 Designer + +You can access module3 visual designer, when you are in a Module3.yml file, and Command+Shift+P and then type: +`Fireback: Module3 Designer` it would popup on the sidebar, and you can edit the modules using forms. + +It might remove extra comments you have added on the yaml though. + -Make sure you have installed the fireback first. (This extension does not install it.) diff --git a/clients/fireback-tools-vs-code-extension/images/logo.png b/clients/fireback-tools-vs-code-extension/images/logo.png new file mode 100644 index 00000000..0ea63462 Binary files /dev/null and b/clients/fireback-tools-vs-code-extension/images/logo.png differ diff --git a/clients/fireback-tools-vs-code-extension/package.json b/clients/fireback-tools-vs-code-extension/package.json index d6d08001..f7408728 100644 --- a/clients/fireback-tools-vs-code-extension/package.json +++ b/clients/fireback-tools-vs-code-extension/package.json @@ -1,7 +1,9 @@ { "name": "fireback-tools", "displayName": "Fireback Tools", - "description": "Fireback tools and auto completion for Module3", + "publisher": "alitorabi", + "icon": "images/logo.png", + "description": "Fireback development and autocompletion for Module3", "version": "1.1.27", "engines": { "vscode": "^1.75.0" diff --git a/docs/docs/download-and-install-fireback.mdx b/docs/docs/download-and-install-fireback.mdx index 51b3512f..126ebebc 100644 --- a/docs/docs/download-and-install-fireback.mdx +++ b/docs/docs/download-and-install-fireback.mdx @@ -8,6 +8,11 @@ sidebar_position: 2 Fireback comes with MSI intallers for Windows, Packages for mac, and Debian packages for ubuntu. Installers will register the binary in the PATH and are recommended way to install: + +**Installers are not signed at this moment, you might need to allow installing from unknown sources, or install it using go install +which is explained later in this document.** + + ### Macosx installers: https://github.com/torabian/fireback/releases/latest/download/fireback_silicon_arm64.pkg diff --git a/docs/docs/vscode-extension-and-developing.mdx b/docs/docs/vscode-extension-and-developing.mdx index 907cced6..58147cc0 100644 --- a/docs/docs/vscode-extension-and-developing.mdx +++ b/docs/docs/vscode-extension-and-developing.mdx @@ -7,4 +7,40 @@ For each release, there is a VSCode extension coming with Fireback, which could a visual yaml editor, and autosuggestions. Still on version 1.1.27, The "Run on Save" plugin is needed, simply to regenerated fireback while saving Module3.yaml files. -I hope on version 1.1.28, VSCode plugin become much better. \ No newline at end of file +## Fireback Tools extention. + + +Installation is available on marketplace and github releases, press Cmd+Shift+X to search for +Fireback extention. + +* https://marketplace.visualstudio.com/items?itemName=AliTorabi.fireback-tools +* https://github.com/torabian/fireback/releases/latest/download/fireback-tools.vsix + +You can install Fireback tools extension from VSCode market place. It offers Module3 visual designer, +as well as some intelisense for Module3.yml files autocompletion. + + +**Plugin requires that `fireback` binary to be installed already on your computer.** +If you have installed it in a different place, go to your `.vscode/settings.json` of project +and add the following settings: + +``` +{ + "fireback.serverPath": "/var/apps/exactplaceoffirebackbinary", + ... other configs +} +``` + +and then restart the extension to get access to language server. + +## Code completion + +This extension offers a code completion feature. For any file which would end on `Module3.yml`, it provides +intelisense to some extension. + +## Module3 Designer + +You can access module3 visual designer, when you are in a Module3.yml file, and Command+Shift+P and then type: +`Fireback: Module3 Designer` it would popup on the sidebar, and you can edit the modules using forms. + +It might remove extra comments you have added on the yaml though. \ No newline at end of file