@diplodoc/cli-tests 4.60.0 → 5.0.0

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 +293 -344
  3. package/e2e/__snapshots__/metadata.spec.ts.snap +119 -144
  4. package/e2e/__snapshots__/plugin-corner-cases.spec.ts.snap +0 -0
  5. package/e2e/__snapshots__/regression.test.ts.snap +904 -715
  6. package/e2e/__snapshots__/restricted-access.test.ts.snap +234 -0
  7. package/e2e/__snapshots__/rtl.spec.ts.snap +248 -302
  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,6 +2,7 @@
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",
@@ -23,152 +24,125 @@ exports[`Allow load custom resources > md2html with metadata > filelist 1`] = `
23
24
  ]"
24
25
  `;
25
26
 
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
- "
27
+ exports[`Allow load custom resources > md2html with metadata 1`] = `
28
+ "<!DOCTYPE html>
29
+ <html lang="ru" dir="ltr">
30
+ <head>
31
+ <meta charset="utf-8">
32
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
33
+ <base href="./" />
34
+ <title>Documentation | Documentation</title>
35
+ <meta name="generator" content="Diplodoc Platform vDIPLODOC-VERSION">
36
+ <meta name="test-yfm" content="inline test">
37
+ <meta name="yfm-config" content="config test">
38
+ <meta name="title" content="Documentation">
39
+ <meta name="noIndex" content="true">
40
+
41
+ <style type="text/css">html, body {min-height:100vh; height:100vh;}</style>
42
+
43
+ <link type="text/css" rel="stylesheet" href="_bundle/search-css-0"/>
44
+ <link type="text/css" rel="stylesheet" href="_bundle/app-css-1"/>
45
+ </head>
46
+ <body class="g-root g-root_theme_light">
47
+ <div id="root"></div>
48
+ <script type="application/json" id="diplodoc-state">
49
+ {"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"]}
50
+ </script>
51
+ <script type="application/javascript">
52
+ const data = document.querySelector('script#diplodoc-state');
53
+ window.__DATA__ = JSON.parse((function unescape(string) {
54
+ return string.replace(/&lt;/g, "<").replace(/&gt;/g, ">").replace(/&amp;/g, "&");
55
+ })(data.innerText));
56
+ window.STATIC_CONTENT = false;
57
+ </script>
58
+ <script type="application/javascript" defer src="toc.js"></script>
59
+ <script type="application/javascript" defer src="_bundle/search-js-0"></script>
60
+ <script type="application/javascript" defer src="_bundle/app-js-1"></script>
61
+ <script type="application/javascript" defer src="_bundle/search-js-2"></script>
62
+
63
+ </body>
64
+ </html>"
73
65
  `;
74
66
 
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
- "
67
+ exports[`Allow load custom resources > md2html with metadata 2`] = `
68
+ "<!DOCTYPE html>
69
+ <html lang="ru" dir="ltr">
70
+ <head>
71
+ <meta charset="utf-8">
72
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
73
+ <base href="./" />
74
+ <title>Documentation</title>
75
+ <meta name="generator" content="Diplodoc Platform vDIPLODOC-VERSION">
76
+ <meta name="test-yfm" content="inline test">
77
+ <meta name="yfm-config" content="config test">
78
+ <meta name="yfm" value="builder in page">
79
+
80
+ <style type="text/css">html, body {min-height:100vh; height:100vh;}</style>
81
+
82
+ <link type="text/css" rel="stylesheet" href="_bundle/search-css-0"/>
83
+ <link type="text/css" rel="stylesheet" href="_bundle/app-css-1"/>
84
+ </head>
85
+ <body class="g-root g-root_theme_light">
86
+ <div id="root"></div>
87
+ <script type="application/json" id="diplodoc-state">
88
+ {"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"]}
89
+ </script>
90
+ <script type="application/javascript">
91
+ const data = document.querySelector('script#diplodoc-state');
92
+ window.__DATA__ = JSON.parse((function unescape(string) {
93
+ return string.replace(/&lt;/g, "<").replace(/&gt;/g, ">").replace(/&amp;/g, "&");
94
+ })(data.innerText));
95
+ window.STATIC_CONTENT = false;
96
+ </script>
97
+ <script type="application/javascript" defer src="toc.js"></script>
98
+ <script type="application/javascript" defer src="_bundle/search-js-0"></script>
99
+ <script type="application/javascript" defer src="_bundle/app-js-1"></script>
100
+ <script type="application/javascript" defer src="_bundle/search-js-2"></script>
101
+
102
+ </body>
103
+ </html>"
121
104
  `;
