Skip to content

Commit e9e5a11

Browse files
committed
Fixed a minor documentation issue
1 parent 480ed5e commit e9e5a11

File tree

11 files changed

+48
-69
lines changed

11 files changed

+48
-69
lines changed

common/build.gradle

-7
Original file line numberDiff line numberDiff line change
@@ -10,13 +10,6 @@ repositories {
1010
jcenter()
1111
}
1212

13-
// todo Remove this
14-
15-
//
16-
//test {
17-
// useJUnitPlatform()
18-
//}
19-
2013
dependencies {
2114
// todo We need move everything to utilCompile instead of main
2215

common/src/main/groovy/in/oneton/snippet/util/Util.groovy

-30
Original file line numberDiff line numberDiff line change
@@ -159,36 +159,6 @@ final class Util {
159159
} else {
160160
description = "${fileParent}-${fileBaseName}".trim()
161161
}
162-
163-
if (description ==~ /.*\+.*/) {
164-
description = description.replaceAll(/\+/, ' with responsive variations')
165-
}
166-
if (description ==~ /^.*:\*\*$/) {
167-
description = description.replaceAll(/:\*\*/, ' + more variations')
168-
}
169-
if (description ==~ /^.*:\?$/) {
170-
description = description.replaceAll(/:\?/, ' help')
171-
}
172-
if (description ==~ /^.*-\*.*$/) {
173-
description = description.replaceAll(/-\*/, ' *forEach flavor')
174-
}
175-
if (description ==~ /^.*@.*$/) {
176-
description = description.replaceAll(/@/, 'attribute directive ')
177-
}
178-
if (description ==~ /^.*_([^\W]+?)?\b.*$/) {
179-
description = description.replaceAll(/_([^\W]+?)?\b/, /$1 snippet/)
180-
}
181-
if (description ==~ /^.*:([a-z ]+)$/) {
182-
description = description.replaceAll(/:([a-z ]+)$/, / + $1 variation/)
183-
}
184-
if (description ==~ /.*-a\b.*/) {
185-
description = description.replaceAll(/-a\b/, ' with link')
186-
}
187-
if (fileBaseName ==~ /^\$.*/) {
188-
description = 'Reactive form variation of ' + description.replaceAll(/\$/, '')
189-
} else if (description ==~ /.*\$.*/) {
190-
description = description.replaceAll(/\$/, ' with observable variation')
191-
}
192162
escapeXml11(description.replace(/-/, ' ')).trim()
193163
}
194164
}

common/src/main/groovy/in/oneton/snippet/util/readme/ReadmeGenerator.groovy

