Skip to content

Commit 87a7fc7

Browse files
hanjoostenhanjoosten
committed
Better names for some parameters
1 parent 9032462 commit 87a7fc7

File tree

7 files changed

+62
-60
lines changed

7 files changed

+62
-60
lines changed

‎package-lock.json‎

Lines changed: 8 additions & 8 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json‎

Lines changed: 31 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -182,10 +182,30 @@
182182
"default": true,
183183
"description": "Include the data analysis chapter in the functional documentation."
184184
},
185-
"ampersand.sqlBinaryTables": {
186-
"type": "boolean",
187-
"default": false,
188-
"description": "Generate binary tables instead of broad tables in SQL database, for testing purposes."
185+
"ampersand.documentation.format": {
186+
"type": "string",
187+
"enum": [
188+
"Asciidoc",
189+
"Context",
190+
"Docbook",
191+
"Docx",
192+
"Html",
193+
"Latex",
194+
"Man",
195+
"Markdown",
196+
"Mediawiki",
197+
"Opendocument",
198+
"Org",
199+
"Pandoc",
200+
"Pdf",
201+
"Plain",
202+
"Rst",
203+
"Rtf",
204+
"Texinfo",
205+
"Textile"
206+
],
207+
"default": "docx",
208+
"description": "The format that the functional specification will be generated to."
189209
},
190210
"ampersand.outputDir": {
191211
"type": "string",
@@ -201,6 +221,11 @@
201221
],
202222
"description": "Pick 'NL' for Dutch or 'EN' for English, as the language to be used in your output. Without this option, output is written in the language of your context."
203223
},
224+
"ampersand.sqlBinaryTables": {
225+
"type": "boolean",
226+
"default": false,
227+
"description": "Generate binary tables instead of broad tables in SQL database, for testing purposes."
228+
},
204229
"ampersand.verbosity": {
205230
"type": "string",
206231
"enum": [
@@ -212,31 +237,6 @@
212237
],
213238
"default": "warn",
214239
"description": "How verose should the output be?"
215-
},
216-
"ampersand.documentation.format": {
217-
"type": "string",
218-
"enum": [
219-
"Asciidoc",
220-
"Context",
221-
"Docbook",
222-
"Docx",
223-
"Html",
224-
"Latex",
225-
"Man",
226-
"Markdown",
227-
"Mediawiki",
228-
"Opendocument",
229-
"Org",
230-
"Pandoc",
231-
"Pdf",
232-
"Plain",
233-
"Rst",
234-
"Rtf",
235-
"Texinfo",
236-
"Textile"
237-
],
238-
"default": "docx",
239-
"description": "The format that the functional specification will be generated to."
240240
}
241241
}
242242
}
@@ -251,12 +251,12 @@
251251
"esbuild-watch": "npm run esbuild-base -- --sourcemap --watch"
252252
},
253253
"dependencies": {
254-
"@types/node": "^22.13.1",
254+
"@types/node": "^22.16.3",
255255
"@types/vscode": "^1.96.0",
256256
"@vscode/test-electron": "^2.4.1",
257257
"@vscode/vsce": "^3.2.1",
258258
"npm": "^11.0.0",
259259
"ts-node": "^10.9.2",
260260
"typescript": "^5.7.3"
261261
}
262-
}
262+
}

