@content-collections/core 0.1.0 → 0.1.2

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 (84) hide show
  1. package/README.md +115 -0
  2. package/dist/index.js +9 -3
  3. package/package.json +5 -1
  4. package/.turbo/turbo-build.log +0 -14
  5. package/.turbo/turbo-test.log +0 -47
  6. package/.turbo/turbo-typecheck.log +0 -4
  7. package/coverage/.tmp/coverage-0.json +0 -1
  8. package/coverage/.tmp/coverage-1.json +0 -1
  9. package/coverage/.tmp/coverage-2.json +0 -1
  10. package/coverage/.tmp/coverage-3.json +0 -1
  11. package/coverage/.tmp/coverage-4.json +0 -1
  12. package/coverage/.tmp/coverage-5.json +0 -1
  13. package/coverage/.tmp/coverage-6.json +0 -1
  14. package/coverage/.tmp/coverage-7.json +0 -1
  15. package/coverage/.tmp/coverage-8.json +0 -1
  16. package/coverage/.tmp/coverage-9.json +0 -1
  17. package/coverage/base.css +0 -224
  18. package/coverage/block-navigation.js +0 -87
  19. package/coverage/builder.ts.html +0 -424
  20. package/coverage/clover.xml +0 -960
  21. package/coverage/collector.ts.html +0 -427
  22. package/coverage/config.ts.html +0 -403
  23. package/coverage/configurationReader.ts.html +0 -409
  24. package/coverage/coverage-final.json +0 -11
  25. package/coverage/events.ts.html +0 -310
  26. package/coverage/favicon.png +0 -0
  27. package/coverage/index.html +0 -251
  28. package/coverage/index.ts.html +0 -106
  29. package/coverage/prettify.css +0 -1
  30. package/coverage/prettify.js +0 -2
  31. package/coverage/sort-arrow-sprite.png +0 -0
  32. package/coverage/sorter.js +0 -196
  33. package/coverage/synchronizer.ts.html +0 -394
  34. package/coverage/transformer.ts.html +0 -607
  35. package/coverage/utils.ts.html +0 -118
  36. package/coverage/writer.ts.html +0 -424
  37. package/src/__tests__/.content-collections/cache/config.001.ts.js +0 -19
  38. package/src/__tests__/.content-collections/cache/config.002.mjs +0 -16
  39. package/src/__tests__/.content-collections/cache/config.002.ts.js +0 -16
  40. package/src/__tests__/.content-collections/cache/config.003.ts.js +0 -24
  41. package/src/__tests__/.content-collections/cache/config.004.mjs +0 -47
  42. package/src/__tests__/.content-collections/different-cache-dir/different.config.js +0 -19
  43. package/src/__tests__/.content-collections/generated-config.002/allPosts.json +0 -13
  44. package/src/__tests__/.content-collections/generated-config.002/index.d.ts +0 -7
  45. package/src/__tests__/.content-collections/generated-config.002/index.js +0 -5
  46. package/src/__tests__/.content-collections/generated-config.004/allAuthors.json +0 -13
  47. package/src/__tests__/.content-collections/generated-config.004/allPosts.json +0 -13
  48. package/src/__tests__/.content-collections/generated-config.004/index.d.ts +0 -10
  49. package/src/__tests__/.content-collections/generated-config.004/index.js +0 -6
  50. package/src/__tests__/collections/posts.ts +0 -15
  51. package/src/__tests__/config.001.ts +0 -19
  52. package/src/__tests__/config.002.ts +0 -14
  53. package/src/__tests__/config.003.ts +0 -6
  54. package/src/__tests__/config.004.ts +0 -47
  55. package/src/__tests__/invalid +0 -1
  56. package/src/__tests__/sources/authors/trillian.md +0 -8
  57. package/src/__tests__/sources/posts/first.md +0 -6
  58. package/src/__tests__/sources/test/001.md +0 -5
  59. package/src/__tests__/sources/test/002.md +0 -5
  60. package/src/__tests__/sources/test/broken-frontmatter +0 -6
  61. package/src/builder.test.ts +0 -180
  62. package/src/builder.ts +0 -113
  63. package/src/collector.test.ts +0 -157
  64. package/src/collector.ts +0 -114
  65. package/src/config.ts +0 -106
  66. package/src/configurationReader.test.ts +0 -104
  67. package/src/configurationReader.ts +0 -108
  68. package/src/events.test.ts +0 -84
  69. package/src/events.ts +0 -75
  70. package/src/index.ts +0 -7
  71. package/src/synchronizer.test.ts +0 -192
  72. package/src/synchronizer.ts +0 -103
  73. package/src/transformer.test.ts +0 -431
  74. package/src/transformer.ts +0 -174
  75. package/src/types.test.ts +0 -137
  76. package/src/types.ts +0 -33
  77. package/src/utils.test.ts +0 -48
  78. package/src/utils.ts +0 -11
  79. package/src/watcher.test.ts +0 -200
  80. package/src/watcher.ts +0 -56
  81. package/src/writer.test.ts +0 -135
  82. package/src/writer.ts +0 -113
  83. package/tsconfig.json +0 -27
  84. package/vite.config.ts +0 -24
