#16 - New setting + message implementation

Author: estruyf

Diff for: CHANGELOG.md

@@ -1,5 +1,9 @@
 # Change Log
 
+## [2.5.0] 11-07-2022
+
+- [#16](https://github.com/estruyf/vscode-typescript-exportallmodules/issues/16): New `exportall.config.message` setting to specify a message that will be added at the top of the generated barrel file.
+
 ## [2.4.1] 20-06-2022
 
 - Changed activation to `onStartupFinished`

Diff for: README.md

@@ -96,6 +96,7 @@ The extension makes use of the following settings:
 | `exportall.config.relExclusion` | Specify the relative folder/file paths to exclude from the export. | string[] | `[]` |
 | `exportall.config.semis` | Specify if you want to enable/disable the usage of semis in the barrel file. | boolean | `true` |
 | `exportall.config.quote` | Specify the character that you want to use as the quoting character; typically `'` or `"`. | string | `'` |
+| `exportall.config.message` | Specify the message that you want to use in the generated barrel file. The message will be added at the top. | string | |
 
 <p align="center">
   <img src="./assets/config.png" alt="Config settings example" style="display: inline-block" />

Diff for: package.json

@@ -159,6 +159,10 @@
 							"Double quote"
 						],
 						"description": "Specify the character that you want to use as the quoting character; typically ' or \""
+					},
+					"exportall.config.message": {
+						"type": "string",
+						"description": "Specify the message that you want to use in the generated barrel file. The message will be added at the top."
 					}
 				}
 			}

Diff for: src/commands/ExportAll.ts

@@ -1,7 +1,7 @@
 import * as vscode from 'vscode';
 import * as path from 'path';
 import * as fs from 'fs';
-import { getSettingName, CONFIG_EXCLUDE, CONFIG_INCLUDE_FOLDERS, CONFIG_RELATIVE_EXCLUDE, CONFIG_SEMIS, CONFIG_QUOTE, EXTENSION_NAME } from '../constants';
+import { getSettingName, CONFIG_EXCLUDE, CONFIG_INCLUDE_FOLDERS, CONFIG_RELATIVE_EXCLUDE, CONFIG_SEMIS, CONFIG_QUOTE, EXTENSION_NAME, CONFIG_MESSAGE, EXTENSION_KEY } from '../constants';
 import { getRelativeFolderPath } from '../helpers';
 import { Logger } from '../helpers/logger';
 
@@ -15,11 +15,13 @@ export class ExportAll {
 
   public static async start(uri: vscode.Uri, runSilent: boolean = true) {
     try {
-      const excludeFiles: string | undefined = vscode.workspace.getConfiguration().get(getSettingName(CONFIG_EXCLUDE));
-      const excludeRel: string | undefined = vscode.workspace.getConfiguration().get(getSettingName(CONFIG_RELATIVE_EXCLUDE));
-      const includeFolders: boolean | undefined = vscode.workspace.getConfiguration().get(getSettingName(CONFIG_INCLUDE_FOLDERS));
-      const semis: boolean | undefined = vscode.workspace.getConfiguration().get(getSettingName(CONFIG_SEMIS));
-      const quote: "\"" | "'"  = vscode.workspace.getConfiguration().get(getSettingName(CONFIG_QUOTE)) ?? "'";
+      const config = vscode.workspace.getConfiguration(EXTENSION_KEY);
+      const excludeFiles: string | undefined = config.get(CONFIG_EXCLUDE);
+      const excludeRel: string | undefined = config.get(CONFIG_RELATIVE_EXCLUDE);
+      const includeFolders: boolean | undefined = config.get(CONFIG_INCLUDE_FOLDERS);
+      const semis: boolean | undefined = config.get(CONFIG_SEMIS);
+      const quote: "\"" | "'"  = config.get(CONFIG_QUOTE) ?? "'";
+      const message: string | string[] | undefined = config.get<string | string[]>(CONFIG_MESSAGE);
 
       const folderPath = uri.fsPath;
       const files = fs.readdirSync(folderPath);
@@ -109,6 +111,12 @@ export class ExportAll {
           const fileUri = vscode.Uri.file(filePath);
           const document = await vscode.workspace.openTextDocument(fileUri);
 
+          // Check if the banner message needs to be added
+          if (message) {
+            output.unshift(`\n`);
+            output.unshift(`// ${message}\n`);
+          }
+
           let fileContents = document.getText();
           let updatedFileContents = output.join("");
 

Diff for: src/constants/Extension.ts

@@ -5,6 +5,7 @@ export const CONFIG_RELATIVE_EXCLUDE = 'config.relExclusion';
 export const CONFIG_INCLUDE_FOLDERS = 'config.includeFoldersToExport';
 export const CONFIG_SEMIS = 'config.semis';
 export const CONFIG_QUOTE = 'config.quote';
+export const CONFIG_MESSAGE = 'config.message';
 
 export const EXTENSION_NAME = "Barrel Generator";