gatsby
Version:
Blazing fast modern site generator for React
212 lines (202 loc) • 8.41 kB
JavaScript
;
var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
exports.__esModule = true;
exports.default = void 0;
var _uniq2 = _interopRequireDefault(require("lodash/uniq"));
var _gatsbyCoreUtils = require("gatsby-core-utils");
var _chalk = _interopRequireDefault(require("chalk"));
var _commonTags = require("common-tags");
var _fastestLevenshtein = require("fastest-levenshtein");
const handleFlags = (flags, configFlags = {}, executingCommand = process.env.gatsby_executing_command) => {
// Prepare config flags.
// Filter out any flags that are set to false.
const availableFlags = new Map();
flags.forEach(flag => {
availableFlags.set(flag.name, flag);
});
// Find unknown flags someone has in their config to warn them about.
const unknownConfigFlags = [];
const unfitConfigFlags = [];
for (const flagName in configFlags) {
if (availableFlags.has(flagName)) {
continue;
}
let flagWithMinDistance;
let minDistance;
for (const availableFlag of flags) {
if (availableFlag.name !== flagName) {
const distanceToFlag = (0, _fastestLevenshtein.distance)(flagName, availableFlag.name);
if (!flagWithMinDistance || distanceToFlag < minDistance) {
flagWithMinDistance = availableFlag.name;
minDistance = distanceToFlag;
}
}
}
if (flagName) {
unknownConfigFlags.push({
flag: flagName,
didYouMean: flagWithMinDistance && minDistance < 4 ? flagWithMinDistance : ``
});
}
}
let unknownFlagMessage = ``;
if (unknownConfigFlags.length > 0) {
unknownFlagMessage = (0, _commonTags.commaListsAnd)`The following flag(s) found in your gatsby-config.js are not known:`;
unknownConfigFlags.forEach(flag => unknownFlagMessage += `\n- ${flag.flag}${flag.didYouMean ? ` (did you mean: ${flag.didYouMean})` : ``}`);
}
let enabledConfigFlags = Object.keys(configFlags).filter(name => configFlags[name] && availableFlags.has(name)).map(flagName => availableFlags.get(flagName));
// Test flags to see if it wants opted in.
const optedInFlags = new Map();
const applicableFlags = new Map();
const lockedInFlags = new Map();
const lockedInFlagsThatAreInConfig = new Map();
availableFlags.forEach(flag => {
if (flag.command !== `all` && flag.command !== executingCommand) {
// if flag is not for all commands and current command doesn't match command flag is for - skip
return;
}
if (flag.noCI && (0, _gatsbyCoreUtils.isCI)()) {
// If we're in CI and flag is not available for CI - skip
return;
}
const fitness = flag.testFitness(flag);
const flagIsSetInConfig = typeof configFlags[flag.name] !== `undefined`;
if (fitness === `LOCKED_IN`) {
enabledConfigFlags.push(flag);
lockedInFlags.set(flag.name, flag);
if (flagIsSetInConfig) {
lockedInFlagsThatAreInConfig.set(flag.name, flag);
}
} else if (!flagIsSetInConfig && fitness === `OPT_IN`) {
// if user didn't explicitly set a flag (either true or false)
// and it qualifies for auto opt-in - add it to optedInFlags
enabledConfigFlags.push(flag);
optedInFlags.set(flag.name, flag);
}
if (fitness === true || fitness === `OPT_IN`) {
applicableFlags.set(flag.name, flag);
}
if (fitness === false && enabledConfigFlags.includes(flag)) {
var _flag$requires;
unfitConfigFlags.push({
flag: flag.name,
requires: (_flag$requires = flag.requires) !== null && _flag$requires !== void 0 ? _flag$requires : ``
});
}
});
let unfitFlagMessage = ``;
if (unfitConfigFlags.length > 0) {
unfitFlagMessage = `The following flag(s) found in your gatsby-config.js are not supported in your environment and will have no effect:\n` + unfitConfigFlags.map(flag => `- ${flag.flag}${flag.requires ? `: ${flag.requires}` : ``}`).join(`\n`);
}
// Filter enabledConfigFlags against various tests
enabledConfigFlags = enabledConfigFlags.filter(flag => {
if (flag.command !== `all` && flag.command !== executingCommand) {
// if flag is not for all commands and current command doesn't match command flag is for - skip
return false;
}
if (flag.noCI && (0, _gatsbyCoreUtils.isCI)()) {
// If we're in CI and flag is not available for CI - skip
return false;
}
// finally check if flag passes fitness check
return flag.testFitness(flag);
});
const addIncluded = flag => {
if (flag.includedFlags) {
flag.includedFlags.forEach(includedName => {
const incExp = flags.find(e => e.name == includedName);
if (incExp) {
const flagIsDisabledByUser = typeof configFlags[includedName] !== `undefined` && !configFlags[includedName];
if (!flagIsDisabledByUser) {
enabledConfigFlags.push(incExp);
addIncluded(incExp);
}
}
});
}
};
// Add to enabledConfigFlags any includedFlags
enabledConfigFlags.forEach(flag => {
addIncluded(flag);
});
enabledConfigFlags = (0, _uniq2.default)(enabledConfigFlags);
// TODO remove flags that longer exist.
// w/ message of thanks
const generateFlagLine = flag => {
let message = ``;
message += `\n- ${flag.name}`;
if (flag.experimental) {
message += ` · ${_chalk.default.black.bgYellow.bold(`EXPERIMENTAL`)}`;
}
if (flag.umbrellaIssue) {
message += ` · (Umbrella Issue (${flag.umbrellaIssue}))`;
}
message += ` · ${flag.description}`;
return message;
};
let message = ``;
// Create message about what flags are active.
if (enabledConfigFlags.length > 0) {
if (enabledConfigFlags.length - optedInFlags.size - lockedInFlags.size > 0) {
message = `The following flags are active:`;
enabledConfigFlags.forEach(flag => {
if (!optedInFlags.has(flag.name) && !lockedInFlags.has(flag.name)) {
message += generateFlagLine(flag);
}
});
}
if (lockedInFlagsThatAreInConfig.size > 0) {
if (message.length > 0) {
message += `\n\n`;
}
message += `Some features you configured with flags are used natively now.
Those flags no longer have any effect and you can remove them from config:`;
lockedInFlagsThatAreInConfig.forEach(flag => {
message += generateFlagLine(flag);
});
}
if (optedInFlags.size > 0) {
if (message.length > 0) {
message += `\n\n`;
}
message += `We're shipping new features! For final testing, we're rolling them out first to a small % of Gatsby users
and your site was automatically chosen as one of them. With your help, we'll then release them to everyone in the next minor release.
We greatly appreciate your help testing the change. Please report any feedback good or bad in the umbrella issue. If you do encounter problems, please disable the flag by setting it to false in your gatsby-config.js like:
flags: {
THE_FLAG: false
}
The following flags were automatically enabled on your site:`;
optedInFlags.forEach(flag => {
message += generateFlagLine(flag);
});
}
if (message.length > 0) {
// if we will print anything about flags, let's try to suggest other available ones
const otherFlagSuggestionLines = [];
const enabledFlagsSet = new Set();
enabledConfigFlags.forEach(f => enabledFlagsSet.add(f.name));
applicableFlags.forEach(flag => {
if (!enabledFlagsSet.has(flag.name) && typeof configFlags[flag.name] === `undefined`) {
// we want to suggest flag when it's not enabled and user specifically didn't use it in config
// we don't want to suggest flag user specifically wanted to disable
otherFlagSuggestionLines.push(generateFlagLine(flag));
}
});
if (otherFlagSuggestionLines.length > 0) {
message += `\n\nThere ${otherFlagSuggestionLines.length === 1 ? `is one other flag` : `are ${otherFlagSuggestionLines.length} other flags`} available that you might be interested in:${otherFlagSuggestionLines.join(``)}`;
}
}
if (message.length > 0) {
message += `\n`;
}
}
return {
enabledConfigFlags,
message,
unknownFlagMessage,
unfitFlagMessage
};
};
var _default = handleFlags;
exports.default = _default;
//# sourceMappingURL=handle-flags.js.map