-
Notifications
You must be signed in to change notification settings - Fork 0
/
dangerfile.ts
477 lines (406 loc) · 11.9 KB
/
dangerfile.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
/**
Copyright 2021 Forestry.io Holdings, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
import { markdown, danger, warn, fail, message, GitHubPRDSL } from 'danger'
import depcheck from 'depcheck'
import * as fs from 'fs'
import * as path from 'path'
import { Buffer } from 'buffer'
const LICENSE_HEADER: string[] = [
`Copyright 2021 Forestry.io Holdings, Inc.`,
`Licensed under the Apache License, Version 2.0 (the "License");`,
`you may not use this file except in compliance with the License.`,
`You may obtain a copy of the License at`,
`http://www.apache.org/licenses/LICENSE-2.0`,
`Unless required by applicable law or agreed to in writing, software`,
`distributed under the License is distributed on an "AS IS" BASIS,`,
`WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.`,
`See the License for the specific language governing permissions and`,
`limitations under the License.`,
]
async function getLocalFileContents(filepath: string) {
return fs.readFileSync(path.resolve(`./${filepath}`), {
encoding: 'utf8',
})
}
interface GithubDraftablePRDSL extends GitHubPRDSL {
draft: Boolean
}
async function getRemoteFileContents(filepath: string) {
const octokit = danger.github.api
const pr = danger.github.pr as GithubDraftablePRDSL
const refType = pr.draft ? 'head' : 'merge'
const { data }: any = await octokit.repos.getContents({
owner: 'tinacms',
repo: 'tinacms',
path: filepath,
ref: `refs/pull/${danger.github.thisPR.number}/${refType}`,
})
return Buffer.from(data.content, 'base64').toString()
}
async function getFileContents(filepath: string) {
if (!danger.github) {
return getLocalFileContents(filepath)
} else {
return getRemoteFileContents(filepath)
}
}
const failAboutIllegalDeps = ({ packageJson }: TinaPackage, deps: string[]) =>
fail(`
Please remove the following dependencies from ${packageJson.name}:
${deps.map(dep => `* ${dep}`).join('\n')}\n
This repository defines the above package in the root level package.json in
order to (1) have consistency across packages and (2) prevent bugs during development.
`)
runChecksOnPullRequest()
/**
* An object representing a package in tinacms/tinacms.
*/
interface TinaPackage {
/**
* The path to the package in the repo.
*/
path: string
/**
* The contents of it's `package.json`.
*/
packageJson: {
name: string
scripts: {
dev: string
build: string
watch: string
}
license: string
dependencies?: { [key: string]: string }
devDependencies?: { [key: string]: string }
}
}
/**
* Executes all checks for the Pull Request.
*/
async function runChecksOnPullRequest() {
const allFiles = [
...danger.git.created_files,
...danger.git.deleted_files,
...danger.git.modified_files,
]
const existingFiles = [
...danger.git.created_files,
...danger.git.modified_files,
]
// Files
await existingFiles
.filter(fileNeedsLicense)
.forEach(checkFileForLicenseHeader)
// Packages
const modifiedPackages = await getModifiedPackages(allFiles)
modifiedPackages.forEach(checkForNpmScripts)
modifiedPackages.forEach(checkForLicense)
modifiedPackages.forEach(checkDeps)
modifiedPackages.forEach(checkForGlobalDeps)
modifiedPackages.forEach(pkg => checkForReadmeChanges(pkg, allFiles))
listTouchedPackages(modifiedPackages)
// Github Actions Workflows
listTouchedWorkflows(allFiles)
// Pull Request
// if (modifiedPackages.length > 0) {
// checkForMilestone()
// }
checkForDocsChanges(allFiles)
}
function checkForReadmeChanges(pkg: TinaPackage, allFiles: string[]) {
const packageFiles = allFiles.filter(file => file.startsWith(pkg.path))
const hasReadme = packageFiles.find(file => file.endsWith('README.md'))
if (!hasReadme) {
warn(
`\`${pkg.path}\` was modified but its README.md was not updated. Please check if any changes should be reflected in the documentation.`
)
}
}
interface Consumers {
[key: string]: Dep[]
}
interface Dep {
file: string
details: string
}
async function checkForDocsChanges(files: string[]) {
files = files.map(file => `/${file}`)
const consumerRequest = await fetch('https://tinacms.org/consumers.json')
const consumers: Consumers = await consumerRequest.json()
const potentialDocChanges: [string, Dep][] = []
Object.keys(consumers).forEach(docFile => {
const dependencies = consumers[docFile]
dependencies.forEach(dep => {
if (files.includes(dep.file)) {
potentialDocChanges.push([docFile, dep])
}
})
})
if (potentialDocChanges.length > 0) {
warnUpdateDoc(potentialDocChanges)
}
}
const warnUpdateDoc = (changes: [string, Dep][]) =>
warn(`
Update Docs for tinacms#${danger.github.pr.number}
<a href="https://github.com/tinacms/tinacms.org/issues/new?&title=${updateDocTitle(
changes
)}&body=${updateDocBody(changes)}">Create Issue</a>
`)
const updateDocTitle = (_changes: [string, Dep][]) =>
encodeURIComponent(`Update Docs for tinacms#${danger.github.pr.number}`)
const updateDocBody = (changes: [string, Dep][]) =>
encodeURIComponent(`
A [pull request](${
danger.github.pr.html_url
}) in tinacms may require documentation updates.
The following files may need to be updated:
| File | Reason |
| --- | --- |
${changes
.map(([file, dep]) => `| ${fileLink(file)} | ${dep.details} |`)
.join('\n')}
`)
const fileLink = (file: string) => {
const filename = file.split('/').pop()
return `[${filename}](https://github.com/tinacms/tinacms.org/tree/master/${file})`
}
/**
* Any PR that modifies one of the packages should be attached to a milestone.
*/
function checkForMilestone() {
// @ts-ignore
const milestone: Milestone = danger.github.pr.milestone
if (milestone) {
message(
`You can expect the changes in this PR to be published on ${formatDate(
new Date(milestone.due_on)
)}`
)
} else {
warn(`@tinacms/dev please add to a Milestone before merging `)
}
}
// This is missing from the `danger` types
interface Milestone {
due_on: string
}
function formatDate(date: Date) {
const day = date.getDay()
const month = date.getMonth() + 1
const year = date.getFullYear()
return `${year}-${month}-${day}`
}
/**
* Example Output:
* ```
* ### Modified Github Workflows
*
* * .github/workflows/main.yml
* * dangerfile.ts
* ```
*/
function listTouchedWorkflows(allFiles: string[]) {
const touchedWorkflows = allFiles.filter(
filepath =>
filepath.startsWith('.github/workflows/') ||
filepath.endsWith('dangerfile.ts')
)
if (touchedWorkflows.length === 0) return
message(`### Modified CI Scripts
* ${touchedWorkflows.join('\n* ')}`)
}
/**
*
*/
function checkForNpmScripts({ packageJson }: TinaPackage) {
if (packageJson.name === '@tinacms/scripts') {
return
}
const scripts = packageJson.scripts || {}
const requiredScripts: (keyof TinaPackage['packageJson']['scripts'])[] = [
'build',
]
requiredScripts.forEach(scriptName => {
if (!scripts[scriptName]) {
fail(`${packageJson.name} is missing a required script: ${scriptName}`)
}
})
}
/**
*
*/
function checkForLicense({ packageJson }: TinaPackage) {
const license = 'Apache-2.0'
if (packageJson.license !== license) {
fail(`${packageJson.name} package.json is missing the license: ${license}`)
}
}
/**
*
*/
function fileNeedsLicense(filepath: string) {
return new RegExp(/\.(js|tsx?)$/).test(filepath)
}
/**
*
*/
async function checkFileForLicenseHeader(filepath: string) {
try {
const content = await getFileContents(filepath)
if (isMissingHeader(content)) {
fail(`${filepath} is missing the license header`)
}
} catch (e) {
fail(e.message)
}
}
function isMissingHeader(content: string) {
for (const line of LICENSE_HEADER) {
if (!content.includes(line)) {
return true
}
}
}
/**
* Example Output:
* ```
* ### Modified Packages
*
* * `@tinacms/fields`
* * `react-tinacms-github`
* ```
*/
function listTouchedPackages(modifiedPackages: TinaPackage[]) {
if (!modifiedPackages.length) return
markdown(`### Modified Packages
The following packages were modified by this pull request:
* ${modifiedPackages
.map(({ packageJson }) => `\`${packageJson.name}\``)
.join('\n* ')}`)
}
/**
* Lists all packages modified by this PR.
*/
async function getModifiedPackages(allFiles: string[]) {
const packageList: TinaPackage[] = []
const paths = new Set(
allFiles
.filter(filepath => filepath.startsWith('packages/'))
.filter(filepath => !filepath.startsWith('packages/demo'))
.filter(filepath => !filepath.startsWith('packages/@testing'))
/**
* These are all the old directory groups.
* For some reason they still exist in Github, even
* though they can't be found. This is causing the danger
* build to fail. Technology, amirite?
*/
.filter(filepath => !filepath.startsWith('packages/api/'))
.filter(filepath => !filepath.startsWith('packages/next/'))
.filter(filepath => !filepath.startsWith('packages/react/'))
.filter(filepath => !filepath.startsWith('packages/gatsby/'))
.filter(filepath => !filepath.startsWith('packages/core/'))
.map(filepath => {
if (filepath.startsWith('packages/@tinacms')) {
return filepath
.split('/')
.slice(0, 3)
.join('/')
}
return filepath
.split('/')
.slice(0, 2)
.join('/')
})
)
const pathArray = Array.from(paths) // typescript doesn't like iterables
for (let path of pathArray) {
try {
// get file contents + JSON decode
await getFileContents(`${path}/package.json`)
.then(JSON.parse)
.then(packageJson => {
packageList.push({
path,
packageJson,
})
})
} catch (e) {
warn(`Could not find package: ${path}: ${e.message}`)
}
}
return packageList
}
function checkDeps(tinaPackage: TinaPackage) {
const DEPCHECK_OPTIONS = {
ignoreMatches: [
'@babel/*',
'@types/*',
'jest',
'tsdx',
'ts-jest',
'tslib',
'typescript',
'*-loader',
'*-webpack-plugin',
'@storybook/*',
'@sambego/*',
'@tinacms/scripts',
'@testing-library/react',
'@testing-library/dom',
],
}
const packagePath = path.resolve(
tinaPackage.path.replace('/package.json', '')
)
// Intentionally cast to any
depcheck(packagePath, DEPCHECK_OPTIONS, (results: any) => {
const unusedDependencies = ['dependencies', 'devDependencies']
unusedDependencies.forEach(type => {
if (results[type].length) {
warnAboutUnused(tinaPackage, type, results[type])
}
})
})
}
const warnAboutUnused = (
{ packageJson }: TinaPackage,
type: string,
deps: string[]
) =>
warn(`${packageJson.name} has unused ${type}
${deps.map(dep => `* ${dep}`).join('\n')}\n
`)
function checkForGlobalDeps(tinaPackage: TinaPackage) {
const deps = Object.keys(tinaPackage.packageJson.dependencies || {})
const devDeps = Object.keys(tinaPackage.packageJson.devDependencies || {})
const illegalDeps = Array.from(new Set([...deps, ...devDeps])).filter(
isIllegal
)
if (illegalDeps.length > 0) {
failAboutIllegalDeps(tinaPackage, illegalDeps)
}
}
function isIllegal(dep: string) {
return (
[
'typescript',
'tslib',
'react',
'react-dom',
'@types/react',
'@types/react-dom',
].indexOf(dep) >= 0
)
}