Skip to content

Commit a63d3a8

Browse files
per1234per1234
committed
Use ">>" in place of "-" between package index ID components
Since package index data occurs in arrays, the rules must indicate to the user the specific element(s) in violation. In the case of standard components (e.g. platform), the form of the IDs is well established (e.g., `arduino:[email protected]`). However, that I know of, there is no standard form for unequivocally identifying a package index data subcomponent (e.g., a tool dependency of a specific platform release). I arbitrarily chose a dash to combine the IDs of the two components (e.g., `arduino:[email protected] - x86_64-linux-gnu`). I received feedback that this was not very clear, with a suggestion to use ">>" instead of the "-" (e.g., `arduino:[email protected] >> x86_64-linux-gnu`).
1 parent 24d0055 commit a63d3a8

File tree

3 files changed

+57
-57
lines changed

3 files changed

+57
-57
lines changed

Diff for: ‎internal/project/projectdata/packageindex.go

+4-4
Original file line numberDiff line numberDiff line change
@@ -56,23 +56,23 @@ func InitializeForPackageIndex() {
5656
}
5757

5858
for _, platformData := range PackageIndexPlatforms() {
59-
packageIndexBoards = append(packageIndexBoards, getPackageIndexData(platformData.Object, platformData.JSONPointer, "boards", platformData.ID, " - {{index . 0}}", []string{"name"})...)
59+
packageIndexBoards = append(packageIndexBoards, getPackageIndexData(platformData.Object, platformData.JSONPointer, "boards", platformData.ID, " >> {{index . 0}}", []string{"name"})...)
6060
}
6161

6262
for _, platformData := range PackageIndexPlatforms() {
63-
packageIndexToolsDependencies = append(packageIndexToolsDependencies, getPackageIndexData(platformData.Object, platformData.JSONPointer, "toolsDependencies", platformData.ID, " - {{index . 0}}:{{index . 1}}@{{index . 2}}", []string{"packager", "name", "version"})...)
63+
packageIndexToolsDependencies = append(packageIndexToolsDependencies, getPackageIndexData(platformData.Object, platformData.JSONPointer, "toolsDependencies", platformData.ID, " >> {{index . 0}}:{{index . 1}}@{{index . 2}}", []string{"packager", "name", "version"})...)
6464
}
6565

6666
for _, platformData := range PackageIndexPlatforms() {
67-
packageIndexDiscoveryDependencies = append(packageIndexDiscoveryDependencies, getPackageIndexData(platformData.Object, platformData.JSONPointer, "discoveryDependencies", platformData.ID, " - {{index . 0}}:{{index . 1}}", []string{"packager", "name"})...)
67+
packageIndexDiscoveryDependencies = append(packageIndexDiscoveryDependencies, getPackageIndexData(platformData.Object, platformData.JSONPointer, "discoveryDependencies", platformData.ID, " >> {{index . 0}}:{{index . 1}}", []string{"packager", "name"})...)
6868
}
6969

7070
for _, packageData := range PackageIndexPackages() {
7171
packageIndexTools = append(packageIndexTools, getPackageIndexData(packageData.Object, packageData.JSONPointer, "tools", packageData.ID, ":{{index . 0}}@{{index . 1}}", []string{"name", "version"})...)
7272
}
7373

7474
for _, toolData := range PackageIndexTools() {
75-
packageIndexSystems = append(packageIndexSystems, getPackageIndexData(toolData.Object, toolData.JSONPointer, "systems", toolData.ID, " - {{index . 0}}", []string{"host"})...)
75+
packageIndexSystems = append(packageIndexSystems, getPackageIndexData(toolData.Object, toolData.JSONPointer, "systems", toolData.ID, " >> {{index . 0}}", []string{"host"})...)
7676
}
7777

7878
packageIndexSchemaValidationResult = packageindex.Validate(PackageIndex())

Diff for: ‎internal/project/projectdata/packageindex_test.go