+17-9
Original file line numberDiff line numberDiff line change
@@ -67,18 +67,26 @@ class ReadmeGenerator {
6767
String parentDirName = snippetResource.parent.substring(snippetResource.parent.lastIndexOf('/') + 1)
6868
String sectionName = parentDirName.replaceAll(/-/, ' ').capitalize()
6969

70-
def snippetHelpBuilder = SnippetHelp.builder()
70+
if (fileBaseName != '$') {
71+
def snippetHelpBuilder = SnippetHelp.builder()
7172
.description(nameToDescription(sectionName, fileBaseName))
7273

73-
def triggerNameDetail = triggerName(prefix, parentDirName, fileBaseName, skipParentDirNameFromTrigger)
74-
snippetHelpBuilder.trigger("${triggerNameDetail.computedPrefix}**${(triggerNameDetail.name - triggerNameDetail.computedPrefix).replaceAll('\\*', '\\\\\\\\*')}**")
75-
76-
List<SnippetHelp> helps = folderToSnippets.get(sectionName)
77-
if (!helps) {
78-
helps = new ArrayList<>()
74+
def triggerNameDetail = triggerName(prefix, parentDirName, fileBaseName, skipParentDirNameFromTrigger)
75+
snippetHelpBuilder.trigger("${triggerNameDetail.computedPrefix}**${(triggerNameDetail.name - triggerNameDetail.computedPrefix).replaceAll('\\*', '\\\\\\\\*')}**")
76+
77+
List<SnippetHelp> helps = folderToSnippets.get(sectionName)
78+
if (!helps) {
79+
helps = new ArrayList<>()
80+
}
81+
helps.add(snippetHelpBuilder.build())
82+
folderToSnippets.put(sectionName, helps)
83+
} else {
84+
def snippetHelp = SnippetHelp.builder()
85+
.trigger("${prefix}-**\$**")
86+
.description('Bootstrap master template')
87+
.build()
88+
folderToSnippets.put('Bootstrap master template', Arrays.asList(snippetHelp))
7989
}
80-
helps.add(snippetHelpBuilder.build())
81-
folderToSnippets.put(sectionName, helps)
8290
}
8391

8492
StringBuilder builder = new StringBuilder()

intellij/.version

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
6.0.1
1+
6.0.2

intellij/CHANGELOG.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
## Since 6.0.2 (7 Dec 2018):
2+
3+
- Fixed a minor documentation issue
4+
- Removed unnecessary spring dependency
5+
16
## Since 6.0.1 (7 Dec 2018):
27

38
- Fixed a minor issue w.r.t help gif

intellij/README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ This plugin is compatible with the following JetBrains products:
88
- PyCharm
99
- RubyMine
1010

11-
![Plugin in action](https://github.com/1tontech/bootstrap4-snippets/raw/intellij-6.0.1/intellij/help.gif)
11+
![Plugin in action](https://github.com/1tontech/bootstrap4-snippets/raw/intellij-6.0.2/intellij/help.gif)
1212

1313
The detailed list of supported template triggers are listed [below](#documentation)
1414

@@ -62,11 +62,11 @@ Here are available live templates
6262

6363
### Bootstrap 4 snippets
6464

65-
#### Bootstrap
65+
#### Bootstrap master template
6666

6767
Trigger | Description
6868
--- | ---
69-
b4-**bootstrap$** | Reactive form variation of Bootstrap
69+
b4-**$** | Bootstrap master template
7070

7171
#### Alert
7272

@@ -109,11 +109,11 @@ b4-**breadcrumb-list** | Breadcrumb list
109109

110110
Trigger | Description
111111
--- | ---
112-
b4-**button-a** | Button with link
112+
b4-**button-a** | Button a
113113
b4-**button-block** | Button block
114114
b4-**button-checkbox** | Button checkbox
115115
b4-**button-default** | Button default
116-
b4-**button-disabled-a** | Button disabled with link
116+
b4-**button-disabled-a** | Button disabled a
117117
b4-**button-input** | Button input
118118
b4-**button-outline** | Button outline
119119
b4-**button-radio** | Button radio
@@ -232,7 +232,7 @@ b4-**jumbotron-fluid** | Jumbotron fluid
232232

233233
Trigger | Description
234234
--- | ---
235-
b4-**list-a** | List with link
235+
b4-**list-a** | List a
236236
b4-**list-badge** | List badge
237237
b4-**list-button** | List button
238238
b4-**list-colors** | List colors
@@ -252,9 +252,9 @@ b4-**modal-sizes** | Modal sizes
252252

253253
Trigger | Description
254254
--- | ---
255-
b4-**nav-a** | Nav with link
255+
b4-**nav-a** | Nav a
256256
b4-**nav-complete** | Nav complete
257-
b4-**nav-tabs-pills-a-variation** | Nav tabs pills with link variation
257+
b4-**nav-tabs-pills-a-variation** | Nav tabs pills a variation
258258
b4-**nav-tabs-pills-dropdown** | Nav tabs pills dropdown
259259
b4-**nav-tabs-pills-ul-variation** | Nav tabs pills ul variation
260260
b4-**nav-ul** | Nav ul
@@ -266,7 +266,7 @@ Trigger | Description
266266
b4-**navbar-background-color** | Navbar background color
267267
b4-**navbar-background** | Navbar background
268268
b4-**navbar-default** | Navbar default
269-
b4-**navbar-minimal-a** | Navbar minimal with link
269+
b4-**navbar-minimal-a** | Navbar minimal a
270270
b4-**navbar-minimal-ul** | Navbar minimal ul
271271
b4-**navbar-non-responsive** | Navbar non responsive
272272
b4-**navbar-placement** | Navbar placement

intellij/build.gradle

+1-2
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ buildscript {
1717
apply plugin: 'org.jetbrains.intellij'
1818

1919
// Will be replaced by build before publish. Leave it as is
20-
version '6.0.1'
20+
version '6.0.2'
2121

2222
apply plugin: 'groovy'
2323
apply plugin: 'java'
@@ -51,7 +51,6 @@ dependencies {
5151
utilCompile group: 'commons-io', name: 'commons-io', version: '2.5'
5252
utilCompile group: 'com.fasterxml.jackson.dataformat', name: 'jackson-dataformat-xml', version: '2.8.4'
5353
utilCompile group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '2.8.4'
54-
utilCompile group: 'org.springframework', name: 'spring-core', version: '4.3.4.RELEASE'
5554
utilCompile group: 'com.vladsch.flexmark', name: 'flexmark', version: '0.28.12'
5655
}
5756

vscode/.version

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
6.0.0
1+
6.0.1

vscode/CHANGELOG.md

+5
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
## Since 6.0.1 (7 Dec 2018):
2+
3+
- Fixed a minor documentation issue
4+
- Removed unnecessary spring dependency
5+
16
## Since 6.0.0 (7 Dec 2018):
27

38
- Major refactoring to unify the codebases of IntelliJ & Vscode plugins

vscode/README.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Bootstrap 4, Font awesome 4, Font Awesome 5 Free & Pro snippets for Visual studi
33

44
Visual studio code plugin containing Bootstrap 4, Font awesome 4 & Font Awesome 5 Free & Pro snippets. This plugin works in both in the stable & the insiders build
55

6-
![Plugin in action](https://github.com/1tontech/bootstrap4-snippets/raw/vscode-6.0.0/vscode/help.gif)
6+
![Plugin in action](https://github.com/1tontech/bootstrap4-snippets/raw/vscode-6.0.1/vscode/help.gif)
77

88
The detailed list of supported template triggers are listed [below](#documentation)
99

@@ -57,11 +57,11 @@ Here are available live templates
5757

5858
### Bootstrap 4 snippets
5959

60-
#### Bootstrap
60+
#### Bootstrap master template
6161

6262
Trigger | Description
6363
--- | ---
64-
b4-**bootstrap$** | Reactive form variation of Bootstrap
64+
b4-**$** | Bootstrap master template
6565

6666
#### Alert
6767

@@ -104,11 +104,11 @@ b4-**breadcrumb-list** | Breadcrumb list
104104

105105
Trigger | Description
106106
--- | ---
107-
b4-**button-a** | Button with link
107+
b4-**button-a** | Button a
108108
b4-**button-block** | Button block
109109
b4-**button-checkbox** | Button checkbox
110110
b4-**button-default** | Button default
111-
b4-**button-disabled-a** | Button disabled with link
111+
b4-**button-disabled-a** | Button disabled a
112112
b4-**button-input** | Button input
113113
b4-**button-outline** | Button outline
114114
b4-**button-radio** | Button radio
@@ -227,7 +227,7 @@ b4-**jumbotron-fluid** | Jumbotron fluid
227227

228228
Trigger | Description
229229
--- | ---
230-
b4-**list-a** | List with link
230+
b4-**list-a** | List a
231231
b4-**list-badge** | List badge
232232
b4-**list-button** | List button
233233
b4-**list-colors** | List colors
@@ -247,9 +247,9 @@ b4-**modal-sizes** | Modal sizes
247247

248248
Trigger | Description
249249
--- | ---
250-
b4-**nav-a** | Nav with link
250+
b4-**nav-a** | Nav a
251251
b4-**nav-complete** | Nav complete
252-
b4-**nav-tabs-pills-a-variation** | Nav tabs pills with link variation
252+
b4-**nav-tabs-pills-a-variation** | Nav tabs pills a variation
253253
b4-**nav-tabs-pills-dropdown** | Nav tabs pills dropdown
254254
b4-**nav-tabs-pills-ul-variation** | Nav tabs pills ul variation
255255
b4-**nav-ul** | Nav ul
@@ -261,7 +261,7 @@ Trigger | Description
261261
b4-**navbar-background-color** | Navbar background color
262262
b4-**navbar-background** | Navbar background
263263
b4-**navbar-default** | Navbar default
264-
b4-**navbar-minimal-a** | Navbar minimal with link
264+
b4-**navbar-minimal-a** | Navbar minimal a
265265
b4-**navbar-minimal-ul** | Navbar minimal ul
266266
b4-**navbar-non-responsive** | Navbar non responsive
267267
b4-**navbar-placement** | Navbar placement

vscode/build.gradle

-1
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ dependencies {
2222
utilCompile group: 'commons-io', name: 'commons-io', version: '2.5'
2323
utilCompile group: 'com.fasterxml.jackson.dataformat', name: 'jackson-dataformat-xml', version: '2.8.4'
2424
utilCompile group: 'com.fasterxml.jackson.core', name: 'jackson-databind', version: '2.8.4'
25-
utilCompile group: 'org.springframework', name: 'spring-core', version: '4.3.4.RELEASE'
2625
}
2726

2827
task regenerate(type: JavaExec) {

0 commit comments

Comments
 (0)