Skip to content

Commit 685d793

Browse files
linawolflinawolf
committed
[BUGFIX] Replace null with "-" in objects.inv.json
Sphinx and even our library itself expect empty values to be a string with "-". Null causes errors
1 parent 9b0b3e4 commit 685d793

File tree

6 files changed

+66
-66
lines changed

6 files changed

+66
-66
lines changed

‎packages/guides/src/Renderer/InterlinkObjectsRenderer.php

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -56,10 +56,10 @@ public function render(RenderCommand $renderCommand): void
5656
$this->urlGenerator->createFileUrl($context, $documentEntry->getFile()),
5757
);
5858
$inventory['std:doc'][$key] = [
59-
$projectNode->getTitle(),
60-
$projectNode->getVersion(),
59+
$projectNode->getTitle() ?? '-',
60+
$projectNode->getVersion() ?? '-',
6161
$url,
62-
$documentEntry->getTitle()->toString(),
62+
$documentEntry->getTitle()->toString() ?? '-',
6363
];
6464
}
6565

@@ -74,10 +74,10 @@ public function render(RenderCommand $renderCommand): void
7474
$this->urlGenerator->createFileUrl($context, $internalTarget->getDocumentPath(), $internalTarget->getAnchor()),
7575
);
7676
$inventory[$linkType][$key] = [
77-
$projectNode->getTitle(),
78-
$projectNode->getVersion(),
77+
$projectNode->getTitle() ?? '-',
78+
$projectNode->getVersion() ?? '-',
7979
$url,
80-
$internalTarget->getTitle(),
80+
$internalTarget->getTitle() ?? '-',
8181
];
8282
}
8383
}
@@ -97,8 +97,8 @@ public function render(RenderCommand $renderCommand): void
9797

9898
EOF
9999
,
100-
$renderCommand->getProjectNode()->getTitle(),
101-
$renderCommand->getProjectNode()->getVersion(),
100+
$renderCommand->getProjectNode()->getTitle() ?? '-',
101+
$renderCommand->getProjectNode()->getVersion() ?? '-',
102102
);
103103
$body = '';
104104

