nuxt-content-assets 0.6.0 → 0.6.1

package/README.md

@@ -47,7 +47,13 @@ That's it!
 
 ## Demo
 
-To run the demo online, go to:
+To view the demo locally, run:
+
+```
+npm run dev
+```
+
+To view the demo online, visit:
 
 - https://stackblitz.com/github/davestewart/nuxt-content-assets?file=demo%2Fapp.vue
 
@@ -55,12 +61,6 @@ You can browse the demo files in:
 
 - https://github.com/davestewart/nuxt-content-assets/tree/main/demo
 
-To run the demo locally, clone the application and from the root, run:
-
-```
-npm run demo
-```
-
 ## Setup
 
 Install the dependency:
@@ -132,7 +132,7 @@ Then pass these to components like so:
 ::
 ```
 
-> Note: to pass size hints in frontmatter, set the `imageSize` configuration option to `'url'`
+> Note: to pass size hints in frontmatter, set the `imageSize` configuration [option](#image-size) to `'url'`
 
 See the [Demo](demo/content/recipes/index.md) for an example.
 
@@ -156,7 +156,7 @@ The module can prevent content jumps by optionally writing image size informatio
 <img src="/image.jpg?width=640&height=480" width="640" height="480" style="aspect-ratio:640/480">
 ```
 
