@diplodoc/cli-tests 4.60.0 → 5.0.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (50) hide show
  1. package/e2e/__snapshots__/include-toc.test.ts.snap +106 -106
  2. package/e2e/__snapshots__/load-custom-resources.spec.ts.snap +303 -350
  3. package/e2e/__snapshots__/metadata.spec.ts.snap +124 -147
  4. package/e2e/__snapshots__/plugin-corner-cases.spec.ts.snap +0 -0
  5. package/e2e/__snapshots__/regression.test.ts.snap +906 -715
  6. package/e2e/__snapshots__/restricted-access.test.ts.snap +234 -0
  7. package/e2e/__snapshots__/rtl.spec.ts.snap +258 -308
  8. package/e2e/__snapshots__/translation.spec.ts.snap +366 -0
  9. package/e2e/errors.spec.ts +31 -0
  10. package/e2e/regression.test.ts +7 -2
  11. package/e2e/restricted-access.test.ts +21 -0
  12. package/e2e/translation.spec.ts +1 -1
  13. package/fixtures/cliAdapter.ts +41 -20
  14. package/fixtures/runners/binary.ts +18 -3
  15. package/fixtures/runners/source.ts +5 -5
  16. package/fixtures/runners/types.ts +7 -1
  17. package/fixtures/utils/file.ts +3 -3
  18. package/fixtures/utils/test.ts +6 -1
  19. package/mocks/errors/unreachable-link/input/exists.md +1 -0
  20. package/mocks/errors/unreachable-link/input/index.md +2 -0
  21. package/mocks/errors/unreachable-link/input/toc.yaml +1 -0
  22. package/mocks/include-toc/test6/input/toc.yaml +1 -0
  23. package/mocks/regression/input/1.md +2 -0
  24. package/mocks/regression/input/generic/1.md +3 -0
  25. package/mocks/regression/input/generic/2.md +3 -0
  26. package/mocks/regression/input/generic/3.md +1 -0
  27. package/mocks/regression/input/generic/Sub notes/1.md +3 -0
  28. package/mocks/regression/input/generic/Sub notes/2.md +3 -0
  29. package/mocks/regression/input/includes/deep.md +1 -0
  30. package/mocks/regression/input/includes.md +3 -0
  31. package/mocks/regression/input/redirects.yaml +6 -0
  32. package/mocks/regression/input/toc.yaml +7 -3
  33. package/mocks/restricted-access/test1/input/index.md +0 -0
  34. package/mocks/restricted-access/test1/input/plugins/index.md +0 -0
  35. package/mocks/restricted-access/test1/input/plugins/index2.md +0 -0
  36. package/mocks/restricted-access/test1/input/plugins/index3.md +0 -0
  37. package/mocks/restricted-access/test1/input/plugins/index4.md +4 -0
  38. package/mocks/restricted-access/test1/input/toc.yaml +28 -0
  39. package/mocks/restricted-access/test2/input/index.md +0 -0
  40. package/mocks/restricted-access/test2/input/plugins/index.md +0 -0
  41. package/mocks/restricted-access/test2/input/project/index.md +0 -0
  42. package/mocks/restricted-access/test2/input/toc.yaml +21 -0
  43. package/mocks/restricted-access/test3/input/a1.md +1 -0
  44. package/mocks/restricted-access/test3/input/folder1/a1.md +1 -0
  45. package/mocks/restricted-access/test3/input/folder1/folder2/a1.md +1 -0
  46. package/mocks/restricted-access/test3/input/folder1/folder2/toc.yaml +8 -0
  47. package/mocks/restricted-access/test3/input/folder1/toc.yaml +10 -0
  48. package/mocks/restricted-access/test3/input/index.md +0 -0
  49. package/mocks/restricted-access/test3/input/toc.yaml +16 -0
  50. package/package.json +1 -1
package/e2e/__snapshots__/metadata.spec.ts.snap CHANGED
@@ -2,20 +2,23 @@
2
2
 
