kuro
/
bmc-tpl-code-all-around
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases 7 Wiki Activity

Add Configuration

kuro 2026-10-15 20:45:53 +00:00
parent 67c0bb774d
commit 9a310c4531
1 changed files with 37 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
Configuration.md Normal file

@ -0,0 +1,37 @@
# ⚙️ Configuration
The **BMC TPL Code All around** extension can be deeply integrated into your workflow. Via the VS Code settings, you can define default values that the plugin automatically uses when creating new modules (e.g., via the `tpl_skeleton` snippet).
This saves you from manually typing the exact same metadata over and over again for every new pattern!
---
## 🛠️ Opening the Settings
1. Open the settings in VS Code via the menu: **File > Preferences > Settings** (Windows/Linux) or **Code > Settings > Settings** (Mac). *(Alternatively: Simply press `Ctrl + ,` or `Cmd + ,`)*
2. Type `TPL` into the search bar at the top.
3. Select **BMC TPL Settings** under the **Extensions** section on the left side.
---
## 📋 Available Settings
Here is an overview of all configuration options the plugin currently offers you:
| Setting | Internal Name | Default Value | Description |
| :--- | :--- | :--- | :--- |
| **Author** | `tpl.metadata.author` | `Kuro` | The default author entered into the `metadata` block when generating a new TPL module (e.g., using `tpl_skeleton`). |
| **Origin** | `tpl.metadata.origin` | `Custom` | Defines the origin of the module (e.g., 'Custom' or your company name). |
| **Publisher** | `tpl.metadata.publisher` | `IT-Operations` | The default publisher for newly generated modules. |
| **Tree Path Base** | `tpl.metadata.treePathBase` | `Grafing` | The first (base) part of the `tree_path` in the metadata. You can easily fill in the categories and subcategories yourself using `Tab` after inserting the snippet. |
| **Version** | `tpl.version` | `23` | The current TPL minor version (e.g., `23` for TPL 1.23). **Important:** This number is inserted into new skeleton scripts (`tpl 1.23 module...`), and the linter also actively uses this value! If an open module is older than this version, the linter issues a warning. |
---
## ⚡ Live-Reload (No restart required!)
A major advantage of the extension: **All changes take effect immediately!**
If, for example, you change the TPL version from `23` to `24`, the linter immediately re-evaluates all `.tpl` files open in the background and may now mark older modules with a warning—without you having to restart VS Code. Snippets will also use the new values immediately from your very next input.
> **Tip for Teams:** You can also save these settings as Workspace settings (in a `.vscode/settings.json` file) and share them via Git. This way, your entire development team automatically shares the exact same publisher and version defaults!