@astrojs/markdoc 0.0.1 → 0.0.3

package/.turbo/turbo-build.log

@@ -1,5 +1,5 @@
-@astrojs/markdoc:build: cache hit, replaying output a0f6fc6f4f62084c
-@astrojs/markdoc:build: 
-@astrojs/markdoc:build: > @astrojs/markdoc@0.0.1 build /home/runner/work/astro/astro/packages/integrations/markdoc
-@astrojs/markdoc:build: > astro-scripts build "src/**/*.ts" && tsc
-@astrojs/markdoc:build: 
+@astrojs/markdoc:build: cache hit, replaying output 30bf30e6debacf79
+@astrojs/markdoc:build: 
+@astrojs/markdoc:build: > @astrojs/markdoc@0.0.3 build /home/runner/work/astro/astro/packages/integrations/markdoc
+@astrojs/markdoc:build: > astro-scripts build "src/**/*.ts" && tsc
+@astrojs/markdoc:build: 

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @astrojs/markdoc
 
+## 0.0.3
+
+### Patch Changes
+
+- [#6552](https://github.com/withastro/astro/pull/6552) [`392ba3e4d`](https://github.com/withastro/astro/commit/392ba3e4d55f73ce9194bd94a2243f1aa62af079) Thanks [@bluwy](https://github.com/bluwy)! - Fix integration return type
+
+## 0.0.2
+
+### Patch Changes
+
+- [#6494](https://github.com/withastro/astro/pull/6494) [`a13e9d7e3`](https://github.com/withastro/astro/commit/a13e9d7e33baccf51e7d4815f99b481ad174bc57) Thanks [@Yan-Thomas](https://github.com/Yan-Thomas)! - Consistency improvements to several package descriptions
+
 ## 0.0.1
 
 ### Patch Changes

package/README.md

@@ -113,21 +113,21 @@ import markdoc from '@astrojs/markdoc';
 
 // https://astro.build/config
 export default defineConfig({
-	integrations: [
-		markdoc({
-			tags: {
-				aside: {
-					render: 'Aside',
+  integrations: [
+    markdoc({
+      tags: {
+        aside: {
+          render: 'Aside',
           attributes: {
             // Component props as attribute definitions
             // See Markdoc's documentation on defining attributes
             // https://markdoc.dev/docs/attributes#defining-attributes
             type: { type: String },
           }
-				},
-			},
-		}),
-	],
+        },
+      },
+    }),
+  ],
 });
 ```
 
@@ -159,11 +159,11 @@ import markdoc from '@astrojs/markdoc';
 
 // https://astro.build/config
 export default defineConfig({
-	integrations: [
-		markdoc({
-			nodes: {
-				heading: {
-					render: 'Heading',
+  integrations: [
+    markdoc({
+      nodes: {
+        heading: {
+          render: 'Heading',
           // Markdoc requires type defs for each attribute.
           // These should mirror the `Props` type of the component
           // you are rendering. 
@@ -172,10 +172,10 @@ export default defineConfig({
           attributes: {
             level: { type: String },
           }
-				},
-			},
-		}),
-	],
+        },
+      },
+    }),
+  ],
 });
 ```
 
@@ -218,7 +218,7 @@ import Aside from './Aside';
 <Aside client:load />
 ```
 
-This component [can be applied via the `components` prop](#render-html-elements-as-astro-components):
+This component [can be applied via the `components` prop](#render-markdoc-nodes--html-elements-as-astro-components):
 
 ```astro
 ---
@@ -277,7 +277,7 @@ Now, you can call this function from any Markdoc content entry:
 ```
 
 :::note
-These options will be applied during [the Markdoc "transform" phase](https://markdoc.dev/docs/render#transform). This is run **at build time** (rather than server request time) both for static and SSR Astro projects. If you need to define configuration at runtime (ex. SSR variables), [see the next section](#Define-markdoc-configuration-at-runtime).
+These options will be applied during [the Markdoc "transform" phase](https://markdoc.dev/docs/render#transform). This is run **at build time** (rather than server request time) both for static and SSR Astro projects. If you need to define configuration at runtime (ex. SSR variables), [see the next section](#define-markdoc-configuration-at-runtime).
 :::
 
 📚 [See the Markdoc documentation](https://markdoc.dev/docs/functions#creating-a-custom-function) for more on using variables or functions in your content.

package/dist/index.d.ts

@@ -1,12 +1,3 @@
 import type { Config } from '@markdoc/markdoc';
-import type { AstroIntegration, ContentEntryType, HookParameters } from 'astro';
-declare type IntegrationWithPrivateHooks = {
-    name: string;
-    hooks: Omit<AstroIntegration['hooks'], 'astro:config:setup'> & {
-        'astro:config:setup': (params: HookParameters<'astro:config:setup'> & {
-            addContentEntryType: (contentEntryType: ContentEntryType) => void;
-        }) => void | Promise<void>;
-    };
-};
-export default function markdoc(markdocConfig?: Config): IntegrationWithPrivateHooks;
-export {};
+import type { AstroIntegration } from 'astro';
+export default function markdoc(markdocConfig?: Config): AstroIntegration;

package/dist/index.js

@@ -11,7 +11,8 @@ function markdoc(markdocConfig = {}) {
   return {
     name: "@astrojs/markdoc",
     hooks: {
-      "astro:config:setup": async ({ updateConfig, config, addContentEntryType }) => {
+      "astro:config:setup": async (params) => {
+        const { updateConfig, config, addContentEntryType } = params;
         function getEntryInfo({ fileUrl, contents }) {
           const parsed = parseFrontmatter(contents, fileURLToPath(fileUrl));
           return {
@@ -38,6 +39,7 @@ function markdoc(markdocConfig = {}) {
                   return;
                 validateRenderProperties(markdocConfig, config);
                 const body = getEntryInfo({
+                  // Can't use `pathToFileUrl` - Vite IDs are not plain file paths
                   fileUrl: new URL(prependForwardSlash(id), "file://"),
                   contents: code
                 }).body;

package/dist/utils.js

@@ -22,6 +22,8 @@ class MarkdocError extends Error {
     super(...params);
     this.type = "MarkdocError";
     const {
+      // Use default code for unknown errors in Astro core
+      // We don't have a best practice for integration error codes yet
       code = 99999,
       name,
       title = "MarkdocError",

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@astrojs/markdoc",
-  "description": "Use Markdoc within Astro",
-  "version": "0.0.1",
+  "description": "Add support for Markdoc pages in your Astro site",
+  "version": "0.0.3",
   "type": "module",
   "types": "./dist/index.d.ts",
   "author": "withastro",
@@ -33,7 +33,7 @@
     "@types/chai": "^4.3.1",
     "@types/html-escaper": "^3.0.0",
     "@types/mocha": "^9.1.1",
-    "astro": "2.1.0",
+    "astro": "2.1.4",
     "astro-scripts": "0.0.14",
     "chai": "^4.3.6",
     "devalue": "^4.2.0",

package/src/index.ts

@@ -3,7 +3,7 @@ import Markdoc from '@markdoc/markdoc';
 import type { AstroConfig, AstroIntegration, ContentEntryType, HookParameters } from 'astro';
 import fs from 'node:fs';
 import { fileURLToPath } from 'node:url';
-import { InlineConfig } from 'vite';
+import type { InlineConfig } from 'vite';
 import {
 	getAstroConfigPath,
 	MarkdocError,
@@ -11,24 +11,19 @@ import {
 	prependForwardSlash,
 } from './utils.js';
 
-type IntegrationWithPrivateHooks = {
-	name: string;
-	hooks: Omit<AstroIntegration['hooks'], 'astro:config:setup'> & {
-		'astro:config:setup': (
-			params: HookParameters<'astro:config:setup'> & {
-				// `contentEntryType` is not a public API
-				// Add type defs here
-				addContentEntryType: (contentEntryType: ContentEntryType) => void;
-			}
-		) => void | Promise<void>;
-	};
+type SetupHookParams = HookParameters<'astro:config:setup'> & {
+	// `contentEntryType` is not a public API
+	// Add type defs here
+	addContentEntryType: (contentEntryType: ContentEntryType) => void;
 };
 
-export default function markdoc(markdocConfig: Config = {}): IntegrationWithPrivateHooks {
+export default function markdoc(markdocConfig: Config = {}): AstroIntegration {
 	return {
 		name: '@astrojs/markdoc',
 		hooks: {
-			'astro:config:setup': async ({ updateConfig, config, addContentEntryType }) => {
+			'astro:config:setup': async (params) => {
+				const { updateConfig, config, addContentEntryType } = params as SetupHookParams;
+
 				function getEntryInfo({ fileUrl, contents }: { fileUrl: URL; contents: string }) {
 					const parsed = parseFrontmatter(contents, fileURLToPath(fileUrl));
 					return {