3
3
  exports[`Allow load custom resources > md2html with metadata > filelist 1`] = `
4
4
  "[
5
+ "_bundle/search-async-1",
5
6
  "_bundle/search-async-0",
6
7
  "_bundle/app-css-1",
7
8
  "_bundle/app-js-1",
8
- "_bundle/search-css-2",
9
+ "_bundle/app-css-3",
9
10
  "_bundle/latex-extension.css",
10
11
  "_bundle/latex-extension.js",
11
12
  "_bundle/mermaid-extension.js",
12
13
  "_bundle/page-constructor-extension.css",
13
14
  "_bundle/page-constructor-extension.js",
14
15
  "_bundle/search-js-0",
15
- "_bundle/search-js-1",
16
16
  "_bundle/search-css-0",
17
- "_bundle/search-js-2",
17
+ "_bundle/search-js-1",
18
+ "_bundle/search-css-3",
18
19
  "_bundle/search-css-1",
20
+ "_bundle/search-js-2",
21
+ "_bundle/search-css-2",
19
22
  "index.html",
20
23
  "page.html",
21
24
  "project/config.html",
@@ -23,152 +26,125 @@ exports[`Allow load custom resources > md2html with metadata > filelist 1`] = `
23
26
  ]"
24
27
  `;
25
28
 
26
- exports[`Allow load custom resources > md2html with metadata > index.html 1`] = `
27
- "
28
- <!DOCTYPE html>
29
- <html lang="ru" dir="ltr">
30
- <head>
31
- <meta charset="utf-8">
32
- <base href="./" />
33
- <meta name="generator" content="Diplodoc Platform vDIPLODOC-VERSION" />
34
- <meta name="test-yfm" content="inline test" />
35
- <meta name="yfm-config" content="config test" />
36
- <meta name="title" content="Documentation" />
37
- <meta name="noIndex" content="true" />
38
-
39
-
40
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
41
- <title>Documentation | Documentation</title>
42
- <style type="text/css">
43
- body {
44
- height: 100vh;
45
- }
46
- </style>
47
- <link type="text/css" rel="stylesheet" href="_bundle/search-css-0" />
48
- <link type="text/css" rel="stylesheet" href="_bundle/app-css-1" />
49
-
50
- </head>
51
- <body class="g-root g-root_theme_light">
52
- <div id="root"></div>
53
- <script type="application/json" id="diplodoc-state">
54
- {"data":{"data":{"title":"Documentation","description":"","meta":{"metadata":[{"name":"generator","content":"Diplodoc Platform vDIPLODOC-VERSION"},{"name":"test-yfm","content":"inline test"},{"name":"yfm-config","content":"config test"}],"title":"Documentation","noIndex":true},"links":[{"title":"Getting started with Documentation","description":"This guide will show you the basics of working with Documentation","href":"page.html"}]},"meta":{"metadata":[{"name":"generator","content":"Diplodoc Platform vDIPLODOC-VERSION"},{"name":"test-yfm","content":"inline test"},{"name":"yfm-config","content":"config test"}],"title":"Documentation","noIndex":true},"title":"Documentation","leading":true},"router":{"pathname":"index","depth":1},"lang":"ru","langs":["ru"]}
55
- </script>
56
- <script type="application/javascript">
57
- function unescapeJsonFromHtml(escaped) {
58
- const unescaped = escaped.replace(/&lt;/g, "<").replace(/&gt;/g, ">").replace(/&amp;/g, "&");
59
- return JSON.parse(unescaped);
60
- }
61
- const data = document.querySelector('script#diplodoc-state');
62
- window.__DATA__ = unescapeJsonFromHtml(data.innerText);
63
- window.STATIC_CONTENT = false;
64
- </script>
65
- <script src="toc.js" type="application/javascript"></script>
66
-
67
- <script type="application/javascript" src="_bundle/search-js-0"></script>
68
- <script type="application/javascript" src="_bundle/app-js-1"></script>
69
- <script type="application/javascript" src="_bundle/search-js-2"></script>
70
- </body>
71
- </html>
72
- "
29
+ exports[`Allow load custom resources > md2html with metadata 1`] = `
30
+ "<!DOCTYPE html>
31
+ <html lang="ru" dir="ltr">
32
+ <head>
33
+ <meta charset="utf-8">
34
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
35
+ <base href="./" />
36
+ <title>Documentation | Documentation</title>
37
+ <meta name="generator" content="Diplodoc Platform vDIPLODOC-VERSION">
38
+ <meta name="test-yfm" content="inline test">
39
+ <meta name="yfm-config" content="config test">
40
+ <meta name="title" content="Documentation">
41
+ <meta name="noIndex" content="true">
42
+
43
+ <style type="text/css">html, body {min-height:100vh; height:100vh;}</style>
44
+
45
+ <link type="text/css" rel="stylesheet" href="_bundle/search-css-1"/>
46
+ <link type="text/css" rel="stylesheet" href="_bundle/app-css-1"/>
47
+ </head>
48
+ <body class="g-root g-root_theme_light">
49
+ <div id="root"></div>
50
+ <script type="application/json" id="diplodoc-state">
51
+ {"data":{"leading":true,"data":{"title":"Documentation","description":"","links":[{"title":"Getting started with Documentation","description":"This guide will show you the basics of working with Documentation","href":"page.html"}]},"meta":{"metadata":[{"name":"generator","content":"Diplodoc Platform vDIPLODOC-VERSION"},{"name":"test-yfm","content":"inline test"},{"name":"yfm-config","content":"config test"}],"title":"Documentation","noIndex":true},"title":"Documentation"},"router":{"pathname":"index","depth":1,"base":"./"},"lang":"ru","langs":["ru"]}
52
+ </script>
53
+ <script type="application/javascript">
54
+ const data = document.querySelector('script#diplodoc-state');
55
+ window.__DATA__ = JSON.parse((function unescape(string) {
56
+ return string.replace(/&lt;/g, "<").replace(/&gt;/g, ">").replace(/&amp;/g, "&");
57
+ })(data.innerText));
58
+ window.STATIC_CONTENT = false;
59
+ </script>
60
+ <script type="application/javascript" defer src="toc.js"></script>
61
+ <script type="application/javascript" defer src="_bundle/search-js-0"></script>
62
+ <script type="application/javascript" defer src="_bundle/app-js-1"></script>
63
+ <script type="application/javascript" defer src="_bundle/search-js-2"></script>
64
+
65
+ </body>
66
+ </html>"
73
67
  `;
