Skip to content

Commit

Permalink
Update GitHub username and some typos.
Browse files Browse the repository at this point in the history
  • Loading branch information
Crystal-Spider committed Jul 16, 2024
1 parent 48a1493 commit 949ee94
Show file tree
Hide file tree
Showing 5 changed files with 49 additions and 42 deletions.
4 changes: 2 additions & 2 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@ name: Bug report
about: Create a report to help us improve
title: Bug
labels: bug
assignees: Nyphet

assignees: Crystal-Spider
---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behavior:

1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
Expand Down
3 changes: 1 addition & 2 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,8 +3,7 @@ name: Feature request
about: Suggest an idea for this project
title: Feature request
labels: enhancement
assignees: Nyphet

assignees: Crystal-Spider
---

**Is your feature request related to a problem? Please describe.**
Expand Down
46 changes: 27 additions & 19 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,13 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

- Nothing new.

## [2.2.0] - 2024/07/16

### Additions

- [#23](https://github.com/Crystal-Spider/jsdoc-generator/pull/23), new options to create single line descriptions and to omit the empty line after descriptions.
- [#24](https://github.com/Crystal-Spider/jsdoc-generator/pull/24), placeholder for unknown type annotations (`any`s).

## [2.1.0] - 2024/04/12

### Changes
Expand All @@ -26,15 +33,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Fixes

- [#18](https://github.com/Nyphet/jsdoc-generator/issues/18), multiline values and descriptions not adding asterisks on new lines.
- [#18](https://github.com/Crystal-Spider/jsdoc-generator/issues/18), multiline values and descriptions not adding asterisks on new lines.
- API key setting not resetting unless the extension is reloaded.

## [2.0.0] - 2023/10/12

### Additions

- Implemented [#16](https://github.com/Nyphet/jsdoc-generator/issues/16), added alignment options.
- Implemented [#10](https://github.com/Nyphet/jsdoc-generator/issues/10), integration of ChatGPT to automatically generate descriptions.
- Implemented [#16](https://github.com/Crystal-Spider/jsdoc-generator/issues/16), added alignment options.
- Implemented [#10](https://github.com/Crystal-Spider/jsdoc-generator/issues/10), integration of ChatGPT to automatically generate descriptions.
- Finally implemented the command to generate JSDoc for all suitable files in the current workspace (recursive).
- Additions command in folder contextual menu to generate JSDoc for all TS and JS files in the folder (recursive).
- Additions command in file contextual menu to generate JSDoc for that file.
Expand All @@ -46,9 +53,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Fixes

- Fixed [#8](https://github.com/Nyphet/jsdoc-generator/issues/8), corrected and improved template tags.
- Fixed [#12](https://github.com/Nyphet/jsdoc-generator/issues/12), prevent adding `@typedef` when `includeTypes` is false.
- Fixed [#17](https://github.com/Nyphet/jsdoc-generator/issues/17), JSDoc generation for functions that deconstruct parameters.
- Fixed [#8](https://github.com/Crystal-Spider/jsdoc-generator/issues/8), corrected and improved template tags.
- Fixed [#12](https://github.com/Crystal-Spider/jsdoc-generator/issues/12), prevent adding `@typedef` when `includeTypes` is false.
- Fixed [#17](https://github.com/Crystal-Spider/jsdoc-generator/issues/17), JSDoc generation for functions that deconstruct parameters.

## [1.3.0] - 2023/07/21

Expand All @@ -69,7 +76,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

### Fixes

- Fixed [#5](https://github.com/Nyphet/jsdoc-generator/issues/5).
- Fixed [#5](https://github.com/Crystal-Spider/jsdoc-generator/issues/5).
- Fixed unnecessary brackets around union or intersection types.
For example, `Type<T & U>` before became `(Type<T & U>)`, now it correctly stays as `Type<T & U>`.

Expand Down Expand Up @@ -105,15 +112,16 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Few basic unit tests.
- This [CHANGELOG] file.

[unreleased]: https://github.com/Nyphet/jsdoc-generator
[2.1.0]: https://github.com/Nyphet/jsdoc-generator/releases/tag/v2.1.0
[2.0.2]: https://github.com/Nyphet/jsdoc-generator/releases/tag/v2.0.2
[2.0.1]: https://github.com/Nyphet/jsdoc-generator/releases/tag/v2.0.1
[2.0.0]: https://github.com/Nyphet/jsdoc-generator/releases/tag/v2.0.0
[1.3.0]: https://github.com/Nyphet/jsdoc-generator/releases/tag/v1.3.0
[1.2.0]: https://github.com/Nyphet/jsdoc-generator/releases/tag/v1.2.0
[1.1.1]: https://github.com/Nyphet/jsdoc-generator/releases/tag/v1.1.1
[1.1.0]: https://github.com/Nyphet/jsdoc-generator/releases/tag/v1.1.0
[1.0.0]: https://github.com/Nyphet/jsdoc-generator/releases/tag/v1.0.0
[readme]: https://github.com/Nyphet/jsdoc-generator
[changelog]: https://github.com/Nyphet/jsdoc-generator/blob/main/CHANGELOG.md
[unreleased]: https://github.com/Crystal-Spider/jsdoc-generator
[2.2.0]: https://github.com/Crystal-Spider/jsdoc-generator/releases/tag/v2.2.0
[2.1.0]: https://github.com/Crystal-Spider/jsdoc-generator/releases/tag/v2.1.0
[2.0.2]: https://github.com/Crystal-Spider/jsdoc-generator/releases/tag/v2.0.2
[2.0.1]: https://github.com/Crystal-Spider/jsdoc-generator/releases/tag/v2.0.1
[2.0.0]: https://github.com/Crystal-Spider/jsdoc-generator/releases/tag/v2.0.0
[1.3.0]: https://github.com/Crystal-Spider/jsdoc-generator/releases/tag/v1.3.0
[1.2.0]: https://github.com/Crystal-Spider/jsdoc-generator/releases/tag/v1.2.0
[1.1.1]: https://github.com/Crystal-Spider/jsdoc-generator/releases/tag/v1.1.1
[1.1.0]: https://github.com/Crystal-Spider/jsdoc-generator/releases/tag/v1.1.0
[1.0.0]: https://github.com/Crystal-Spider/jsdoc-generator/releases/tag/v1.0.0
[readme]: https://github.com/Crystal-Spider/jsdoc-generator
[changelog]: https://github.com/Crystal-Spider/jsdoc-generator/blob/main/CHANGELOG.md
36 changes: 18 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,10 +37,10 @@ This extension contributes the following settings:
Leave empty to disable.
Default: `""`
- `jsdoc-generator.emptyLineAfterHeader`:
Whether to prefer single line comments (`/** ... */`) whenever possible.
Whether to prefer single line comments (`/** ... */`) whenever possible.
Default: `true`
- `jsdoc-generator.singleLineComments`:
Whether to add an empty line after the header (description, date, author).
Whether to add an empty line after the header (description, date, author).
Default: `false`
- `jsdoc-generator.includeTypes`:
Whether to include types into the generated JSDoc.
Expand Down Expand Up @@ -196,53 +196,53 @@ Some non [everyday types](https://www.typescriptlang.org/docs/handbook/2/everyda

## Release Notes

### [2.2.0](https://github.com/Nyphet/jsdoc-generator/releases/tag/v2.2.0)
### [2.2.0](https://github.com/Crystal-Spider/jsdoc-generator/releases/tag/v2.2.0)

- [#23](https://github.com/Crystal-Spider/jsdoc-generator/pull/23), new options to create single line descriptions and to omit the empty line after descriptions.
- [#24](https://github.com/Crystal-Spider/jsdoc-generator/pull/24), placeholder for unknown type annotations (`any`s).

### [2.1.0](https://github.com/Nyphet/jsdoc-generator/releases/tag/v2.1.0)
### [2.1.0](https://github.com/Crystal-Spider/jsdoc-generator/releases/tag/v2.1.0)

- [#22](https://github.com/Crystal-Spider/jsdoc-generator/issues/22), changing how date tag format is handled.

### [2.0.2](https://github.com/Nyphet/jsdoc-generator/releases/tag/v2.0.2)
### [2.0.2](https://github.com/Crystal-Spider/jsdoc-generator/releases/tag/v2.0.2)

- [#20](https://github.com/Crystal-Spider/jsdoc-generator/issues/20), missing JSDoc terminator.

### [2.0.1](https://github.com/Nyphet/jsdoc-generator/releases/tag/v2.0.1)
### [2.0.1](https://github.com/Crystal-Spider/jsdoc-generator/releases/tag/v2.0.1)

- Fixed [#18](https://github.com/Nyphet/jsdoc-generator/issues/18), multiline values and descriptions not adding asterisks on new lines.
- Fixed [#18](https://github.com/Crystal-Spider/jsdoc-generator/issues/18), multiline values and descriptions not adding asterisks on new lines.
- Fixed API key setting not resetting unless the extension is reloaded.

### [2.0.0](https://github.com/Nyphet/jsdoc-generator/releases/tag/v2.0.0)
### [2.0.0](https://github.com/Crystal-Spider/jsdoc-generator/releases/tag/v2.0.0)

- Fixed [#8](https://github.com/Nyphet/jsdoc-generator/issues/8), corrected and improved template tags.
- Fixed [#12](https://github.com/Nyphet/jsdoc-generator/issues/12), prevent adding `@typedef` when `includeTypes` is false.
- Fixed [#17](https://github.com/Nyphet/jsdoc-generator/issues/17), JSDoc generation for functions that deconstruct parameters.
- Implemented [#16](https://github.com/Nyphet/jsdoc-generator/issues/16), added alignment options.
- Implemented [#10](https://github.com/Nyphet/jsdoc-generator/issues/10), integration of ChatGPT to automatically generate descriptions.
- Fixed [#8](https://github.com/Crystal-Spider/jsdoc-generator/issues/8), corrected and improved template tags.
- Fixed [#12](https://github.com/Crystal-Spider/jsdoc-generator/issues/12), prevent adding `@typedef` when `includeTypes` is false.
- Fixed [#17](https://github.com/Crystal-Spider/jsdoc-generator/issues/17), JSDoc generation for functions that deconstruct parameters.
- Implemented [#16](https://github.com/Crystal-Spider/jsdoc-generator/issues/16), added alignment options.
- Implemented [#10](https://github.com/Crystal-Spider/jsdoc-generator/issues/10), integration of ChatGPT to automatically generate descriptions.
- Finally implemented the command to generate JSDoc for all suitable files in the current workspace (recursive).
- Added command in folder contextual menu to generate JSDoc for all TS and JS files in the folder (recursive).
- Added command in file contextual menu to generate JSDoc for that file.
- Added progress loader to keep track of the generating JSDocs or interrupt the generation.
- Now explicitly overridden methods will only add the `@override` and `@inheritdoc` tags.

### [1.3.0](https://github.com/Nyphet/jsdoc-generator/releases/tag/v1.3.0)
### [1.3.0](https://github.com/Crystal-Spider/jsdoc-generator/releases/tag/v1.3.0)

Added a new setting option to create custom tags.

### [1.2.0](https://github.com/Nyphet/jsdoc-generator/releases/tag/v1.2.0)
### [1.2.0](https://github.com/Crystal-Spider/jsdoc-generator/releases/tag/v1.2.0)

Added a new setting option to disable type inference and added support for JavaScript.

### [1.1.1](https://github.com/Nyphet/jsdoc-generator/releases/tag/v1.1.1)
### [1.1.1](https://github.com/Crystal-Spider/jsdoc-generator/releases/tag/v1.1.1)

Added two setting options.

### [1.1.0](https://github.com/Nyphet/jsdoc-generator/releases/tag/v1.1.0)
### [1.1.0](https://github.com/Crystal-Spider/jsdoc-generator/releases/tag/v1.1.0)

Added support for Typescript React.

### [1.0.0](https://github.com/Nyphet/jsdoc-generator/releases/tag/v1.0.0)
### [1.0.0](https://github.com/Crystal-Spider/jsdoc-generator/releases/tag/v1.0.0)

Initial release of JSDoc Generator.
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -201,7 +201,7 @@
},
"repository": {
"type": "git",
"url": "https://github.com/Nyphet/jsdoc-generator.git"
"url": "https://github.com/Crystal-Spider/jsdoc-generator.git"
},
"scripts": {
"package": "vsce package",
Expand Down

0 comments on commit 949ee94

Please sign in to comment.