diff --git a/.github/workflows/release-hana-cli.yml b/.github/workflows/release-hana-cli.yml index 3b27226..05e85b6 100644 --- a/.github/workflows/release-hana-cli.yml +++ b/.github/workflows/release-hana-cli.yml @@ -211,7 +211,7 @@ jobs: npm ci --prefix app/vue npm ci --prefix vscode-extension npm run build:vscode - cd vscode-extension && npx vsce package --no-dependencies + cd vscode-extension && npx vsce package - name: Verify package version matches tag run: | diff --git a/.github/workflows/vscode-extension.yml b/.github/workflows/vscode-extension.yml index dec4f21..e62a2e5 100644 --- a/.github/workflows/vscode-extension.yml +++ b/.github/workflows/vscode-extension.yml @@ -44,7 +44,7 @@ jobs: test -f "$BUNDLE" || { echo "::error::$BUNDLE missing — bundle step did not copy the Vue build"; exit 1; } grep -q "Import / Export / Convert" "$BUNDLE" || { echo "::error::Bundled webview is stale: 'Import / Export / Convert' group not found in $BUNDLE"; exit 1; } echo "Bundled webview contains the current navigation." - - run: cd vscode-extension && npx vsce package --no-dependencies + - run: cd vscode-extension && npx vsce package - uses: actions/upload-artifact@v7 if: matrix.os == 'ubuntu-latest' && matrix.node == 22 with: diff --git a/package.json b/package.json index bba4ac1..a1ed68b 100644 --- a/package.json +++ b/package.json @@ -54,7 +54,7 @@ "release:notes": "node scripts/extract-release-notes.js", "build:vue": "cd app/vue && npm run build", "build:vscode": "cd vscode-extension && npm run bundle", - "package:vscode": "npm run build:vscode && cd vscode-extension && node -e \"const fs=require('fs');for(const f of fs.readdirSync('.'))if(f.endsWith('.vsix'))fs.rmSync(f)\" && npx vsce package --no-dependencies", + "package:vscode": "cd vscode-extension && npm run package", "prepack": "npm run build:vue && npm run package:vscode" }, "repository": { diff --git a/vscode-extension/LICENSE b/vscode-extension/LICENSE new file mode 100644 index 0000000..53896a0 --- /dev/null +++ b/vscode-extension/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 [2026] [SAP SE] + + 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/vscode-extension/README.md b/vscode-extension/README.md new file mode 100644 index 0000000..06d567d --- /dev/null +++ b/vscode-extension/README.md @@ -0,0 +1,59 @@ +# hana-cli Tools for SAP HANA + +Visual editors and database tools for **SAP HANA**, powered by [hana-cli](https://github.com/SAP-samples/hana-developer-cli-tool-example). + +This extension brings the most-used capabilities of the `hana-cli` developer tool directly into Visual Studio Code — custom editors for HANA design-time artifacts, an interactive tools panel, and quick commands for exploring a connected database. + +## Features + +### Custom editors + +Open HANA design-time files and inspect them visually — no need to read raw source: + +| File type | Editor | +|-----------|--------| +| `*.hdbcalculationview` | Calculation View Editor | +| `*.hdbtable`, `*.hdbmigrationtable` | Table Inspector | +| `*.hdbview` | View Inspector | +| `*.hdbprocedure` | Procedure Inspector | +| `*.hdbfunction` | Function Inspector | +| `*.hdbsynonym` | Synonym Inspector | +| `*.hdbrole` | Role Inspector | +| `*.hdbsequence` | Sequence Inspector | + +### Commands + +Available from the Command Palette (`Ctrl/Cmd+Shift+P`), all prefixed with **HANA:** + +- **Open hana-cli Tools** — launch the interactive tools panel +- **New Query Editor** — run ad-hoc SQL against the connected database +- **Show Tables** / **Show Views** — browse catalog objects +- **System Info** — inspect the connected HANA system +- **Add Connection** — store HANA connection details securely +- **Import Data** — load data into a table +- **CF Login** — authenticate to Cloud Foundry + +## Connection resolution + +On activation the extension automatically resolves a HANA connection from your workspace, trying in order: + +1. `default-env.json` +2. `.cdsrc-private.json` (CAP dynamic binding) +3. `.env` / `VCAP_SERVICES` +4. Connections you save via **HANA: Add Connection** (stored in VS Code Secret Storage) + +The current connection is shown in the status bar. + +## Requirements + +- Visual Studio Code `^1.85.0` +- A reachable SAP HANA database (HANA Cloud or on-premise). For CAP projects, a bound HDI container or `default-env.json` is used automatically. + +## Learn more + +- [hana-cli documentation](https://sap-samples.github.io/hana-developer-cli-tool-example/) +- [Source & issues](https://github.com/SAP-samples/hana-developer-cli-tool-example) + +## License + +Licensed under the [Apache License 2.0](./LICENSE). diff --git a/vscode-extension/icon.png b/vscode-extension/icon.png new file mode 100644 index 0000000..4680749 Binary files /dev/null and b/vscode-extension/icon.png differ diff --git a/vscode-extension/package.json b/vscode-extension/package.json index 46e0411..9ab3a0b 100644 --- a/vscode-extension/package.json +++ b/vscode-extension/package.json @@ -2,8 +2,19 @@ "name": "hana-cli", "displayName": "hana-cli Tools for SAP HANA", "description": "Visual editors and database tools for SAP HANA powered by hana-cli", - "version": "0.1.3", + "version": "0.1.6", "publisher": "SAP-samples", + "icon": "icon.png", + "license": "Apache-2.0", + "repository": { + "type": "git", + "url": "git+https://github.com/SAP-samples/hana-developer-cli-tool-example.git", + "directory": "vscode-extension" + }, + "homepage": "https://sap-samples.github.io/hana-developer-cli-tool-example/", + "bugs": { + "url": "https://github.com/SAP-samples/hana-developer-cli-tool-example/issues" + }, "engines": { "vscode": "^1.85.0" }, @@ -169,7 +180,8 @@ "build:webview": "cd ../app/vue && npm run build:vscode", "bundle": "npm run build:webview && npm run compile && npm run copy:i18n && node esbuild.config.mjs --production", "bundle:dev": "npm run build:webview && npm run compile && npm run copy:i18n && node esbuild.config.mjs", - "package": "npm run bundle && vsce package", + "package": "npm run clean:vsix && npm run bundle && vsce package", + "clean:vsix": "node -e \"const fs=require('fs');for(const f of fs.readdirSync('.'))if(f.endsWith('.vsix'))fs.rmSync(f)\"", "pretest": "tsc -p tsconfig.test.json", "test": "node ./out/test/runTests.js" },