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.

Sign up for GitHub

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

Jump to bottom

feat: restart server on markdoc config change #7467

Merged
merged 6 commits into from
Jun 27, 2023
Merged

feat: restart server on markdoc config change #7467

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
94503a7
deps: vite-plugin-restart
bholmesdev Jun 23, 2023
ebf889c
feat: restart on markdoc config change
bholmesdev Jun 23, 2023
d75d44d
chore: changeset
bholmesdev Jun 23, 2023
1397bd4
chore: roll our own restarter!
bholmesdev Jun 26, 2023
23d1ebf
deps: remove vite-plugin-restart
bholmesdev Jun 26, 2023
ce2f157
refactor: use good enough option
bholmesdev Jun 27, 2023
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/wet-apples-smoke.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@astrojs/markdoc': patch
---

Restart the dev server whenever your markdoc config changes.
35 changes: 17 additions & 18 deletions packages/integrations/markdoc/src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import Markdoc from '@markdoc/markdoc';
import type { AstroConfig, AstroIntegration, ContentEntryType, HookParameters } from 'astro';
import crypto from 'node:crypto';
import fs from 'node:fs';
import { fileURLToPath, pathToFileURL } from 'node:url';
import { fileURLToPath } from 'node:url';
import {
hasContentFlag,
isValidUrl,
Expand All @@ -15,11 +15,15 @@ import {
} from './utils.js';
// @ts-expect-error Cannot find module 'astro/assets' or its corresponding type declarations.
import { emitESMImage } from 'astro/assets';
import { bold, red, yellow } from 'kleur/colors';
import { bold, red } from 'kleur/colors';
import path from 'node:path';
import type * as rollup from 'rollup';
import { normalizePath } from 'vite';
import { loadMarkdocConfig, type MarkdocConfigResult } from './load-config.js';
import {
loadMarkdocConfig,
SUPPORTED_MARKDOC_CONFIG_FILES,
type MarkdocConfigResult,
} from './load-config.js';
import { setupConfig } from './runtime.js';

type SetupHookParams = HookParameters<'astro:config:setup'> & {
Expand All @@ -45,15 +49,13 @@ export default function markdocIntegration(legacyConfig?: any): AstroIntegration
}
let markdocConfigResult: MarkdocConfigResult | undefined;
let markdocConfigResultId = '';
let astroConfig: AstroConfig;
return {
name: '@astrojs/markdoc',
hooks: {
'astro:config:setup': async (params) => {
const {
config: astroConfig,
updateConfig,
addContentEntryType,
} = params as SetupHookParams;
const { updateConfig, addContentEntryType } = params as SetupHookParams;
astroConfig = params.config;

markdocConfigResult = await loadMarkdocConfig(astroConfig);
if (markdocConfigResult) {
Expand Down Expand Up @@ -204,10 +206,8 @@ export const Content = createComponent({

updateConfig({
vite: {
vite: {
ssr: {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How long has that been there... :houston_panic:

external: ['@astrojs/markdoc/prism', '@astrojs/markdoc/shiki'],
},
ssr: {
external: ['@astrojs/markdoc/prism', '@astrojs/markdoc/shiki'],
},
build: {
rollupOptions,
Expand All @@ -233,12 +233,11 @@ export const Content = createComponent({
},
'astro:server:setup': async ({ server }) => {
server.watcher.on('all', (event, entry) => {
if (prependForwardSlash(pathToFileURL(entry).pathname) === markdocConfigResultId) {
console.log(
yellow(
`${bold('[Markdoc]')} Restart the dev server for config changes to take effect.`
)
);
for (const markdocConfigBase of SUPPORTED_MARKDOC_CONFIG_FILES) {
const absolutePath = new URL(markdocConfigBase, astroConfig.root);
if (entry === fileURLToPath(absolutePath)) {
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume this will be the file path and not a Vite ID. Let me know if that's wrong!

bluwy marked this conversation as resolved.
Show resolved Hide resolved
server.restart();
}
}
});
},
Expand Down
2 changes: 1 addition & 1 deletion packages/integrations/markdoc/src/load-config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import * as fs from 'node:fs';
import { fileURLToPath } from 'node:url';
import type { AstroMarkdocConfig } from './config.js';

const SUPPORTED_MARKDOC_CONFIG_FILES = [
export const SUPPORTED_MARKDOC_CONFIG_FILES = [
'markdoc.config.js',
'markdoc.config.mjs',
'markdoc.config.mts',
Expand Down