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

Adds a new "astro:build:generated" hook for SSG builds (#4772)

Browse source 
* adds a new "astro:build:generated" hook for SSG builds

* chore: add changeset
This commit is contained in:
Tony Sullivan 2022-09-15 21:02:07 +00:00 committed by GitHub
parent b2da8a124a
commit 03b18e8d1b
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
5 changed files with 38 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
.changeset/four-eggs-compare.md Normal file
View file

@ -0,0 +1,5 @@
---
'astro': minor
---
Adds a new "astro:build:generated" hook that runs after SSG builds finish but **before** build artifacts are cleaned up. This is a very specific use case, "astro:build:done" is probably what you're looking for.

1
packages/astro/src/@types/astro.ts
View file

@ -1159,6 +1159,7 @@ export interface AstroIntegration {
target: 'client' | 'server';
updateConfig: (newConfig: ViteConfigWithSSR) => void;
}) => void | Promise<void>;
'astro:build:generated'?: (options: { dir: URL }) => void | Promise<void>;
'astro:build:done'?: (options: {
pages: { pathname: string }[];
dir: URL;

4
packages/astro/src/core/build/generate.ts
View file

@ -19,6 +19,7 @@ import {
removeTrailingForwardSlash,
} from '../../core/path.js';
import type { RenderOptions } from '../../core/render/core';
import { runHookBuildGenerated } from '../../integrations/index.js';
import { BEFORE_HYDRATION_SCRIPT_ID, PAGE_SCRIPT_ID } from '../../vite-plugin-scripts/index.js';
import { call as callEndpoint } from '../endpoint/index.js';
import { debug, info } from '../logger/core.js';
@ -111,6 +112,9 @@ export async function generatePages(opts: StaticBuildOptions, internals: BuildIn
for (const pageData of eachPageData(internals)) {
await generatePage(opts, internals, pageData, ssrEntry, builtPaths);
}
await runHookBuildGenerated({ config: opts.astroConfig, buildConfig: opts.buildConfig, logging: opts.logging });
info(opts.logging, null, dim(`Completed in ${getTimeStat(timer, performance.now())}.\n`));
}

22
packages/astro/src/integrations/index.ts
View file

@ -263,6 +263,28 @@ export async function runHookBuildSsr({
}
}
export async function runHookBuildGenerated({
config,
buildConfig,
logging,
}: {
config: AstroConfig;
buildConfig: BuildConfig;
logging: LogOptions;
}) {
const dir = config.output === 'server' ? buildConfig.client : config.outDir;
for (const integration of config.integrations) {
if (integration?.hooks?.['astro:build:generated']) {
await withTakingALongTimeMsg({
name: integration.name,
hookResult: integration.hooks['astro:build:generated']({ dir }),
logging,
});
}
}
}
export async function runHookBuildDone({
config,
buildConfig,

6
packages/astro/test/static-build-dir.test.js
View file

@ -4,6 +4,8 @@ import { loadFixture } from './test-utils.js';
describe('Static build: dir takes the URL path to the output directory', () => {
/** @type {URL} */
let checkDir;
/** @type {URL} */
let checkGeneratedDir;
before(async () => {
const fixture = await loadFixture({
root: './fixtures/static-build-dir/',
@ -11,6 +13,9 @@ describe('Static build: dir takes the URL path to the output directory', () => {
{
name: '@astrojs/dir',
hooks: {
'astro:build:generated': ({ dir }) => {
checkGeneratedDir = dir;
},
'astro:build:done': ({ dir }) => {
checkDir = dir;
},
@ -25,5 +30,6 @@ describe('Static build: dir takes the URL path to the output directory', () => {
expect(removeTrailingSlash(checkDir.toString())).to.be.equal(
removeTrailingSlash(new URL('./fixtures/static-build-dir/dist', import.meta.url).toString())
);
expect(checkDir.toString()).to.be.equal(checkGeneratedDir.toString());
});
});