Skip to content

Commit

Permalink
Rename 'configurations.json' with 'qbs-configurations.json'
Browse files Browse the repository at this point in the history
Task-number: #52
  • Loading branch information
denis-shienkov committed Aug 1, 2021
1 parent cf9532a commit 9bc1235
Show file tree
Hide file tree
Showing 9 changed files with 21 additions and 13 deletions.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
8 changes: 4 additions & 4 deletions docs/build-configurations.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,21 +10,21 @@ 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.

## 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
`<path/to/your/project/.vscode/configurations.json>`.
`<path/to/your/project/.vscode/qbs-configurations.json>`.

The default format of this file is the following:

Expand Down
6 changes: 3 additions & 3 deletions docs/how-to.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/qbs-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion i18n/rus/package.i18n.json
Original file line number Diff line number Diff line change
Expand Up @@ -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": "Проект"
}
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
},
Expand Down
2 changes: 1 addition & 1 deletion package.nls.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
2 changes: 1 addition & 1 deletion src/commands/qbseditconfigurationcommand.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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));
Expand Down
2 changes: 1 addition & 1 deletion src/qbssettings.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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,
Expand Down

0 comments on commit 9bc1235

Please sign in to comment.