Updated documentation

This commit is contained in:
Florian Bouillon 2021-07-15 17:13:26 +00:00
parent 39dc365887
commit 35d0af0b0a
3 changed files with 246 additions and 236 deletions

View File

@ -1,123 +1,128 @@
# Change Log
All notable changes to the "code-stats-vscode" extension will be documented in this file.
## [1.0.18] - 2020-04-01
### Changed
Updated dependencies.
## [1.0.16/1.0.17] - 2020-01-06
### Changed
Updated dependencies.
Filtered out certain output types like code runner output, etc.
## [1.0.15] - 2019-04-04
### Changed
Added Q# to languages.
Merged PR from thebird956:
Replaced deprecated 'vscode.previewHtml' command to the webview API.
## [1.0.14] - 2019-04-04
### Changed
Updated deps and VS code engine version.
## [1.0.13] - 2018-11-28
### Changed
Updated some outdated vulnerable dependency packages.
## [1.0.12] - 2018-07-05
### Changed
Updated some outdated dependency packages.
## [1.0.11] - 2018-07-04
### Changed
Fixed the missing lodash.template dependency for the merged HTML profile view.
## [1.0.10] - 2018-07-04
### Changed
Updated security vulnerable dependecy per CVE-2017-16042. Growl to 1.10.5
## [1.0.9] - 2018-07-04
### Added
Merged a PR from scout199 to for a HTML-profile view and addition of username setting.
### Changed
Change in the extension publisher account from juha-ristolainen to riussi. You need to uninstall the old extension and re-install.
## [1.0.8] - 2017-08-28
Merged a PR from nicd to refactor the counting logic.
## [1.0.7] - 2017-05-29
### Changed
Merged a PR from sharpred to count formatting a large JSON-file only as 1 XP.
## [1.0.6] - 2017-03-24
### Changed
Changed the plugin to default to just langId if the langId is not found in the mapped language names.
Added Elm and Elixir to mapped names.
## [1.0.5] - 2017-03-18
### Changed
Changed language names to reflect the ones already used in Code::Stats.
## [1.0.4] - 2017-03-18
### Added
Added a manual mapping to natural language language names.
## [1.0.3] - 2017-03-18
### Added
Added license for the logo from Nicd.
### Changed
Fixed an accumulation of xp bug
## [1.0.2] - 2017-03-17
### Added
Added a logo for the extension.
## [1.0.1] - 2017-03-17
### Added
Added the missing github information to package.json
Added the .vsix installation package as well.
## [1.0.0] - 2017-03-17
### Added
Initial release of code-stats-vscode
# Change Log
All notable changes to the "code-stats-vscode" extension will be documented in this file.
## [1.1.0] - 2021-07-15
- Extension now works on remote containers without anything to do
- A command can now be used to set the API_KEY setting
## [1.0.18] - 2020-04-01
### Changed
Updated dependencies.
## [1.0.16/1.0.17] - 2020-01-06
### Changed
Updated dependencies.
Filtered out certain output types like code runner output, etc.
## [1.0.15] - 2019-04-04
### Changed
Added Q# to languages.
Merged PR from thebird956:
Replaced deprecated 'vscode.previewHtml' command to the webview API.
## [1.0.14] - 2019-04-04
### Changed
Updated deps and VS code engine version.
## [1.0.13] - 2018-11-28
### Changed
Updated some outdated vulnerable dependency packages.
## [1.0.12] - 2018-07-05
### Changed
Updated some outdated dependency packages.
## [1.0.11] - 2018-07-04
### Changed
Fixed the missing lodash.template dependency for the merged HTML profile view.
## [1.0.10] - 2018-07-04
### Changed
Updated security vulnerable dependecy per CVE-2017-16042. Growl to 1.10.5
## [1.0.9] - 2018-07-04
### Added
Merged a PR from scout199 to for a HTML-profile view and addition of username setting.
### Changed
Change in the extension publisher account from juha-ristolainen to riussi. You need to uninstall the old extension and re-install.
## [1.0.8] - 2017-08-28
Merged a PR from nicd to refactor the counting logic.
## [1.0.7] - 2017-05-29
### Changed
Merged a PR from sharpred to count formatting a large JSON-file only as 1 XP.
## [1.0.6] - 2017-03-24
### Changed
Changed the plugin to default to just langId if the langId is not found in the mapped language names.
Added Elm and Elixir to mapped names.
## [1.0.5] - 2017-03-18
### Changed
Changed language names to reflect the ones already used in Code::Stats.
## [1.0.4] - 2017-03-18
### Added
Added a manual mapping to natural language language names.
## [1.0.3] - 2017-03-18
### Added
Added license for the logo from Nicd.
### Changed
Fixed an accumulation of xp bug
## [1.0.2] - 2017-03-17
### Added
Added a logo for the extension.
## [1.0.1] - 2017-03-17
### Added
Added the missing github information to package.json
Added the .vsix installation package as well.
## [1.0.0] - 2017-03-17
### Added
Initial release of code-stats-vscode

229
README.md
View File

