@monorepolint/rules 0.6.0-alpha.1 → 0.6.0-alpha.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 (61) hide show
  1. package/.turbo/turbo-clean.log +1 -1
  2. package/.turbo/turbo-compile-typescript.log +1 -1
  3. package/.turbo/turbo-lint.log +1 -1
  4. package/.turbo/turbo-test.log +212 -667
  5. package/.turbo/turbo-transpile-typescript.log +5 -5
  6. package/CHANGELOG.md +33 -0
  7. package/build/js/index.js +12 -17
  8. package/build/js/index.js.map +1 -1
  9. package/build/tsconfig.tsbuildinfo +1 -1
  10. package/build/types/__tests__/utils.d.ts +4 -9
  11. package/build/types/__tests__/utils.d.ts.map +1 -1
  12. package/build/types/fileContents.d.ts +1 -1
  13. package/build/types/fileContents.d.ts.map +1 -1
  14. package/build/types/standardTsconfig.d.ts.map +1 -1
  15. package/coverage/base.css +224 -0
  16. package/coverage/block-navigation.js +87 -0
  17. package/coverage/clover.xml +1546 -0
  18. package/coverage/coverage-final.json +19 -0
  19. package/coverage/favicon.png +0 -0
  20. package/coverage/index.html +131 -0
  21. package/coverage/prettify.css +1 -0
  22. package/coverage/prettify.js +2 -0
  23. package/coverage/sort-arrow-sprite.png +0 -0
  24. package/coverage/sorter.js +196 -0
  25. package/coverage/src/alphabeticalDependencies.ts.html +142 -0
  26. package/coverage/src/alphabeticalScripts.ts.html +136 -0
  27. package/coverage/src/bannedDependencies.ts.html +559 -0
  28. package/coverage/src/consistentDependencies.ts.html +355 -0
  29. package/coverage/src/consistentVersions.ts.html +508 -0
  30. package/coverage/src/fileContents.ts.html +385 -0
  31. package/coverage/src/index.html +311 -0
  32. package/coverage/src/index.ts.html +169 -0
  33. package/coverage/src/mustSatisfyPeerDependencies.ts.html +2317 -0
  34. package/coverage/src/nestedWorkspaces.ts.html +265 -0
  35. package/coverage/src/packageEntry.ts.html +355 -0
  36. package/coverage/src/packageOrder.ts.html +454 -0
  37. package/coverage/src/packageScript.ts.html +382 -0
  38. package/coverage/src/requireDependency.ts.html +298 -0
  39. package/coverage/src/standardTsconfig.ts.html +490 -0
  40. package/coverage/src/util/checkAlpha.ts.html +262 -0
  41. package/coverage/src/util/createRuleFactory.ts.html +184 -0
  42. package/coverage/src/util/index.html +161 -0
  43. package/coverage/src/util/makeDirectory.ts.html +157 -0
  44. package/coverage/src/util/packageDependencyGraphService.ts.html +427 -0
  45. package/package.json +16 -20
  46. package/src/__tests__/alphabeticalScripts.spec.ts +2 -2
  47. package/src/__tests__/bannedDependencies.spec.ts +3 -3
  48. package/src/__tests__/consistentDependencies.spec.ts +2 -2
  49. package/src/__tests__/consistentVersions.spec.ts +3 -3
  50. package/src/__tests__/fileContents.spec.ts +3 -3
  51. package/src/__tests__/mustSatisfyPeerDependencies.spec.ts +3 -3
  52. package/src/__tests__/nestedWorkspaces.spec.ts +3 -3
  53. package/src/__tests__/packageEntry.spec.ts +2 -2
  54. package/src/__tests__/packageOrder.spec.ts +2 -2
  55. package/src/__tests__/packageScript.spec.ts +3 -3
  56. package/src/__tests__/requireDependency.spec.ts +2 -2
  57. package/src/__tests__/utils.ts +3 -3
  58. package/src/fileContents.ts +9 -3
  59. package/src/standardTsconfig.ts +1 -0
  60. package/vitest.config.mjs +14 -0
  61. package/jest.config.cjs +0 -4