package/coverage/configurationReader.ts.html DELETED
@@ -1,409 +0,0 @@
1
-
2
- <!doctype html>
3
- <html lang="en">
4
-
5
- <head>
6
- <title>Code coverage report for configurationReader.ts</title>
7
- <meta charset="utf-8" />
8
- <link rel="stylesheet" href="prettify.css" />
9
- <link rel="stylesheet" href="base.css" />
10
- <link rel="shortcut icon" type="image/x-icon" href="favicon.png" />
11
- <meta name="viewport" content="width=device-width, initial-scale=1" />
12
- <style type='text/css'>
13
- .coverage-summary .sorter {
14
- background-image: url(sort-arrow-sprite.png);
15
- }
16
- </style>
17
- </head>
18
-
19
- <body>
20
- <div class='wrapper'>
21
- <div class='pad1'>
22
- <h1><a href="index.html">All files</a> configurationReader.ts</h1>
23
- <div class='clearfix'>
24
-
25
- <div class='fl pad1y space-right2'>
26
- <span class="strong">100% </span>
27
- <span class="quiet">Statements</span>
28
- <span class='fraction'>108/108</span>
29
- </div>
30
-
31
-
32
- <div class='fl pad1y space-right2'>
33
- <span class="strong">100% </span>
34
- <span class="quiet">Branches</span>
35
- <span class='fraction'>16/16</span>
36
- </div>
37
-
38
-
39
- <div class='fl pad1y space-right2'>
40
- <span class="strong">100% </span>
41
- <span class="quiet">Functions</span>
42
- <span class='fraction'>6/6</span>
43
- </div>
44
-
45
-
46
- <div class='fl pad1y space-right2'>
47
- <span class="strong">100% </span>
48
- <span class="quiet">Lines</span>
49
- <span class='fraction'>108/108</span>
50
- </div>
51
-
52
-
53
- </div>
54
- <p class="quiet">
55
- Press <em>n</em> or <em>j</em> to go to the next uncovered block, <em>b</em>, <em>p</em> or <em>k</em> for the previous block.
56
- </p>
57
- <template id="filterTemplate">
58
- <div class="quiet">
59
- Filter:
60
- <input oninput="onInput()" type="search" id="fileSearch">
61
- </div>
62
- </template>
63
- </div>
64
- <div class='status-line high'></div>
65
- <pre><table class="coverage">
66
- <tr><td class="line-count quiet"><a name='L1'></a><a href='#L1'>1</a>
67
- <a name='L2'></a><a href='#L2'>2</a>
68
- <a name='L3'></a><a href='#L3'>3</a>
69
- <a name='L4'></a><a href='#L4'>4</a>
70
- <a name='L5'></a><a href='#L5'>5</a>
71
- <a name='L6'></a><a href='#L6'>6</a>
72
- <a name='L7'></a><a href='#L7'>7</a>
73
- <a name='L8'></a><a href='#L8'>8</a>
74
- <a name='L9'></a><a href='#L9'>9</a>
75
- <a name='L10'></a><a href='#L10'>10</a>
76
- <a name='L11'></a><a href='#L11'>11</a>
77
- <a name='L12'></a><a href='#L12'>12</a>
78
- <a name='L13'></a><a href='#L13'>13</a>
79
- <a name='L14'></a><a href='#L14'>14</a>
80
- <a name='L15'></a><a href='#L15'>15</a>
81
- <a name='L16'></a><a href='#L16'>16</a>
82
- <a name='L17'></a><a href='#L17'>17</a>
83
- <a name='L18'></a><a href='#L18'>18</a>
84
- <a name='L19'></a><a href='#L19'>19</a>
85
- <a name='L20'></a><a href='#L20'>20</a>
86
- <a name='L21'></a><a href='#L21'>21</a>
87
- <a name='L22'></a><a href='#L22'>22</a>
88
- <a name='L23'></a><a href='#L23'>23</a>
89
- <a name='L24'></a><a href='#L24'>24</a>
90
- <a name='L25'></a><a href='#L25'>25</a>
91
- <a name='L26'></a><a href='#L26'>26</a>
92
- <a name='L27'></a><a href='#L27'>27</a>
93
- <a name='L28'></a><a href='#L28'>28</a>
94
- <a name='L29'></a><a href='#L29'>29</a>
95
- <a name='L30'></a><a href='#L30'>30</a>
96
- <a name='L31'></a><a href='#L31'>31</a>
97
- <a name='L32'></a><a href='#L32'>32</a>
98
- <a name='L33'></a><a href='#L33'>33</a>
99
- <a name='L34'></a><a href='#L34'>34</a>
100
- <a name='L35'></a><a href='#L35'>35</a>
101
- <a name='L36'></a><a href='#L36'>36</a>
102
- <a name='L37'></a><a href='#L37'>37</a>
103
- <a name='L38'></a><a href='#L38'>38</a>
104
- <a name='L39'></a><a href='#L39'>39</a>
105
- <a name='L40'></a><a href='#L40'>40</a>
106
- <a name='L41'></a><a href='#L41'>41</a>
107
- <a name='L42'></a><a href='#L42'>42</a>
108
- <a name='L43'></a><a href='#L43'>43</a>
109
- <a name='L44'></a><a href='#L44'>44</a>
110
- <a name='L45'></a><a href='#L45'>45</a>
111
- <a name='L46'></a><a href='#L46'>46</a>
112
- <a name='L47'></a><a href='#L47'>47</a>
113
- <a name='L48'></a><a href='#L48'>48</a>
114
- <a name='L49'></a><a href='#L49'>49</a>
115
- <a name='L50'></a><a href='#L50'>50</a>
116
- <a name='L51'></a><a href='#L51'>51</a>
117
- <a name='L52'></a><a href='#L52'>52</a>
118
- <a name='L53'></a><a href='#L53'>53</a>
119
- <a name='L54'></a><a href='#L54'>54</a>
120
- <a name='L55'></a><a href='#L55'>55</a>
121
- <a name='L56'></a><a href='#L56'>56</a>
122
- <a name='L57'></a><a href='#L57'>57</a>
123
- <a name='L58'></a><a href='#L58'>58</a>
124
- <a name='L59'></a><a href='#L59'>59</a>
125
- <a name='L60'></a><a href='#L60'>60</a>
126
- <a name='L61'></a><a href='#L61'>61</a>
127
- <a name='L62'></a><a href='#L62'>62</a>
128
- <a name='L63'></a><a href='#L63'>63</a>
129
- <a name='L64'></a><a href='#L64'>64</a>
130
- <a name='L65'></a><a href='#L65'>65</a>
131
- <a name='L66'></a><a href='#L66'>66</a>
132
- <a name='L67'></a><a href='#L67'>67</a>
133
- <a name='L68'></a><a href='#L68'>68</a>
134
- <a name='L69'></a><a href='#L69'>69</a>
135
- <a name='L70'></a><a href='#L70'>70</a>
136
- <a name='L71'></a><a href='#L71'>71</a>
137
- <a name='L72'></a><a href='#L72'>72</a>
138
- <a name='L73'></a><a href='#L73'>73</a>
139
- <a name='L74'></a><a href='#L74'>74</a>
140
- <a name='L75'></a><a href='#L75'>75</a>
141
- <a name='L76'></a><a href='#L76'>76</a>
142
- <a name='L77'></a><a href='#L77'>77</a>
143
- <a name='L78'></a><a href='#L78'>78</a>
144
- <a name='L79'></a><a href='#L79'>79</a>
145
- <a name='L80'></a><a href='#L80'>80</a>
146
- <a name='L81'></a><a href='#L81'>81</a>
147
- <a name='L82'></a><a href='#L82'>82</a>
148
- <a name='L83'></a><a href='#L83'>83</a>
149
- <a name='L84'></a><a href='#L84'>84</a>
150
- <a name='L85'></a><a href='#L85'>85</a>
151
- <a name='L86'></a><a href='#L86'>86</a>
152
- <a name='L87'></a><a href='#L87'>87</a>
153
- <a name='L88'></a><a href='#L88'>88</a>
154
- <a name='L89'></a><a href='#L89'>89</a>
155
- <a name='L90'></a><a href='#L90'>90</a>
156
- <a name='L91'></a><a href='#L91'>91</a>
157
- <a name='L92'></a><a href='#L92'>92</a>
158
- <a name='L93'></a><a href='#L93'>93</a>
159
- <a name='L94'></a><a href='#L94'>94</a>
160
- <a name='L95'></a><a href='#L95'>95</a>
161
- <a name='L96'></a><a href='#L96'>96</a>
162
- <a name='L97'></a><a href='#L97'>97</a>
163
- <a name='L98'></a><a href='#L98'>98</a>
164
- <a name='L99'></a><a href='#L99'>99</a>
165
- <a name='L100'></a><a href='#L100'>100</a>
166
- <a name='L101'></a><a href='#L101'>101</a>
167
- <a name='L102'></a><a href='#L102'>102</a>
168
- <a name='L103'></a><a href='#L103'>103</a>
169
- <a name='L104'></a><a href='#L104'>104</a>
170
- <a name='L105'></a><a href='#L105'>105</a>
171
- <a name='L106'></a><a href='#L106'>106</a>
172
- <a name='L107'></a><a href='#L107'>107</a>
173
- <a name='L108'></a><a href='#L108'>108</a>
174
- <a name='L109'></a><a href='#L109'>109</a></td><td class="line-coverage quiet"><span class="cline-any cline-yes">1x</span>
175
- <span class="cline-any cline-yes">1x</span>
176
- <span class="cline-any cline-yes">1x</span>
177
- <span class="cline-any cline-yes">1x</span>
178
- <span class="cline-any cline-yes">1x</span>
179
- <span class="cline-any cline-yes">1x</span>
180
- <span class="cline-any cline-yes">1x</span>
181
- <span class="cline-any cline-yes">1x</span>
182
- <span class="cline-any cline-yes">1x</span>
183
- <span class="cline-any cline-yes">1x</span>
184
- <span class="cline-any cline-yes">2x</span>
185
- <span class="cline-any cline-yes">2x</span>
186
- <span class="cline-any cline-yes">2x</span>
187
- <span class="cline-any cline-yes">2x</span>
188
- <span class="cline-any cline-yes">2x</span>
189
- <span class="cline-any cline-yes">2x</span>
190
- <span class="cline-any cline-yes">1x</span>
191
- <span class="cline-any cline-yes">1x</span>
192
- <span class="cline-any cline-yes">1x</span>
193
- <span class="cline-any cline-yes">1x</span>
194
- <span class="cline-any cline-yes">1x</span>
195
- <span class="cline-any cline-yes">1x</span>
196
- <span class="cline-any cline-yes">1x</span>
197
- <span class="cline-any cline-yes">1x</span>
198
- <span class="cline-any cline-yes">1x</span>
199
- <span class="cline-any cline-yes">1x</span>
200
- <span class="cline-any cline-yes">16x</span>
201
- <span class="cline-any cline-yes">16x</span>
202
- <span class="cline-any cline-yes">16x</span>
203
- <span class="cline-any cline-yes">16x</span>
204
- <span class="cline-any cline-yes">1x</span>
205
- <span class="cline-any cline-yes">1x</span>
206
- <span class="cline-any cline-yes">1x</span>
207
- <span class="cline-any cline-yes">1x</span>
208
- <span class="cline-any cline-yes">1x</span>
209
- <span class="cline-any cline-yes">1x</span>
210
- <span class="cline-any cline-yes">1x</span>
211
- <span class="cline-any cline-yes">1x</span>
212
- <span class="cline-any cline-yes">1x</span>
213
- <span class="cline-any cline-yes">16x</span>
214
- <span class="cline-any cline-yes">16x</span>
215
- <span class="cline-any cline-yes">3x</span>
216
- <span class="cline-any cline-yes">3x</span>
217
- <span class="cline-any cline-yes">13x</span>
218
- <span class="cline-any cline-yes">13x</span>
219
- <span class="cline-any cline-yes">1x</span>
220
- <span class="cline-any cline-yes">16x</span>
221
- <span class="cline-any cline-yes">16x</span>
222
- <span class="cline-any cline-yes">16x</span>
223
- <span class="cline-any cline-yes">16x</span>
224
- <span class="cline-any cline-yes">16x</span>
225
- <span class="cline-any cline-yes">16x</span>
226
- <span class="cline-any cline-yes">16x</span>
227
- <span class="cline-any cline-yes">16x</span>
228
- <span class="cline-any cline-yes">16x</span>
229
- <span class="cline-any cline-yes">16x</span>
230
- <span class="cline-any cline-yes">16x</span>
231
- <span class="cline-any cline-yes">16x</span>
232
- <span class="cline-any cline-yes">16x</span>
233
- <span class="cline-any cline-yes">16x</span>
234
- <span class="cline-any cline-yes">16x</span>
235
- <span class="cline-any cline-yes">15x</span>
236
- <span class="cline-any cline-yes">1x</span>
237
- <span class="cline-any cline-yes">1x</span>
238
- <span class="cline-any cline-yes">1x</span>
239
- <span class="cline-any cline-yes">1x</span>
240
- <span class="cline-any cline-yes">1x</span>
241
- <span class="cline-any cline-yes">17x</span>
242
- <span class="cline-any cline-yes">17x</span>
243
- <span class="cline-any cline-yes">17x</span>
244
- <span class="cline-any cline-yes">17x</span>
245
- <span class="cline-any cline-yes">17x</span>
246
- <span class="cline-any cline-yes">17x</span>
247
- <span class="cline-any cline-yes">17x</span>
248
- <span class="cline-any cline-yes">1x</span>
249
- <span class="cline-any cline-yes">1x</span>
250
- <span class="cline-any cline-yes">1x</span>
251
- <span class="cline-any cline-yes">1x</span>
252
- <span class="cline-any cline-yes">1x</span>
253
- <span class="cline-any cline-yes">16x</span>
254
- <span class="cline-any cline-yes">16x</span>
255
- <span class="cline-any cline-yes">16x</span>
256
- <span class="cline-any cline-yes">16x</span>
257
- <span class="cline-any cline-yes">16x</span>
258
- <span class="cline-any cline-yes">16x</span>
259
- <span class="cline-any cline-yes">16x</span>
260
- <span class="cline-any cline-yes">16x</span>
261
- <span class="cline-any cline-yes">17x</span>
262
- <span class="cline-any cline-yes">1x</span>
263
- <span class="cline-any cline-yes">1x</span>
264
- <span class="cline-any cline-yes">1x</span>
265
- <span class="cline-any cline-yes">1x</span>
266
- <span class="cline-any cline-yes">1x</span>
267
- <span class="cline-any cline-yes">15x</span>
268
- <span class="cline-any cline-yes">15x</span>
269
- <span class="cline-any cline-yes">15x</span>
270
- <span class="cline-any cline-yes">15x</span>
271
- <span class="cline-any cline-yes">15x</span>
272
- <span class="cline-any cline-yes">15x</span>
273
- <span class="cline-any cline-yes">15x</span>
274
- <span class="cline-any cline-yes">15x</span>
275
- <span class="cline-any cline-yes">15x</span>
276
- <span class="cline-any cline-yes">17x</span>
277
- <span class="cline-any cline-yes">17x</span>
278
- <span class="cline-any cline-yes">1x</span>
279
- <span class="cline-any cline-yes">1x</span>
280
- <span class="cline-any cline-yes">1x</span>
281
- <span class="cline-any cline-yes">1x</span>
282
- <span class="cline-any cline-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">import * as esbuild from "esbuild";
283
- import fs from "node:fs/promises";
284
- import path from "node:path";
285
- import packageJson from "../package.json";
286
- import { AnyCollection } from "./config";
287
- import { existsSync } from "node:fs";
288
- &nbsp;
289
- export type ErrorType = "Read" | "Compile";
290
- &nbsp;
291
- export class ConfigurationError extends Error {
292
- type: ErrorType;
293
- constructor(type: ErrorType, message: string) {
294
- super(message);
295
- this.type = type;
296
- }
297
- }
298
- &nbsp;
299
- export type InternalConfiguration = {
300
- collections: Array&lt;AnyCollection&gt;;
301
- path: string;
302
- generateTypes?: boolean;
303
- };
304
- &nbsp;
305
- const importPathPlugin: esbuild.Plugin = {
306
- name: "import-path",
307
- setup(build) {
308
- build.onResolve({ filter: /^\@content-collections\/core$/ }, () =&gt; {
309
- return { path: path.join(__dirname, "index.ts"), external: true };
310
- });
311
- },
312
- };
313
- &nbsp;
314
- export type Options = {
315
- configName: string;
316
- cacheDir?: string;
317
- };
318
- &nbsp;
319
- export const defaultConfigName = "content-collection-config.mjs";
320
- &nbsp;
321
- function resolveCacheDir(config: string, options: Options) {
322
- if (options.cacheDir) {
323
- return options.cacheDir;
324
- }
325
- return path.join(path.dirname(config), ".content-collections", "cache");
326
- }
327
- &nbsp;
328
- async function compile(configurationPath: string, outfile: string) {
329
- const plugins: Array&lt;esbuild.Plugin&gt; = [];
330
- if (process.env.NODE_ENV === "test") {
331
- plugins.push(importPathPlugin);
332
- }
333
- &nbsp;
334
- await esbuild.build({
335
- entryPoints: [configurationPath],
336
- external: [...Object.keys(packageJson.dependencies), "@content-collections/*"],
337
- bundle: true,
338
- platform: "node",
339
- format: "esm",
340
- plugins,
341
- outfile,
342
- });
343
- }
344
- &nbsp;
345
- // errorHandler does not make sense here:
346
- // because if the configuration is invalid, the program should exit
347
- &nbsp;
348
- export function createConfigurationReader() {
349
- return async (
350
- configurationPath: string,
351
- options: Options = {
352
- configName: defaultConfigName,
353
- }
354
- ): Promise&lt;InternalConfiguration&gt; =&gt; {
355
- if (!existsSync(configurationPath)) {
356
- throw new ConfigurationError(
357
- "Read",
358
- `configuration file ${configurationPath} does not exist`
359
- );
360
- }
361
- &nbsp;
362
- const cacheDir = resolveCacheDir(configurationPath, options);
363
- await fs.mkdir(cacheDir, { recursive: true });
364
- &nbsp;
365
- const outfile = path.join(cacheDir, options.configName);
366
- &nbsp;
367
- try {
368
- await compile(configurationPath, outfile);
369
- } catch (error) {
370
- throw new ConfigurationError(
371
- "Compile",
372
- `configuration file ${configurationPath} is invalid: ${error}`
373
- );
374
- }
375
- &nbsp;
376
- const module = await import(
377
- `file://${path.resolve(outfile)}?x=${Date.now()}`
378
- );
379
- return {
380
- ...module.default,
381
- path: configurationPath,
382
- generateTypes: true,
383
- };
384
- };
385
- }
386
- &nbsp;
387
- export type ConfigurationReader = Awaited&lt;
388
- ReturnType&lt;typeof createConfigurationReader&gt;
389
- &gt;;
390
- &nbsp;</pre></td></tr></table></pre>
391
-
392
- <div class='push'></div><!-- for sticky footer -->
393
- </div><!-- /wrapper -->
394
- <div class='footer quiet pad2 space-top1 center small'>
395
- Code coverage generated by
396
- <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
397
- at 2024-01-15T18:52:01.749Z
398
- </div>
399
- <script src="prettify.js"></script>
400
- <script>
401
- window.onload = function () {
402
- prettyPrint();
403
- };
404
- </script>
405
- <script src="sorter.js"></script>
406
- <script src="block-navigation.js"></script>
407
- </body>
408
- </html>
409
-