npm - @zubyjs/sitemap - Versions diffs - 1.0.42 - Mend

@zubyjs/sitemap 1.0.42

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (4) hide show

package/README.md ADDED Viewed

@@ -0,0 +1,76 @@
+# @zubyjs/sitemap
+The plugin for Zuby.js that automatically generates a sitemap.xml file for your website
+from your pages.
+## Installation
+First, install the `@zubyjs/sitemap` package using your favorite package manager.
+If you aren't sure, you can use npm:
+```sh
+npm install @zubyjs/sitemap
+```
+Then add the `@zubyjs/sitemap` plugin to your `zuby.config.mjs` file under the `plugins` option:
+```diff lang="js" title="zuby.config.mjs"
+  import { defineConfig } from 'zuby';
+  import preact from '@zubyjs/preact';
++ import sitemap from '@zubyjs/sitemap';
+  export default defineConfig({
+    outDir: '.zuby',
+    jsx: preact(),
+  + plugins: [
+  +     sitemap()
+  + ]
+    ^^^^^^^^
+  });
+```
+Then add meta tag to your `pages/layout.jsx` file
+to link the generated `sitemap.xml` file on your website:
+```diff lang="jsx" title="pages/layout.jsx"
+export default function Layout({
+  children,
+  context,
+}) {
+  return (
+    <html>
+      <head>
+        <meta charSet="UTF-8" />
++       <link rel="sitemap" type="application/xml" href="/sitemap.xml" />
+        <title>{context.title}</title>
+      </head>
+      <body>{children}</body>
+    </html>
+  );
+}
+```
+And that's it! Now you can run `zuby build` and the sitemap.xml file will be generated.
+NOTE: Always make sure that all zuby packages are in sync in your `package.json` file:
+```diff lang="json"
+  {
+    "name": "my-zuby-app",
+    "version": "1.0.0",
+    "dependencies": {
+      "zuby": "latest",
+      "@zubyjs/sitemap": "latest"
+    }
+  }
+```
+## Contributing
+This package is part of Zuby.js workspace and maintained by the team behind the [Zuby package](https://www.npmjs.com/package/zuby).
+Please refer to it for more details how to contribute.
+## License
+MIT

package/index.d.ts ADDED Viewed

@@ -0,0 +1,36 @@
+import { ZubyPlugin } from 'zuby/types.js';
+export interface SitemapPluginOptions {
+    /**
+     * The filter function that filters the paths that should be included in the sitemap.
+     * @example filter: (path) => path !== '/secret'
+     * @default () => true
+     */
+    filter?: (path: string) => boolean;
+    /**
+     * Additional custom paths that should be included in the sitemap.
+     * @example customPages: ['/custom-page', '/custom-page-2']
+     * @default []
+     */
+    customPages?: string[];
+    /**
+     * The maximum number of entries per sitemap file.
+     * @example entryLimit: 10000
+     * @default 45000
+     */
+    entryLimit?: number;
+    /**
+     * The name of the sitemap file without extension.
+     * @example filename: 'my-sitemap'
+     * @default 'sitemap'
+     */
+    filename?: string;
+}
+/**
+ * Zuby.js plugin that generates sitemap.xml
+ * from pre-rendered paths.
+ * @param options
+ * @returns ZubyPlugin
+ */
+declare const _default: ({ filter, customPages, entryLimit, filename, }?: SitemapPluginOptions) => ZubyPlugin;
+export default _default;
+export declare function splitToParts(array: string[], parts: number): string[][];

package/index.js ADDED Viewed

@@ -0,0 +1,66 @@
+import { resolve } from 'path';
+import { writeFile } from 'fs/promises';
+/**
+ * Zuby.js plugin that generates sitemap.xml
+ * from pre-rendered paths.
+ * @param options
+ * @returns ZubyPlugin
+ */
+export default ({ filter = () => true, customPages = [], entryLimit = 45000, filename = 'sitemap', } = {}) => ({
+    name: 'zuby-sitemap-plugin',
+    description: 'generating sitemap.xml...',
+    buildStep: true,
+    hooks: {
+        'zuby:build:done': async ({ config, logger }) => {
+            const { site, outDir, i18n, prerenderPaths } = config;
+            if (!site) {
+                logger?.warn(`WARNING: The "site" property is not defined in zuby.config.mjs. Skipping sitemap generation.`);
+                return;
+            }
+            logger.info('Generating sitemap from pre-rendered paths...');
+            const removeLocale = (path) => {
+                for (const locale of i18n?.locales || []) {
+                    if (path.startsWith(`/${locale}/`))
+                        return path.replace(`/${locale}/`, '/');
+                    if (path === `/${locale}`)
+                        return '/';
+                }
+                return path;
+            };
+            const normalizePath = (path) => {
+                return path.replace(/(.+)\/$/, '').replace(/\/\/+/g, '/');
+            };
+            const paths = [...customPages, ...prerenderPaths.filter(filter)].map(normalizePath);
+            const entries = paths.map(path => {
+                const localizedPaths = i18n
+                    ? paths.filter(filteredPath => {
+                        return removeLocale(path) === removeLocale(filteredPath);
+                    })
+                    : [];
+                const alternateLinks = localizedPaths.map(path => {
+                    const locale = i18n.locales.find(locale => path.startsWith(`/${locale}`)) || i18n.defaultLocale;
+                    return `<xhtml:link rel="alternate" hreflang="${locale}" href="${new URL(path, config.site).href}" />`;
+                });
+                return `<url><loc>${new URL(path, config.site).href}</loc>${alternateLinks.join('')}</url>`;
+            });
+            const parts = Math.ceil(entries.length / entryLimit);
+            const entriesParts = splitToParts(entries, parts);
+            const subSitemapPromises = entriesParts.map((entries, index) => {
+                return writeFile(normalizePath(resolve(outDir, 'client', `${filename}-${index}.xml`)), `<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">${entries.join('\r\n')}</urlset>`);
+            });
+            await Promise.all(subSitemapPromises);
+            const sitemapIndexEntries = entriesParts.map((_, index) => {
+                return `<sitemap><loc>${new URL(`${filename}-${index}.xml`, site).href}</loc></sitemap>`;
+            });
+            await writeFile(normalizePath(resolve(outDir, 'client', `${filename}.xml`)), `<sitemapindex xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">${sitemapIndexEntries.join('\r\n')}</sitemapindex>`);
+            logger.info(`Generated ${filename}.xml`);
+        },
+    },
+});
+export function splitToParts(array, parts) {
+    const result = [];
+    for (let i = parts; i > 0; i--) {
+        result.push(array.splice(0, Math.ceil(array.length / i)));
+    }
+    return result;
+}

package/package.json ADDED Viewed

@@ -0,0 +1,40 @@
+{
+  "name": "@zubyjs/sitemap",
+  "version": "1.0.42",
+  "description": "Zuby.js sitemap plugin",
+  "type": "module",
+  "main": "index.js",
+  "scripts": {
+    "release": "cd ./dist && npm publish --access public && cd ..",
+    "bump-version": "npm version patch",
+    "build": "rm -rf dist/ stage/ && mkdir dist && tsc && cp -rf package.json README.md stage/sitemap/src/* dist/ && rm -rf stage/",
+    "push-build": "npm run build && cd dist && yalc push --force && cd ..",
+    "test": "exit 0"
+  },
+  "publishConfig": {
+    "directory": "dist",
+    "linkDirectory": true
+  },
+  "peerDependencies": {
+    "zuby": "^1.0.0"
+  },
+  "bugs": {
+    "url": "https://gitlab.com/futrou/zuby.js/-/issues",
+    "email": "zuby@futrou.com"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://gitlab.com/futrou/zuby.js.git"
+  },
+  "homepage": "https://zuby.futrou.com",
+  "keywords": [
+    "zuby-plugin",
+    "zuby",
+    "sitemap",
+    "seo"
+  ],
+  "engines": {
+    "node": ">=16"
+  }
+}