74
68
 
75
- exports[`Allow load custom resources > md2html with metadata > page.html 1`] = `
76
- "
77
- <!DOCTYPE html>
78
- <html lang="ru" dir="ltr">
79
- <head>
80
- <meta charset="utf-8">
81
- <base href="./" />
82
- <meta name="generator" content="Diplodoc Platform vDIPLODOC-VERSION" />
83
- <meta name="test-yfm" content="inline test" />
84
- <meta name="yfm-config" content="config test" />
85
- <meta name="yfm" value="builder in page" />
86
-
87
-
88
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
89
- <title>Documentation</title>
90
- <style type="text/css">
91
- body {
92
- height: 100vh;
93
- }
94
- </style>
95
- <link type="text/css" rel="stylesheet" href="_bundle/search-css-0" />
96
- <link type="text/css" rel="stylesheet" href="_bundle/app-css-1" />
97
-
98
- </head>
99
- <body class="g-root g-root_theme_light">
100
- <div id="root"></div>
101
- <script type="application/json" id="diplodoc-state">
102
- {"data":{"meta":{"metadata":[{"name":"generator","content":"Diplodoc Platform vDIPLODOC-VERSION"},{"name":"test-yfm","content":"inline test"},{"name":"yfm-config","content":"config test"},{"name":"yfm","value":"builder in page"}]},"headings":[],"title":"","html":"&lt;p&gt;Lorem&lt;/p&gt;/n","leading":false},"router":{"pathname":"page","depth":1},"lang":"ru","langs":["ru"]}
103
- </script>
104
- <script type="application/javascript">
105
- function unescapeJsonFromHtml(escaped) {
106
- const unescaped = escaped.replace(/&lt;/g, "<").replace(/&gt;/g, ">").replace(/&amp;/g, "&");
107
- return JSON.parse(unescaped);
108
- }
109
- const data = document.querySelector('script#diplodoc-state');
110
- window.__DATA__ = unescapeJsonFromHtml(data.innerText);
111
- window.STATIC_CONTENT = false;
112
- </script>
113
- <script src="toc.js" type="application/javascript"></script>
114
-
115
- <script type="application/javascript" src="_bundle/search-js-0"></script>
116
- <script type="application/javascript" src="_bundle/app-js-1"></script>
117
- <script type="application/javascript" src="_bundle/search-js-2"></script>
118
- </body>
119
- </html>
120
- "
69
+ exports[`Allow load custom resources > md2html with metadata 2`] = `
70
+ "<!DOCTYPE html>
71
+ <html lang="ru" dir="ltr">
72
+ <head>
73
+ <meta charset="utf-8">
74
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
75
+ <base href="./" />
76
+ <title>Documentation</title>
77
+ <meta name="generator" content="Diplodoc Platform vDIPLODOC-VERSION">
78
+ <meta name="test-yfm" content="inline test">
79
+ <meta name="yfm-config" content="config test">
80
+ <meta name="yfm" value="builder in page">
81
+
82
+ <style type="text/css">html, body {min-height:100vh; height:100vh;}</style>
83
+
84
+ <link type="text/css" rel="stylesheet" href="_bundle/search-css-1"/>
85
+ <link type="text/css" rel="stylesheet" href="_bundle/app-css-1"/>
86
+ </head>
87
+ <body class="g-root g-root_theme_light">
88
+ <div id="root"></div>
89
+ <script type="application/json" id="diplodoc-state">
90
+ {"data":{"leading":false,"html":"&lt;p&gt;Lorem&lt;/p&gt;/n","meta":{"metadata":[{"name":"generator","content":"Diplodoc Platform vDIPLODOC-VERSION"},{"name":"test-yfm","content":"inline test"},{"name":"yfm-config","content":"config test"},{"name":"yfm","value":"builder in page"}]},"headings":[],"title":""},"router":{"pathname":"page","depth":1,"base":"./"},"lang":"ru","langs":["ru"]}
91
+ </script>
92
+ <script type="application/javascript">
93
+ const data = document.querySelector('script#diplodoc-state');
94
+ window.__DATA__ = JSON.parse((function unescape(string) {
95
+ return string.replace(/&lt;/g, "<").replace(/&gt;/g, ">").replace(/&amp;/g, "&");
96
+ })(data.innerText));
97
+ window.STATIC_CONTENT = false;
98
+ </script>
99
+ <script type="application/javascript" defer src="toc.js"></script>
100
+ <script type="application/javascript" defer src="_bundle/search-js-0"></script>
101
+ <script type="application/javascript" defer src="_bundle/app-js-1"></script>
102
+ <script type="application/javascript" defer src="_bundle/search-js-2"></script>
103
+
104
+ </body>
105
+ </html>"
121
106
  `;
122
107
 
123
- exports[`Allow load custom resources > md2html with metadata > project/config.html 1`] = `
124
- "
125
- <!DOCTYPE html>
126
- <html lang="ru" dir="ltr">
127
- <head>
128
- <meta charset="utf-8">
129
- <base href="../" />
130
- <meta name="generator" content="Diplodoc Platform vDIPLODOC-VERSION" />
131
- <meta name="test-yfm" content="inline test" />
132
- <meta name="yfm-config" content="config test" />
133
- <meta name="yfm" value="builder in config" />
134
-
135
-
136
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
137
- <title>Documentation</title>
138
- <style type="text/css">
139
- body {
140
- height: 100vh;
141
- }
142
- </style>
143
- <link type="text/css" rel="stylesheet" href="_bundle/search-css-0" />
144
- <link type="text/css" rel="stylesheet" href="_bundle/app-css-1" />
145
-
146
- </head>
147
- <body class="g-root g-root_theme_light">
148
- <div id="root"></div>
149
- <script type="application/json" id="diplodoc-state">
150
- {"data":{"meta":{"metadata":[{"name":"generator","content":"Diplodoc Platform vDIPLODOC-VERSION"},{"name":"test-yfm","content":"inline test"},{"name":"yfm-config","content":"config test"},{"name":"yfm","value":"builder in config"}]},"headings":[],"title":"","html":"&lt;p&gt;Lorem&lt;/p&gt;/n","leading":false},"router":{"pathname":"project/config","depth":2},"lang":"ru","langs":["ru"]}
151
- </script>
152
- <script type="application/javascript">
153
- function unescapeJsonFromHtml(escaped) {
154
- const unescaped = escaped.replace(/&lt;/g, "<").replace(/&gt;/g, ">").replace(/&amp;/g, "&");
155
- return JSON.parse(unescaped);
156
- }
157
- const data = document.querySelector('script#diplodoc-state');
158
- window.__DATA__ = unescapeJsonFromHtml(data.innerText);
159
- window.STATIC_CONTENT = false;
160
- </script>
161
- <script src="toc.js" type="application/javascript"></script>
162
-
163
- <script type="application/javascript" src="_bundle/search-js-0"></script>
164
- <script type="application/javascript" src="_bundle/app-js-1"></script>
165
- <script type="application/javascript" src="_bundle/search-js-2"></script>
166
- </body>
167
- </html>
168
- "
108
+ exports[`Allow load custom resources > md2html with metadata 3`] = `
109
+ "<!DOCTYPE html>
110
+ <html lang="ru" dir="ltr">
111
+ <head>
112
+ <meta charset="utf-8">
113
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
114
+ <base href="../" />
115
+ <title>Documentation</title>
116
+ <meta name="generator" content="Diplodoc Platform vDIPLODOC-VERSION">
117
+ <meta name="test-yfm" content="inline test">
118
+ <meta name="yfm-config" content="config test">
119
+ <meta name="yfm" value="builder in config">
120
+
121
+ <style type="text/css">html, body {min-height:100vh; height:100vh;}</style>
122
+
123
+ <link type="text/css" rel="stylesheet" href="_bundle/search-css-1"/>
124
+ <link type="text/css" rel="stylesheet" href="_bundle/app-css-1"/>
125
+ </head>
126
+ <body class="g-root g-root_theme_light">
127
+ <div id="root"></div>
128
+ <script type="application/json" id="diplodoc-state">
129
+ {"data":{"leading":false,"html":"&lt;p&gt;Lorem&lt;/p&gt;/n","meta":{"metadata":[{"name":"generator","content":"Diplodoc Platform vDIPLODOC-VERSION"},{"name":"test-yfm","content":"inline test"},{"name":"yfm-config","content":"config test"},{"name":"yfm","value":"builder in config"}]},"headings":[],"title":""},"router":{"pathname":"project/config","depth":2,"base":"../"},"lang":"ru","langs":["ru"]}
130
+ </script>
131
+ <script type="application/javascript">
132
+ const data = document.querySelector('script#diplodoc-state');
133
+ window.__DATA__ = JSON.parse((function unescape(string) {
134
+ return string.replace(/&lt;/g, "<").replace(/&gt;/g, ">").replace(/&amp;/g, "&");
135
+ })(data.innerText));
136
+ window.STATIC_CONTENT = false;
137
+ </script>
138
+ <script type="application/javascript" defer src="toc.js"></script>
139
+ <script type="application/javascript" defer src="_bundle/search-js-0"></script>
140
+ <script type="application/javascript" defer src="_bundle/app-js-1"></script>
141
+ <script type="application/javascript" defer src="_bundle/search-js-2"></script>
142
+
143
+ </body>
144
+ </html>"
169
145
  `;
