FilesExpand file tree

master

/

jsdoc2md.js

Copy path

Blame

More file actions

Blame

More file actions

Latest commit

 

History

History

History

148 lines (124 loc) · 4.5 KB

master

/

jsdoc2md.js

Copy path

Top

File metadata and controls

• Code
• Blame

148 lines (124 loc) · 4.5 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

142

143

144

145

146

147

'use strict'

import jsdoc2md from 'jsdoc-to-markdown'

import fs from 'fs'

import path from 'path'

/* input and output paths */

// Function to get all files that match the glob pattern

const findByExtensionSync = (dir, ext) => {

const matchedFiles = [];

const files = fs.readdirSync(dir);

for (const file of files) {

const fileExt = path.extname(file);

if (fileExt === `.${ext}`) {

matchedFiles.push(path.join(dir,file));

}

}

return matchedFiles;

};

// main function

(async ()=> {

// Get all files to read js docs

const inputFiles = findByExtensionSync('js/src', 'js')

const proInputFiles = findByExtensionSync('js/src/pro', 'js');

const basePartials = './wiki/basePartials/'

const basePartial = fs.readdirSync (basePartials).map (file => basePartials + file)

const exchangePartials = './wiki/exchangePartials/'

const exchangePartial = fs.readdirSync (exchangePartials).map (file => exchangePartials + file)

const outputFolder = './wiki/'

const outputFile = './wiki/baseSpec.md'

const helper = './wiki/helpers.cjs'

console.log ('📰 loading js docs...')

let templateData = await Promise.all(inputFiles.map (file => jsdoc2md.getTemplateData({ files: file })));

templateData = templateData.filter (x => x.length > 0)

// TODO: handle alias exchanges

let proTemplateData = await Promise.all(proInputFiles.map (file => jsdoc2md.getTemplateData({ files: file })));

proTemplateData = proTemplateData.filter (x => x.length > 0)

// assign pro classes to REST template data

proTemplateData.forEach((proData) => {

const classArray = templateData.find ((template) => template[0].id === proData[0].memberof);

if (classArray) {

const classArray = templateData.find ((template) => template[0].id === proData[0].memberof);

classArray.push(...proData);

}

})

console.log ('📰 rendering docs for each exchange...')

const template = fs.readFileSync ('./wiki/spec.hbs', 'utf8')

const outputByExchange = await Promise.all (templateData.map (data => jsdoc2md.render ({ template, data, partial: exchangePartial, helper })))

// Group docs by method

const groupedByMethod = templateData.reduce((acc, arr) => {

arr.filter(obj => obj.kind === 'function' && !obj.ignore).forEach(obj => {

const method = obj.name;

if (!acc[method]) {

acc[method] = [{

id: method,

longname: method,

name: method,

kind: "",

scope: "instance",

description: obj.description,

params: obj.params,

returns: obj.returns,

}];

}

obj.exchange = obj.memberof

obj.memberof = method

acc[method].push(obj);

});

return acc;

}, {});

let duplicateIds = []

const templateDataGroupedByMethod = Object.values(groupedByMethod)

.map(group => {

// Filter out duplicate IDs within each group's data array. This is done to avoid Jsdoc2md error: Maximum call stack size exceeded

return group.filter((item, index, self) => {

if (index === self.findIndex(el => el.id === item.id)) {

return true

} else {

console.error ('🚨 duplicate id found: ', item.id)

duplicateIds.push (item.id)

return false

}

}

);

})

.sort((a, b) => a[0].name < b[0].name ? -1 : 1);

if (duplicateIds.length > 0) {

throw new Error ('🚨 duplicate ids found: ' + duplicateIds.join (', '))

}

const baseOutput = await Promise.all(templateDataGroupedByMethod.map(data =>

jsdoc2md.render({ template, data, partial: basePartial, helper})

));

console.log ('📰 creating index of exchange functions')

const exchangeLinks = []

outputByExchange.forEach ((output, i) => {

const name = templateData[i][0].id

const fileName = 'exchanges/' + name + '.md'

try {

fs.writeFileSync(outputFolder + fileName, output)

} catch (e) {

const error = `Error writing file ${fileName}: ${e.message}`

console.error(error)

throw error

}

exchangeLinks.push (`\t- [${name}](${fileName})`)

})

fs.writeFileSync (outputFile, baseOutput.join ('\n---\n'))

const sidebar =

`

- [Install](Install.md)

- [Examples](Examples.md)

- [Manual](Manual.md)

- [CCXT Pro](ccxt.pro.manual.md)

- [Contributing](CONTRIBUTING.md)

- [Supported Exchanges](Exchange-Markets.md)

- [Exchanges By Country](Exchange-Markets-By-Country.md)

- [API Spec By Method](baseSpec.md)

- [FAQ](FAQ.md)

- [Changelog](CHANGELOG.md)

- [Awesome](Awesome.md)

- API Spec by Exchange

${exchangeLinks.join('\n')}

`

fs.writeFileSync('./wiki/_sidebar.md', sidebar);

console.log ('📰 finished rendering docs! 🙌 😶‍🌫')

})()