Added a configuration for default header template.

Author: sidmishraw

CHANGELOG.md

@@ -6,6 +6,10 @@ Author: Sidharth Mishra
 
 All notable changes to the "topper" extension will be documented in this file.
 
+### [v1.1.0]
+
+-   Added a new configuration parameter called `topper.defaultHeaderTemplate`. This parameter allows to customize the default header template across all the languages in case a custom language specific template is not defined yet. The language ID used for the default header template is `default` and it should not be tinkered with!!!
+
 ### [v1.0.0]
 
 **[!!!] This release has breaking changes and might need some configuration from your part for the first time you start using it –– especially on older files that were annotated with older versions of Topper. No worries for new users and new files.**

README.md

@@ -1,18 +1,14 @@
 # Topper
 
 ```
-Version: 1.0.0
+Version: 1.1.0
 ```
 
 `Topper` is a file header utility. It will add a header to the file depending on the configurations made by you.
 
 ## Features
 
-> Note: the GIF below is deprecated, will be replacing it with a new one soon.
-
-> [DEPRECATED] The gif below shows how to use the `Topper` extension. Valid for extension version <= 0.4.0
-
-![](https://zippy.gfycat.com/LeanNeatEasternnewt.gif)
+Make yourself a language and profile specific beautiful or helpful file header. Have fun!
 
 ## Extension Settings
 
@@ -45,6 +41,28 @@ The default setting is:
 
 You can add any number of profiles to the list. You also have the ability to add in any number of parameters here in your profiles. This way you can use those parameters in the header templates.
 
+### `topper.defaultHeaderTemplate`: This configuration allows you to set a default header template across all the langauges in case you haven't defined a custom language specific header template. The language ID used for this header template is `default` and it should not be tinkered with. By default its value is:
+
+```json
+{
+    "default": {
+        "headerBegin": "/**",
+        "headerPrefix": "*",
+        "headerEnd": "*/",
+        "template": [
+            "${headerBegin}",
+            "${headerPrefix} ${fileName}",
+            "${headerPrefix} @author ${author}",
+            "${headerPrefix} @description ${description}",
+            "${headerPrefix} @created ${createdDate}",
+            "${headerPrefix} @copyright ${copyright}",
+            "${headerPrefix} @last-modified ${lastModifiedDate}",
+            "${headerEnd}"
+        ]
+    }
+}
+```
+
 ### `topper.headerTemplates`: This is the list of all the header templates you configure depending upon the languages being used.
 
 The list of language Ids can be found here: [https://code.visualstudio.com/docs/languages/identifiers](https://code.visualstudio.com/docs/languages/identifiers).

package-lock.json

@@ -2,7 +2,7 @@
     "name": "topper",
     "displayName": "topper",
     "description": "A fileheader utility.",
-    "version": "1.0.0",
+    "version": "1.1.0",
     "publisher": "sidmishraw",
     "engines": {
         "vscode": "^1.13.0"
@@ -48,6 +48,27 @@
                         }
                     ]
                 },
+                "topper.defaultHeaderTemplate": {
+                    "type": "object",
+                    "description": "The default header template that can be used for all languages if no-custom template is defined. The default language ID is `default`. Please don't use some other language ID for the default header template.",
+                    "default": {
+                        "default": {
+                            "headerBegin": "/**",
+                            "headerPrefix": "*",
+                            "headerEnd": "*/",
+                            "template": [
+                                "${headerBegin}",
+                                "${headerPrefix} ${fileName}",
+                                "${headerPrefix} @author ${author}",
+                                "${headerPrefix} @description ${description}",
+                                "${headerPrefix} @created ${createdDate}",
+                                "${headerPrefix} @copyright ${copyright}",
+                                "${headerPrefix} @last-modified ${lastModifiedDate}",
+                                "${headerEnd}"
+                            ]
+                        }
+                    }
+                },
                 "topper.headerTemplates": {
                     "type": "array",
                     "description": "Configure the templates for the headers depending on the languageId inferred by the editor. The list of language Ids can be found here: https://code.visualstudio.com/docs/languages/identifiers. \nIf the file's languageId is not configured here, it defaults to the `defaultCStyled` header template. \nPlease do not delete this template. Copy it over when configuring this section. \nNote: Please keep the `defaultCStyled` as the first element in the list of all the header templates. \nFor more information, refer to the Readme.md.",

package.json

@@ -52,6 +52,8 @@ import {
     DEFAULT_DATETIME_FORMAT,
     INSERT_AT_ROW,
     INSERT_AT_COL,
+    DEFAULT_HEADER_TEMPLATE,
+    DEFAULT_LANGUAGE_ID,
 } from './topper';
 import { Optional } from '../util/optional';
 import { stat } from 'fs';
@@ -145,6 +147,12 @@ function getSelectedHeaderTemplate(headerTemplates: HeaderTemplate[], languageId
  * @returns the default header template, used mostly for C-styled languages.
  */
 function getDefaultHeaderTemplate(): LanguageHeaderTemplate {
+    const defaultHeaderTemplate: HeaderTemplate | undefined = workspace.getConfiguration(TOPPER).get(DEFAULT_HEADER_TEMPLATE);
+    if (defaultHeaderTemplate) {
+        // return the configured default header template if it is available, else
+        // fallback to the hard-coded default.
+        return defaultHeaderTemplate[DEFAULT_LANGUAGE_ID];
+    }
     return new LanguageHeaderTemplate('/**', '*', '*/', [
         '${headerBegin}',
         '${headerPrefix} ${fileName}',

src/topper/service.ts

@@ -64,6 +64,12 @@ export const CUSTOM_TEMPLATE_PARAMETERS = 'customTemplateParameters';
 /** the key for header templates defined in the topper config. */
 export const HEADER_TEMPLATES = 'headerTemplates';
 
+/** the key for the default header template used for all the languages if no custom template is defined. */
+export const DEFAULT_HEADER_TEMPLATE = 'defaultHeaderTemplate';
+
+/** the default language ID to be used for the default header template. */
+export const DEFAULT_LANGUAGE_ID = 'default';
+
 // list of intrinsic parameter names that topper provides
 //
 /** the file name. It is a key whose value is defined by topper. */