From 9bc12358228333f58380a5efc56f30167df0e7a0 Mon Sep 17 00:00:00 2001 From: Denis Shienkov Date: Sun, 1 Aug 2021 21:53:16 +0300 Subject: [PATCH] Rename 'configurations.json' with 'qbs-configurations.json' Task-number: #52 --- CHANGELOG.md | 8 ++++++++ docs/build-configurations.md | 8 ++++---- docs/how-to.md | 6 +++--- docs/qbs-settings.md | 2 +- i18n/rus/package.i18n.json | 2 +- package.json | 2 +- package.nls.json | 2 +- src/commands/qbseditconfigurationcommand.ts | 2 +- src/qbssettings.ts | 2 +- 9 files changed, 21 insertions(+), 13 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index d6daf17..3b050bb 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # What's New? +## 1.0.3 + +- Next bug-fix release. +- [#52](https://github.com/denis-shienkov/vscode-qbs/issues/52) +Right now need to use the `qbs-configurations.json` file instead +of the `overriden-properties.json` file to specify the build +configurations and its overridden properties. + ## 1.0.2 - Next bug-fix release. diff --git a/docs/build-configurations.md b/docs/build-configurations.md index 71e9538..83ecb5b 100644 --- a/docs/build-configurations.md +++ b/docs/build-configurations.md @@ -10,10 +10,10 @@ QBS allows to override any project properties on the resolving stage. Details about the data format for this can be found in the official QBS [documentation](https://doc.qt.io/qbs/language-introduction.html#overriding-property-values-from-the-command-line). Although, this extension allows you to do this using a special -`configurations.json` file. The data format in this file corresponds to +`qbs-configurations.json` file. The data format in this file corresponds to the official documentation, the link to which is given above. -When this extension starts, it creates by default the `configurations.json` +When this extension starts, it creates by default the `qbs-configurations.json` file containing all pre-defined buid configurations. The user can extend this file by its purposes. When the file is changed, the extension will automatically start resolving the project with the new configurations and overridden properties. @@ -21,10 +21,10 @@ start resolving the project with the new configurations and overridden propertie ## Create a configurations You can to call the `Edit Build Configuration` command from the command palette. -This command will create the default `configurations.json` file (if it is not +This command will create the default `qbs-configurations.json` file (if it is not exists yet), and then will open this file in the editor. By default this file will be created in the current project workspace folder, along the path -``. +``. The default format of this file is the following: diff --git a/docs/how-to.md b/docs/how-to.md index 6fe8ad5..096f1e6 100644 --- a/docs/how-to.md +++ b/docs/how-to.md @@ -50,10 +50,10 @@ or press the **Debug** button in the status bar. ## Edit a build configurations * From the command palette in VS Code, run the **QBS: Edit Build Configuration** -command, which will create the `configurations.json` file. +command, which will create the `qbs-configurations.json` file. * Add desired build configurations and the overridden properties to this -`configurations.json` file, and save it. -* When the `configurations.json` file is saved, the project will automatically +`qbs-configurations.json` file, and save it. +* When the `qbs-configurations.json` file is saved, the project will automatically resolved with the new build configurations. ## Set up include paths for C++ IntelliSense diff --git a/docs/qbs-settings.md b/docs/qbs-settings.md index c3567de..48c007d 100644 --- a/docs/qbs-settings.md +++ b/docs/qbs-settings.md @@ -24,7 +24,7 @@ below, for more information about variable expansion. | `qbs.logLevel`| Uses the specified [log level](https://doc.qt.io/qbs/cli-build.html#op-op-op-op-log-op-op-level-op-lt-op-level-op-gt-op). | `info` | No. | | `qbs.launchFilePath`| Specify location to the debugger configuration in the `launch.json` file. | `${sourceDirectory}/.vscode/launch.json` | Yes. | | `qbs.showDisabledProjectItems`| Shows the disabled project items (sub-projects, products, groups). | `false` | No. | -| `qbs.configurationsFilePath`| Specify location to the build configurations `configurations.json` file. | `${sourceDirectory}/.vscode/configurations.json` | Yes. | +| `qbs.configurationsFilePath`| Specify location to the build configurations `qbs-configurations.json` file. | `${sourceDirectory}/.vscode/qbs-configurations.json` | Yes. | | `qbs.clearOutputBeforeOperation`| Clears the output console before starting the operation (applicable for Resolve, Clean, Build, and ReBuild operations). | `false` | No. | ## Variable substitution diff --git a/i18n/rus/package.i18n.json b/i18n/rus/package.i18n.json index c87fe89..07b7b69 100644 --- a/i18n/rus/package.i18n.json +++ b/i18n/rus/package.i18n.json @@ -35,7 +35,7 @@ "qbs-tools.configuration.qbs.logLevel.description": "Указывает, хочет ли клиент получать данные журнала и/или предупреждающие сообщения.", "qbs-tools.configuration.qbs.launchFilePath.description": "Полный путь к файлу launch.json, содержащему конфигурации отладчиков.", "qbs-tools.configuration.qbs.showDisabledProjectItems.description": "Отображать отключенные элементы проекта.", - "qbs-tools.configuration.qbs.configurationsFilePath.description": "Полный путь к файлу configurations.json, содержащему конфигурации сборки.", + "qbs-tools.configuration.qbs.configurationsFilePath.description": "Полный путь к файлу qbs-configurations.json, содержащему конфигурации сборки.", "qbs-tools.configuration.qbs.clearOutputBeforeOperation.description": "Очищать вывод перед запуском операции.", "qbs-tools.configuration.views.qbs.project.description": "Проект" } diff --git a/package.json b/package.json index 34f9277..a426b71 100644 --- a/package.json +++ b/package.json @@ -450,7 +450,7 @@ }, "qbs.configurationsFilePath": { "type": "string", - "default": "${sourceDirectory}/.vscode/configurations.json", + "default": "${sourceDirectory}/.vscode/qbs-configurations.json", "description": "%qbs-tools.configuration.qbs.configurationsFilePath.description%", "scope": "resource" }, diff --git a/package.nls.json b/package.nls.json index 1b8cbf5..8b229b5 100644 --- a/package.nls.json +++ b/package.nls.json @@ -35,7 +35,7 @@ "qbs-tools.configuration.qbs.logLevel.description": "Indicates whether the client would like to receive log-data and/or warning messages.", "qbs-tools.configuration.qbs.launchFilePath.description": "The full path to the 'launch.json' file, containing the debugging rules.", "qbs-tools.configuration.qbs.showDisabledProjectItems.description": "Show disabled project items.", - "qbs-tools.configuration.qbs.configurationsFilePath.description": "The full path to the 'configurations.json' file, containing the build configurations.", + "qbs-tools.configuration.qbs.configurationsFilePath.description": "The full path to the 'qbs-configurations.json' file, containing the build configurations.", "qbs-tools.configuration.qbs.clearOutputBeforeOperation.description": "Clear the output before starting the operation.", "qbs-tools.configuration.views.qbs.project.description": "Project" } diff --git a/src/commands/qbseditconfigurationcommand.ts b/src/commands/qbseditconfigurationcommand.ts index 0ffbcf8..6b52ec3 100644 --- a/src/commands/qbseditconfigurationcommand.ts +++ b/src/commands/qbseditconfigurationcommand.ts @@ -5,7 +5,7 @@ import * as QbsUtils from '../qbsutils'; import {QbsSession} from '../qbssession'; export async function onEditConfigurationCommand(session: QbsSession) { - // Create and show the `configurations.json` file. + // Create and show the `qbs-configurations.json` file. const filePath = session.settings().configurationsFilePath(); QbsUtils.ensureFileCreated(filePath, QbsUtils.writeDefaultConfigurations); const doc = await vscode.workspace.openTextDocument(vscode.Uri.file(filePath)); diff --git a/src/qbssettings.ts b/src/qbssettings.ts index 2bf9611..268f7dc 100644 --- a/src/qbssettings.ts +++ b/src/qbssettings.ts @@ -47,7 +47,7 @@ const DEFAULT_SETTINGS_DIR_PATH = ''; const DEFAULT_COMMAND_ECHO_MODE = QbsCommandEchoMode.Summary; const DEFAULT_SHOW_DISABLED_PROJECT_ITEMS = true; const DEFAULT_CLEAR_OUTPUT_BEFORE_OPERATION = false; -const DEFAULT_CONFIGURATIONS_FILE_PATH = `${SOURCE_DIR_PATTERN}/.vscode/configurations.json`; +const DEFAULT_CONFIGURATIONS_FILE_PATH = `${SOURCE_DIR_PATTERN}/.vscode/qbs-configurations.json`; export enum QbsSettingsEvent { NothingRequired,