nuxt-seo-utils 5.0.0

package/README.md

@@ -0,0 +1,61 @@
+<h1 align='center'>nuxt-seo-utils</h1>
+
+<p align="center">
+<a href='https://github.com/harlan-zw/nuxt-seo-utils/actions/workflows/test.yml'>
+</a>
+<a href="https://www.npmjs.com/package/nuxt-seo-utils" target="__blank"><img src="https://img.shields.io/npm/v/nuxt-seo-utils?style=flat&colorA=002438&colorB=28CF8D" alt="NPM version"></a>
+<a href="https://www.npmjs.com/package/nuxt-seo-utils" target="__blank"><img alt="NPM Downloads" src="https://img.shields.io/npm/dm/nuxt-seo-utils?flat&colorA=002438&colorB=28CF8D"></a>
+<a href="https://github.com/harlan-zw/nuxt-seo-utils" target="__blank"><img alt="GitHub stars" src="https://img.shields.io/github/stars/harlan-zw/nuxt-seo-utils?flat&colorA=002438&colorB=28CF8D"></a>
+</p>
+
+<p align="center">
+SEO utilities for Nuxt to help you make your site more discoverable and shareable.
+</p>
+
+<p align="center">
+<table>
+<tbody>
+<td align="center">
+<img width="800" height="0" /><br>
+<i>Status:</i> <a href="https://github.com/harlan-zw/nuxt-seo-utils/releases/tag/v3.0.0">v3 Released</a> <br>
+<sup> Please report any issues 🐛</sup><br>
+<sub>Made possible by my <a href="https://github.com/sponsors/harlan-zw">Sponsor Program 💖</a><br> Follow me <a href="https://twitter.com/harlan_zw">@harlan_zw</a> 🐦 • Join <a href="https://discord.gg/275MBUBvgP">Discord</a> for help</sub><br>
+<img width="800" height="0" />
+</td>
+</tbody>
+</table>
+</p>
+
+## Features
+
+- ▲ Next.js inspired [Metadata Files](https://nextjs.org/docs/app/api-reference/file-conventions/metadata)
+- ✨ Use SEO meta in your nuxt.config (`app.seoMeta`) and route rules
+- 🤖 Adds meta tags (`og:title`, `og:description`, etc.) from page title and description
+- 🧙 Correct tags that need to be absolute (i.e `og:image`)
+- 🧩 Site config template params `useHead({ title: '%site.title' })`
+- 🍞 Breadcrumb composable
+- 🧙 Best practice defaults and enhanced titles
+
+## Installation
+
+Install `nuxt-seo-utils` dependency to your project:
+
+```bash
+npx nuxi@latest module add nuxt-seo-utils
+```
+
+# Documentation
+
+[📖 Read the full documentation](https://nuxtseo.com/docs/utils) for more information.
+
+## Sponsors
+
+<p align="center">
+  <a href="https://raw.githubusercontent.com/harlan-zw/static/main/sponsors.svg">
+    <img src='https://raw.githubusercontent.com/harlan-zw/static/main/sponsors.svg'/>
+  </a>
+</p>
+
+## License
+
+MIT License © 2022-PRESENT [Harlan Wilton](https://github.com/harlan-zw)

package/dist/module.cjs

@@ -0,0 +1,5 @@
+module.exports = function(...args) {
+  return import('./module.mjs').then(m => m.default.call(this, ...args))
+}
+const _meta = module.exports.meta = require('./module.json')
+module.exports.getMeta = () => Promise.resolve(_meta)

package/dist/module.d.mts

@@ -0,0 +1,103 @@
+import * as _nuxt_schema from '@nuxt/schema';
+
+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 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;
+    /**
+     * Enables debug logs and a debug endpoint.
+     *
+     * @default false
+     */
+    debug: boolean;
+}
+declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
+
+export { type ModuleOptions, _default as default };

package/dist/module.d.ts

@@ -0,0 +1,103 @@
+import * as _nuxt_schema from '@nuxt/schema';
+
+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 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;
+    /**
+     * Enables debug logs and a debug endpoint.
+     *
+     * @default false
+     */
+    debug: boolean;
+}
+declare const _default: _nuxt_schema.NuxtModule<ModuleOptions, ModuleOptions, false>;
+
+export { type ModuleOptions, _default as default };

package/dist/module.json

@@ -0,0 +1,13 @@
+{
+  "name": "nuxt-seo-utils",
+  "configKey": "seo",
+  "compatibility": {
+    "nuxt": ">=3.6.1",
+    "bridge": false
+  },
+  "version": "4.0.1",
+  "builder": {
+    "@nuxt/module-builder": "0.8.4",
+    "unbuild": "2.0.0"
+  }
+}