From 9ec7809d0087f05b5cc00e2347271de2a7e31b34 Mon Sep 17 00:00:00 2001 From: Matthias Vallentin Date: Wed, 22 Jan 2025 14:25:40 +0100 Subject: [PATCH] Make the repo an official marketplace package --- .vscodeignore | 21 +++++++++++--- LICENSE | 22 +++++++++++++- README.md | 50 +++++++++++++++++++++++++++++--- package.json | 80 ++++++++++++++++++++++++++++----------------------- 4 files changed, 128 insertions(+), 45 deletions(-) diff --git a/.vscodeignore b/.vscodeignore index f369b5e..e983cce 100644 --- a/.vscodeignore +++ b/.vscodeignore @@ -1,4 +1,17 @@ -.vscode/** -.vscode-test/** -.gitignore -vsc-extension-quickstart.md +# Ignore everything by default. +* + +# Allow only necessary files for this package. +!syntaxes/*.json +!language-configuration.json + +# Also allow core metadata files required for packaging. +!package.json +!README.md +!CHANGELOG.md +!LICENSE +!logo.png + +# Exclude common unwanted directories and files. +.vscode/ +.github/ diff --git a/LICENSE b/LICENSE index 1333ed7..27b00c3 100644 --- a/LICENSE +++ b/LICENSE @@ -1 +1,21 @@ -TODO +MIT License + +Copyright (c) 2024 Tenzir + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/README.md b/README.md index adf601f..7edf51a 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,49 @@ -# tql +# TQL - VS Code Extension -Visual Studio Code extension for working with TQL. Provides simple syntax highlighting. +[![VS Code Marketplace](https://img.shields.io/badge/VSCode-Install-blue?logo=visualstudiocode)](https://marketplace.visualstudio.com/items?itemName=tenzir.vscode-tql) -## Installing +A Visual Studio Code extension for working with the [Tenzir Query Language (TQL)](https://docs.tenzir.com). -Copy this directory to `/.vscode/extensions`, and restart Code. +This extension provides syntax highlighting and language support for TQL. + +## Installation + +### **From the VS Code Marketplace (Recommended)** + +1. Open **Visual Studio Code** +2. Go to **Extensions** (`Ctrl+Shift+X` / `Cmd+Shift+X`) +3. Search for **"TQL"** +4. Click **Install** + +### **Manual Installation (VSIX Package)** + +If you have a `.vsix` file: + +```sh +code --install-extension vscode-tql-.vsix +``` + +## Usage + +1. Open a `.tql` file in VS Code. +2. The syntax highlighting will be applied automatically. +3. More language features coming soon! + +## Extension Settings + +This extension does not add new settings (yet). + +Future updates may introduce customization options. + +## Contributing + +Contributions are welcome! 🎉 +If you'd like to improve this extension, please: + +- Open an issue on [GitHub](https://github.com/tenzir/vscode-tql/issues) +- Submit a pull request + +## License + +This extension is licensed under the **MIT License**. +See [LICENSE](./LICENSE.txt) for details. diff --git a/package.json b/package.json index 239c8e3..c8dacbd 100644 --- a/package.json +++ b/package.json @@ -1,38 +1,46 @@ { - "name": "@tenzir/vscode-tql", - "displayName": "TQL", - "publisher": "Tenzir", - "publishConfig": { - "access": "public" - }, - "description": "Syntax highlighting for the Tenzir Query Language", - "icon": "logo.png", - "version": "0.0.3", - "repository": { - "type": "git", - "url": "https://github.com/tenzir/vscode-tql" - }, - "files": [ - "syntaxes/*.json", - "language-configuration.json" - ], - "engines": { - "vscode": "^1.84.0" - }, - "categories": [ - "Programming Languages" - ], - "contributes": { - "languages": [{ - "id": "tql", - "aliases": ["TQL", "tql"], - "extensions": [".tql"], - "configuration": "./language-configuration.json" - }], - "grammars": [{ - "language": "tql", - "scopeName": "text.tql", - "path": "./syntaxes/tql.tmLanguage.json" - }] - } + "name": "vscode-tql", + "displayName": "TQL", + "publisher": "tenzir", + "publishConfig": { + "access": "public" + }, + "description": "Syntax highlighting for the Tenzir Query Language (TQL)", + "icon": "logo.png", + "version": "0.0.3", + "repository": { + "type": "git", + "url": "https://github.com/tenzir/vscode-tql" + }, + "engines": { + "vscode": "^1.84.0" + }, + "categories": [ + "Programming Languages" + ], + "contributes": { + "languages": [ + { + "id": "tql", + "aliases": [ + "TQL", + "tql" + ], + "extensions": [ + ".tql" + ], + "configuration": "./language-configuration.json" + } + ], + "grammars": [ + { + "language": "tql", + "scopeName": "text.tql", + "path": "./syntaxes/tql.tmLanguage.json" + } + ] + }, + "__metadata": { + "size": 91847 + } }