Skip to content

Commit 6a91ef2

Browse files
committed
doc: add plugin vendor & update description
1 parent 76ed014 commit 6a91ef2

File tree

7 files changed

+44
-12
lines changed

7 files changed

+44
-12
lines changed

CHANGELOG.md

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,16 +4,11 @@
44

55
## [Unreleased]
66
### Added
7+
- add plugin vendor
78

89
### Changed
10+
- update description
911

10-
### Deprecated
11-
12-
### Removed
13-
14-
### Fixed
15-
16-
### Security
1712
## [0.0.5]
1813
### Added
1914
- Add hint information at the configuration window

README.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,12 @@
66
[![Downloads](https://img.shields.io/jetbrains/plugin/d/15507-codetime.svg)](https://plugins.jetbrains.com/plugin/15507-codetime)
77

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

12+
![CodeTime Dashboard](img/dashboard-light.png)
13+
![CodeTime Dashboard](img/dashboard-dark.png)
14+
1215
## Support Jetbrains IDES
1316

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

28-
2931
<!-- Plugin description -->
3032
## Installation
3133

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

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

54+
## Configuration
55+
56+
<kbd>Tools</kbd> > <kbd>Codetime Configuration</kbd> > <kbd>Input Token</kbd>
57+
<!-- Plugin description end -->
58+
59+
![Configuration](./img/configuration.png)
60+
61+
<!-- Plugin description -->
62+
## Troubleshooting
63+
- Turn debug mode:
64+
65+
<kbd>Tools</kbd> > <kbd>Codetime Configuration</kbd> > <kbd>Enable Debug Mode</kbd>
66+
67+
68+
- Check Log(idea.log file):
69+
70+
<kbd>Help</kbd> > <kbd>Show Log</kbd>
5271
<!-- Plugin description end -->
72+
73+
![Troubleshooting](./img/configuration.png)

build.gradle.kts

Lines changed: 18 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ tasks {
9595
sinceBuild(pluginSinceBuild)
9696
untilBuild(pluginUntilBuild)
9797

98-
// Extract the <!-- Plugin description --> section from README.md and provide for the plugin's manifest
98+
// Extract all the <!-- Plugin description --> section from README.md and provide for the plugin's manifest
9999
pluginDescription(
100100
closure {
101101
File("./README.md").readText().lines().run {
@@ -105,7 +105,23 @@ tasks {
105105
if (!containsAll(listOf(start, end))) {
106106
throw GradleException("Plugin description section not found in README.md:\n$start ... $end")
107107
}
108-
subList(indexOf(start) + 1, indexOf(end))
108+
val descriptionList = ArrayList<String>()
109+
var inDescription = false
110+
// There may be many <!-- Plugin description --> section
111+
forEach tmp@{
112+
if (it == start) {
113+
inDescription = true
114+
return@tmp
115+
}
116+
if (it == end) {
117+
inDescription = false
118+
return@tmp
119+
}
120+
if (inDescription) {
121+
descriptionList.add(it)
122+
}
123+
}
124+
descriptionList
109125
}.joinToString("\n").run { markdownToHTML(this) }
110126
}
111127
)

gradle.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
pluginGroup = com.github.si9ma.codetimejetbrains
55
pluginName_ = codetime
6-
pluginVersion = 0.0.5
6+
pluginVersion = 0.0.6
77
pluginSinceBuild = 193
88
pluginUntilBuild = 203.*
99
# Plugin Verifier integration -> https://github.com/JetBrains/gradle-intellij-plugin#plugin-verifier-dsl

img/configuration.png

44.2 KB
Loading

img/dashboard-dark.png

315 KB
Loading

img/dashboard-light.png

276 KB
Loading

0 commit comments

Comments
 (0)