SDK-Einstellungen: settings.json

Signatur

{
  "format": 1,
  "newProjects": {
    "root": "D:\\Projekte",
    "sourceFolder": "source",
    "buildFolder": "build",
    "deliveryFolder": "delivery",
    "neutralLanguage": "sl",
    "targetAccess": "x64",
    "configurations": "Debug;Release;Kunde"
  },
  "paths": {
    "packages": "D:\\Pakete",
    "templates": "D:\\Vorlagen;%USERPROFILE%\\Vorlagen",
    "controlBlocks": "%LOCALAPPDATA%\\WKL\\Access Components\\2.0.0\\control-blocks",
    "bootstrapperManager": "D:\\Werkzeuge\\Wkl.Bootstrapper.Manager.accdb"
  },
  "behavior": {
    "exportOnSave": true,
    "checkCodeBeforeBuild": true,
    "askBeforeReopen": false,
    "language": "de",
    "terminalShell": "pwsh"
  },
  "publisher": {
    "template": "D:\\Herausgeber\\publisher.json"
  }
}

Zusammenfassung

Die Einstellungen des SDK gehören Ihrem Windows-Benutzer, nicht einem Projekt: Vorgaben für neue Projekte, die Ordner, in denen das SDK Release-Pakete, Vorlagen, Steuerelementbausteine und den Bootstrapper Manager findet, das Verhalten des Add-Ins und eine Herausgebervorlage. Das Add-In (Einstellungen in der Gruppe Tools) und die Befehlszeile (`wkl-office settings`) lesen und schreiben dieselbe Datei.

Die Datei ist %APPDATA%\WKL\Office SDK\settings.json im servergespeicherten Teil Ihres Profils: Sie wandert mit einem servergespeicherten Profil auf einen anderen PC und bleibt erhalten, wenn Sie eine andere Version des SDK installieren. Ohne die Datei gelten die Vorgaben des SDK. Die Umgebungsvariable WKL_SDK_SETTINGS nennt eine andere Datei, etwa auf einem Build-Server.

Rangfolge

Ein Wert gilt in dieser Reihenfolge; die erste Stelle, die einen Wert nennt, gewinnt:

die Projektdatei (.acproj), soweit sie für die Einstellung eine Eigenschaft hat;
die Umgebungsvariable der Einstellung;
settings.json;
die Vorgabe des SDK.

Der Dialog SDK-Einstellungen und wkl-office settings list zeigen, woher jeder Wert kommt. Ein Wert, den Sie in die Datei schreiben, gilt nicht, solange seine Umgebungsvariable gesetzt ist; beide weisen darauf hin.

Einträge

