Skip to content

Commit b633ae5

Browse files
committed
[UPDATE] files CHANGELOG and README
1 parent 64b6d55 commit b633ae5

File tree

5 files changed

+36
-7
lines changed

5 files changed

+36
-7
lines changed

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/).
1616
- removing trailing spaces from the header
1717
- option to prefer single line comments to multiline one per language
1818

19+
## Fixed
20+
21+
- issue introduced in version 1.0.17 where an extra line would be added after each single comment line.
22+
1923
## [1.0.17] - 7/02/2026
2024

2125
### Fixed

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -252,6 +252,7 @@ The extension currently supports the following languages:
252252
- Add an option to toggle between single and multi line comments preference (during initial generation)
253253
- Add an option to override the comment used for single line comments per language (during initial generation)
254254
- Add an option to override the comment used for multiline comments per language (during initial generation)
255+
- Fix issue where version 1.0.17 would add extra lines between single line comments in the header
255256

256257
---
257258

vscode/asperheader/CHANGELOG.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,21 @@ All notable changes to this project will be documented in this file.
55
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
66
and this project adheres to [Semantic Versioning](https://semver.org/).
77

8+
## [1.0.18] - 7/02/2026
9+
10+
## Added
11+
12+
- language prepend option
13+
- language append option
14+
- language single line comment override
15+
- language multiline comment override
16+
- removing trailing spaces from the header
17+
- option to prefer single line comments to multiline one per language
18+
19+
## Fixed
20+
21+
- issue introduced in version 1.0.17 where an extra line would be added after each single comment line.
22+
823
## [1.0.17] - 7/02/2026
924

1025
### Fixed

vscode/asperheader/README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,13 @@ AsperHeader contributes the following settings:
104104
| `asperheader.randomLogo` | boolean | `false` | Insert a random ASCII logo on each header generation. |
105105
| `asperheader.extensionIgnore` | array | `[]` | File extensions to ignore when saving. |
106106
| `asperheader.useWorkspaceNameWhenAvailable` | boolean | `false` | Use the workspace name when available. |
107-
| `asperheader.projectDescription` | string | "" | The description to use instead of asking the user every time. |
107+
| `asperheader.projectDescription` | string | `""` | The description to use instead of asking the user every time. |
108+
| `asperheader.languagePrepend` | object | `{}` | If set, and language is matched, will put the text specified in the string in front of the comment during the initial generation of the header. example for python: `{"python": "r"}`, example for bash scripts: `{"bash":"#!/usr/bin/env bash\n"}` |
109+
| `asperheader.languageAppend` | object | `{}` | If set, and language is matched, will append the text specified in the string after the comment during the initial generation of the header. Useful for adding formatting or boilerplate. example: `{"python": "\n# Code begins"}` to add a separator comment after the header |
110+
| `asperheader.languageSingleLineCommentOverride` | object | `{}` | Specify an override of your choice for the single line comment to be used when it's specified language (name is case insensitive) is matched. example: `{"idris":"\|\|\|"}` instead of the default '--' |
111+
| `asperheader.languageMultiLineCommentOverride` | object | `{}` | Specify an override of your choice for the multiline comment to be used when it's specified language (name is case insensitive) is matched. example: `{"c":["/*","**","*/"]}` |
112+
| `asperheader.removeTrailingHeaderSpaces` | boolean | `true` | Toggle wether to remove trailing whitespaces from the lines in the header that might contain them due to the generation (i.e: a space after the `LOGO:` due to there being a newline instead of text) |
113+
| `asperheader.preferSingleLineComments` | boolean | `false` | Prefer using the single line comments when available for the language instead of the multiline version |
108114

109115
---
110116

@@ -239,6 +245,15 @@ The extension currently supports the following languages:
239245

240246
- Fix issue of bulk saving only updating the open file.
241247

248+
### 1.0.18
249+
250+
- Add an option to specify a character to add before the header based on the language (during initial header generation)
251+
- Add an option to specify a character to add after the header based on the language (during initial header generation)
252+
- Add an option to toggle between single and multi line comments preference (during initial generation)
253+
- Add an option to override the comment used for single line comments per language (during initial generation)
254+
- Add an option to override the comment used for multiline comments per language (during initial generation)
255+
- Fix issue where version 1.0.17 would add extra lines between single line comments in the header
256+
242257
---
243258

244259
## Following Extension Guidelines

vscode/asperheader/package-lock.json

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

0 commit comments

Comments
 (0)