This repository has been archived by the owner on Nov 29, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 650
/
Copy pathfetch-docs.js
169 lines (150 loc) · 5.33 KB
/
fetch-docs.js
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
var fs = require('fs')
var os = require('os')
var path = require('path')
var tar = require('tar-fs')
var gunzip = require('gunzip-maybe')
var mkdir = require('mkdirp')
var nugget = require('nugget')
var cpr = require('cpr')
var through = require('through2')
var rimraf = require('rimraf')
var yaml = require('yamljs')
var toTitleCase = require('titlecase')
// settings!
// var settings = {
// latest: boolean,
// version: string,
// finalDir: string
// }
module.exports = function fetchDocs (settings, callback) {
updateVersions(settings)
var url = 'https://api.github.com/repos/atom/electron/tarball/' + settings.version
settings.tmpDir = path.join(os.tmpDir(), 'electron-tmp-download')
// Create temp directory to fetch tarball into
mkdir(settings.tmpDir, function (error) {
if (error) return callback(error)
var filename = 'electron.tar.gz'
var opts = {
headers: {"user-agent": "Electron"},
target: filename,
dir: settings.tmpDir,
resume: true,
verbose: true
}
nugget(url, opts, function (error) {
if (error) return callback(error)
extractDocs(filename, settings, callback)
})
})
}
function updateVersions (settings) {
var config = yaml.load(settings.config)
if (settings.latest) config.latest_version = settings.version
if (config.available_versions.indexOf(settings.version) === -1) {
config.available_versions.push(settings.version)
}
fs.writeFileSync(settings.config, yaml.stringify(config))
}
// Extract just the 'docs' directory from within
// tarball, then prepend each markdown file with
// Jekyll front matter
function extractDocs (filename, settings, callback) {
var tarball = path.join(settings.tmpDir, filename)
var extract = tar.extract(settings.tmpDir, {
ignore: function (name) {
return name.indexOf('/docs/') === -1
},
mapStream: function (fileStream, header) {
var frontmatter
if (path.extname(header.name) === '.md') {
var metadata = constructDocMetadata(header.name, settings.version)
metadata.source_url = constructSourceUrl(header.name)
if (path.basename(header.name, '.md') === 'README') {
metadata.permalink = '/docs/' + settings.version + '/index.html'
frontmatter = new Buffer('---\n' + yaml.stringify(metadata) + '---\n\n')
return fileStream.pipe(frontMatterify(frontmatter)).pipe(removeMdUrls())
}
frontmatter = new Buffer('---\n' + yaml.stringify(metadata) + '---\n\n')
return fileStream.pipe(frontMatterify(frontmatter))
}
return fileStream
}
})
extract.on('entry', function extracting (header, stream, next) {
var extractedElectronDir = header.name.split('/')[0]
settings.newDir = path.join(settings.tmpDir, extractedElectronDir)
})
extract.on('finish', function extracted () {
settings.versionDir = path.join(settings.newDir, settings.version)
settings.extractedDocsDir = path.join(settings.newDir, 'docs')
settings.finalDir = path.join(process.cwd(), settings.finalDir, settings.version)
moveDirectories(settings, callback)
})
fs.createReadStream(tarball).pipe(gunzip()).pipe(extract)
}
function frontMatterify (frontmatter) {
var appended = false
return through(function (obj, enc, next) {
if (!appended) this.push(frontmatter)
appended = true
this.push(obj)
next()
})
}
function removeMdUrls () {
return through(function (obj, enc, next) {
var regex = /\.md\)/ig
var edits = obj.toString().replace(regex, ')')
this.push(edits)
next()
})
}
function constructSourceUrl (path) {
var baseUrl = 'https://github.com/atom/electron/blob/master/'
var source = path.split('/')
source.splice(0, 1)
return baseUrl + source.join('/')
}
function constructDocMetadata (path, version) {
var metadata = {}
metadata.version = version
var pathArray = path.split('/')
pathArray.splice(0, 2)
if (pathArray.length === 1) {
metadata.category = "Table of Contents"
metadata.title = formatDocTitle(pathArray[0])
} else {
if (pathArray[0] === 'api') metadata.category = 'API'
else metadata.category = toTitleCase(pathArray[0])
metadata.title = formatDocTitle(pathArray[1])
}
return metadata
}
function formatDocTitle (filename) {
filename = filename.replace('.md', '')
filename = filename.split('-').join(' ')
return toTitleCase(filename)
}
// Take newly extracted 'docs' directory, name it according
// to appropriate Electron version, copy it to electron.atom.io
// '_docs' directory and delete temp directory
function moveDirectories (settings, callback) {
fs.rename(settings.extractedDocsDir, settings.versionDir, function renamed (error) {
if (error) return callback(error)
cpr(settings.versionDir, settings.finalDir, function moved (error) {
if (error) return callback(error)
rimraf(settings.tmpDir, function deleted (error) {
if (error) return callback(error)
if (settings.latest) createLatestDir(settings, callback)
else if (callback) callback(null, 'Done! Docs are in ' + settings.finalDir)
})
})
})
}
function createLatestDir (settings, callback) {
var latestDir = settings.finalDir.replace(settings.version, 'latest')
cpr(settings.finalDir, latestDir, function moved (error) {
if (error) return callback(error)
callback(null, 'Done! Docs are in ' + settings.finalDir + ' and /latest.')
})
}