Eintrag	Werte	Vorgabe	Umgebungsvariable	Bedeutung
`newProjects.root`	Ordner	keiner	–	`wkl-office new` legt ein Projekt, das nur mit Namen angegeben ist (`new Kunden`), in diesem Ordner an.
`newProjects.sourceFolder`	Ordnername	`source`	–	`SourceRoot` eines neuen Projekts.
`newProjects.buildFolder`	Ordnername	`build`	–	`BaseOutputPath` eines neuen Projekts und der Ordner in seiner `.gitignore`.
`newProjects.deliveryFolder`	Ordnername	`delivery`	–	`DeliveryRoot` eines neuen Projekts.
`newProjects.neutralLanguage`	Sprachcode	keine	–	`NeutralLanguage` eines neuen Projekts, zum Beispiel `sl`.
`newProjects.targetAccess`	`x86`, `x64`, `any`	`any`	–	`TargetAccess` eines neuen Projekts.
`newProjects.configurations`	Namen, durch `;` getrennt	Debug und Release	–	Die Konfigurationen, die ein neues Projekt neben Debug und Release angibt (`Configurations`).
`paths.packages`	Ordner	keiner	`WKL_PACKAGES`	Der Ordner der Release-Pakete (`<Produkt>\<Version>`); eine neue Auslieferung schlägt daraus die neueste Version jeder WKL-Bibliothek vor.
`paths.templates`	Ordner, durch `;` getrennt	keine	`WKL_ACCESS_TEMPLATES`	Wo die `Template` eines Projekts gesucht wird, wenn sie nicht relativ zum Projekt liegt.
`paths.controlBlocks`	Ordner	keiner	`WKL_ACCESS_CONTROL_BLOCKS`	Die Steuerelementbausteine der WKL Forms Object Library, wenn weder das Projekt noch seine Vorlage einen Ordner nennt.
`paths.bootstrapperManager`	Datei	die installierte Version	`WKL_BOOTSTRAPPER_MANAGER`	Die Datenbank des Bootstrapper Manager statt der neuesten installierten Version.
`behavior.exportOnSave`	`true`, `false`	`true`	–	Ob Speichern im VBA-Editor die Änderungen exportiert, für ein Projekt, für das Sie das nicht selbst ein- oder ausgeschaltet haben.
`behavior.checkCodeBeforeBuild`	`true`, `false`	`false`	–	Erstellen und neu öffnen und Neu erstellen und neu öffnen prüfen zuerst den Code; ein Fehler stoppt den Build, bevor die Datenbank geschlossen wird, Warnungen nicht.
`behavior.askBeforeReopen`	`true`, `false`	`true`	–	Ob Erstellen und neu öffnen und Neu erstellen und neu öffnen nachfragen, bevor sie die Datenbank schließen.
`behavior.language`	`en`, `de`, `sl`, `hr`, `it`	die Sprache von Office	`WKL_SDK_LANGUAGE`	Die Sprache des Add-Ins und der Befehlszeile.
`behavior.terminalShell`	`pwsh`, `powershell`, `cmd`	PowerShell 7, sonst Windows PowerShell	–	Die Shell des Terminals im Add-In.
`publisher.template`	Datei	keine	–	Eine `publisher.json`, die in den `DeliveryRoot` eines Projekts kopiert wird, wenn seine Auslieferung eingerichtet wird und es noch keine `publisher.json` hat.

Ordner und Dateien dürfen Umgebungsvariablen enthalten (%USERPROFILE%). Ein Ordnername hat keinen Pfad.

Was nicht in den Einstellungen steht

Das SDK wiederholt nicht, was Access und der VBA-Editor schon anbieten. Ändern Sie diese Einstellungen dort:

Einstellung	Wo
Vertrauenswürdige Speicherorte, Makroeinstellungen, Add-Ins	Access: Datei › Optionen › Trust Center
Startformular, Navigationsbereich, Menüband einer Datenbank	Access: Datei › Optionen › Aktuelle Datenbank (im Projekt: `source/application/properties.json`)
Standarddateiformat, Standarddatenbankordner	Access: Datei › Optionen › Allgemein
Variablendeklaration erforderlich, Automatische Syntaxüberprüfung, Schriftart, Tabulatorbreite	VBA-Editor: Extras › Optionen
Bei Bedarf kompilieren, Unterbrechen bei Fehlern	VBA-Editor: Extras › Optionen › Allgemein

Hinweise

Format. format ist 1. Eine Datei eines neueren Formats wird mit einer Meldung abgelehnt statt teilweise gelesen: Der Dialog SDK-Einstellungen bietet dann nichts zum Ändern an, und wkl-office settings endet mit Exitcode 3; die Datei wird also nie überschrieben. Verwenden Sie die Version des SDK, die sie geschrieben hat, oder entfernen Sie die Datei.
Unbekannte Einträge werden mit der Liste der Einträge abgelehnt; ein vertippter Name bleibt so nie unbemerkt.
Eine Datei, die sich nicht lesen lässt, gilt für jeden anderen Befehl als nicht vorhanden; er arbeitet mit den Vorgaben.
Bestehende Projekte behalten ihre Einstellungen: Die Einträge unter newProjects gelten nur für wkl-office new.

Codebeispiel

wkl-office settings set paths.packages D:\Pakete
wkl-office settings set behavior.askBeforeReopen false
wkl-office settings get paths.packages
paths.packages = D:\Pakete (settings)
wkl-office settings set paths.packages

Die letzte Zeile entfernt den Eintrag; danach gilt wieder die Vorgabe.