Skip to content
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Commit 72f0edd

Browse files
per1234per1234
committedDec 15, 2020
Improve category data in check configurations
This information is currently only used for the JSON format output, so these changes have no implications for code.
1 parent 857d74b commit 72f0edd

File tree

1 file changed

+44
-44
lines changed

1 file changed

+44
-44
lines changed
 

‎check/checkconfigurations/checkconfigurations.go

+44-44
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ var configurations = []Type{
5959
{
6060
ProjectType: projecttype.Library,
6161
Category: "structure",
62-
Subcategory: "",
62+
Subcategory: "general",
6363
ID: "",
6464
Brief: "invalid",
6565
Description: "",
@@ -74,7 +74,7 @@ var configurations = []Type{
7474
{
7575
ProjectType: projecttype.Library,
7676
Category: "structure",
77-
Subcategory: "",
77+
Subcategory: "root folder",
7878
ID: "",
7979
Brief: "folder name too long",
8080
Description: "This will be problematic for people doing manual installation of the library.",
@@ -89,7 +89,7 @@ var configurations = []Type{
8989
{
9090
ProjectType: projecttype.Library,
9191
Category: "structure",
92-
Subcategory: "",
92+
Subcategory: "root folder",
9393
ID: "",
9494
Brief: "disallowed characters in folder name",
9595
Description: "This will be problematic for people doing manual installation of the library.",
@@ -104,7 +104,7 @@ var configurations = []Type{
104104
{
105105
ProjectType: projecttype.Library,
106106
Category: "structure",
107-
Subcategory: "",
107+
Subcategory: "miscellaneous",
108108
ID: "",
109109
Brief: "submodule",
110110
Description: "",
@@ -119,7 +119,7 @@ var configurations = []Type{
119119
{
120120
ProjectType: projecttype.Library,
121121
Category: "structure",
122-
Subcategory: "general",
122+
Subcategory: "miscellaneous",
123123
ID: "",
124124
Brief: "symlink",
125125
Description: "",
@@ -134,7 +134,7 @@ var configurations = []Type{
134134
{
135135
ProjectType: projecttype.Library,
136136
Category: "structure",
137-
Subcategory: "",
137+
Subcategory: "miscellaneous",
138138
ID: "",
139139
Brief: ".development file",
140140
Description: "",
@@ -149,7 +149,7 @@ var configurations = []Type{
149149
{
150150
ProjectType: projecttype.Library,
151151
Category: "structure",
152-
Subcategory: "",
152+
Subcategory: "miscellaneous",
153153
ID: "",
154154
Brief: ".exe file",
155155
Description: "",
@@ -164,7 +164,7 @@ var configurations = []Type{
164164
{
165165
ProjectType: projecttype.Library,
166166
Category: "structure",
167-
Subcategory: "general",
167+
Subcategory: "source code",
168168
ID: "",
169169
Brief: "name-header mismatch",
170170
Description: `The name value determines the installation folder name and the folder match to the filename in the #include directive influences "folder name priority".`,
@@ -179,7 +179,7 @@ var configurations = []Type{
179179
{
180180
ProjectType: projecttype.Library,
181181
Category: "structure",
182-
Subcategory: "",
182+
Subcategory: "source code",
183183
ID: "",
184184
Brief: "incorrect src folder case",
185185
Description: "",
@@ -194,7 +194,7 @@ var configurations = []Type{
194194
{
195195
ProjectType: projecttype.Library,
196196
Category: "structure",
197-
Subcategory: "",
197+
Subcategory: "source code",
198198
ID: "",
199199
Brief: "recursive with utility folder",
200200
Description: "",
@@ -209,7 +209,7 @@ var configurations = []Type{
209209
{
210210
ProjectType: projecttype.Library,
211211
Category: "structure",
212-
Subcategory: "",
212+
Subcategory: "extras folder",
213213
ID: "",
214214
Brief: "incorrect extras folder name",
215215
Description: "",
@@ -224,7 +224,7 @@ var configurations = []Type{
224224
{
225225
ProjectType: projecttype.Library,
226226
Category: "structure",
227-
Subcategory: "",
227+
Subcategory: "extras folder",
228228
ID: "",
229229
Brief: "incorrect extras folder name case",
230230
Description: "",
@@ -1064,7 +1064,7 @@ var configurations = []Type{
10641064
{
10651065
ProjectType: projecttype.Library,
10661066
Category: "code",
1067-
Subcategory: "",
1067+
Subcategory: "miscellaneous",
10681068
ID: "",
10691069
Brief: "incorrect Arduino.h case",
10701070
Description: "This causes compilation failure on filename case-sensitive OS (e.g., Linux).",
@@ -1078,8 +1078,8 @@ var configurations = []Type{
10781078
},
10791079
{
10801080
ProjectType: projecttype.Library,
1081-
Category: "structure",
1082-
Subcategory: "",
1081+
Category: "documentation",
1082+
Subcategory: "miscellaneous",
10831083
ID: "",
10841084
Brief: "no readme",
10851085
Description: "",
@@ -1093,8 +1093,8 @@ var configurations = []Type{
10931093
},
10941094
{
10951095
ProjectType: projecttype.Library,
1096-
Category: "structure",
1097-
Subcategory: "",
1096+
Category: "documentation",
1097+
Subcategory: "miscellaneous",
10981098
ID: "",
10991099
Brief: "no license file",
11001100
Description: "",
@@ -1123,8 +1123,8 @@ var configurations = []Type{
11231123
},
11241124
{
11251125
ProjectType: projecttype.Library,
1126-
Category: "structure",
1127-
Subcategory: "",
1126+
Category: "documentation",
1127+
Subcategory: "examples",
11281128
ID: "",
11291129
Brief: "no examples",
11301130
Description: "",
@@ -1138,8 +1138,8 @@ var configurations = []Type{
11381138
},
11391139
{
11401140
ProjectType: projecttype.Library,
1141-
Category: "structure",
1142-
Subcategory: "",
1141+
Category: "documentation",
1142+
Subcategory: "examples",
11431143
ID: "",
11441144
Brief: "incorrect examples folder name",
11451145
Description: "",
@@ -1153,8 +1153,8 @@ var configurations = []Type{
11531153
},
11541154
{
11551155
ProjectType: projecttype.Library,
1156-
Category: "structure",
1157-
Subcategory: "",
1156+
Category: "documentation",
1157+
Subcategory: "examples",
11581158
ID: "",
11591159
Brief: "incorrect examples folder name case",
11601160
Description: "",
@@ -1169,7 +1169,7 @@ var configurations = []Type{
11691169
{
11701170
ProjectType: projecttype.Sketch,
11711171
Category: "structure",
1172-
Subcategory: "",
1172+
Subcategory: "root folder",
11731173
ID: "",
11741174
Brief: "name mismatch",
11751175
Description: "",
@@ -1184,7 +1184,7 @@ var configurations = []Type{
11841184
{
11851185
ProjectType: projecttype.Sketch,
11861186
Category: "structure",
1187-
Subcategory: "",
1187+
Subcategory: "file name",
11881188
ID: "",
11891189
Brief: "disallowed characters in file name",
11901190
Description: "",
@@ -1199,7 +1199,7 @@ var configurations = []Type{
11991199
{
12001200
ProjectType: projecttype.Sketch,
12011201
Category: "structure",
1202-
Subcategory: "",
1202+
Subcategory: "file name",
12031203
ID: "",
12041204
Brief: "file name too long",
12051205
Description: "",
@@ -1214,7 +1214,7 @@ var configurations = []Type{
12141214
{
12151215
ProjectType: projecttype.Sketch,
12161216
Category: "structure",
1217-
Subcategory: "",
1217+
Subcategory: "file name",
12181218
ID: "SS001",
12191219
Brief: ".pde extension",
12201220
Description: "The .pde extension is used by both Processing sketches and Arduino sketches. Processing sketches should either be in the \"data\" subfolder of the sketch or in the \"extras\" folder of the library. Arduino sketches should use the modern .ino extension.",
@@ -1229,7 +1229,7 @@ var configurations = []Type{
12291229
{
12301230
ProjectType: projecttype.Sketch,
12311231
Category: "structure",
1232-
Subcategory: "",
1232+
Subcategory: "miscellaneous",
12331233
ID: "",
12341234
Brief: "incorrect src folder case",
12351235
Description: "",
@@ -1244,7 +1244,7 @@ var configurations = []Type{
12441244
{
12451245
ProjectType: projecttype.Sketch,
12461246
Category: "code",
1247-
Subcategory: "",
1247+
Subcategory: "miscellaneous",
12481248
ID: "",
12491249
Brief: "incorrect Arduino.h case",
12501250
Description: "This causes compilation failure on filename case-sensitive OS (e.g., Linux).",
@@ -1258,8 +1258,8 @@ var configurations = []Type{
12581258
},
12591259
{
12601260
ProjectType: projecttype.Sketch,
1261-
Category: "structure",
1262-
Subcategory: "",
1261+
Category: "documentation",
1262+
Subcategory: "miscellaneous",
12631263
ID: "",
12641264
Brief: "no readme",
12651265
Description: "",
@@ -1273,8 +1273,8 @@ var configurations = []Type{
12731273
},
12741274
{
12751275
ProjectType: projecttype.Sketch,
1276-
Category: "structure",
1277-
Subcategory: "",
1276+
Category: "documentation",
1277+
Subcategory: "miscellaneous",
12781278
ID: "",
12791279
Brief: "no license file",
12801280
Description: "",
@@ -1288,8 +1288,8 @@ var configurations = []Type{
12881288
},
12891289
{
12901290
ProjectType: projecttype.Sketch,
1291-
Category: "metadata",
1292-
Subcategory: "sketch.json",
1291+
Category: "sketch.json",
1292+
Subcategory: "general",
12931293
ID: "",
12941294
Brief: "invalid sketch.json JSON format",
12951295
Description: "",
@@ -1303,8 +1303,8 @@ var configurations = []Type{
13031303
},
13041304
{
13051305
ProjectType: projecttype.Sketch,
1306-
Category: "metadata",
1307-
Subcategory: "sketch.json",
1306+
Category: "sketch.json",
1307+
Subcategory: "general",
13081308
ID: "",
13091309
Brief: "invalid sketch.json data format",
13101310
Description: "",
@@ -1318,8 +1318,8 @@ var configurations = []Type{
13181318
},
13191319
{
13201320
ProjectType: projecttype.Platform,
1321-
Category: "structure",
1322-
Subcategory: "",
1321+
Category: "documentation",
1322+
Subcategory: "miscellaneous",
13231323
ID: "",
13241324
Brief: "no readme",
13251325
Description: "",
@@ -1333,8 +1333,8 @@ var configurations = []Type{
13331333
},
13341334
{
13351335
ProjectType: projecttype.Platform,
1336-
Category: "structure",
1337-
Subcategory: "",
1336+
Category: "documentation",
1337+
Subcategory: "miscellaneous",
13381338
ID: "",
13391339
Brief: "no license file",
13401340
Description: "",
@@ -1379,7 +1379,7 @@ var configurations = []Type{
13791379
{
13801380
ProjectType: projecttype.Platform,
13811381
Category: "code",
1382-
Subcategory: "",
1382+
Subcategory: "miscellaneous",
13831383
ID: "",
13841384
Brief: "incorrect Arduino.h case",
13851385
Description: "This causes compilation failure on filename case-sensitive OS (e.g., Linux).",
@@ -1394,7 +1394,7 @@ var configurations = []Type{
13941394
{
13951395
ProjectType: projecttype.PackageIndex,
13961396
Category: "data",
1397-
Subcategory: "",
1397+
Subcategory: "general",
13981398
ID: "",
13991399
Brief: "Invalid JSON format",
14001400
Description: "",
@@ -1409,7 +1409,7 @@ var configurations = []Type{
14091409
{
14101410
ProjectType: projecttype.PackageIndex,
14111411
Category: "data",
1412-
Subcategory: "",
1412+
Subcategory: "general",
14131413
ID: "",
14141414
Brief: "Invalid format",
14151415
Description: "",

0 commit comments

Comments
 (0)
Please sign in to comment.