Skip to content

Commit

Permalink
Update: documents.
Browse files Browse the repository at this point in the history
  • Loading branch information
uctakeoff committed Jul 4, 2020
1 parent a15f940 commit e658cec
Show file tree
Hide file tree
Showing 5 changed files with 41 additions and 7 deletions.
11 changes: 11 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,17 @@ Check [Keep a Changelog](http://keepachangelog.com/) for recommendations on how

* workspace counter in status bar.

## [2.0.0]

### Added

- New Command : `Save the collected language configurations`.

### Update

- This extension is no longer resident.
- Don't save whether or not the program is shown in the status bar in the settings.

## [1.3.5]

### Fixed
Expand Down
27 changes: 25 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,13 @@ VS Code extension: counts blank lines, comment lines, and physical lines of sour
* [github](https://github.com/uctakeoff/vscode-counter)
* [Marketplace](https://marketplace.visualstudio.com/items?itemName=uctakeoff.vscode-counter)

## VSCode Counter 2.0 is released!

* Experimental support for "**VSCode Remove Development**".

When using VSCode Counter in *VSCode Remove Development*, use the `Save language configurations` function You will need to.
[See below for more information](#save-language-configurations).

## Features

- Count the code lines of source code in workspace or directory.
Expand Down Expand Up @@ -41,9 +48,25 @@ VS Code extension: counts blank lines, comment lines, and physical lines of sour

* Available languages can be increased by adding language extensions.

### Save language configurations

**VSCode Counter** is able to aggregate in unknown languages by referring to the information in the installed language extensions. However, I found out that **this information is not available in Remote Development**.

Therefore, VSCode Counter's ability of **collecting VSCode language extensions** is now called as an independent function. The idea is to collect the information once in the local environment and store it so that it can be used remotely.

* First, launch VSCode on your local server.
* Then, open the command palette and select `VSCodeCounter: Save the collected language configurations`.
* Then *settings.json* will store the configuration information collected from the current language extensions .
![](images/save_lang.png)
* Connect to the remote and use the VSCodecounter as usual.


You can also change the location where your configurations are stored.
However, you must carry the stored information to the remote environment by yourself.


## Extension Settings

* `VSCodeCounter.showInStatusBar`: Whether to show the count result of the current file on the status bar in real time.
* `VSCodeCounter.useGitignore`: Whether to use '.gitignore' files for excluding files.
* `VSCodeCounter.useFilesExclude`: Whether to use setting 'files.exclude' for excluding files.
* `VSCodeCounter.printNumberWithCommas`: Whether to print a number with commas as thousands separators.(except for CSV)
Expand All @@ -56,6 +79,6 @@ VS Code extension: counts blank lines, comment lines, and physical lines of sour
* `VSCodeCounter.outputAsCSV`: Whether to output the result as a CSV file.
* `VSCodeCounter.outputAsMarkdown`: Whether to output the result as a Markdown file.
* `VSCodeCounter.outputPreviewType`: Type of output file to preview after counting. Choose from `text`, `csv`, `markdown` or `none`.
* `VSCodeCounter.blockComment`: Define patterns indicating the beginning and end of the block document(here document).
* `VSCodeCounter.saveLocation`: Specify where to store the collected language configurations.

**Enjoy!**
Binary file added images/save_lang.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 4 additions & 4 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -272,7 +272,7 @@
"vscode-test": "^1.4.0"
},
"dependencies": {
"jsonc-parser": "^2.2.1",
"jsonc-parser": "^2.3.0",
"minimatch": "^3.0.4"
}
}

0 comments on commit e658cec

Please sign in to comment.