Infrastructure/astro
0
Fork 0
mirror of https://github.com/withastro/astro.git synced 2024-12-16 21:46:22 -05:00
Code Issues Activity

fix: log install instructions for adapters instead

Browse source
This commit is contained in:
bholmesdev 2022-07-08 11:28:15 -04:00
parent 54808020d1
commit 1a459f152b
1 changed files with 40 additions and 56 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

96
packages/astro/src/core/add/index.ts
View file

@ -105,8 +105,12 @@ export default async function add(names: string[], { cwd, flags, logging, teleme
// Some packages might have a common alias! We normalize those here.
const integrationNames = names.map((name) => (ALIASES.has(name) ? ALIASES.get(name)! : name));
const integrations = await validateIntegrations(integrationNames);
const integrationsAndAdapters = await validateIntegrations(integrationNames);
const integrations = integrationsAndAdapters.filter(isIntegration);
const adapters = integrationsAndAdapters.filter(isAdapter);
logAdapterInstallInstructions(adapters, logging);
if (integrations.length) {
let ast: t.File | null = null;
try {
ast = await parseAstroConfig(configURL);
@ -126,12 +130,8 @@ export default async function add(names: string[], { cwd, flags, logging, teleme
debug('add', 'Astro config ensured `defineConfig`');
for (const integration of integrations) {
if (integration.type === 'adapter') {
await setAdapter(ast, integration);
} else {
await addIntegration(ast, integration);
}
debug('add', `Astro config added integration ${integration.id}`);
debug('add', `Astro config added ${integration.type} ${integration.id}`);
}
} catch (err) {
debug('add', 'Error parsing/modifying astro config: ', err);
@ -139,7 +139,6 @@ export default async function add(names: string[], { cwd, flags, logging, teleme
}
let configResult: UpdateResult | undefined;
let installResult: UpdateResult | undefined;
if (ast) {
try {
@ -165,7 +164,7 @@ export default async function add(names: string[], { cwd, flags, logging, teleme
const missingDeps = integrations.filter(
(integration) => !deps.includes(integration.packageName)
);
if (missingDeps.length === 0) {
if (missingDeps.length === 0 && !adapters.length) {
info(logging, null, msg.success(`Configuration up-to-date.`));
return;
}
@ -175,13 +174,19 @@ export default async function add(names: string[], { cwd, flags, logging, teleme
break;
}
}
}
installResult = await tryToInstallIntegrations({ integrations, cwd, flags, logging });
let installResult = await tryToInstallIntegrations({
integrations: integrationsAndAdapters,
cwd,
flags,
logging
});
switch (installResult) {
case UpdateResult.updated: {
const len = integrations.length;
if (integrations.find((integration) => integration.id === 'tailwind')) {
const len = integrationsAndAdapters.length;
if (integrationsAndAdapters.find((entry) => entry.id === 'tailwind')) {
const possibleConfigFiles = [
'./tailwind.config.cjs',
'./tailwind.config.mjs',
@ -214,7 +219,7 @@ export default async function add(names: string[], { cwd, flags, logging, teleme
debug('add', `Using existing Tailwind configuration`);
}
}
const list = integrations.map((integration) => ` - ${integration.packageName}`).join('\n');
const list = integrationsAndAdapters.map((entry) => ` - ${entry.packageName}`).join('\n');
info(
logging,
null,
@ -268,6 +273,29 @@ Documentation: https://docs.astro.build/en/guides/integrations-guide/`;
return err;
}
function isIntegration(integration: IntegrationInfo): integration is IntegrationInfo & { type: 'integration' } {
return integration.type === 'integration';
}
function isAdapter(integration: IntegrationInfo): integration is IntegrationInfo & { type: 'adapter' } {
return integration.type === 'adapter';
}
function logAdapterInstallInstructions(adapters: (IntegrationInfo & { type: 'adapter' })[], logging: LogOptions) {
for (const adapter of adapters) {
info(
logging,
null,
`\n ${cyan(`Check our deployment docs for ${bold(adapter.packageName)} to update your "adapter" config.`)}`
);
}
info(
logging,
null,
`\n ${bold(cyan('https://docs.astro.build/en/guides/deploy/'))}`
);
}
async function addIntegration(ast: t.File, integration: IntegrationInfo) {
const integrationId = t.identifier(toIdent(integration.id));
@ -324,50 +352,6 @@ async function addIntegration(ast: t.File, integration: IntegrationInfo) {
});
}
async function setAdapter(ast: t.File, adapter: IntegrationInfo) {
const adapterId = t.identifier(toIdent(adapter.id));
ensureImport(
ast,
t.importDeclaration(
[t.importDefaultSpecifier(adapterId)],
t.stringLiteral(adapter.packageName)
)
);
visit(ast, {
// eslint-disable-next-line @typescript-eslint/no-shadow
ExportDefaultDeclaration(path) {
if (!t.isCallExpression(path.node.declaration)) return;
const configObject = path.node.declaration.arguments[0];
if (!t.isObjectExpression(configObject)) return;
let adapterProp = configObject.properties.find((prop) => {
if (prop.type !== 'ObjectProperty') return false;
if (prop.key.type === 'Identifier') {
if (prop.key.name === 'adapter') return true;
}
if (prop.key.type === 'StringLiteral') {
if (prop.key.value === 'adapter') return true;
}
return false;
}) as t.ObjectProperty | undefined;
const adapterCall = t.callExpression(adapterId, []);
if (!adapterProp) {
configObject.properties.push(
t.objectProperty(t.identifier('adapter'), adapterCall)
);
return;
}
adapterProp.value = adapterCall;
},
});
}
const enum UpdateResult {
none,
updated,