File size: 2,865 Bytes
fc93158 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 | import { resolveEmojiAndHomepage } from "./entry-metadata.js";
import {
evaluateRequirementsFromMetadataWithRemote,
type RequirementConfigCheck,
type RequirementRemote,
type Requirements,
type RequirementsMetadata,
} from "./requirements.js";
export type EntryMetadataRequirementsParams = Parameters<
typeof evaluateEntryMetadataRequirements
>[0];
export function evaluateEntryMetadataRequirements(params: {
always: boolean;
metadata?: (RequirementsMetadata & { emoji?: string; homepage?: string }) | null;
frontmatter?: {
emoji?: string;
homepage?: string;
website?: string;
url?: string;
} | null;
hasLocalBin: (bin: string) => boolean;
localPlatform: string;
remote?: RequirementRemote;
isEnvSatisfied: (envName: string) => boolean;
isConfigSatisfied: (pathStr: string) => boolean;
}): {
emoji?: string;
homepage?: string;
required: Requirements;
missing: Requirements;
requirementsSatisfied: boolean;
configChecks: RequirementConfigCheck[];
} {
const { emoji, homepage } = resolveEmojiAndHomepage({
metadata: params.metadata,
frontmatter: params.frontmatter,
});
const { required, missing, eligible, configChecks } = evaluateRequirementsFromMetadataWithRemote({
always: params.always,
metadata: params.metadata ?? undefined,
hasLocalBin: params.hasLocalBin,
localPlatform: params.localPlatform,
remote: params.remote,
isEnvSatisfied: params.isEnvSatisfied,
isConfigSatisfied: params.isConfigSatisfied,
});
return {
...(emoji ? { emoji } : {}),
...(homepage ? { homepage } : {}),
required,
missing,
requirementsSatisfied: eligible,
configChecks,
};
}
export function evaluateEntryMetadataRequirementsForCurrentPlatform(
params: Omit<EntryMetadataRequirementsParams, "localPlatform">,
): ReturnType<typeof evaluateEntryMetadataRequirements> {
return evaluateEntryMetadataRequirements({
...params,
localPlatform: process.platform,
});
}
export function evaluateEntryRequirementsForCurrentPlatform(params: {
always: boolean;
entry: {
metadata?: (RequirementsMetadata & { emoji?: string; homepage?: string }) | null;
frontmatter?: {
emoji?: string;
homepage?: string;
website?: string;
url?: string;
} | null;
};
hasLocalBin: (bin: string) => boolean;
remote?: RequirementRemote;
isEnvSatisfied: (envName: string) => boolean;
isConfigSatisfied: (pathStr: string) => boolean;
}): ReturnType<typeof evaluateEntryMetadataRequirements> {
return evaluateEntryMetadataRequirementsForCurrentPlatform({
always: params.always,
metadata: params.entry.metadata,
frontmatter: params.entry.frontmatter,
hasLocalBin: params.hasLocalBin,
remote: params.remote,
isEnvSatisfied: params.isEnvSatisfied,
isConfigSatisfied: params.isConfigSatisfied,
});
}
|