Variables for testing purposes

[Taitava]

I'm thinking about the following new variables:

• {{obsidian_version}} - done & released
• {{operating_system:name}} - done & released
• {{operating_system:version}} - not done

Added 2023-04-02:

• {{sc_plugin:plugin-version}} - done & released
• {{sc_plugin:settings-version}} - done & released

These are not so much needed for practical, real world usage, but I'm building a test suite and the idea is to be able to automatically insert those three details in each test report.

Another way

• I can probably find out OS version with a shell command
• Test suite needs to be customised for each supported operating system (Windows, Linux, Mac), so I can probably just use static operating system names. OS versions can still be dynamic.
• Obsidian version probably needs a {{variable}} in any case, unless Obsidian introduces a commandline API that can tell the version. I guess a {{variable}} is the easiest thing.

(Offtopic: I'll create a new discussion about the test suite when I have developed it further. Basically the idea is to ensure a high quality and reliably functioning plugin. All bugs cannot be found in testing, but with solid testing it's more encouraging to release new versions when I know that the product has gone through a detailed and standardised test that should bring up most issues.)

[Taitava]

{{obsidian_version}} or {{obsidian_api_version}}?

I'm going to use apiVersion variable to determine the version of Obsidian - as that's the only version I was able to find from Obsidian API. I just need to test will it give actually the current version of Obsidian, or will it give the latest version when the API has changed. Not every new version of Obsidian make changes to the API.

https://github.com/obsidianmd/obsidian-api/blob/902badd38ba907689f0917d7b193f7e33d1284fe/obsidian.d.ts#L293-L298

[Taitava]

For Obsidian 1.5.3, apiVersion does seem to give 1.5.3, and the latest Obsidian API change seems to be for version 1.5.1. So my conclusion is that apiVersion seems to indicate Obsidian's actual version. 👍

Anyway, I will be using the variable name {{obsidian_api_version}} when promoting the currently debug-only variable {{obsidian_api:version}} to an always available variable in SC 0.22.0. So, the word API is kept in the variable to denote the source of the information just in case it ever happens to make any difference.

[Taitava]

Promoting and renaming variables

• {{obsidian_api:version}} --> {{obsidian_api_version}} with optional :major / :minor / :patch arguments.
• {{shell_commands_plugin:plugin-version}} --> {{shell_commands_plugin_version:plugin}} with optional :major / :minor / :patch arguments.
• {{shell_commands_plugin:settings-version}} --> {{shell_commands_plugin_version:settings}} with optional :major / :minor / :patch arguments.

These variables will be made always available, i.e. they do not require debug mode anymore, in SC 0.22.0.

{{operating_system:name}}/{{operating_system:id}} will stay the way it currently is, at least for now.

[Taitava]

Hmm, I created issue #387 from the above comment's Reference in a new issue action, but GitHub didn't mark it to this discussion.