+31-31
Original file line numberDiff line numberDiff line change
@@ -96,93 +96,93 @@ func TestInitializeForPackageIndex(t *testing.T) {
9696
packageIndexBoardsAssertion: assert.NotNil,
9797
packageIndexBoardsDataAssertion: []PackageIndexData{
9898
{
99-
ID: "foopackager1:[email protected] - My Board",
99+
ID: "foopackager1:[email protected] >> My Board",
100100
JSONPointer: "/packages/0/platforms/0/boards/0",
101101
},
102102
{
103-
ID: "foopackager1:[email protected] - My Board Pro",
103+
ID: "foopackager1:[email protected] >> My Board Pro",
104104
JSONPointer: "/packages/0/platforms/0/boards/1",
105105
},
106106
{
107-
ID: "foopackager1:[email protected] - My Board",
107+
ID: "foopackager1:[email protected] >> My Board",
108108
JSONPointer: "/packages/0/platforms/1/boards/0",
109109
},
110110
{
111-
ID: "foopackager1:[email protected] - My Board Pro",
111+
ID: "foopackager1:[email protected] >> My Board Pro",
112112
JSONPointer: "/packages/0/platforms/1/boards/1",
113113
},
114114
{
115-
ID: "foopackager2:[email protected] - My Board",
115+
ID: "foopackager2:[email protected] >> My Board",
116116
JSONPointer: "/packages/1/platforms/0/boards/0",
117117
},
118118
{
119-
ID: "foopackager2:[email protected] - My Board Pro",
119+
ID: "foopackager2:[email protected] >> My Board Pro",
120120
JSONPointer: "/packages/1/platforms/0/boards/1",
121121
},
122122
{
123-
ID: "foopackager2:[email protected] - My Board",
123+
ID: "foopackager2:[email protected] >> My Board",
124124
JSONPointer: "/packages/1/platforms/1/boards/0",
125125
},
126126
{
127-
ID: "foopackager2:[email protected] - My Board Pro",
127+
ID: "foopackager2:[email protected] >> My Board Pro",
128128
JSONPointer: "/packages/1/platforms/1/boards/1",
129129
},
130130
},
131131
packageIndexToolsDependenciesAssertion: assert.NotNil,
132132
packageIndexToolsDependenciesDataAssertion: []PackageIndexData{
133133
{
134-
ID: "foopackager1:[email protected] - arduino:[email protected]",
134+
ID: "foopackager1:[email protected] >> arduino:[email protected]",
135135
JSONPointer: "/packages/0/platforms/0/toolsDependencies/0",
136136
},
137137
{
138-
ID: "foopackager1:[email protected] - arduino:[email protected]",
138+
ID: "foopackager1:[email protected] >> arduino:[email protected]",
139139
JSONPointer: "/packages/0/platforms/0/toolsDependencies/1",
140140
},
141141
{
142-
ID: "foopackager1:[email protected] - arduino:[email protected]",
142+
ID: "foopackager1:[email protected] >> arduino:[email protected]",
143143
JSONPointer: "/packages/0/platforms/1/toolsDependencies/0",
144144
},
145145
{
146-
ID: "foopackager1:[email protected] - arduino:[email protected]",
146+
ID: "foopackager1:[email protected] >> arduino:[email protected]",
147147
JSONPointer: "/packages/0/platforms/1/toolsDependencies/1",
148148
},
149149
{
150-
ID: "foopackager2:[email protected] - arduino:arm-none-eabi-gcc@7-2017q4",
150+
ID: "foopackager2:[email protected] >> arduino:arm-none-eabi-gcc@7-2017q4",
151151
JSONPointer: "/packages/1/platforms/0/toolsDependencies/0",
152152
},
153153
{
154-
ID: "foopackager2:[email protected] - arduino:[email protected]",
154+
ID: "foopackager2:[email protected] >> arduino:[email protected]",
155155
JSONPointer: "/packages/1/platforms/0/toolsDependencies/1",
156156
},
157157
{
158-
ID: "foopackager2:[email protected] - arduino:[email protected]",
158+
ID: "foopackager2:[email protected] >> arduino:[email protected]",
159159
JSONPointer: "/packages/1/platforms/1/toolsDependencies/0",
160160
},
161161
{
162-
ID: "foopackager2:[email protected] - arduino:arm-none-eabi-gcc@7-2017q4",
162+
ID: "foopackager2:[email protected] >> arduino:arm-none-eabi-gcc@7-2017q4",
163163
JSONPointer: "/packages/1/platforms/1/toolsDependencies/1",
164164
},
165165
},
166166
packageIndexDiscoveryDependenciesAssertion: assert.NotNil,
167167
packageIndexDiscoveryDependenciesDataAssertion: []PackageIndexData{
168168
{
169-
ID: "foopackager1:[email protected] - arduino:ble-discovery",
169+
ID: "foopackager1:[email protected] >> arduino:ble-discovery",
170170
JSONPointer: "/packages/0/platforms/1/discoveryDependencies/0",
171171
},
172172
{
173-
ID: "foopackager1:[email protected] - barpackager:carrier-pigeon-discovery",
173+
ID: "foopackager1:[email protected] >> barpackager:carrier-pigeon-discovery",
174174
JSONPointer: "/packages/0/platforms/1/discoveryDependencies/1",
175175
},
176176
{
177-
ID: "foopackager2:[email protected] - arduino:ble-discovery",
177+
ID: "foopackager2:[email protected] >> arduino:ble-discovery",
178178
JSONPointer: "/packages/1/platforms/0/discoveryDependencies/0",
179179
},
180180
{
181-
ID: "foopackager2:[email protected] - bazpackager:signal-flag-discovery",
181+
ID: "foopackager2:[email protected] >> bazpackager:signal-flag-discovery",
182182
JSONPointer: "/packages/1/platforms/0/discoveryDependencies/1",
183183
},
184184
{
185-
ID: "foopackager2:[email protected] - quxpackager:sneakernet-discovery",
185+
ID: "foopackager2:[email protected] >> quxpackager:sneakernet-discovery",
186186
JSONPointer: "/packages/1/platforms/1/discoveryDependencies/0",
187187
},
188188
},
@@ -200,19 +200,19 @@ func TestInitializeForPackageIndex(t *testing.T) {
200200
packageIndexSystemsAssertion: assert.NotNil,
201201
packageIndexSystemsDataAssertion: []PackageIndexData{
202202
{
203-
ID: "foopackager2:[email protected] - i386-apple-darwin11",
203+
ID: "foopackager2:[email protected] >> i386-apple-darwin11",
204204
JSONPointer: "/packages/1/tools/0/systems/0",
205205
},
206206
{
207-
ID: "foopackager2:[email protected] - x86_64-linux-gnu",
207+
ID: "foopackager2:[email protected] >> x86_64-linux-gnu",
208208
JSONPointer: "/packages/1/tools/0/systems/1",
209209
},
210210
{
211-
ID: "foopackager2:[email protected] - arm-linux-gnueabihf",
211+
ID: "foopackager2:[email protected] >> arm-linux-gnueabihf",
212212
JSONPointer: "/packages/1/tools/1/systems/0",
213213
},
214214
{
215-
ID: "foopackager2:[email protected] - i686-mingw32",
215+
ID: "foopackager2:[email protected] >> i686-mingw32",
216216
JSONPointer: "/packages/1/tools/1/systems/1",
217217
},
218218
},
@@ -297,7 +297,7 @@ func TestInitializeForPackageIndex(t *testing.T) {
297297
JSONPointer: "/packages/1/platforms/2/boards/0",
298298
},
299299
{
300-
ID: "foopackager2:[email protected] - My Board Pro",
300+
ID: "foopackager2:[email protected] >> My Board Pro",
301301
JSONPointer: "/packages/1/platforms/2/boards/1",
302302
},
303303
},
@@ -348,7 +348,7 @@ func TestInitializeForPackageIndex(t *testing.T) {
348348
JSONPointer: "/packages/1/platforms/2/toolsDependencies/2",
349349
},
350350
{
351-
ID: "foopackager2:[email protected] - arduino:[email protected]",
351+
ID: "foopackager2:[email protected] >> arduino:[email protected]",
352352
JSONPointer: "/packages/1/platforms/2/toolsDependencies/3",
353353
},
354354
},
@@ -395,7 +395,7 @@ func TestInitializeForPackageIndex(t *testing.T) {
395395
JSONPointer: "/packages/1/platforms/2/discoveryDependencies/1",
396396
},
397397
{
398-
ID: "foopackager2:[email protected] - quxpackager:sneakernet-discovery",
398+
ID: "foopackager2:[email protected] >> quxpackager:sneakernet-discovery",
399399
JSONPointer: "/packages/1/platforms/2/discoveryDependencies/3",
400400
},
401401
},
@@ -518,7 +518,7 @@ func TestInitializeForPackageIndex(t *testing.T) {
518518
JSONPointer: "/packages/1/platforms/2/boards/0",
519519
},
520520
{
521-
ID: "foopackager2:[email protected] - My Board Pro",
521+
ID: "foopackager2:[email protected] >> My Board Pro",
522522
JSONPointer: "/packages/1/platforms/2/boards/1",
523523
},
524524
},
@@ -569,7 +569,7 @@ func TestInitializeForPackageIndex(t *testing.T) {
569569
JSONPointer: "/packages/1/platforms/2/toolsDependencies/2",
570570
},
571571
{
572-
ID: "foopackager2:[email protected] - arduino:[email protected]",
572+
ID: "foopackager2:[email protected] >> arduino:[email protected]",
573573
JSONPointer: "/packages/1/platforms/2/toolsDependencies/3",
574574
},
575575
},
@@ -616,7 +616,7 @@ func TestInitializeForPackageIndex(t *testing.T) {
616616
JSONPointer: "/packages/1/platforms/2/discoveryDependencies/1",
617617
},
618618
{
619-
ID: "foopackager2:[email protected] - quxpackager:sneakernet-discovery",
619+
ID: "foopackager2:[email protected] >> quxpackager:sneakernet-discovery",
620620
JSONPointer: "/packages/1/platforms/2/discoveryDependencies/3",
621621
},
622622
},

0 commit comments

Comments
 (0)