122
105
 
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
- "
106
+ exports[`Allow load custom resources > md2html with metadata 3`] = `
107
+ "<!DOCTYPE html>
108
+ <html lang="ru" dir="ltr">
109
+ <head>
110
+ <meta charset="utf-8">
111
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
112
+ <base href="../" />
113
+ <title>Documentation</title>
114
+ <meta name="generator" content="Diplodoc Platform vDIPLODOC-VERSION">
115
+ <meta name="test-yfm" content="inline test">
116
+ <meta name="yfm-config" content="config test">
117
+ <meta name="yfm" value="builder in config">
118
+
119
+ <style type="text/css">html, body {min-height:100vh; height:100vh;}</style>
120
+
121
+ <link type="text/css" rel="stylesheet" href="_bundle/search-css-0"/>
122
+ <link type="text/css" rel="stylesheet" href="_bundle/app-css-1"/>
123
+ </head>
124
+ <body class="g-root g-root_theme_light">
125
+ <div id="root"></div>
126
+ <script type="application/json" id="diplodoc-state">
127
+ {"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"]}
128
+ </script>
129
+ <script type="application/javascript">
130
+ const data = document.querySelector('script#diplodoc-state');
131
+ window.__DATA__ = JSON.parse((function unescape(string) {
132
+ return string.replace(/&lt;/g, "<").replace(/&gt;/g, ">").replace(/&amp;/g, "&");
133
+ })(data.innerText));
134
+ window.STATIC_CONTENT = false;
135
+ </script>
136
+ <script type="application/javascript" defer src="toc.js"></script>
137
+ <script type="application/javascript" defer src="_bundle/search-js-0"></script>
138
+ <script type="application/javascript" defer src="_bundle/app-js-1"></script>
139
+ <script type="application/javascript" defer src="_bundle/search-js-2"></script>
140
+
141
+ </body>
142
+ </html>"
169
143
  `;
170
144
 
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"};"`;
145
+ 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
146
 
173
147
  exports[`Allow load custom resources > md2md with metadata > filelist 1`] = `
174
148
  "[
@@ -179,7 +153,7 @@ exports[`Allow load custom resources > md2md with metadata > filelist 1`] = `
179
153
  ]"
180
154
  `;
181
155
 
182
- exports[`Allow load custom resources > md2md with metadata > index.yaml 1`] = `
156
+ exports[`Allow load custom resources > md2md with metadata 1`] = `
183
157
  "title: Documentation
184
158
  description: ''
185
159
  meta:
@@ -199,7 +173,7 @@ links:
199
173
  "
200
174
  `;
201
175
 
202
- exports[`Allow load custom resources > md2md with metadata > page.md 1`] = `
176
+ exports[`Allow load custom resources > md2md with metadata 2`] = `
203
177
  "---
204
178
  metadata:
205
179
  - name: generator
@@ -215,7 +189,7 @@ metadata:
215
189
  Lorem"
216
190
  `;
217
191
 
218
- exports[`Allow load custom resources > md2md with metadata > project/config.md 1`] = `
192
+ exports[`Allow load custom resources > md2md with metadata 3`] = `
219
193
  "---
220
194
  metadata:
221
195
  - name: generator
@@ -231,7 +205,7 @@ metadata:
231
205
  Lorem"
232
206
  `;
233
207
 
234
- exports[`Allow load custom resources > md2md with metadata > toc.yaml 1`] = `
208
+ exports[`Allow load custom resources > md2md with metadata 4`] = `
235
209
  "title: Documentation
236
210
  href: index.yaml
237
211
  items:
@@ -239,5 +213,6 @@ items:
239
213
  href: page.md
240
214
  - name: Config
241
215
  href: project/config.md
216
+ path: toc.yaml
242
217
  "
243
218
  `;