@thegetty/quire-cli 1.0.0-rc.44 → 1.0.0-rc.46

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 (243) hide show
  1. package/CHANGELOG.md +0 -36
  2. package/README.md +0 -9
  3. package/bin/cli.js +1 -46
  4. package/package.json +9 -25
  5. package/src/Command.js +6 -26
  6. package/src/commands/README.md +122 -213
  7. package/src/commands/build.js +37 -45
  8. package/src/commands/clean.js +19 -33
  9. package/src/commands/conf.js +43 -0
  10. package/src/commands/create.js +14 -42
  11. package/src/commands/epub.js +31 -67
  12. package/src/commands/index.js +2 -9
  13. package/src/commands/info.js +86 -88
  14. package/src/commands/pdf.js +82 -63
  15. package/src/commands/preview.js +31 -32
  16. package/src/commands/validate.js +20 -64
  17. package/src/commands/version.js +43 -0
  18. package/src/errors/validation/validation-error.js +11 -20
  19. package/src/helpers/clean.js +1 -1
  20. package/src/helpers/is-quire.js +31 -0
  21. package/src/helpers/test-cwd.js +6 -5
  22. package/src/helpers/which.js +4 -10
  23. package/src/lib/11ty/README.md +19 -135
  24. package/src/lib/11ty/api.js +93 -235
  25. package/src/lib/11ty/cli.js +37 -112
  26. package/src/lib/11ty/index.js +5 -64
  27. package/src/lib/11ty/paths.js +103 -0
  28. package/src/lib/README.md +0 -330
  29. package/src/lib/conf/README.md +69 -86
  30. package/src/lib/conf/config.js +3 -5
  31. package/src/lib/conf/defaults.js +0 -65
  32. package/src/lib/conf/schema.js +9 -103
  33. package/src/lib/epub/README.md +2 -133
  34. package/src/lib/epub/epub.js +11 -36
  35. package/src/lib/epub/index.js +21 -111
  36. package/src/lib/epub/pandoc.js +4 -33
  37. package/src/lib/git/README.md +2 -151
  38. package/src/lib/git/index.js +13 -217
  39. package/src/lib/i18n/README.md +3 -0
  40. package/src/lib/i18n/config.js +53 -0
  41. package/src/lib/i18n/index.js +43 -0
  42. package/src/lib/i18n/localeService.js +58 -0
  43. package/src/lib/pdf/README.md +0 -131
  44. package/src/lib/pdf/index.js +21 -124
  45. package/src/lib/pdf/paged.js +52 -100
  46. package/src/lib/pdf/prince.js +37 -115
  47. package/src/lib/pdf/split.js +33 -61
  48. package/src/lib/quire/README.md +19 -0
  49. package/src/lib/quire/index.js +353 -0
  50. package/src/lib/reporter/README.md +2 -211
  51. package/src/lib/reporter/index.js +0 -607
  52. package/src/main.js +48 -221
  53. package/src/packageConfig.js +0 -17
  54. package/src/validators/utils.js +1 -2
  55. package/schemas/config.schema.json +0 -194
  56. package/schemas/figures.schema.json +0 -56
  57. package/schemas/layout.schema.json +0 -5
  58. package/schemas/objects.schema.json +0 -62
  59. package/schemas/publication.schema.json +0 -140
  60. package/schemas/references.schema.json +0 -29
  61. package/src/Command.spec.js +0 -99
  62. package/src/commands/build.spec.js +0 -113
  63. package/src/commands/build.test.js +0 -397
  64. package/src/commands/clean.spec.js +0 -118
  65. package/src/commands/clean.test.js +0 -382
  66. package/src/commands/config.js +0 -238
  67. package/src/commands/config.spec.js +0 -107
  68. package/src/commands/config.test.js +0 -845
  69. package/src/commands/create.spec.js +0 -112
  70. package/src/commands/create.test.js +0 -415
  71. package/src/commands/doctor.js +0 -251
  72. package/src/commands/doctor.spec.js +0 -115
  73. package/src/commands/doctor.test.js +0 -1409
  74. package/src/commands/epub.spec.js +0 -114
  75. package/src/commands/epub.test.js +0 -503
  76. package/src/commands/help.js +0 -60
  77. package/src/commands/help.test.js +0 -132
  78. package/src/commands/info.spec.js +0 -72
  79. package/src/commands/info.test.js +0 -512
  80. package/src/commands/pdf.spec.js +0 -114
  81. package/src/commands/pdf.test.js +0 -464
  82. package/src/commands/preview.spec.js +0 -97
  83. package/src/commands/preview.test.js +0 -250
  84. package/src/commands/use.js +0 -56
  85. package/src/commands/use.spec.js +0 -61
  86. package/src/commands/use.test.js +0 -280
  87. package/src/commands/validate.spec.js +0 -90
  88. package/src/commands/validate.test.js +0 -378
  89. package/src/commands/workflows.js +0 -70
  90. package/src/errors/build/build-failed-error.js +0 -19
  91. package/src/errors/build/config-field-missing-error.js +0 -20
  92. package/src/errors/build/config-file-not-found-error.js +0 -20
  93. package/src/errors/build/index.js +0 -11
  94. package/src/errors/help/help-topic-not-found-error.js +0 -30
  95. package/src/errors/help/index.js +0 -8
  96. package/src/errors/index.js +0 -58
  97. package/src/errors/input/index.js +0 -8
  98. package/src/errors/input/invalid-input-error.js +0 -21
  99. package/src/errors/install/dependency-install-error.js +0 -19
  100. package/src/errors/install/directory-not-empty-error.js +0 -25
  101. package/src/errors/install/index.js +0 -12
  102. package/src/errors/install/invalid-path-error.js +0 -31
  103. package/src/errors/install/invalid-starter-error.js +0 -27
  104. package/src/errors/install/version-not-found-error.js +0 -35
  105. package/src/errors/output/epub-generation-error.js +0 -19
  106. package/src/errors/output/index.js +0 -14
  107. package/src/errors/output/invalid-epub-library-error.js +0 -20
  108. package/src/errors/output/invalid-pdf-library-error.js +0 -20
  109. package/src/errors/output/missing-build-output-error.js +0 -21
  110. package/src/errors/output/pdf-generation-error.js +0 -24
  111. package/src/errors/output/tool-not-found-error.js +0 -37
  112. package/src/errors/project/index.js +0 -10
  113. package/src/errors/project/not-in-project-error.js +0 -20
  114. package/src/errors/project/project-create-error.js +0 -21
  115. package/src/errors/quire-error.js +0 -27
  116. package/src/errors/validation/index.js +0 -3
  117. package/src/errors/validation/unknown-config-key-error.js +0 -27
  118. package/src/errors/validation/unknown-config-operation-error.js +0 -24
  119. package/src/helpers/docs-url.js +0 -32
  120. package/src/helpers/pager.js +0 -59
  121. package/src/helpers/pager.test.js +0 -85
  122. package/src/helpers/suggest-similar.js +0 -124
  123. package/src/helpers/suggest-similar.test.js +0 -108
  124. package/src/helpers/test-cwd.test.js +0 -192
  125. package/src/lib/11ty/index.test.js +0 -655
  126. package/src/lib/commander/index.js +0 -103
  127. package/src/lib/commander/index.test.js +0 -86
  128. package/src/lib/commander/options.js +0 -237
  129. package/src/lib/commander/options.test.js +0 -205
  130. package/src/lib/conf/build-status.js +0 -103
  131. package/src/lib/conf/build-status.test.js +0 -247
  132. package/src/lib/conf/config.test.js +0 -281
  133. package/src/lib/conf/format.js +0 -60
  134. package/src/lib/conf/format.test.js +0 -106
  135. package/src/lib/conf/helpers.js +0 -91
  136. package/src/lib/conf/helpers.test.js +0 -136
  137. package/src/lib/conf/index.js +0 -22
  138. package/src/lib/constants.js +0 -28
  139. package/src/lib/doctor/README.md +0 -667
  140. package/src/lib/doctor/checks/environment/cli-version.js +0 -62
  141. package/src/lib/doctor/checks/environment/cli-version.test.js +0 -132
  142. package/src/lib/doctor/checks/environment/git-available.js +0 -77
  143. package/src/lib/doctor/checks/environment/git-available.test.js +0 -52
  144. package/src/lib/doctor/checks/environment/index.js +0 -13
  145. package/src/lib/doctor/checks/environment/node-version.js +0 -66
  146. package/src/lib/doctor/checks/environment/node-version.test.js +0 -17
  147. package/src/lib/doctor/checks/environment/npm-available.js +0 -66
  148. package/src/lib/doctor/checks/environment/npm-available.test.js +0 -52
  149. package/src/lib/doctor/checks/environment/os-info.js +0 -48
  150. package/src/lib/doctor/checks/environment/os-info.test.js +0 -81
  151. package/src/lib/doctor/checks/environment/runtime-info.js +0 -51
  152. package/src/lib/doctor/checks/environment/runtime-info.test.js +0 -132
  153. package/src/lib/doctor/checks/outputs/epub-output.js +0 -119
  154. package/src/lib/doctor/checks/outputs/epub-output.test.js +0 -277
  155. package/src/lib/doctor/checks/outputs/index.js +0 -10
  156. package/src/lib/doctor/checks/outputs/pdf-output.js +0 -144
  157. package/src/lib/doctor/checks/outputs/pdf-output.test.js +0 -377
  158. package/src/lib/doctor/checks/outputs/stale-build.js +0 -122
  159. package/src/lib/doctor/checks/outputs/stale-build.test.js +0 -282
  160. package/src/lib/doctor/checks/project/data-files.js +0 -56
  161. package/src/lib/doctor/checks/project/data-files.test.js +0 -125
  162. package/src/lib/doctor/checks/project/dependencies.js +0 -53
  163. package/src/lib/doctor/checks/project/dependencies.test.js +0 -71
  164. package/src/lib/doctor/checks/project/index.js +0 -11
  165. package/src/lib/doctor/checks/project/quire-11ty.js +0 -98
  166. package/src/lib/doctor/checks/project/quire-11ty.test.js +0 -170
  167. package/src/lib/doctor/checks/project/quire-project.js +0 -38
  168. package/src/lib/doctor/checks/project/quire-project.test.js +0 -47
  169. package/src/lib/doctor/checks/tools/index.js +0 -10
  170. package/src/lib/doctor/checks/tools/pandoc-available.js +0 -82
  171. package/src/lib/doctor/checks/tools/pandoc-available.test.js +0 -73
  172. package/src/lib/doctor/checks/tools/prince-available.js +0 -81
  173. package/src/lib/doctor/checks/tools/prince-available.test.js +0 -73
  174. package/src/lib/doctor/constants.js +0 -39
  175. package/src/lib/doctor/formatDuration.js +0 -108
  176. package/src/lib/doctor/formatDuration.test.js +0 -76
  177. package/src/lib/doctor/formatters/human.js +0 -257
  178. package/src/lib/doctor/formatters/human.test.js +0 -463
  179. package/src/lib/doctor/formatters/index.js +0 -8
  180. package/src/lib/doctor/formatters/json.js +0 -78
  181. package/src/lib/doctor/formatters/json.test.js +0 -174
  182. package/src/lib/doctor/formatters/shared.js +0 -129
  183. package/src/lib/doctor/formatters/shared.test.js +0 -194
  184. package/src/lib/doctor/index.js +0 -271
  185. package/src/lib/doctor/index.test.js +0 -797
  186. package/src/lib/epub/engines.js +0 -46
  187. package/src/lib/epub/index.test.js +0 -518
  188. package/src/lib/epub/pandoc.test.js +0 -122
  189. package/src/lib/epub/schema.js +0 -21
  190. package/src/lib/error/README.md +0 -170
  191. package/src/lib/error/handler.js +0 -107
  192. package/src/lib/git/index.spec.js +0 -80
  193. package/src/lib/git/index.test.js +0 -453
  194. package/src/lib/help/frontmatter.js +0 -77
  195. package/src/lib/help/frontmatter.test.js +0 -139
  196. package/src/lib/help/index.js +0 -146
  197. package/src/lib/help/index.test.js +0 -188
  198. package/src/lib/help/topics/configuration.md +0 -77
  199. package/src/lib/help/topics/debugging.md +0 -69
  200. package/src/lib/help/topics/epub.md +0 -74
  201. package/src/lib/help/topics/pdf.md +0 -74
  202. package/src/lib/help/topics/publishing.md +0 -80
  203. package/src/lib/help/topics/workflows.md +0 -50
  204. package/src/lib/installer/index.js +0 -309
  205. package/src/lib/installer/index.spec.js +0 -83
  206. package/src/lib/installer/index.test.js +0 -545
  207. package/src/lib/logger/README.md +0 -424
  208. package/src/lib/logger/debug.js +0 -132
  209. package/src/lib/logger/debug.spec.js +0 -130
  210. package/src/lib/logger/debug.test.js +0 -128
  211. package/src/lib/logger/index.js +0 -228
  212. package/src/lib/logger/index.spec.js +0 -131
  213. package/src/lib/logger/index.test.js +0 -578
  214. package/src/lib/npm/README.md +0 -127
  215. package/src/lib/npm/index.js +0 -198
  216. package/src/lib/npm/index.spec.js +0 -60
  217. package/src/lib/npm/index.test.js +0 -355
  218. package/src/lib/pdf/engines.js +0 -46
  219. package/src/lib/pdf/index.test.js +0 -708
  220. package/src/lib/pdf/paged.test.js +0 -366
  221. package/src/lib/pdf/prince.test.js +0 -202
  222. package/src/lib/pdf/schema.js +0 -21
  223. package/src/lib/pdf/split.test.js +0 -445
  224. package/src/lib/platform.js +0 -95
  225. package/src/lib/process/manager.js +0 -110
  226. package/src/lib/process/manager.test.js +0 -55
  227. package/src/lib/project/build.js +0 -162
  228. package/src/lib/project/build.test.js +0 -275
  229. package/src/lib/project/config.js +0 -48
  230. package/src/lib/project/config.test.js +0 -134
  231. package/src/lib/project/detect.js +0 -47
  232. package/src/lib/project/detect.test.js +0 -157
  233. package/src/lib/project/index.js +0 -56
  234. package/src/lib/project/output-paths.js +0 -87
  235. package/src/lib/project/output-paths.test.js +0 -66
  236. package/src/lib/project/paths.js +0 -272
  237. package/src/lib/project/version.js +0 -110
  238. package/src/lib/project/version.test.js +0 -350
  239. package/src/lib/reporter/index.test.js +0 -862
  240. package/src/main.spec.js +0 -61
  241. package/src/main.test.js +0 -347
  242. package/src/validators/validate-data-files.js +0 -154
  243. package/src/validators/validate-data-files.test.js +0 -217