@ -1,112 +1,117 @@
# Code::Stats extension to Visual Studio Code.
This is a Visual Studio Code extension to send updates to [https://codestats.net](https://codestats.net)
## NOTICE
I had to publish the latest version under a new publisher account. This means that if you have the old version installed you won't get an update for it. You have to uninstall the 1.0.8 or older version and install the new one from the new publisher name 'riussi' from https://marketplace.visualstudio.com/items?itemName=riussi.code-stats-vscode
## Features
This extension tracks the amount of changes you make to your files and sends out pulses to [https://codestats.net/api-docs#pulse](https://codestats.net/api-docs#pulse) to track your XP.
## Extension Settings
You need to register your machine at [https://codestats.net/my/machines](https://codestats.net/my/machines) to get an API key which you need to set in the settings.
This extension contributes the following settings:
- `codestats.apikey`: API key for your machine
- `codestats.apiurl`: Base URL for the API-endpoint
- `codestats.username`: Code::stats username
## Known Issues
## Release Notes
### 1.0.18
Updated dependencies.
### 1.0.16/1.0.17
Updated dependencies.
Added filtering out of some output languages like code runner, etc.
### 1.0.15
Added Q# to languages.
Merged PR from thebird956:
Replaced deprecated 'vscode.previewHtml' command to the webview API.
### 1.0.14
Updated deps and moved to latest VS code engine.
### 1.0.13
Updated some outdated vulnerable dependency packages. Moved the repo to Gitlab.
### 1.0.12
Updated some outdated dependency packages.
### 1.0.11
Fixed the missing lodash.template dependency for the merged HTML profile view.
### 1.0.10
Updated security vulnerable dependecy per CVE-2017-16042. Growl to 1.10.5
### 1.0.9
Merged a PR from scout199 to for a HTML-profile view and addition of username setting.
Change in the extension publisher account from juha-ristolainen to riussi. You need to uninstall the old extension and re-install.
### 1.0.8
Merged a PR from nicd to refactor the counting logic.
### 1.0.7
Merged a PR from sharpred to count formatting a large JSON-object only as 1 XP.
### 1.0.6
Changed to return just the langId if not found in the mapped languages names.
Added Elm and Elixir to the mapped names.
### 1.0.5
Changed language names to reflect the ones already used in Code::Stats.
### 1.0.4
Added a manual mapping to natural language language names.
### 1.0.3
Fixed an accumulation of XP bug.
Added a license for the logo.
### 1.0.2
Added a logo for the extension.
### 1.0.1
Added the missing github information to package.json
Added the .vsix installation package as well.
### 1.0.0
Initial release of code-stats-vscode
### For more information
- [Gitlab repository](https://gitlab.com/juha.ristolainen/code-stats-vscode)
**Enjoy!**
# Code::Stats extension to Visual Studio Code.
This is a Visual Studio Code extension to send updates to [https://codestats.net](https://codestats.net)
## Note
This is a fork that will try stay up to date with VSCode and available on open-vsx.org
## Features
This extension tracks the amount of changes you make to your files and sends out pulses to [https://codestats.net/api-docs#pulse](https://codestats.net/api-docs#pulse) to track your XP.
## Extension Settings
You need to register your machine at [https://codestats.net/my/machines](https://codestats.net/my/machines) to get an API key which you need to set in the settings.
This extension contributes the following settings:
- `codestats.apikey`: API key for your machine
- `codestats.apiurl`: Base URL for the API-endpoint
- `codestats.username`: Code::stats username
## Known Issues
## Release Notes
### 1.1.0
- Extension now works on remote containers without anything to do
- A command can now be used to set the API_KEY setting
### 1.0.18
Updated dependencies.
### 1.0.16/1.0.17
Updated dependencies.
Added filtering out of some output languages like code runner, etc.
### 1.0.15
Added Q# to languages.
Merged PR from thebird956:
Replaced deprecated 'vscode.previewHtml' command to the webview API.
### 1.0.14
Updated deps and moved to latest VS code engine.
### 1.0.13
Updated some outdated vulnerable dependency packages. Moved the repo to Gitlab.
### 1.0.12
Updated some outdated dependency packages.
### 1.0.11
Fixed the missing lodash.template dependency for the merged HTML profile view.
### 1.0.10
Updated security vulnerable dependecy per CVE-2017-16042. Growl to 1.10.5
### 1.0.9
Merged a PR from scout199 to for a HTML-profile view and addition of username setting.
Change in the extension publisher account from juha-ristolainen to riussi. You need to uninstall the old extension and re-install.
### 1.0.8
Merged a PR from nicd to refactor the counting logic.
### 1.0.7
Merged a PR from sharpred to count formatting a large JSON-object only as 1 XP.
### 1.0.6
Changed to return just the langId if not found in the mapped languages names.
Added Elm and Elixir to the mapped names.
### 1.0.5
Changed language names to reflect the ones already used in Code::Stats.
### 1.0.4
Added a manual mapping to natural language language names.
### 1.0.3
Fixed an accumulation of XP bug.
Added a license for the logo.
### 1.0.2
Added a logo for the extension.
### 1.0.1
Added the missing github information to package.json
Added the .vsix installation package as well.
### 1.0.0
Initial release of code-stats-vscode
### For more information
- [Gitlab repository](https://gitlab.com/juha.ristolainen/code-stats-vscode)
**Enjoy!**

View File

@ -15,7 +15,7 @@
"icon": "logo.png",
"repository": {
"type": "gitlab",
"url": "https://gitlab.com/juha.ristolainen/code-stats-vscode"
"url": "https://gitlab.com/aviortheking/code-stats-vscode"
},
"engines": {
"vscode": "^1.43.2"