94 lines
3.4 KiB
JavaScript
94 lines
3.4 KiB
JavaScript
const fs = require('fs')
|
|
const path = require('path')
|
|
const { reduce } = require('lodash')
|
|
const allVersions = require('./all-versions')
|
|
const versionSatisfiesRange = require('./version-satisfies-range')
|
|
const checkIfNextVersionOnly = require('./check-if-next-version-only')
|
|
const dataDirectory = require('./data-directory')
|
|
const encodeBracketedParentheses = require('./encode-bracketed-parentheses')
|
|
const featuresDir = path.posix.join(__dirname, '../data/features')
|
|
|
|
let featureData
|
|
if (fs.existsSync(featuresDir)) {
|
|
featureData = dataDirectory(featuresDir, {
|
|
preprocess: dataString =>
|
|
encodeBracketedParentheses(dataString.trimEnd()),
|
|
ignorePatterns: [/README\.md$/]
|
|
})
|
|
}
|
|
|
|
// return an array of versions that an article's product versions encompasses
|
|
function getApplicableVersions (frontmatterVersions, filepath) {
|
|
if (typeof frontmatterVersions === 'undefined') {
|
|
throw new Error(`No \`versions\` frontmatter found in ${filepath}`)
|
|
}
|
|
|
|
// all versions are applicable!
|
|
if (frontmatterVersions === '*') {
|
|
return Object.keys(allVersions)
|
|
}
|
|
|
|
// get an array like: [ 'free-pro-team@latest', 'enterprise-server@2.21', 'enterprise-cloud@latest' ]
|
|
const applicableVersions = []
|
|
|
|
// Check for frontmatter that includes a feature name, like:
|
|
// fpt: '*'
|
|
// feature: 'foo'
|
|
// or multiple feature names, like:
|
|
// fpt: '*'
|
|
// feature: ['foo', 'bar']
|
|
// and add the versions affiliated with the feature (e.g., foo) to the frontmatter versions object:
|
|
// fpt: '*'
|
|
// ghes: '>=2.23'
|
|
// ghae: '*'
|
|
const versionsToEvaluate = reduce(frontmatterVersions, (result, value, key) => {
|
|
if (key === 'feature') {
|
|
if (typeof value === 'string') {
|
|
Object.assign(result, { ...featureData[value].versions })
|
|
} else {
|
|
value.forEach(str => {
|
|
Object.assign(result, { ...featureData[str].versions })
|
|
})
|
|
}
|
|
delete result[key]
|
|
} else {
|
|
result[key] = value
|
|
}
|
|
return result
|
|
}, {})
|
|
|
|
let isNextVersionOnly = false
|
|
|
|
// where frontmatter is something like:
|
|
// fpt: '*'
|
|
// ghes: '>=2.19'
|
|
// ghae: '*'
|
|
// ^ where each key corresponds to a plan's short name (defined in lib/all-versions.js)
|
|
Object.entries(versionsToEvaluate)
|
|
.forEach(([plan, planValue]) => {
|
|
// Special handling for frontmatter that evalues to the next GHES release number or a hardcoded `next`.
|
|
isNextVersionOnly = checkIfNextVersionOnly(planValue)
|
|
|
|
// For each plan (e.g., enterprise-server), get matching versions from allVersions object
|
|
Object.values(allVersions)
|
|
.filter(relevantVersion => relevantVersion.plan === plan || relevantVersion.shortName === plan)
|
|
.forEach(relevantVersion => {
|
|
// Use a dummy value of '1.0' for non-numbered versions like free-pro-team and github-ae
|
|
// This will evaluate to true against '*' but false against 'next', which is what we want.
|
|
const versionToCompare = relevantVersion.hasNumberedReleases ? relevantVersion.currentRelease : '1.0'
|
|
|
|
if (versionSatisfiesRange(versionToCompare, planValue)) {
|
|
applicableVersions.push(relevantVersion.version)
|
|
}
|
|
})
|
|
})
|
|
|
|
if (!applicableVersions.length && !isNextVersionOnly) {
|
|
throw new Error(`No applicable versions found for ${filepath}. Please double-check the page's \`versions\` frontmatter.`)
|
|
}
|
|
|
|
return applicableVersions
|
|
}
|
|
|
|
module.exports = getApplicableVersions
|