@@ -1,217 +0,0 @@
1
- import test from 'ava'
2
- import sinon from 'sinon'
3
- import esmock from 'esmock'
4
-
5
- test.beforeEach((t) => {
6
- t.context.sandbox = sinon.createSandbox()
7
- })
8
-
9
- test.afterEach.always((t) => {
10
- t.context.sandbox.restore()
11
- })
12
-
13
- test('validateDataFiles returns notInProject when data dir does not exist', async (t) => {
14
- const { sandbox } = t.context
15
-
16
- const { validateDataFiles } = await esmock('./validate-data-files.js', {
17
- 'node:fs': {
18
- default: {
19
- existsSync: sandbox.stub().returns(false),
20
- },
21
- },
22
- })
23
-
24
- const result = validateDataFiles()
25
-
26
- t.true(result.valid)
27
- t.true(result.notInProject)
28
- t.is(result.fileCount, 0)
29
- t.deepEqual(result.errors, [])
30
- })
31
-
32
- test('validateDataFiles returns error when required file is missing', async (t) => {
33
- const { sandbox } = t.context
34
-
35
- const existsStub = sandbox.stub()
36
- existsStub.withArgs('content/_data').returns(true)
37
- existsStub.withArgs('content/_data/publication.yaml').returns(false)
38
- existsStub.returns(false)
39
-
40
- const path = await import('node:path')
41
- const { validateDataFiles } = await esmock('./validate-data-files.js', {
42
- 'node:fs': {
43
- default: {
44
- existsSync: existsStub,
45
- readdirSync: sandbox.stub().returns([]),
46
- },
47
- },
48
- 'node:path': {
49
- default: path.default,
50
- },
51
- })
52
-
53
- const result = validateDataFiles()
54
-
55
- t.false(result.valid)
56
- t.true(result.errors.includes('Required file missing: publication.yaml'))
57
- })
58
-
59
- test('validateDataFiles validates all YAML files in directory', async (t) => {
60
- const { sandbox } = t.context
61
-
62
- const existsStub = sandbox.stub()
63
- existsStub.withArgs('content/_data').returns(true)
64
- existsStub.withArgs('content/_data/publication.yaml').returns(true)
65
- existsStub.returns(true)
66
-
67
- const readFileStub = sandbox.stub()
68
- readFileStub.callsFake((filePath) => {
69
- if (filePath.includes('publication.yaml')) {
70
- return 'title: Test Publication'
71
- }
72
- if (filePath.includes('config.yaml')) {
73
- return 'setting: value'
74
- }
75
- throw new Error('ENOENT')
76
- })
77
-
78
- const path = await import('node:path')
79
- const { validateDataFiles } = await esmock('./validate-data-files.js', {
80
- 'node:fs': {
81
- default: {
82
- existsSync: existsStub,
83
- readdirSync: sandbox.stub().returns(['publication.yaml', 'config.yaml']),
84
- readFileSync: readFileStub,
85
- },
86
- },
87
- 'node:path': {
88
- default: path.default,
89
- },
90
- './utils.js': {
91
- getSchemaForDocument: sandbox.stub().returns(null),
92
- checkForDuplicateIds: sandbox.stub(),
93
- },
94
- })
95
-
96
- const result = validateDataFiles()
97
-
98
- t.true(result.valid)
99
- t.is(result.fileCount, 2)
100
- t.is(result.files.length, 2)
101
- })
102
-
103
- test('validateYamlFile returns error for invalid YAML syntax', async (t) => {
104
- const { sandbox } = t.context
105
-
106
- const path = await import('node:path')
107
- const { validateYamlFile } = await esmock('./validate-data-files.js', {
108
- 'node:fs': {
109
- default: {
110
- existsSync: sandbox.stub().returns(true),
111
- readFileSync: sandbox.stub().returns('title: [invalid yaml'),
112
- },
113
- },
114
- 'node:path': {
115
- default: path.default,
116
- },
117
- './utils.js': {
118
- getSchemaForDocument: sandbox.stub().returns(null),
119
- checkForDuplicateIds: sandbox.stub(),
120
- },
121
- })
122
-
123
- const result = validateYamlFile('content/_data/test.yaml')
124
-
125
- t.false(result.valid)
126
- t.true(result.errors.some((e) => e.includes('YAML syntax error')))
127
- })
128
-
129
- test('validateYamlFile returns error when file not found', async (t) => {
130
- const { sandbox } = t.context
131
-
132
- const path = await import('node:path')
133
- const { validateYamlFile } = await esmock('./validate-data-files.js', {
134
- 'node:fs': {
135
- default: {
136
- existsSync: sandbox.stub().returns(false),
137
- },
138
- },
139
- 'node:path': {
140
- default: path.default,
141
- },
142
- })
143
-
144
- const result = validateYamlFile('content/_data/missing.yaml')
145
-
146
- t.false(result.valid)
147
- t.true(result.errors.some((e) => e.includes('File not found')))
148
- })
149
-
150
- test('validateYamlFile validates against schema when available', async (t) => {
151
- const { sandbox } = t.context
152
-
153
- const schema = {
154
- type: 'object',
155
- required: ['title'],
156
- properties: {
157
- title: { type: 'string' },
158
- },
159
- }
160
-
161
- const path = await import('node:path')
162
- const { validateYamlFile } = await esmock('./validate-data-files.js', {
163
- 'node:fs': {
164
- default: {
165
- existsSync: sandbox.stub().returns(true),
166
- readFileSync: sandbox.stub().returns('notitle: value'),
167
- },
168
- },
169
- 'node:path': {
170
- default: path.default,
171
- },
172
- './utils.js': {
173
- getSchemaForDocument: sandbox.stub().returns(schema),
174
- checkForDuplicateIds: sandbox.stub(),
175
- },
176
- })
177
-
178
- const result = validateYamlFile('content/_data/test.yaml')
179
-
180
- t.false(result.valid)
181
- t.true(result.errors.some((e) => e.includes('title')))
182
- })
183
-
184
- test('validateYamlFile catches duplicate ID errors', async (t) => {
185
- const { sandbox } = t.context
186
-
187
- const path = await import('node:path')
188
- const { validateYamlFile } = await esmock('./validate-data-files.js', {
189
- 'node:fs': {
190
- default: {
191
- existsSync: sandbox.stub().returns(true),
192
- readFileSync: sandbox.stub().returns('title: Test'),
193
- },
194
- },
195
- 'node:path': {
196
- default: path.default,
197
- },
198
- './utils.js': {
199
- getSchemaForDocument: sandbox.stub().returns(null),
200
- checkForDuplicateIds: sandbox.stub().throws({
201
- reason: 'Duplicate IDs found: fig-1, fig-2',
202
- }),
203
- },
204
- })
205
-
206
- const result = validateYamlFile('content/_data/figures.yaml')
207
-
208
- t.false(result.valid)
209
- t.true(result.errors.some((e) => e.includes('duplicate IDs')))
210
- })
211
-
212
- test('default export is validateDataFiles', async (t) => {
213
- const module = await import('./validate-data-files.js')
214
-
215
- t.is(typeof module.default, 'function')
216
- t.is(module.default, module.validateDataFiles)
217
- })