-If you use custom [ProseImg](https://content.nuxtjs.org/api/components/prose) components, you can pass these values to your own markup:
+If you use [ProseImg](https://content.nuxtjs.org/api/components/prose) components, you can pass these values to your own markup:
 
 ```vue
 <template>
@@ -172,7 +172,7 @@ export default {
 </script>
 ```
 
-See the [configuration](#image-size) section to add this, and the [Demo](demo/components/_content/ProseImg.vue) for an example.
+See the [configuration](#image-size) section to add this, and the [Demo](demo/components/temp/ProseImg.vue) for an example.
 
 ### Build
 
@@ -219,10 +219,10 @@ The output path can be customised using a template string:
 assets/content/[name]-[hash].[ext]
 ```
 
-The first part of the path should be public root-relative folder:
+The first part of the path is where you want content assets to be served from:
 
 ```
-assets/img/content
+assets/content/
 ```
 
 The optional second part of the path indicates the relative location of each image: 
@@ -323,30 +323,51 @@ If you want to see what the module does as it runs, set `debug` to true:
 
 Should you wish to develop the project, the scripts are:
 
+Develop the module itself:
+
 ```bash
 # install dependencies
 npm install
 
-# generate type stubs
-npm run dev:prepare
-
-# develop with the demo
+# develop (runs using the demo)
 npm run dev
 
-# build the demo
-npm run dev:build
-
 # run eslint
 npm run lint
 
 # run vitest
 npm run test
 npm run test:watch
+```
+
+Build and check the demo:
+
+```bash
+# generate demo type stubs
+npm run demo:prepare
 
+# generate the demo output
+npm run demo:generate
+
+# serve the demo output
+npm run demo:serve
+
+# build the demo
+npm run demo:build
+```
+
+Make a new release:
+
+```bash
 # release new version
 npm run release
+
+# dry run the release
+npm run release:dry
 ```
 
+Make sure to edit changelog and update `package.json` version first!
+
 <!-- Badges -->
 [npm-version-src]: https://img.shields.io/npm/v/nuxt-content-assets/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
 [npm-version-href]: https://npmjs.com/package/nuxt-content-assets

package/dist/module.json

@@ -4,5 +4,5 @@
   "compatibility": {
     "nuxt": "^3.0.0"
   },
-  "version": "0.6.0"
+  "version": "0.6.1"
 }

package/dist/module.mjs

@@ -87,7 +87,7 @@ const module = defineNuxtModule({
     debug: false
   },
   setup(options, nuxt) {
-    var _a;
+    var _a, _b;
     const pluginPath = resolve("./runtime/plugin");
     const buildPath = nuxt.options.buildDir;
     const cachePath = Path.resolve(buildPath, "content-assets");
@@ -146,8 +146,9 @@ const module = defineNuxtModule({
     const publicFolder = Path.join(cachePath, assetsDir);
     const sourceFolders = Object.values(sources);
     const assets = {};
+    (_a = nuxt.options).content || (_a.content = {});
     if (nuxt.options.content) {
-      (_a = nuxt.options.content).ignores || (_a.ignores = []);
+      (_b = nuxt.options.content).ignores || (_b.ignores = []);
     }
     sourceFolders.forEach((folder) => {
       const pattern = `${folder}/**/*.{${extensions.join(",")}}`;

package/dist/runtime/config.d.ts

@@ -0,0 +1,2 @@
+export declare const moduleName = "nuxt-content-assets";
+export declare const moduleKey = "content-assets";

package/dist/runtime/config.mjs

@@ -0,0 +1,2 @@
+export const moduleName = "nuxt-content-assets";
+export const moduleKey = "content-assets";

package/dist/runtime/plugin.d.ts

@@ -1,2 +1,3 @@
-declare const _default: any;
-export default _default;
+import type { NitroAppPlugin } from 'nitropack';
+declare const plugin: NitroAppPlugin;
+export default plugin;

package/dist/runtime/plugin.mjs

@@ -14,8 +14,8 @@ function getAsset(absDoc, relAsset) {
   const absAsset = Path.join(Path.dirname(absDoc), relAsset);
   return assets[absAsset] || {};
 }
-export default defineNitroPlugin(async (nitroApp) => {
-  nitroApp.hooks.hook("content:file:afterParse", async (file) => {
+const plugin = async (nitro) => {
+  nitro.hooks.hook("content:file:afterParse", async (file) => {
     if (file._id.endsWith(".md")) {
       const absDoc = getDocPath(file._id);
       const filter = (value, key) => !(String(key).startsWith("_") || key === "body");
@@ -52,4 +52,5 @@ export default defineNitroPlugin(async (nitroApp) => {
       });
     }
   });
-});
+};
+export default plugin;

package/dist/runtime/utils/debug.mjs

@@ -1,6 +1,6 @@
 import Path from "path";
 import Fs from "fs";
-import { moduleKey } from "../../config";
+import { moduleKey } from "../config.mjs";
 export function log(...data) {
   console.info(`[${moduleKey}]`, ...data);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nuxt-content-assets",
-  "version": "0.6.0",
+  "version": "0.6.1",
   "description": "Enable locally-located assets in Nuxt Content",
   "repository": "davestewart/nuxt-content-assets",
   "license": "MIT",
@@ -19,15 +19,16 @@
   ],
   "scripts": {
     "dev": "nuxi dev demo",
-    "dev:build": "nuxi build demo",
-    "dev:prepare": "nuxt-module-build --stub && nuxi prepare demo",
     "build": "nuxt-module-build",
-    "release": "npm run lint && npm run test && npm run build && npm publish && git push --follow-tags",
-    "release:dry": "npm run lint && npm run test && npm run build && npm publish --dry-run",
-    "release:old": "npm run lint && npm run test && npm run build && changelogen --release && npm publish && git push --follow-tags",
     "lint": "eslint .",
     "test": "vitest run",
-    "test:watch": "vitest watch"
+    "test:watch": "vitest watch",
+    "demo:prepare": "nuxt-module-build --stub && nuxi prepare demo",
+    "demo:generate": "nuxt generate demo",
+    "demo:serve": "npx serve demo/dist",
+    "demo:build": "nuxi build demo",
+    "release": "npm run lint && npm run test && npm run build && npm publish && git push --follow-tags",
+    "release:dry": "npm run lint && npm run test && npm run build && npm publish --dry-run"
   },
   "dependencies": {
     "@nuxt/kit": "^3.3.2",