134 lines
5.0 KiB
JavaScript
134 lines
5.0 KiB
JavaScript
'use strict'
|
|
|
|
const fs = require('fs')
|
|
const TypeDoc = require('typedoc')
|
|
const path = require('path')
|
|
const json5 = require('json5')
|
|
const pkgJson = require('../package.json')
|
|
const rimraf = require('rimraf')
|
|
|
|
const rootDir = path.join(__dirname, '..')
|
|
|
|
function camelise (str) {
|
|
return str.replace(/-([a-z])/g,
|
|
function (m, w) {
|
|
return w.toUpperCase()
|
|
})
|
|
}
|
|
|
|
const tsConfigPath = path.join(rootDir, 'tsconfig.json')
|
|
const tempTsConfigPath = path.join(rootDir, '.tsconfig.json')
|
|
|
|
async function typedoc () {
|
|
const app = new TypeDoc.Application()
|
|
|
|
// prepare tsconfig
|
|
const tsConfig = json5.parse(fs.readFileSync(tsConfigPath, 'utf8'))
|
|
tsConfig.include = ['src/ts/**/*', 'build/typings/**/*.d.ts']
|
|
tsConfig.exclude = ['src/**/*.spec.ts']
|
|
fs.writeFileSync(tempTsConfigPath, JSON.stringify(tsConfig, undefined, 2))
|
|
|
|
// If you want TypeDoc to load tsconfig.json / typedoc.json files
|
|
app.options.addReader(new TypeDoc.TSConfigReader())
|
|
app.options.addReader(new TypeDoc.TypeDocReader())
|
|
|
|
app.bootstrap({
|
|
// typedoc options here
|
|
tsconfig: tempTsConfigPath,
|
|
entryPoints: ['src/ts/index.ts'],
|
|
plugin: ['typedoc-plugin-markdown'],
|
|
includeVersion: true,
|
|
entryDocument: 'API.md',
|
|
readme: 'none',
|
|
hideBreadcrumbs: true,
|
|
excludePrivate: true
|
|
})
|
|
|
|
const project = app.convert()
|
|
|
|
if (project) {
|
|
// Project may not have converted correctly
|
|
const output = path.join(rootDir, './docs')
|
|
|
|
// Rendered docs
|
|
await app.generateDocs(project, output)
|
|
}
|
|
}
|
|
|
|
function getRepositoryData () {
|
|
if (typeof pkgJson.repository === 'string') {
|
|
const repodata = pkgJson.repository.split(/[:/]/)
|
|
const repoProvider = repodata[0]
|
|
if (repoProvider === 'github' || repoProvider === 'gitlab' || repoProvider === 'bitbucket') {
|
|
return {
|
|
repoProvider,
|
|
repoUsername: repodata[1],
|
|
repoName: repodata.slice(2).join('/')
|
|
}
|
|
} else return null
|
|
} else {
|
|
if (pkgJson.repository.url !== 'undefined') {
|
|
const regex = /(?:.+?\+)?http[s]?:\/\/(?<repoProvider>[\w._-]+)\.\w{2,3}\/(?<repoUsername>[\w._-]+)\/(?<repoName>[\w._\-/]+?)\.git/
|
|
const match = pkgJson.repository.url.match(regex)
|
|
return {
|
|
repoProvider: match[1],
|
|
repoUsername: match[2],
|
|
repoName: match[3]
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
const { repoProvider, repoUsername, repoName } = getRepositoryData() || { repoProvider: null, repoUsername: null, repoName: null }
|
|
|
|
const regex = /^(?:(?<scope>@.*?)\/)?(?<name>.*)/ // We are going to take only the package name part if there is a scope, e.g. @my-org/package-name
|
|
const { name } = pkgJson.name.match(regex).groups
|
|
const camelCaseName = camelise(name)
|
|
|
|
const iifeBundlePath = path.relative('.', pkgJson.exports['./iife-browser-bundle'])
|
|
const esmBundlePath = path.relative('.', pkgJson.exports['./esm-browser-bundle'])
|
|
const umdBundlePath = path.relative('.', pkgJson.exports['./umd-browser-bundle'])
|
|
|
|
let iifeBundle, esmBundle, umdBundle, workflowBadget, coverallsBadge
|
|
if (repoProvider) {
|
|
switch (repoProvider) {
|
|
case 'github':
|
|
iifeBundle = `[IIFE bundle](https://raw.githubusercontent.com/${repoUsername}/${repoName}/main/${iifeBundlePath})`
|
|
esmBundle = `[ESM bundle](https://raw.githubusercontent.com/${repoUsername}/${repoName}/main/${esmBundlePath})`
|
|
umdBundle = `[UMD bundle](https://raw.githubusercontent.com/${repoUsername}/${repoName}/main/${umdBundlePath})`
|
|
workflowBadget = `[](https://github.com/${repoUsername}/${repoName}/actions/workflows/build-and-test.yml)`
|
|
coverallsBadge = `[](https://coveralls.io/github/${repoUsername}/${repoName}?branch=main)`
|
|
break
|
|
|
|
case 'gitlab':
|
|
iifeBundle = `[IIFE bundle](https://gitlab.com/${repoUsername}/${repoName}/-/raw/master/${iifeBundlePath}?inline=false)`
|
|
esmBundle = `[ESM bundle](https://gitlab.com/${repoUsername}/${repoName}/-/raw/master/${esmBundlePath}?inline=false)`
|
|
umdBundle = `[UMD bundle](https://gitlab.com/${repoUsername}/${repoName}/-/raw/master/${umdBundlePath}?inline=false)`
|
|
break
|
|
|
|
default:
|
|
break
|
|
}
|
|
}
|
|
|
|
const templateFile = path.join(rootDir, pkgJson.directories.src, 'docs/index.md')
|
|
let template = fs.readFileSync(templateFile, { encoding: 'UTF-8' })
|
|
.replace(/\{\{PKG_NAME\}\}/g, pkgJson.name)
|
|
.replace(/\{\{PKG_CAMELCASE\}\}/g, camelCaseName)
|
|
.replace(/\{\{IIFE_BUNDLE\}\}/g, iifeBundle || 'IIFE bundle')
|
|
.replace(/\{\{ESM_BUNDLE\}\}/g, esmBundle || 'ESM bundle')
|
|
.replace(/\{\{UMD_BUNDLE\}\}/g, umdBundle || 'UMD bundle')
|
|
|
|
if (repoProvider && repoProvider === 'github') {
|
|
template = template.replace(/\{\{GITHUB_ACTIONS_BADGES\}\}/g, workflowBadget + '\n' + coverallsBadge)
|
|
} else {
|
|
template = template.replace(/\{\{GITHUB_ACTIONS_BADGES\}\}/g, '')
|
|
}
|
|
|
|
const readmeFile = path.join(rootDir, 'README.md')
|
|
fs.writeFileSync(readmeFile, template)
|
|
|
|
typedoc()
|
|
|
|
rimraf.sync(tempTsConfigPath)
|