mirror of
https://github.com/puppeteer/puppeteer
synced 2024-06-14 14:02:48 +00:00
0820d48f80
This patch adds a preprocessor command to link to the latest-released API from the README.md. Fixes #1923.
80 lines
2.9 KiB
JavaScript
80 lines
2.9 KiB
JavaScript
/**
|
|
* Copyright 2017 Google Inc. All rights reserved.
|
|
*
|
|
* Licensed under the Apache License, Version 2.0 (the "License");
|
|
* you may not use this file except in compliance with the License.
|
|
* You may obtain a copy of the License at
|
|
*
|
|
* http://www.apache.org/licenses/LICENSE-2.0
|
|
*
|
|
* Unless required by applicable law or agreed to in writing, software
|
|
* distributed under the License is distributed on an "AS IS" BASIS,
|
|
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
* See the License for the specific language governing permissions and
|
|
* limitations under the License.
|
|
*/
|
|
|
|
const Message = require('../Message');
|
|
|
|
module.exports = function(sources, version) {
|
|
// Release version is everything that doesn't include "-".
|
|
const isReleaseVersion = !version.includes('-');
|
|
const lastReleasedAPILink = `[API](https://github.com/GoogleChrome/puppeteer/blob/v${version.split('-')[0]}/docs/api.md)`;
|
|
|
|
const messages = [];
|
|
const commands = [];
|
|
for (const source of sources) {
|
|
const text = source.text();
|
|
const commandStartRegex = /<!--\s*gen:([a-z-]+)\s*-->/ig;
|
|
const commandEndRegex = /<!--\s*gen:stop\s*-->/ig;
|
|
let start;
|
|
|
|
while (start = commandStartRegex.exec(text)) { // eslint-disable-line no-cond-assign
|
|
commandEndRegex.lastIndex = commandStartRegex.lastIndex;
|
|
const end = commandEndRegex.exec(text);
|
|
if (!end) {
|
|
messages.push(Message.error(`Failed to find 'gen:stop' for command ${start[0]}`));
|
|
return messages;
|
|
}
|
|
const name = start[1];
|
|
const from = commandStartRegex.lastIndex;
|
|
const to = end.index;
|
|
const originalText = text.substring(from, to);
|
|
commands.push({name, from, to, originalText, source});
|
|
commandStartRegex.lastIndex = commandEndRegex.lastIndex;
|
|
}
|
|
}
|
|
|
|
const changedSources = new Set();
|
|
// Iterate commands in reverse order so that edits don't conflict.
|
|
commands.sort((a, b) => b.from - a.from);
|
|
for (const command of commands) {
|
|
let newText = null;
|
|
if (command.name === 'version')
|
|
newText = isReleaseVersion ? 'v' + version : 'Tip-Of-Tree';
|
|
else if (command.name === 'empty-if-release')
|
|
newText = isReleaseVersion ? '' : command.originalText;
|
|
else if (command.name === 'last-released-api')
|
|
newText = lastReleasedAPILink;
|
|
if (newText === null)
|
|
messages.push(Message.error(`Unknown command 'gen:${command.name}'`));
|
|
else if (applyCommand(command, newText))
|
|
changedSources.add(command.source);
|
|
}
|
|
for (const source of changedSources)
|
|
messages.push(Message.warning(`GEN: updated ${source.projectPath()}`));
|
|
return messages;
|
|
};
|
|
|
|
/**
|
|
* @param {{name: string, from: number, to: number, source: !Source}} command
|
|
* @param {string} editText
|
|
* @return {boolean}
|
|
*/
|
|
function applyCommand(command, editText) {
|
|
const text = command.source.text();
|
|
const newText = text.substring(0, command.from) + editText + text.substring(command.to);
|
|
return command.source.setText(newText);
|
|
}
|
|
|