FilesExpand file tree

 main

/

check-github-github-links.js

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

executable file

·

141 lines (121 loc) · 4.55 KB

 main

/

check-github-github-links.js

Copy path

Top

File metadata and controls

• Code
• Blame

executable file

·

141 lines (121 loc) · 4.55 KB

Raw

Copy raw file

Download raw file

Open symbols panel

Edit and raw actions

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

#!/usr/bin/env node

// [start-readme]

//

// Run this script to get all broken docs.github.com links in github/github

//

// [end-readme]

import { getContents, getPathsWithMatchingStrings } from './helpers/git-utils.js'

import got from 'got'

if (!process.env.GITHUB_TOKEN) {

console.error('Error! You must have a GITHUB_TOKEN set in an .env file to run this script.')

process.exit(1)

}

main()

async function main() {

const searchStrings = ['https://docs.github.com', 'GitHub help_url', 'GitHub developer_help_url']

const foundFiles = await getPathsWithMatchingStrings(searchStrings, 'github', 'github')

const searchFiles = [...foundFiles]

.filter((file) => endsWithAny(['.rb', '.yml', '.yaml', '.txt', '.pdf', '.erb', '.js'], file))

.filter(

(file) =>

!file.includes('test/') &&

!file.includes('app/views/') &&

!file.includes('config.') &&

!file.includes('app/api/description/')

)

const docsLinksFiles = []

const urlRegEx =

/https?:\/\/(www\.)?[-a-zA-Z0-9@:%._+~#=]{1,256}\.[a-zA-Z0-9()]{1,6}\b([-a-zA-Z0-9()@:%_+.~#?&//=]*)/g

for (const file of searchFiles) {

const contents = await getContents('github', 'github', 'master', file)

if (

contents.includes('https://docs.github.com') ||

contents.includes('GitHub.help_url') ||

contents.includes('GitHub.developer_help_url')

) {

const docsIndices = getIndicesOf('https://docs.github.com', contents)

const helpIndices = getIndicesOf('GitHub.help_url', contents)

helpIndices.push(...getIndicesOf('GitHub.developer_help_url', contents))

if (docsIndices.length > 0) {

docsIndices.forEach((numIndex) => {

// Assuming we don't have links close to 500 characters long

const docsLink = contents.substring(numIndex, numIndex + 500).match(urlRegEx)

docsLinksFiles.push([docsLink[0].toString().replace(/[^a-zA-Z0-9]*$|\\n$/g, ''), file])

})

}

if (helpIndices.length > 0) {

helpIndices.forEach((numIndex) => {

// There are certain links like #{GitHub.help_url}#{learn_more_path} and #{GitHub.developer_help_url}#{learn_more_path} that we should skip

if (

(contents.substring(numIndex, numIndex + 11) === 'GitHub.help' &&

contents.charAt(numIndex + 16) !== '#') ||

(contents.substring(numIndex, numIndex + 16) === 'GitHub.developer' &&

contents.charAt(numIndex + 26) !== '#')

) {

const startSearchIndex = contents.indexOf('/', numIndex)

// Looking for the closest '/' after GitHub.developer_help_url or GitHub.help_url

// There are certain links that don't start with `/` so we want to skip those.

// If there's no `/` within 30 characters of GitHub.help_url/GitHub.developer_help_url, skip

if (startSearchIndex - numIndex < 30) {

const helpLink =

'https://docs.github.com' +

contents

.substring(

startSearchIndex,

regexIndexOf(

contents,

/\n|"\)|{@email_tracking_params}|\^http|Ahttps|example|This|TODO"|[{}|"%><.,')* ]/,

startSearchIndex + 1

)

)

.trim()

docsLinksFiles.push([helpLink, file])

}

}

})

}

}

}

const brokenLinks = []

await Promise.all(

docsLinksFiles.map(async (file) => {

try {

await got(file[0])

} catch {

brokenLinks.push(file)

}

})

)

if (!brokenLinks.length) {

console.log('All links are good!')

process.exit(0)

}

console.log(`Found ${brokenLinks.length} total broken links in github/github`)

console.log('```')

console.log(`${JSON.stringify([...brokenLinks], null, 2)}`)

console.log('```')

// Exit unsuccessfully if broken links are found.

process.exit(1)

}

function endsWithAny(suffixes, string) {

for (const suffix of suffixes) {

if (string.endsWith(suffix)) return true

}

return false

}

function getIndicesOf(searchString, string) {

const searchStrLen = searchString.length

if (searchStrLen === 0) return []

let startIndex = 0

let index

const indices = []

while ((index = string.indexOf(searchString, startIndex)) > -1) {

indices.push(index)

startIndex = index + searchStrLen

}

return indices

}

function regexIndexOf(string, regex, startPos) {

const indexOf = string.substring(startPos || 0).search(regex)

return indexOf >= 0 ? indexOf + (startPos || 0) : indexOf

}