‎src/commands/generateAtlasCommand.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,10 +7,10 @@ export class generateAtlasCommand implements ICommand {
77
private builder: terminalBuilder = new terminalBuilder();
88

99
runCommand() {
10-
if (extensionSettings.mainScriptSetting === undefined || extensionSettings.folderSetting === undefined)
10+
if (extensionSettings.rootScriptName === undefined || extensionSettings.rootScriptFolder === undefined)
1111
return;
1212

13-
const currentActiveFilePath: string | undefined = fileUtils.generateWorkspacePath([extensionSettings.folderSetting, extensionSettings.mainScriptSetting]);
13+
const currentActiveFilePath: string | undefined = fileUtils.generateWorkspacePath([extensionSettings.rootScriptFolder, extensionSettings.rootScriptName]);
1414

1515
if (currentActiveFilePath === undefined)
1616
return;

‎src/commands/generateFunctionalSpecCommand.ts‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -22,19 +22,19 @@ export class generateFunctionalSpecCommand implements ICommand {
2222
* 8. Runs the constructed command in the configured terminal.
2323
*/
2424
runCommand(): void {
25-
if (extensionSettings.mainScriptSetting === undefined) {
25+
if (extensionSettings.rootScriptName === undefined) {
2626
console.error("Main script not set in settings");
2727
return
2828
};
29-
console.info("Script setting: " + extensionSettings.mainScriptSetting);
29+
console.info("Script setting: " + extensionSettings.rootScriptName);
3030

31-
if (extensionSettings.folderSetting === undefined) {
31+
if (extensionSettings.rootScriptFolder === undefined) {
3232
console.error("Folder not set in settings");
3333
return;
3434
};
35-
console.info("Folder setting: " + extensionSettings.folderSetting);
35+
console.info("Folder setting: " + extensionSettings.rootScriptFolder);
3636

37-
const mainScriptPath: string = fileUtils.generateWorkspacePath([extensionSettings.folderSetting, extensionSettings.mainScriptSetting]);
37+
const mainScriptPath: string = fileUtils.generateWorkspacePath([extensionSettings.rootScriptFolder, extensionSettings.rootScriptName]);
3838

3939
const terminal = this.builder.setName("Ampersand generate functional spec")
4040
.setWorkingDir(['.'])
@@ -45,7 +45,7 @@ export class generateFunctionalSpecCommand implements ICommand {
4545
mainScriptPath,
4646
"--format " + extensionSettings.documentation.format,
4747
extensionSettings.graphicsSetting ? "" : "--no-graphics",
48-
extensionSettings.documentation.intro ? "" : "--no-intro",
48+
extensionSettings.documentation.intro ? "" : "--no-Intro",
4949
extensionSettings.documentation.sharedLang ? "" : "--no-SharedLang",
5050
extensionSettings.documentation.diagnosis ? "" : "--no-Diagnosis",
5151
extensionSettings.documentation.conceptualAnalysis ? "" : "--no-ConceptualAnalysis",

‎src/commands/generatePrototypeCommand.ts‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,19 @@ export class generatePrototypeCommand implements ICommand {
77
private builder: terminalBuilder = new terminalBuilder();
88

99
runCommand(): void {
10-
if (extensionSettings.mainScriptSetting === undefined) {
10+
if (extensionSettings.rootScriptName === undefined) {
1111
console.error("Main script not set in settings");
1212
return
1313
};
14-
console.info("Script setting: " + extensionSettings.mainScriptSetting);
14+
console.info("Script setting: " + extensionSettings.rootScriptName);
1515

16-
if (extensionSettings.folderSetting === undefined) {
16+
if (extensionSettings.rootScriptFolder === undefined) {
1717
console.error("Folder not set in settings");
1818
return;
1919
};
20-
console.info("Folder setting: " + extensionSettings.folderSetting);
20+
console.info("Folder setting: " + extensionSettings.rootScriptFolder);
2121

22-
const mainScriptPath: string = fileUtils.generateWorkspacePath([extensionSettings.folderSetting, extensionSettings.mainScriptSetting]);
22+
const mainScriptPath: string = fileUtils.generateWorkspacePath([extensionSettings.rootScriptFolder, extensionSettings.rootScriptName]);
2323

2424
const terminal = this.builder.setName("Ampersand generate functional spec")
2525
.setWorkingDir(['.'])

‎src/utils/settings.ts‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ export interface ExtensionSettings {
1010
dataAnalysis: boolean;
1111
format: string;
1212
};
13-
folderSetting: string;
13+
rootScriptFolder: string;
1414
graphicsSetting: boolean;
15-
mainScriptSetting: string;
15+
rootScriptName: string;
1616
outputDir: string;
1717
sqlBinaryTables: boolean;
1818
verbosity: string;
@@ -26,17 +26,19 @@ export function loadSettings() {
2626
const config = vscode.workspace.getConfiguration('ampersand');
2727

2828
extensionSettings = {
29+
rootScriptName: config.get('mainScriptName', "main.adl"),
30+
rootScriptFolder: config.get('folderName', "./project"),
31+
graphicsSetting: config.get('graphics', true),
2932
documentation: config.get<ExtensionSettings['documentation']>('documentation', {
3033
intro: true,
3134
sharedLang: true,
3235
diagnosis: true,
3336
conceptualAnalysis: true,
3437
dataAnalysis: true,
35-
format: "docx"
38+
format: "docx",
39+
datamodelOnly: false,
40+
text: true
3641
}),
37-
folderSetting: config.get('folderName', "./project"),
38-
graphicsSetting: config.get('graphics', true),
39-
mainScriptSetting: config.get('mainScriptName', "main.adl"),
4042
outputDir: config.get('outputDir', "./output"),
4143
outputLanguage: config.get('outputLanguage', "NL"),
4244
sqlBinaryTables: config.get('sqlBinaryTables', false),

‎src/utils/zipUtils.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,10 @@ import { fileUtils, extensionSettings } from '../utils';
66

77
export class zipUtils {
88
static zipFolder(extensionPath: string): string | undefined {
9-
if (extensionSettings.mainScriptSetting === undefined || extensionSettings.folderSetting === undefined)
9+
if (extensionSettings.rootScriptName === undefined || extensionSettings.rootScriptFolder === undefined)
1010
return;
1111

12-
const folderPath: string = fileUtils.generateWorkspacePath([extensionSettings.folderSetting]);
12+
const folderPath: string = fileUtils.generateWorkspacePath([extensionSettings.rootScriptFolder]);
1313

1414
//Zip folder and encode
1515
const zipOutPath: string = path.join(extensionPath, "assets", "out.zip");

0 commit comments

Comments
 (0)