Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adds a new "astro:build:generated" hook for SSG builds #4775

Merged
merged 4 commits into from
Sep 21, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/four-eggs-compare.md
Original file line number Diff line number Diff line change
@@ -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 change: 1 addition & 0 deletions packages/astro/src/@types/astro.ts
Original file line number Diff line number Diff line change
Expand Up @@ -1160,6 +1160,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;
Expand Down
7 changes: 7 additions & 0 deletions packages/astro/src/core/build/generate.ts
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,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';
Expand Down Expand Up @@ -113,6 +114,12 @@ export async function generatePages(opts: StaticBuildOptions, internals: BuildIn
await generatePage(opts, internals, pageData, ssrEntry, builtPaths);
}

await runHookBuildGenerated({
config: opts.settings.config,
buildConfig: opts.buildConfig,
logging: opts.logging,
});

info(opts.logging, null, dim(`Completed in ${getTimeStat(timer, performance.now())}.\n`));
}

Expand Down
22 changes: 22 additions & 0 deletions packages/astro/src/integrations/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -267,6 +267,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,
Expand Down
6 changes: 6 additions & 0 deletions packages/astro/test/static-build-dir.test.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,18 @@ 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/',
integrations: [
{
name: '@astrojs/dir',
hooks: {
'astro:build:generated': ({ dir }) => {
checkGeneratedDir = dir;
},
'astro:build:done': ({ dir }) => {
checkDir = dir;
},
Expand All @@ -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());
});
});