Skip to content

Commit 005773e

Browse files
committed
Move to v1.2.0
1 parent 3118ae7 commit 005773e

File tree

7 files changed

+490
-1670
lines changed

7 files changed

+490
-1670
lines changed

CHANGELOG.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,3 +68,12 @@
6868

6969
### Fixed
7070
- The automatic update not working on Windows due to carriage returns (`\r`).
71+
72+
## [1.2.0] - 30-07-2022
73+
### Added
74+
- New `file-header-generator.rustDocString` property that determines if Rust comments will implement the new docstring-aware description.
75+
76+
### Changed
77+
- 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.
78+
- Rust last-edited updates to overwrite comments with the current comment style (based on the `file-header-generator.rustDocString` property).
79+
- The internal codebase to now use a Header struct, which makes it much more clear what we're parsing and how.

README.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,13 +32,14 @@ This extension contributes the following settings:
3232
* `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:
3333
* `<locale>`: Formats according to the standard locale, as reported by the system. Can also use the `FFF` format for this.
3434
* `<iso>`: Formats according to the standard ISO format.
35+
* `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).
3536

3637

3738
## Issues
3839

3940
If you encounter any issues, have suggestions or would like something to change, don't hesitate to leave an issue at our [github](https://github.com/Lut99/FileHeaderGenerator/issues)! Please try to use the appropriate tags so I can process them more efficiently.
4041

41-
Also note that I'm mostly making this extension for myself - that means that I might not respond to issues immediately or incorporate them, even if they're super good ideas.
42+
Also note that I'm mostly making this extension for myself - that means that I might not respond to issues immediately or incorporate them, even if they're super good ideas (but I am definitely willing to listen).
4243

4344

4445
## Release Notes
@@ -72,3 +73,7 @@ Fixed a few vulnerabilities and added support for shellscript (bash etc), Makefi
7273
### 1.1.0
7374

7475
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.
76+
77+
### 1.2.0
78+
79+
Added docstring-aware style for Rust and an appropriate setting for that. Also revamped backend parsing algorithm.

Test.rs

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
// TEST.rs
2+
// by Lut99
3+
//
4+
// Created:
5+
// 30 Jul 2022, 16:56:55
6+
// Last edited:
7+
// 30 Jul 2022, 17:39:57
8+
// Auto updated?
9+
// Yes
10+
//
11+
// Description:
12+
//! Test 4242
13+
//
14+
15+
16+
// by [object Object]
17+
//
18+
// Created:
19+
// 30 Jul 2022, 16:56:15
20+
// Last edited:
21+
// 30 Jul 2022, 16:56:18
22+
// Auto updated?
23+
// Yes
24+
//
25+
// Description:
26+
//! Test 42
27+
//
28+
29+
// UNTITLED 1
30+
// by Lut99
31+
//
32+
// Created:
33+
// 30 Jul 2022, 12:29:55
34+
// Last edited:
35+
// 30 Jul 2022, 16:48:26
36+
// Auto updated?
37+
// Yes
38+
//
39+
// Description:
40+
//! Test
41+
//
42+
43+

file-header-generator-1.2.0.vsix

385 KB
Binary file not shown.

0 commit comments

Comments
 (0)