npm - routerino - Versions diffs - 1.0.0 - Mend

routerino 1.0.0

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 (6) hide show

package/LICENSE ADDED Viewed

@@ -0,0 +1,21 @@
+MIT License
+Copyright (c) 2023 Nerds With Keyboards
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md ADDED Viewed

@@ -0,0 +1,65 @@
+# Routerino
+Tiny, SEO-focused router for React CSR websites, such as JAMStack or Vite.js sites. Supports [Prerender](https://github.com/prerender/prerender) tags for handling redirects and 404 codes for SEO bots. Routerino can even generate your sitemap.xml file from your routes!
+## Installation
+```sh
+npm i routerino
+```
+## Usage
+Here is a basic usage example:
+```jsx
+import Routerino from "routerino";
+const routes = [
+  {
+    path: "/",
+    element: <p>Hello, world!</p>,
+    title: "Hello!",
+    description: "Lorem ipsum......",
+  },
+];
+const App = () => (
+  <div>
+    <header>
+      <a href="/">Home</a>
+    </header>
+    <Routerino routes={routes} titlePostfix=" | Foo.com" />
+    <footer>
+      <p>Copyright 2048 Foo.com</p>
+    </footer>
+  </div>
+);
+export default App;
+```
+## Generating a sitemap from routes
+Run the command `build-sitemap` to create a sitemap.xml for your site. Adjust the arguments to your needs.
+Arguments:
+- routeFilePath: The path to whichever file contains your routes. The routes array can be defined either directly in the props to Routerino, or stored in an array called routes/Routes.
+- hostname: The domain to use as the base for the URLs in the sitemap.
+- outputPath: The path to write the new sitemap XML file.
+Example:
+```sh
+build-sitemap routeFilePath=src/routes.jsx hostname=https://example.com outputPath=dist/sitemap.xml
+# sitemap.xml with 12 URLs written to dist/sitemap.xml
+```
+Add `build-sitemap` to your build command to update automatically on every build. This sitemap only includes the location entry, as the rest are [mostly ignored by Google](https://developers.google.com/search/docs/crawling-indexing/sitemaps/build-sitemap#additional-notes-about-xml-sitemaps).
+### License
+Routerino is [MIT licensed](./LICENSE).

package/build-sitemap.js ADDED Viewed

@@ -0,0 +1,75 @@
+#!/usr/bin/env node
+import fs from "fs";
+// parse the args
+const { routeFilePath, hostname, outputPath } = process.argv
+  .filter((arg) => arg.includes("="))
+  .reduce((acc, cur) => {
+    const split = cur.split("=");
+    acc[split[0]] = split[1];
+    return acc;
+  }, {});
+// input checks
+if (!(routeFilePath && hostname && outputPath)) {
+  console.error(
+    `Error: missing some args! Cannot create sitemap.\nRequired args:\n - routeFilePath: ${routeFilePath}\n - hostname: ${hostname}\n - outputPath: ${outputPath}`
+  );
+  process.exit(1);
+}
+function getPathsFromFile(routeFilePath) {
+  // get file contents as a string, stripping comments
+  const routeFileString =
+    fs
+      .readFileSync(routeFilePath)
+      ?.toString()
+      ?.replace(/\/\/.*|\/\*[\s\S]*?\*\//g, "") ?? "";
+  // match the routes array
+  //
+  // 1: routes or Routes
+  // 2: any spacing
+  // 3: = or :
+  // 4: any spacing
+  // 5: optional open brace
+  // 6: any spacing
+  // 7: group capture start - open bracket
+  // 8: any characters
+  // 9: group capture end - close bracket
+  //
+  // examples:
+  //  - Routes = [...]
+  //  - routes = [...]
+  //  - <Router routes={[...]} />
+  //  - <Router {...{ routes: [...] }} />
+  const arrayMatch = routeFileString.match(
+    /[rR]outes\s*[=:]\s*\{?\s*(\[[\s\S]*\])/
+  );
+  const routeString = arrayMatch[0] ?? "";
+  // match the paths
+  const matches = routeString.match(/path:\s*(["'`]).*?\1/g);
+  const paths =
+    matches.length > 0
+      ? matches.map((pathString) =>
+          pathString.match(/(["'`]).*?\1/)[0].slice(1, -1)
+        )
+      : [];
+  return paths;
+}
+function createSitemap({ hostname, paths }) {
+  return `<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd" xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+${paths.map((path) => `  <url><loc>${hostname}${path}</loc></url>`).join("\n")}
+</urlset>`;
+}
+const paths = getPathsFromFile(routeFilePath);
+const sitemap = createSitemap({ hostname, paths });
+if (sitemap) {
+  fs.writeFileSync(outputPath, sitemap);
+  console.log(`sitemap.xml with ${paths.length} URLs written to ${outputPath}`);
+}

package/dist/routerino.js ADDED Viewed

@@ -0,0 +1,103 @@
+import { jsx as s, jsxs as g, Fragment as $ } from "react/jsx-runtime";
+import e from "prop-types";
+function o({ tag: d = "meta", ...l }) {
+  const a = Object.keys(l);
+  if (a.length < 1)
+    return console.error(
+      `updateHeadTag() received no attributes to set for ${d} tag`
+    );
+  let c = null;
+  for (let r = 0; r < a.length && (a[r] !== "content" && (c = document.querySelector(
+    `${d}[${a[r]}='${l[a[r]]}']`
+  )), !c); r++)
+    ;
+  c || (c = document.createElement(d)), Object.keys(l).forEach(
+    (r) => c.setAttribute(r, l[r])
+  ), document.querySelector("head").appendChild(c);
+}
+function y({
+  routes: d,
+  notFoundTemplate: l,
+  notFoundTitle: a,
+  errorTemplate: c,
+  errorTitle: r,
+  useTrailingSlash: h,
+  usePrerenderTags: p,
+  titlePrefix: u,
+  titlePostfix: f
+}) {
+  var m;
+  try {
+    let n = ((m = window == null ? void 0 : window.location) == null ? void 0 : m.pathname) ?? "/";
+    n === "/index.html" && (n = "/");
+    const T = d.find((i) => i.path === n), b = d.find(
+      (i) => `${i.path}/` === n || i.path === `${n}/`
+    ), t = T ?? b;
+    if (t) {
+      if (t.title) {
+        const i = `${t.titlePrefix ?? u}${t.title}${t.titlePostfix ?? f}`;
+        document.title = i, o({ property: "og:title", content: t.title });
+      }
+      return t.description && (o({ name: "description", content: t.description }), o({
+        property: "og:description",
+        content: t.description
+      })), p && (h && !n.endsWith("/") ? (o({ name: "prerender-status-code", content: "301" }), o({
+        name: "prerender-header",
+        content: `Location: ${window.location.href}/`
+      })) : !h && n.endsWith("/") && (o({ name: "prerender-status-code", content: "301" }), o({
+        name: "prerender-header",
+        content: `Location: ${window.location.href.slice(0, -1)}`
+      }))), t.tags && t.tags.length ? (t.tags.find(({ property: i }) => i === "og:type") || o({ property: "og:type", content: "website" }), t.tags.forEach((i) => o(i))) : o({ property: "og:type", content: "website" }), t.element ? t.element : (console.error(`No element found for ${n}`), document.title = `${u}${a}${f}`, p && o({ name: "prerender-status-code", content: "404" }), l);
+    }
+    return console.error(`No route found for ${n}`), document.title = `${u}${a}${f}`, p && o({ name: "prerender-status-code", content: "404" }), l;
+  } catch (n) {
+    return console.error(`Routerino error: ${n}`), p && o({ name: "prerender-status-code", content: "500" }), document.title = `${u}${r}${f}`, c;
+  }
+}
+y.defaultProps = {
+  routes: [
+    {
+      path: "/",
+      element: /* @__PURE__ */ s("p", { children: "This is the default route. Pass an array of routes to the Routerino component in order to configure your own pages." }),
+      description: "The default route example description.",
+      tags: [{ property: "og:locale", content: "en_US" }]
+    }
+  ],
+  notFoundTemplate: /* @__PURE__ */ g($, { children: [
+    /* @__PURE__ */ s("p", { children: "No page found for this URL. [404]" }),
+    /* @__PURE__ */ s("p", { children: /* @__PURE__ */ s("a", { href: "/", children: "Home" }) })
+  ] }),
+  notFoundTitle: "Page not found [404]",
+  errorTemplate: /* @__PURE__ */ g($, { children: [
+    /* @__PURE__ */ s("p", { children: "Page failed to load. [500]" }),
+    /* @__PURE__ */ s("p", { children: /* @__PURE__ */ s("a", { href: "/", children: "Home" }) })
+  ] }),
+  errorTitle: "Page error [500]",
+  useTrailingSlash: !0,
+  usePrerenderTags: !0,
+  titlePrefix: "",
+  titlePostfix: ""
+};
+const w = e.exact({
+  path: e.string.isRequired,
+  element: e.element.isRequired,
+  title: e.string,
+  description: e.string,
+  tags: e.arrayOf(e.object),
+  titlePrefix: e.string,
+  titlePostfix: e.string
+});
+y.propTypes = {
+  routes: e.arrayOf(w),
+  notFoundTemplate: e.element,
+  notFoundTitle: e.string,
+  errorTemplate: e.element,
+  errorTitle: e.string,
+  useTrailingSlash: e.bool,
+  usePrerenderTags: e.bool,
+  titlePrefix: e.string,
+  titlePostfix: e.string
+};
+export {
+  y as default
+};

package/dist/routerino.umd.cjs ADDED Viewed

@@ -0,0 +1 @@

package/package.json ADDED Viewed

@@ -0,0 +1,55 @@
+{
+  "name": "routerino",
+  "version": "1.0.0",
+  "description": "Tiny, SEO-focused router for React websites",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nerds-with-keyboards/routerino.git"
+  },
+  "keywords": [
+    "router",
+    "react",
+    "seo",
+    "prerender"
+  ],
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/nerds-with-keyboards/routerino/issues"
+  },
+  "homepage": "https://github.com/nerds-with-keyboards/routerino#readme",
+  "files": [
+    "dist"
+  ],
+  "bin": {
+    "build-sitemap": "build-sitemap.js"
+  },
+  "type": "module",
+  "exports": {
+    "import": "./dist/routerino.js",
+    "require": "./dist/routerino.umd.cjs"
+  },
+  "scripts": {
+    "build": "vite build",
+    "test": "echo TODO",
+    "prepublishOnly": "vite build"
+  },
+  "devDependencies": {
+    "@vitejs/plugin-react": "^4.1.0",
+    "prop-types": "^15.8.1",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "vite": "^4.4.9"
+  },
+  "peerDependencies": {
+    "prop-types": "^15.0.0",
+    "react": "^18.0.0",
+    "react-dom": "^18.0.0"
+  },
+  "engines": {
+    "node": ">=20"
+  },
+  "volta": {
+    "node": "20.7.0",
+    "npm": "10.1.0"
+  }
+}