mirror of
https://github.com/nodejs/node.git
synced 2026-11-09 15:11:11 -05:00
Rich Trott
b6cd2155c3
Our documentation uses em dashes inconsistently. They are treated inconsistently typographically too. (For example, they are sometimes surrounded by spaces and sometimes not.) They are also often confused with ordinary hyphens such as in the CHANGELOG, where they are inadvertently mixed together in a single list. The difference is not obvious in the raw markdown but is very noticeable when rendered, appearing to be a typographical error (which it in fact is). The em dash is never needed. There are always alternatives. Remove em dashes entirely. PR-URL: https://github.com/nodejs/node/pull/32080 Reviewed-By: Richard Lau <riclau@uk.ibm.com> Reviewed-By: James M Snell <jasnell@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
77 lines
2.3 KiB
JavaScript
77 lines
2.3 KiB
JavaScript
'use strict';
|
|
|
|
const { readFileSync } = require('fs');
|
|
const path = require('path');
|
|
const srcRoot = path.join(__dirname, '..', '..');
|
|
|
|
let _versions;
|
|
|
|
const isRelease = () => {
|
|
const re = /#define NODE_VERSION_IS_RELEASE 0/;
|
|
const file = path.join(srcRoot, 'src', 'node_version.h');
|
|
return !re.test(readFileSync(file, { encoding: 'utf8' }));
|
|
};
|
|
|
|
const getUrl = (url) => {
|
|
return new Promise((resolve, reject) => {
|
|
const https = require('https');
|
|
const request = https.get(url, { timeout: 5000 }, (response) => {
|
|
if (response.statusCode !== 200) {
|
|
reject(new Error(
|
|
`Failed to get ${url}, status code ${response.statusCode}`));
|
|
}
|
|
response.setEncoding('utf8');
|
|
let body = '';
|
|
response.on('aborted', () => reject());
|
|
response.on('data', (data) => body += data);
|
|
response.on('end', () => resolve(body));
|
|
});
|
|
request.on('error', (err) => reject(err));
|
|
request.on('timeout', () => request.abort());
|
|
});
|
|
};
|
|
|
|
const kNoInternet = !!process.env.NODE_TEST_NO_INTERNET;
|
|
|
|
module.exports = {
|
|
async versions() {
|
|
if (_versions) {
|
|
return _versions;
|
|
}
|
|
|
|
// The CHANGELOG.md on release branches may not reference newer semver
|
|
// majors of Node.js so fetch and parse the version from the master branch.
|
|
const url =
|
|
'https://raw.githubusercontent.com/nodejs/node/master/CHANGELOG.md';
|
|
let changelog;
|
|
const file = path.join(srcRoot, 'CHANGELOG.md');
|
|
if (kNoInternet) {
|
|
changelog = readFileSync(file, { encoding: 'utf8' });
|
|
} else {
|
|
try {
|
|
changelog = await getUrl(url);
|
|
} catch (e) {
|
|
// Fail if this is a release build, otherwise fallback to local files.
|
|
if (isRelease()) {
|
|
throw e;
|
|
} else {
|
|
console.warn(`Unable to retrieve ${url}. Falling back to ${file}.`);
|
|
changelog = readFileSync(file, { encoding: 'utf8' });
|
|
}
|
|
}
|
|
}
|
|
const ltsRE = /Long Term Support/i;
|
|
const versionRE = /\* \[Node\.js ([0-9.]+)\]\S+ (.*)\r?\n/g;
|
|
_versions = [];
|
|
let match;
|
|
while ((match = versionRE.exec(changelog)) != null) {
|
|
const entry = { num: `${match[1]}.x` };
|
|
if (ltsRE.test(match[2])) {
|
|
entry.lts = true;
|
|
}
|
|
_versions.push(entry);
|
|
}
|
|
return _versions;
|
|
}
|
|
};
|