nuxt-seo-utils 7.0.18 → 8.0.1

package/README.md

@@ -29,6 +29,7 @@ While there are several features covering many aspects of SEO, it covers importa
 - 🧩 Site config template params `useHead({ title: '%site.title' })`
 - 🍞 Breadcrumb composable
 - 🧙 Best practice defaults and enhanced titles
+- ⚡ Inline minification of `<script>` and `<style>` tags (esbuild + lightningcss at build, lightweight runtime fallback)
 
 ## Installation
 
@@ -38,11 +39,17 @@ Install `nuxt-seo-utils` dependency to your project:
 npx nuxi@latest module add nuxt-seo-utils
 ```
 
+> [!TIP]
+> Generate an Agent Skill for this package using [skilld](https://github.com/harlan-zw/skilld):
+> ```bash
+> npx skilld add nuxt-seo-utils
+> ```
+
 💡 Need a complete SEO solution for Nuxt? Check out [Nuxt SEO](https://nuxtseo.com).
 
 ## Documentation
 
-[📖 Read the full documentation](https://nuxtseo.com/docs/utils) for more information.
+[📖 Read the full documentation](https://nuxtseo.com/docs/seo-utils) for more information.
 
 ## Demos
 
@@ -70,5 +77,5 @@ Licensed under the [MIT license](https://github.com/harlan-zw/nuxt-seo-utils/blo
 [license-src]: https://img.shields.io/github/license/harlan-zw/nuxt-seo-utils.svg?style=flat&colorA=18181B&colorB=28CF8D
 [license-href]: https://github.com/harlan-zw/nuxt-seo-utils/blob/main/LICENSE.md
 
-[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
+[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt
 [nuxt-href]: https://nuxt.com

package/bin/nuxt-seo-utils.mjs

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import '../dist/cli.mjs'

package/dist/cli.d.mts

@@ -0,0 +1,2 @@
+
+export { };

package/dist/cli.d.ts

@@ -0,0 +1,2 @@
+
+export { };

package/dist/cli.mjs

@@ -0,0 +1,118 @@
+import { Buffer } from 'node:buffer';
+import { existsSync } from 'node:fs';
+import { writeFile } from 'node:fs/promises';
+import process from 'node:process';
+import { loadNuxtConfig } from '@nuxt/kit';
+import { defineCommand, runMain } from 'citty';
+import { colors } from 'consola/utils';
+import { resolve } from 'pathe';
+
+const name = "nuxt-seo-utils";
+const version = "8.0.1";
+const description = "SEO utilities to improve your Nuxt sites discoverability and shareability";
+
+const ICON_SIZES = [
+  { name: "icon-16x16.png", width: 16, height: 16 },
+  { name: "icon-32x32.png", width: 32, height: 32 },
+  { name: "apple-touch-icon.png", width: 180, height: 180 },
+  { name: "icon-192x192.png", width: 192, height: 192 },
+  { name: "icon-512x512.png", width: 512, height: 512 }
+];
+const SUPPORTED_FORMATS = /* @__PURE__ */ new Set(["svg", "png", "jpg", "jpeg", "webp"]);
+const cwdArgs = {
+  cwd: {
+    type: "string",
+    description: "Specify the working directory",
+    valueHint: "directory",
+    default: "."
+  }
+};
+function pngToIco(pngBuffers) {
+  const count = pngBuffers.length;
+  const headerSize = 6;
+  const dirEntrySize = 16;
+  const dataOffset = headerSize + dirEntrySize * count;
+  const header = Buffer.alloc(headerSize);
+  header.writeUInt16LE(0, 0);
+  header.writeUInt16LE(1, 2);
+  header.writeUInt16LE(count, 4);
+  const dirEntries = [];
+  let offset = dataOffset;
+  for (const png of pngBuffers) {
+    const entry = Buffer.alloc(dirEntrySize);
+    const size = Math.min(256, 32);
+    entry.writeUInt8(size === 256 ? 0 : size, 0);
+    entry.writeUInt8(size === 256 ? 0 : size, 1);
+    entry.writeUInt8(0, 2);
+    entry.writeUInt8(0, 3);
+    entry.writeUInt16LE(1, 4);
+    entry.writeUInt16LE(32, 6);
+    entry.writeUInt32LE(png.length, 8);
+    entry.writeUInt32LE(offset, 12);
+    dirEntries.push(entry);
+    offset += png.length;
+  }
+  return Buffer.concat([header, ...dirEntries, ...pngBuffers]);
+}
+async function loadSharp() {
+  const mod = await import('sharp').catch(() => {
+    console.error(colors.red("sharp is required for icon generation. Install it with:"));
+    console.error(colors.cyan("  pnpm add -D sharp"));
+    process.exit(1);
+  });
+  return mod.default;
+}
+const main = defineCommand({
+  meta: { name, version, description },
+  args: {
+    command: {
+      type: "positional",
+      required: false
+    },
+    ...cwdArgs
+  },
+  subCommands: {
+    icons: defineCommand({
+      meta: {
+        name: "icons",
+        description: "Generate favicon and icon variants from a source image"
+      },
+      args: {
+        ...cwdArgs,
+        source: {
+          type: "string",
+          description: "Source image file relative to the public directory (e.g. logo.svg)",
+          required: true
+        }
+      },
+      async run(ctx) {
+        const cwd = resolve(String(ctx.args.cwd));
+        const nuxtConfig = await loadNuxtConfig({ cwd });
+        const publicDir = resolve(cwd, nuxtConfig.dir?.public ?? "public");
+        const source = String(ctx.args.source);
+        const sourcePath = resolve(publicDir, source);
+        if (!existsSync(sourcePath)) {
+          console.error(colors.red(`Source file not found: ${sourcePath}`));
+          process.exit(1);
+        }
+        const ext = source.split(".").pop()?.toLowerCase();
+        if (!ext || !SUPPORTED_FORMATS.has(ext)) {
+          console.error(colors.red(`Unsupported format "${ext}". Use: ${[...SUPPORTED_FORMATS].join(", ")}`));
+          process.exit(1);
+        }
+        const sharp = await loadSharp();
+        console.log(colors.cyan(`Generating icons from ${colors.bold(String(source))}...`));
+        for (const icon of ICON_SIZES) {
+          const outputPath = resolve(publicDir, icon.name);
+          await sharp(sourcePath).resize(icon.width, icon.height, { fit: "contain", background: { r: 0, g: 0, b: 0, alpha: 0 } }).png().toFile(outputPath);
+          console.log(colors.green(`  ${icon.name} (${icon.width}x${icon.height})`));
+        }
+        const faviconPng = await sharp(sourcePath).resize(32, 32, { fit: "contain", background: { r: 0, g: 0, b: 0, alpha: 0 } }).png().toBuffer();
+        await writeFile(resolve(publicDir, "favicon.ico"), pngToIco([faviconPng]));
+        console.log(colors.green("  favicon.ico (32x32)"));
+        console.log(colors.bold(colors.green("\nDone! Generated all icon variants.")));
+      }
+    })
+  }
+});
+runMain(main);

package/dist/module.d.mts

@@ -98,10 +98,35 @@ interface ModuleOptions {
      * @default false
      */
     redirectToCanonicalSiteUrl?: boolean;
+    /**
+     * Sets the `tagPriority` for SEO and Open Graph meta tags generated by this module.
+     * Lower numbers appear earlier in the `<head>`. Style blocks default to 40-60,
+     * so a value below 40 ensures SEO tags appear before them, which is important
+     * for OG crawlers that only parse the first 1MB of a page.
+     *
+     * @default 30
+     */
+    tagPriority: number;
     /**
      * The SEO meta object to be used as defaults.
      */
     meta: MetaFlatSerializable;
+    /**
+     * Minify inline `<script>` and `<style>` tags in SSR responses. Both toggles are independent.
+     *
+     * - `true`: Enables both build and runtime minification.
+     * - `false`: Disabled.
+     * - `{ build?: boolean, runtime?: boolean }`: Toggle each mode independently.
+     *
+     * **Build mode**: Minifies static `app.head` scripts/styles and prerendered route HTML using esbuild (JS) and lightningcss (CSS).
+     * **Runtime mode**: Minifies all inline scripts/styles per SSR request via an Unhead `ssr:render` plugin using lightweight pure JS minifiers.
+     *
+     * @default true
+     */
+    minify: boolean | {
+        build?: boolean;
+        runtime?: boolean;
+    };
     /**
      * Enables debug logs and a debug endpoint.
      *

package/dist/module.d.ts

@@ -0,0 +1,140 @@
+import * as _nuxt_schema from '@nuxt/schema';
+import { MetaFlatSerializable } from '../dist/runtime/types.js';
+
+interface ModuleOptions {
+    /**
+     * Whether the SEO experiements should run.
+     *
+     * @default true
+     */
+    enabled: boolean;
+    /**
+     * Should the files in the public directory be used to infer tags such as favicon, apple-touch-icon, and
+     * open graph images.
+     *
+     * @default true
+     */
+    metaDataFiles: boolean;
+    /**
+     * Should head data be inferred from the current input to fill in the gaps.
+     *
+     * For example:
+     * - If you supply a title, this will automatically add an og:title.
+     * - If you provide an og:image, it will automatically add a twitter:image.
+     *
+     * @default true
+     */
+    automaticOgAndTwitterTags: boolean;
+    /**
+     * Attempts to treeshake the `useSeoMeta` function. Can save around 5kb in the client bundle.
+     *
+     * @default true
+     */
+    treeShakeUseSeoMeta: boolean;
+    /**
+     * Injects site config into the `useHead` composable such as setting the title template
+     *
+     * @default true
+     */
+    mergeWithSiteConfig: boolean;
+    /**
+     * Adds `head` and `seoMeta` to the route rules and app config.
+     *
+     * @default true
+     */
+    extendRouteRules: boolean;
+    /**
+     * Tries to convert relative image paths to absolute paths in meta tags.
+     *
+     * @default true
+     */
+    fixRequiredAbsoluteMetaTagsLinks: boolean;
+    /**
+     * Extends the `head` in the Nuxt config with the `seoMeta` object.
+     *
+     * @default true
+     */
+    extendNuxtConfigAppHeadSeoMeta: boolean;
+    /**
+     * Augments the head schema with `/public` files making it easier to reference them in the head.
+     *
+     * @default true
+     */
+    extendNuxtConfigAppHeadTypes: boolean;
+    /**
+     * @dead
+     */
+    setupNuxtConfigAppHeadWithMoreDefaults: boolean;
+    /**
+     * Will ensure a title is always set by providing a fallback title based on the casing the last slug segment.
+     *
+     * @default true
+     */
+    fallbackTitle?: boolean;
+    /**
+     * Will set up a number of defaults for meta tags and Schema.org, if the modules and config are available.
+     *
+     * @default true
+     */
+    automaticDefaults?: boolean;
+    /**
+     * When enabled, it will whitelist the query parameters that are allowed in the canonical URL.
+     */
+    canonicalQueryWhitelist?: string[];
+    /**
+     * When enabled, it will lowercase the canonical URL.
+     *
+     * @default true
+     */
+    canonicalLowercase?: boolean;
+    /**
+     * When enabled, it will redirect any request to the canonical domain (site url) using a 301 redirect on non-dev environments.
+     *
+     * E.g if the site url is 'www.example.com' and the user visits 'example.com',
+     * they will be redirected to 'www.example.com'.
+     *
+     * This is useful for SEO as it prevents duplicate content and consolidates page rank.
+     *
+     * @default false
+     */
+    redirectToCanonicalSiteUrl?: boolean;
+    /**
+     * Sets the `tagPriority` for SEO and Open Graph meta tags generated by this module.
+     * Lower numbers appear earlier in the `<head>`. Style blocks default to 40-60,
+     * so a value below 40 ensures SEO tags appear before them, which is important
+     * for OG crawlers that only parse the first 1MB of a page.
+     *
+     * @default 30
+     */
+    tagPriority: number;
+    /**
+     * The SEO meta object to be used as defaults.
+     */
+    meta: MetaFlatSerializable;
+    /**
+     * Minify inline `<script>` and `<style>` tags in SSR responses. Both toggles are independent.
+     *
+     * - `true`: Enables both build and runtime minification.
+     * - `false`: Disabled.
+     * - `{ build?: boolean, runtime?: boolean }`: Toggle each mode independently.
+     *
+     * **Build mode**: Minifies static `app.head` scripts/styles and prerendered route HTML using esbuild (JS) and lightningcss (CSS).
+     * **Runtime mode**: Minifies all inline scripts/styles per SSR request via an Unhead `ssr:render` plugin using lightweight pure JS minifiers.
+     *
+     * @default true
+     */
+    minify: boolean | {
+        build?: boolean;
+        runtime?: boolean;
+    };
+    /**
+     * Enables debug logs and a debug endpoint.
+     *
+     * @default false
+     */
+    debug: boolean;
+}
+declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
+
+export { _default as default };
+export type { ModuleOptions };

package/dist/module.json

@@ -4,7 +4,7 @@
   "compatibility": {
     "nuxt": ">=3.16.0"
   },
-  "version": "7.0.18",
+  "version": "8.0.1",
   "builder": {
     "@nuxt/module-builder": "1.0.2",
     "unbuild": "3.6.1"