170
146
 
171
- exports[`Allow load custom resources > md2html with metadata > toc.js 1`] = `"window.__DATA__.data.toc = {"title":"Documentation","href":"index.html","items":[{"name":"Documentation","href":"page.html","id":"UUID"},{"name":"Config","href":"project/config.html","id":"UUID"}],"id":"UUID"};"`;
147
+ exports[`Allow load custom resources > md2html with metadata 4`] = `"window.__DATA__.data.toc = {"title":"Documentation","href":"index.html","items":[{"name":"Documentation","href":"page.html","id":"UUID"},{"name":"Config","href":"project/config.html","id":"UUID"}],"path":"toc.yaml","id":"UUID"};"`;
172
148
 
173
149
  exports[`Allow load custom resources > md2md with metadata > filelist 1`] = `
174
150
  "[
@@ -179,7 +155,7 @@ exports[`Allow load custom resources > md2md with metadata > filelist 1`] = `
179
155
  ]"
180
156
  `;
181
157
 
182
- exports[`Allow load custom resources > md2md with metadata > index.yaml 1`] = `
158
+ exports[`Allow load custom resources > md2md with metadata 1`] = `
183
159
  "title: Documentation
184
160
  description: ''
185
161
  meta:
@@ -199,7 +175,7 @@ links:
199
175
  "
200
176
  `;
201
177
 
202
- exports[`Allow load custom resources > md2md with metadata > page.md 1`] = `
178
+ exports[`Allow load custom resources > md2md with metadata 2`] = `
203
179
  "---
204
180
  metadata:
205
181
  - name: generator
@@ -215,7 +191,7 @@ metadata:
215
191
  Lorem"
216
192
  `;
217
193
 
218
- exports[`Allow load custom resources > md2md with metadata > project/config.md 1`] = `
194
+ exports[`Allow load custom resources > md2md with metadata 3`] = `
219
195
  "---
220
196
  metadata:
221
197
  - name: generator
@@ -231,7 +207,7 @@ metadata:
231
207
  Lorem"
232
208
  `;
233
209
 
234
- exports[`Allow load custom resources > md2md with metadata > toc.yaml 1`] = `
210
+ exports[`Allow load custom resources > md2md with metadata 4`] = `
235
211
  "title: Documentation
236
212
  href: index.yaml
237
213
  items:
@@ -239,5 +215,6 @@ items:
239
215
  href: page.md
240
216
  - name: Config
241
217
  href: project/config.md
218
+ path: toc.yaml
242
219
  "
243
220
  `;