‎tests/Integration/tests/anchor/anchor-to-page/expected/objects.inv.json

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,46 @@
11
{
22
"std:doc": {
33
"index": [
4-
null,
5-
null,
4+
"-",
5+
"-",
66
"index.html",
77
"Page"
88
],
99
"rst-overview": [
10-
null,
11-
null,
10+
"-",
11+
"-",
1212
"rst-overview.html",
1313
"Overview"
1414
],
1515
"sphinx-overview": [
16-
null,
17-
null,
16+
"-",
17+
"-",
1818
"sphinx-overview.html",
1919
"Overview"
2020
]
2121
},
2222
"std:label": {
2323
"page": [
24-
null,
25-
null,
24+
"-",
25+
"-",
2626
"index.html#page",
2727
"Page"
2828
],
2929
"overview": [
30-
null,
31-
null,
30+
"-",
31+
"-",
3232
"sphinx-overview.html#overview",
3333
"Overview"
3434
],
3535
"rst-overview": [
36-
null,
37-
null,
36+
"-",
37+
"-",
3838
"rst-overview.html#rst-overview",
3939
"Overview"
4040
],
4141
"sphinx-overview": [
42-
null,
43-
null,
42+
"-",
43+
"-",
4444
"sphinx-overview.html#sphinx-overview",
4545
"Overview"
4646
]

‎tests/Integration/tests/confval/expected/objects.inv.json

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
{
22
"std:doc": {
33
"index": [
4-
null,
5-
null,
4+
"-",
5+
"-",
66
"index.html",
77
"Confval directive"
88
]
99
},
1010
"std:label": {
1111
"confval-directive": [
12-
null,
13-
null,
12+
"-",
13+
"-",
1414
"index.html#confval-directive",
1515
"Confval directive"
1616
]
1717
},
1818
"std:confval": {
1919
"demo": [
20-
null,
21-
null,
20+
"-",
21+
"-",
2222
"index.html#demo",
2323
"demo"
2424
]

‎tests/Integration/tests/interlink/inventory_json/expected/objects.inv.json

Lines changed: 24 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,76 +1,76 @@
11
{
22
"std:doc": {
33
"index": [
4-
null,
5-
null,
4+
"-",
5+
"-",
66
"index.html",
77
"Document Title"
88
],
99
"page1": [
10-
null,
11-
null,
10+
"-",
11+
"-",
1212
"page1.html",
1313
"Page 1"
1414
],
1515
"page2": [
16-
null,
17-
null,
16+
"-",
17+
"-",
1818
"page2.html",
1919
"Page 2"
2020
],
2121
"subfolder\/index": [
22-
null,
23-
null,
22+
"-",
23+
"-",
2424
"subfolder\/index.html",
2525
"Subfolder Index"
2626
],
2727
"subfolder\/subpage1": [
28-
null,
29-
null,
28+
"-",
29+
"-",
3030
"subfolder\/subpage1.html",
3131
"Subpage 1"
3232
],
3333
"subfolder\/subpage2": [
34-
null,
35-
null,
34+
"-",
35+
"-",
3636
"subfolder\/subpage2.html",
3737
"Subpage 2"
3838
]
3939
},
4040
"std:label": {
4141
"document-title": [
42-
null,
43-
null,
42+
"-",
43+
"-",
4444
"index.html#document-title",
4545
"Document Title"
4646
],
4747
"page-1": [
48-
null,
49-
null,
48+
"-",
49+
"-",
5050
"page1.html#page-1",
5151
"Page 1"
5252
],
5353
"page-2": [
54-
null,
55-
null,
54+
"-",
55+
"-",
5656
"page2.html#page-2",
5757
"Page 2"
5858
],
5959
"subfolder-index": [
60-
null,
61-
null,
60+
"-",
61+
"-",
6262
"subfolder\/index.html#subfolder-index",
6363
"Subfolder Index"
6464
],
6565
"subpage-1": [
66-
null,
67-
null,
66+
"-",
67+
"-",
6868
"subfolder\/subpage1.html#subpage-1",
6969
"Subpage 1"
7070
],
7171
"subpage-2": [
72-
null,
73-
null,
72+
"-",
73+
"-",
7474
"subfolder\/subpage2.html#subpage-2",
7575
"Subpage 2"
7676
]

‎tests/Integration/tests/meta/project-title/expected/objects.inv.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,15 @@
22
"std:doc": {
33
"index": [
44
"My Project",
5-
null,
5+
"-",
66
"index.html",
77
"Document Title"
88
]
99
},
1010
"std:label": {
1111
"document-title": [
1212
"My Project",
13-
null,
13+
"-",
1414
"index.html#document-title",
1515
"Document Title"
1616
]

‎tests/Integration/tests/option/expected/objects.inv.json

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,42 @@
11
{
22
"std:doc": {
33
"index": [
4-
null,
5-
null,
4+
"-",
5+
"-",
66
"index.html",
77
"Some Title"
88
]
99
},
1010
"std:label": {
1111
"some-title": [
12-
null,
13-
null,
12+
"-",
13+
"-",
1414
"index.html#some-title",
1515
"Some Title"
1616
]
1717
},
1818
"std:option": {
1919
"dest-dir": [
20-
null,
21-
null,
20+
"-",
21+
"-",
2222
"index.html#dest-dir",
2323
"dest_dir"
2424
],
2525
"m-module-module-module": [
26-
null,
27-
null,
26+
"-",
27+
"-",
2828
"index.html#m-module-module-module",
2929
"-m <module>, --module <module>"
3030
],
3131
"m": [
32-
null,
33-
null,
32+
"-",
33+
"-",
3434
"index.html#m",
3535
"-m <module>, --module <module>"
3636
],
3737
"module": [
38-
null,
39-
null,
38+
"-",
39+
"-",
4040
"index.html#module",
4141
"-m <module>, --module <module>"
4242
]

0 commit comments

Comments
 (0)