Implemented 1.3.0

Author: Lut99

.gitignore

@@ -1,2 +1,3 @@
 out/*
 node_modules/*
+package-lock.json

CHANGELOG.md

@@ -1,41 +1,58 @@
 # Change Log
 
-## [Unreleased]
 
-## [1.0.0] - 15-01-2020
+## [1.3.0] - 2023-01-21
+### Added
+- Support for WGSL and [eFLINT](https://gitlab.com/eflint).
+- A section on the definition of custom languages in the `README.md` file.
+- The possibility to define your own languages using the new `file-header-generator.customLanguages` property.
 
-- Initial release
+### Changed
+- The `file-header-generator.rustDocString` property to `file-header-generator.docString`.
+- The order of the CHANGELOG.md file
+- The dates in the CHANGELOG.md file
 
-## [1.0.1] - 15-01-2020
+### Fixed
+- Security vulnerability by bumping luxon to 2.5.2.
 
+
+## [1.2.0] - 2022-07-30
 ### Added
-- TypeScript support
-- JavaScript support
+ - New `file-header-generator.rustDocString` property that determines if Rust comments will implement the new docstring-aware description.
+
+### Changed
+ - Rust to now be docstring-aware, using `//!` for the description to propagate it to Rust's auto-generated docs. This behaviour can be controlled with the `file-header-generator.rustDocString` setting.
+ - Rust last-edited updates to overwrite comments with the current comment style (based on the `file-header-generator.rustDocString` property).
+ - The internal codebase to now use a Header struct, which makes it much more clear what we're parsing and how.
 
-## [1.0.2] - 15-01-2020
+
+## [1.1.0] - 2021-12-21
 
 ### Added
-- Now displays notification when command `Generate Header` is run but the extension isn't enabled
+ - Rust support
 
-### Fixed
-- Extension is now enabling itself according to the config, not always setting itself to disabled
+### Changed
+ - The FileHeaderGenerator can now use custom dateformats, which can be edited by the 'dateFormat' option.
+ - Changed the default number of lines to search from 20 to 15.
+ - The extension now starts up after Visual Studio Code does, increasing startup performance.
 
-## [1.0.3] - 15-01-2020
+### Fixed
+ - The automatic update not working on Windows due to carriage returns (`\r`).
 
-### Added
-- The changelog file is now maintained
 
-## [1.0.4] - 23-01-2020
+## [1.0.7] - 2021-05-01
 
 ### Added
-- CUDA (.cu) support
+ - Shellscript support
+ - Makefile support
+ - CMake support
+ - GLSL support
 
-## [1.0.5] - 23-01-2020
+### Fixed
+ - A few vulnerabilities in dependencies, by upgrading to newer dependencies.
 
-### Added
-- Updated the changelog and README to include version 1.0.4 and 1.0.5.
 
-## [1.0.6] - 16-03-2020
+## [1.0.6] - 2020-03-16
 
 ### Added
 - HTML support
@@ -45,35 +62,40 @@
 ### Changed
 - Altered placeholder for file description to be a little more accurate
 
-## [1.0.7] - 01-05-2021
+
+## [1.0.5] - 2020-01-23
 
 ### Added
- - Shellscript support
- - Makefile support
- - CMake support
- - GLSL support
+- Updated the changelog and README to include version 1.0.4 and 1.0.5.
 
-### Fixed
- - A few vulnerabilities in dependencies, by upgrading to newer dependencies.
 
-## [1.1.0] - 21-12-2021
+## [1.0.4] - 2020-01-23
 
 ### Added
- - Rust support
+- CUDA (.cu) support
 
-### Changed
- - The FileHeaderGenerator can now use custom dateformats, which can be edited by the 'dateFormat' option.
- - Changed the default number of lines to search from 20 to 15.
- - The extension now starts up after Visual Studio Code does, increasing startup performance.
+
+## [1.0.3] - 2020-01-15
+
+### Added
+- The changelog file is now maintained
+
+
+## [1.0.2] - 2020-01-15
+
+### Added
+- Now displays notification when command `Generate Header` is run but the extension isn't enabled
 
 ### Fixed
- - The automatic update not working on Windows due to carriage returns (`\r`).
+- Extension is now enabling itself according to the config, not always setting itself to disabled
+
+
+## [1.0.1] - 2020-01-15
 
-## [1.2.0] - 30-07-2022
 ### Added
- - New `file-header-generator.rustDocString` property that determines if Rust comments will implement the new docstring-aware description.
+- TypeScript support
+- JavaScript support
 
-### Changed
- - Rust to now be docstring-aware, using `//!` for the description to propagate it to Rust's auto-generated docs. This behaviour can be controlled with the `file-header-generator.rustDocString` setting.
- - Rust last-edited updates to overwrite comments with the current comment style (based on the `file-header-generator.rustDocString` property).
- - The internal codebase to now use a Header struct, which makes it much more clear what we're parsing and how.
+
+## [1.0.0] - 2020-01-15
+Initial release.

README.md

@@ -15,6 +15,60 @@ The creation of a new header is really easy. Simply run the command: "Generate H
 When the header is generated, it is automatically maintained (i.e., the 'Last Edited' date is updated) every time the file is saved. To stop this behaviour, set 'Auto updated?' to no or remove it altogether.
 
 
+### Custom languages
+In addition to a wide range of builtin languages, the File Header Generator also supports defining custom languages.
+
+A language is defined in terms of a _comment set_, which is either a triplet or quadruplet of "comments" (though they can be any string) that are written before each line of the header.
+
+There are three comment types that must be defined for every language:
+- The first comment in the set is the _start comment_, i.e., the prefix printed before the first line.
+- The second comment in the set is the _middle comment_, i.e., the prefix printed for lines not covered by the other comment types.
+- The third comment in the set is the _end comment_, i.e., the prefix printed for the last line.
+
+Then there is also one optional comment type:
+- The fourth comment in the set is the _doc comment_, which is printed before lines part of the description. This distinction allows some languages to extract semantic information from the header (e.g., Rust).
+
+Concretely, you can define your own comment by adding it to the map in the `file-header-generator.customLanguages` setting. For example, you can set the following in your [`settings.json`](https://code.visualstudio.com/docs/getstarted/settings) for a Plain Text (`plaintext`) file:
+
+```json
+{
+    "file-header-generator.customLanguages": {
+        "plaintext": [ "!0", "!1", "!2" ],
+    }
+}
+```
+As you can see, the syntax is mapping the language ID to a list with each of the definitions for the comment types.
+
+When you generate a header in such a file, you should get:
+
+![Example header with custom comments](images/plaintext-header-1.png)  
+_An example header generated with our custom definition, which shows where each comment type is printed._
+
+Another example where we use a custom docstring:
+```json
+{
+    "file-header-generator.customLanguages": {
+        "plaintext": [ "!0", "!1", "!2", "!d" ],
+    }
+}
+```
+
+![Example header with custom comments, including a docstring one](images/plaintext-header-2.png)  
+_An example header generated with our custom definition that also shows a doc comment._
+
+You can add as many custom mappings as you like.
+
+> Tip! You can discover the language ID by opening up the language menu and checking the brackets after every language. That shows its ID.
+> 
+> The button can be found in the bottom-right, usually with the name of the language of your current file:
+> 
+> ![Shows the button to spawn the language menu](images/language-menu-button.png)  
+> 
+> Clicking it reveals a menu that looks like the following:
+> 
+> ![Shows an example view on the language menu, with the language IDs in brackets](images/language-menu.png)  
+
+
 ## Commands
 
 The File Header Generator extension current contributes the following command:
@@ -32,7 +86,8 @@ This extension contributes the following settings:
 * `file-header-generator.dateFormat`: The format of dates written by the FileHeaderGenerator. Is set to the current locale by default (see the list of special tokens below). For an overview of the tokens available, refer to [https://moment.github.io/luxon/#/formatting?id=table-of-tokens](https://moment.github.io/luxon/#/formatting?id=table-of-tokens.). Additionally, there are a few extra values:
     * `<locale>`: Formats according to the standard locale, as reported by the system. Can also use the `FFF` format for this.
     * `<iso>`: Formats according to the standard ISO format.
-* `file-header-generator.rustDocString`: Whether or not to use new comments for the Rust language to work better with Rust's build-in docstrings. Note that enabling this will automatically overwrite old style comments on save (and vice versa).
+* `file-header-generator.customLanguages`: Defines support for custom languages. Map the language ID to a triplet of a start, middle and end comment, and optionally a docstring. See [its own section](#custom-langauges) for more information.
+* `file-header-generator.docString`: Whether or not to use special doc-comments for the description part. For example, Rust has `//!`, which makes the language server aware of the description for the module. Note that enabling this will automatically overwrite old style comments on save (and vice versa).
 
 
 ## Issues
@@ -46,34 +101,38 @@ Also note that I'm mostly making this extension for myself - that means that I m
 
 See the release notes for each version below. For a full overview, check CHANGELOG.md.
 
-### 1.0.0
+### 1.3.0
 
-Initial release of the extension.
+Support for custom language definitions, as well as a few new builtin ones (WGSL and [eFLINT](https://gitlab.com/eflint)). This release also sees a security fix.
 
-### 1.0.1
+### 1.2.0
 
-Added Typescript and Javascript support.
+Added docstring-aware style for Rust and an appropriate setting for that. Also revamped backend parsing algorithm.
 
-### 1.0.2
+### 1.1.0
 
-Extension was now disabled whatever the setting was. Also added notification for when Generate Header is run but the extension isn't enabled.
+Changed the date formatting from local to custom, and added support for Rust files. Also fixed the bug where the auto-update wouldn't work on Windows.
 
-### 1.0.4
+### 1.0.7
 
-Added CUDA files support.
+Fixed a few vulnerabilities and added support for shellscript (bash etc), Makefile, Cmake and GLSL files.
 
 ### 1.0.6
 
 Added support for HTML, CSS and PHP languages.
 
-### 1.0.7
+### 1.0.4
 
-Fixed a few vulnerabilities and added support for shellscript (bash etc), Makefile, Cmake and GLSL files.
+Added CUDA files support.
 
-### 1.1.0
+### 1.0.2
 
-Changed the date formatting from local to custom, and added support for Rust files. Also fixed the bug where the auto-update wouldn't work on Windows.
+Extension was now disabled whatever the setting was. Also added notification for when Generate Header is run but the extension isn't enabled.
 
-### 1.2.0
+### 1.0.1
 
-Added docstring-aware style for Rust and an appropriate setting for that. Also revamped backend parsing algorithm.
+Added Typescript and Javascript support.
+
+### 1.0.0
+
+Initial release of the extension.