Skip to content

Commit

Permalink
doc: add plugin vendor & update description
Browse files Browse the repository at this point in the history
  • Loading branch information
si9ma committed Jan 2, 2021
1 parent 76ed014 commit 6a91ef2
Show file tree
Hide file tree
Showing 7 changed files with 44 additions and 12 deletions.
9 changes: 2 additions & 7 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,11 @@

## [Unreleased]
### Added
- add plugin vendor

### Changed
- update description

### Deprecated

### Removed

### Fixed

### Security
## [0.0.5]
### Added
- Add hint information at the configuration window
Expand Down
25 changes: 23 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,9 +6,12 @@
[![Downloads](https://img.shields.io/jetbrains/plugin/d/15507-codetime.svg)](https://plugins.jetbrains.com/plugin/15507-codetime)

<!-- Plugin description -->
Codetime jetbrains plugin. Statistical analysis of your programming time.
[Codetime](https://codetime.datreks.com/) jetbrains plugin. Statistical analysis of your programming time.
<!-- Plugin description end -->

![CodeTime Dashboard](img/dashboard-light.png)
![CodeTime Dashboard](img/dashboard-dark.png)

## Support Jetbrains IDES

[![CLion](https://github.com/JetBrains/logos/blob/master/web/clion/clion.svg)](https://www.jetbrains.com/clion/)
Expand All @@ -25,7 +28,6 @@ Codetime jetbrains plugin. Statistical analysis of your programming time.
[![WebStorm](https://github.com/JetBrains/logos/blob/master/web/webstorm/webstorm.svg)](https://www.jetbrains.com/webstorm/)
[![Android Studio](./img/android-studio.svg)](https://developer.android.com/studio)


<!-- Plugin description -->
## Installation

Expand All @@ -49,4 +51,23 @@ Codetime jetbrains plugin. Statistical analysis of your programming time.

- Visit https://codetime.datreks.com/ to see your code time statistical analysis.

## Configuration

<kbd>Tools</kbd> > <kbd>Codetime Configuration</kbd> > <kbd>Input Token</kbd>
<!-- Plugin description end -->

![Configuration](./img/configuration.png)

<!-- Plugin description -->
## Troubleshooting
- Turn debug mode:

<kbd>Tools</kbd> > <kbd>Codetime Configuration</kbd> > <kbd>Enable Debug Mode</kbd>


- Check Log(idea.log file):

<kbd>Help</kbd> > <kbd>Show Log</kbd>
<!-- Plugin description end -->

![Troubleshooting](./img/configuration.png)
20 changes: 18 additions & 2 deletions build.gradle.kts
Original file line number Diff line number Diff line change
Expand Up @@ -95,7 +95,7 @@ tasks {
sinceBuild(pluginSinceBuild)
untilBuild(pluginUntilBuild)

// Extract the <!-- Plugin description --> section from README.md and provide for the plugin's manifest
// Extract all the <!-- Plugin description --> section from README.md and provide for the plugin's manifest
pluginDescription(
closure {
File("./README.md").readText().lines().run {
Expand All @@ -105,7 +105,23 @@ tasks {
if (!containsAll(listOf(start, end))) {
throw GradleException("Plugin description section not found in README.md:\n$start ... $end")
}
subList(indexOf(start) + 1, indexOf(end))
val descriptionList = ArrayList<String>()
var inDescription = false
// There may be many <!-- Plugin description --> section
forEach tmp@{
if (it == start) {
inDescription = true
return@tmp
}
if (it == end) {
inDescription = false
return@tmp
}
if (inDescription) {
descriptionList.add(it)
}
}
descriptionList
}.joinToString("\n").run { markdownToHTML(this) }
}
)
Expand Down
2 changes: 1 addition & 1 deletion gradle.properties
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@

pluginGroup = com.github.si9ma.codetimejetbrains
pluginName_ = codetime
pluginVersion = 0.0.5
pluginVersion = 0.0.6
pluginSinceBuild = 193
pluginUntilBuild = 203.*
# Plugin Verifier integration -> https://github.com/JetBrains/gradle-intellij-plugin#plugin-verifier-dsl
Expand Down
Binary file added img/configuration.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/dashboard-dark.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added img/dashboard-light.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6a91ef2

Please sign in to comment.