package/coverage/src/packageScript.ts.html ADDED
@@ -0,0 +1,382 @@
1
+
2
+ <!doctype html>
3
+ <html lang="en">
4
+
5
+ <head>
6
+ <title>Code coverage report for src/packageScript.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> / <a href="index.html">src</a> packageScript.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'>78/78</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'>23/23</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'>3/3</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'>78/78</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 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></td><td class="line-coverage quiet"><span class="cline-any cline-yes">1x</span>
166
+ <span class="cline-any cline-neutral">&nbsp;</span>
167
+ <span class="cline-any cline-neutral">&nbsp;</span>
168
+ <span class="cline-any cline-neutral">&nbsp;</span>
169
+ <span class="cline-any cline-neutral">&nbsp;</span>
170
+ <span class="cline-any cline-neutral">&nbsp;</span>
171
+ <span class="cline-any cline-neutral">&nbsp;</span>
172
+ <span class="cline-any cline-neutral">&nbsp;</span>
173
+ <span class="cline-any cline-neutral">&nbsp;</span>
174
+ <span class="cline-any cline-neutral">&nbsp;</span>
175
+ <span class="cline-any cline-neutral">&nbsp;</span>
176
+ <span class="cline-any cline-neutral">&nbsp;</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">1x</span>
185
+ <span class="cline-any cline-yes">1x</span>
186
+ <span class="cline-any cline-yes">1x</span>
187
+ <span class="cline-any cline-yes">1x</span>
188
+ <span class="cline-any cline-neutral">&nbsp;</span>
189
+ <span class="cline-any cline-neutral">&nbsp;</span>
190
+ <span class="cline-any cline-neutral">&nbsp;</span>
191
+ <span class="cline-any cline-yes">1x</span>
192
+ <span class="cline-any cline-neutral">&nbsp;</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">16x</span>
197
+ <span class="cline-any cline-yes">16x</span>
198
+ <span class="cline-any cline-yes">4x</span>
199
+ <span class="cline-any cline-yes">4x</span>
200
+ <span class="cline-any cline-yes">4x</span>
201
+ <span class="cline-any cline-yes">4x</span>
202
+ <span class="cline-any cline-yes">2x</span>
203
+ <span class="cline-any cline-yes">2x</span>
204
+ <span class="cline-any cline-yes">2x</span>
205
+ <span class="cline-any cline-yes">2x</span>
206
+ <span class="cline-any cline-yes">2x</span>
207
+ <span class="cline-any cline-yes">4x</span>
208
+ <span class="cline-any cline-yes">4x</span>
209
+ <span class="cline-any cline-yes">4x</span>
210
+ <span class="cline-any cline-yes">12x</span>
211
+ <span class="cline-any cline-yes">12x</span>
212
+ <span class="cline-any cline-yes">12x</span>
213
+ <span class="cline-any cline-yes">12x</span>
214
+ <span class="cline-any cline-yes">12x</span>
215
+ <span class="cline-any cline-neutral">&nbsp;</span>
216
+ <span class="cline-any cline-yes">12x</span>
217
+ <span class="cline-any cline-yes">4x</span>
218
+ <span class="cline-any cline-yes">4x</span>
219
+ <span class="cline-any cline-yes">12x</span>
220
+ <span class="cline-any cline-yes">8x</span>
221
+ <span class="cline-any cline-yes">14x</span>
222
+ <span class="cline-any cline-yes">4x</span>
223
+ <span class="cline-any cline-yes">4x</span>
224
+ <span class="cline-any cline-yes">14x</span>
225
+ <span class="cline-any cline-yes">14x</span>
226
+ <span class="cline-any cline-yes">8x</span>
227
+ <span class="cline-any cline-yes">8x</span>
228
+ <span class="cline-any cline-yes">8x</span>
229
+ <span class="cline-any cline-neutral">&nbsp;</span>
230
+ <span class="cline-any cline-yes">12x</span>
231
+ <span class="cline-any cline-neutral">&nbsp;</span>
232
+ <span class="cline-any cline-yes">12x</span>
233
+ <span class="cline-any cline-yes">10x</span>
234
+ <span class="cline-any cline-neutral">&nbsp;</span>
235
+ <span class="cline-any cline-yes">10x</span>
236
+ <span class="cline-any cline-yes">8x</span>
237
+ <span class="cline-any cline-yes">8x</span>
238
+ <span class="cline-any cline-yes">8x</span>
239
+ <span class="cline-any cline-yes">8x</span>
240
+ <span class="cline-any cline-yes">4x</span>
241
+ <span class="cline-any cline-yes">4x</span>
242
+ <span class="cline-any cline-yes">4x</span>
243
+ <span class="cline-any cline-yes">4x</span>
244
+ <span class="cline-any cline-yes">8x</span>
245
+ <span class="cline-any cline-yes">8x</span>
246
+ <span class="cline-any cline-yes">8x</span>
247
+ <span class="cline-any cline-yes">8x</span>
248
+ <span class="cline-any cline-neutral">&nbsp;</span>
249
+ <span class="cline-any cline-yes">10x</span>
250
+ <span class="cline-any cline-yes">10x</span>
251
+ <span class="cline-any cline-yes">10x</span>
252
+ <span class="cline-any cline-neutral">&nbsp;</span>
253
+ <span class="cline-any cline-yes">10x</span>
254
+ <span class="cline-any cline-yes">10x</span>
255
+ <span class="cline-any cline-yes">10x</span>
256
+ <span class="cline-any cline-yes">10x</span>
257
+ <span class="cline-any cline-yes">10x</span>
258
+ <span class="cline-any cline-yes">10x</span>
259
+ <span class="cline-any cline-yes">10x</span>
260
+ <span class="cline-any cline-yes">12x</span>
261
+ <span class="cline-any cline-yes">16x</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-neutral">&nbsp;</span></td><td class="text"><pre class="prettyprint lang-js">/*!
265
+ * Copyright 2019 Palantir Technologies, Inc.
266
+ *
267
+ * Licensed under the MIT license. See LICENSE file in the project root for details.
268
+ *
269
+ */
270
+ &nbsp;
271
+ import { mutateJson, PackageJson } from "@monorepolint/utils";
272
+ import { diff } from "jest-diff";
273
+ import * as r from "runtypes";
274
+ import { createRuleFactory } from "./util/createRuleFactory.js";
275
+ &nbsp;
276
+ export const Options = r.Record({
277
+ scripts: r.Dictionary(
278
+ r.Union(
279
+ r.String,
280
+ r.Record({
281
+ options: r.Array(r.String.Or(r.Undefined)),
282
+ fixValue: r.Union(r.String, r.Undefined, r.Literal(false)).optional(),
283
+ })
284
+ )
285
+ ), // string =&gt; string
286
+ });
287
+ &nbsp;
288
+ export type Options = r.Static&lt;typeof Options&gt;;
289
+ &nbsp;
290
+ export const MSG_NO_SCRIPTS_BLOCK = "No scripts block in package.json";
291
+ &nbsp;
292
+ export const packageScript = createRuleFactory&lt;Options&gt;({
293
+ name: "packageScript",
294
+ check: (context, options) =&gt; {
295
+ const packageJson = context.getPackageJson();
296
+ if (packageJson.scripts === undefined) {
297
+ context.addError({
298
+ file: context.getPackageJsonPath(),
299
+ message: MSG_NO_SCRIPTS_BLOCK,
300
+ fixer: () =&gt; {
301
+ mutateJson&lt;PackageJson&gt;(context.getPackageJsonPath(), context.host, (input) =&gt; {
302
+ input.scripts = {};
303
+ return input;
304
+ });
305
+ },
306
+ });
307
+ return;
308
+ }
309
+ for (const [name, value] of Object.entries(options.scripts)) {
310
+ const allowedValues = new Set&lt;string | undefined&gt;();
311
+ let fixValue: string | undefined | false;
312
+ let allowEmpty = false;
313
+ let fixToEmpty = false;
314
+ &nbsp;
315
+ if (typeof value === "string") {
316
+ allowedValues.add(value);
317
+ fixValue = value;
318
+ } else {
319
+ for (const q of value.options) {
320
+ if (q === undefined) {
321
+ allowEmpty = true;
322
+ }
323
+ allowedValues.add(q);
324
+ }
325
+ fixToEmpty = Object.prototype.hasOwnProperty.call(value, "fixValue") &amp;&amp; value.fixValue === undefined;
326
+ fixValue = value.fixValue;
327
+ }
328
+ &nbsp;
329
+ const actualValue = packageJson.scripts[name];
330
+ &nbsp;
331
+ if (!allowedValues.has(actualValue) &amp;&amp; !(allowEmpty === true &amp;&amp; actualValue === undefined)) {
332
+ let fixer;
333
+ &nbsp;
334
+ if (fixValue !== false &amp;&amp; (fixValue !== undefined || fixToEmpty === true)) {
335
+ const q = fixValue;
336
+ fixer = () =&gt; {
337
+ mutateJson&lt;PackageJson&gt;(context.getPackageJsonPath(), context.host, (input) =&gt; {
338
+ if (fixToEmpty &amp;&amp; q === undefined) {
339
+ delete input.scripts![name];
340
+ } else {
341
+ input.scripts![name] = q!;
342
+ }
343
+ return input;
344
+ });
345
+ };
346
+ }
347
+ &nbsp;
348
+ const validOptionsString = Array.from(allowedValues.values())
349
+ .map((a) =&gt; (a === undefined ? "(empty)" : `'${a}'`))
350
+ .join(", ");
351
+ &nbsp;
352
+ context.addError({
353
+ file: context.getPackageJsonPath(),
354
+ message: `Expected standardized script entry for '${name}'. Valid options: ${validOptionsString}`,
355
+ longMessage: diff(validOptionsString + "\n", (packageJson.scripts[name] || "") + "\n"),
356
+ fixer,
357
+ });
358
+ }
359
+ }
360
+ },
361
+ validateOptions: Options.check,
362
+ });
363
+ &nbsp;</pre></td></tr></table></pre>
364
+
365
+ <div class='push'></div><!-- for sticky footer -->
366
+ </div><!-- /wrapper -->
367
+ <div class='footer quiet pad2 space-top1 center small'>
368
+ Code coverage generated by
369
+ <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
370
+ at 2025-01-17T16:18:41.406Z
371
+ </div>
372
+ <script src="../prettify.js"></script>
373
+ <script>
374
+ window.onload = function () {
375
+ prettyPrint();
376
+ };
377
+ </script>
378
+ <script src="../sorter.js"></script>
379
+ <script src="../block-navigation.js"></script>
380
+ </body>
381
+ </html>
382
+