@openreachtech/furo-vue 1.3.1

package/nuxt/index.js

@@ -0,0 +1,109 @@
+import {
+  addPlugin,
+  createResolver,
+  defineNuxtModule,
+  directoryToURL,
+  hasNuxtModule,
+  installModule,
+  tryResolveModule,
+} from '@nuxt/kit'
+
+const ICON_MODULE_NAME = '@nuxt/icon'
+
+const DEFAULT_ICON_COMPONENT_NAME = 'Icon'
+
+/**
+ * Nuxt module installing the application's icon component as the renderer
+ * `<FuroIcon>` hands every name the registry lacks.
+ */
+export default defineNuxtModule({
+  meta: {
+    name: '@openreachtech/furo-vue',
+    configKey: 'furoVue',
+  },
+
+  defaults: {
+    iconComponentName: null,
+  },
+
+  /**
+   * Set up this module.
+   *
+   * @param {{
+   *   iconComponentName: string | null
+   * }} options - Module options.
+   * @param {import('@nuxt/schema').Nuxt} nuxt - The Nuxt instance.
+   * @returns {Promise<void>}
+   */
+  async setup (
+    options,
+    nuxt
+  ) {
+    await ensureIconModule({
+      nuxt,
+    })
+
+    Object.assign(nuxt.options.appConfig, {
+      furoVue: {
+        iconComponentName: extractIconComponentName({
+          options,
+          nuxt,
+        }),
+      },
+    })
+
+    const resolver = createResolver(import.meta.url)
+
+    addPlugin(resolver.resolve('./runtime/furo-icon-renderer.js'))
+  },
+})
+
+/**
+ * Leave an already-registered icon module alone, register a merely installed
+ * one, and fail naming what to install when the application has neither.
+ *
+ * @param {{
+ *   nuxt: import('@nuxt/schema').Nuxt
+ * }} params - Parameters of this function.
+ * @returns {Promise<void>}
+ * @throws {Error} When the icon module is absent from the application.
+ */
+async function ensureIconModule ({
+  nuxt,
+}) {
+  if (hasNuxtModule(ICON_MODULE_NAME, nuxt)) {
+    return
+  }
+
+  const resolvedPath = await tryResolveModule(
+    ICON_MODULE_NAME,
+    nuxt.options.modulesDir.map(directoryToURL)
+  )
+
+  if (!resolvedPath) {
+    throw new Error(`[@openreachtech/furo-vue] the Nuxt module needs \`${ICON_MODULE_NAME}\` to draw the names the icon registry lacks. Install it with \`npm install ${ICON_MODULE_NAME}\`, or drop this module and install a renderer yourself with \`furoIconRegistry.useIconRenderer()\`.`)
+  }
+
+  await installModule(ICON_MODULE_NAME, undefined, nuxt)
+}
+
+/**
+ * Extract the name the icon component is globally registered under, which the
+ * icon module lets an application rename.
+ *
+ * @param {{
+ *   options: {
+ *     iconComponentName: string | null
+ *   }
+ *   nuxt: import('@nuxt/schema').Nuxt
+ * }} params - Parameters of this function.
+ * @returns {string} Component name.
+ */
+function extractIconComponentName ({
+  options,
+  nuxt,
+}) {
+  return options.iconComponentName
+    ?? nuxt.options.icon?.componentName
+    ?? DEFAULT_ICON_COMPONENT_NAME
+}

package/nuxt/runtime/furo-icon-renderer.js

@@ -0,0 +1,24 @@
+import {
+  defineNuxtPlugin,
+  useAppConfig,
+} from 'nuxt/app'
+
+// Reached relatively because a published tarball has no `~` alias and no
+// self-reference to resolve `@openreachtech/furo-vue/icons` against.
+import {
+  furoIconRegistry,
+} from '../../lib/components/atoms/FuroIcon/icons.js'
+
+/**
+ * Hand every name the icon registry lacks to the application's icon component,
+ * which resolves the whole catalogue.
+ */
+export default defineNuxtPlugin(() => {
+  const {
+    iconComponentName,
+  } = useAppConfig().furoVue
+
+  furoIconRegistry.useIconRenderer({
+    component: iconComponentName,
+  })
+})

package/package.json

@@ -0,0 +1,137 @@
+{
+  "name": "@openreachtech/furo-vue",
+  "version": "1.3.1",
+  "description": "furo for Vue",
+  "main": "index.js",
+  "types": "./types/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./types/index.d.ts",
+      "default": "./index.js"
+    },
+    "./toast": {
+      "types": "./types/generated/components/organisms/FuroToast/toast.d.ts",
+      "default": "./lib/components/organisms/FuroToast/toast.js"
+    },
+    "./icons": {
+      "types": "./types/generated/components/atoms/FuroIcon/icons.d.ts",
+      "default": "./lib/components/atoms/FuroIcon/icons.js"
+    },
+    "./icon-renderers": {
+      "types": "./types/generated/components/atoms/FuroIcon/iconRenderers.d.ts",
+      "default": "./lib/components/atoms/FuroIcon/iconRenderers.js"
+    },
+    "./nuxt": {
+      "default": "./nuxt/index.js"
+    },
+    "./lib/*.js": {
+      "types": "./types/generated/*.d.ts",
+      "default": "./lib/*.js"
+    },
+    "./lib/*.vue": {
+      "types": "./types/generated/*.vue.d.ts",
+      "default": "./lib/*.vue"
+    },
+    "./*": "./*"
+  },
+  "files": [
+    "lib/",
+    "nuxt/",
+    "types/",
+    "public/furo-vue/",
+    "!**/.directorykeeper",
+    "!types/jest.d.ts"
+  ],
+  "scripts": {
+    "build": "nuxt build",
+    "dev": "npm run cache; nuxt dev",
+    "generate": "nuxt generate",
+    "start": "nuxt start",
+    "cache": "node -e \"require('fs').rm('./node_modules/.cache', { recursive: true, force: true }, err => { if (err) console.error(err); console.log('Cache cleared'); })\"",
+    "l": "npm run lint",
+    "lint": "eslint app components eslint layouts lib middleware nuxt pages scripts tests eslint.config.js index.js jest.config.js nuxt.config.js",
+    "clean:types": "node -e \"require('fs').rmSync('./types/generated', { recursive: true, force: true })\"",
+    "build:types": "npm run clean:types && vue-tsc -p tsconfig.build.json && npm run verify:types",
+    "verify:types": "node scripts/verify-declaration-coverage.mjs",
+    "prepack": "npm run build:types",
+    "docs:manifest": "node scripts/generate-component-manifest.mjs",
+    "icons:data": "node scripts/generate-icon-data.mjs",
+    "test": "export NODE_OPTIONS=\"$NODE_OPTIONS --experimental-vm-modules\"; jest"
+  },
+  "type": "module",
+  "sideEffects": [
+    "**/*.css"
+  ],
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/openreachtech/furo-vue.git"
+  },
+  "keywords": [
+    "furo",
+    "nuxt"
+  ],
+  "homepage": "https://github.com/openreachtech/furo-vue#readme",
+  "author": "Open Reach Tech Inc.",
+  "bugs": {
+    "url": "https://github.com/openreachtech/furo-vue/issues"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "@iconify/vue": "^5.0.1",
+    "@openreachtech/furo": "^1.10.1",
+    "@tiptap/core": "^3.30.0",
+    "@tiptap/extension-highlight": "^3.30.0",
+    "@tiptap/extension-image": "^3.30.0",
+    "@tiptap/extension-mention": "^3.30.0",
+    "@tiptap/extension-text-align": "^3.30.0",
+    "@tiptap/extension-text-style": "^3.30.0",
+    "@tiptap/extension-typography": "^3.30.0",
+    "@tiptap/pm": "^3.30.0",
+    "@tiptap/starter-kit": "^3.30.0",
+    "@tiptap/vue-3": "^3.30.0",
+    "marked": "^18.0.9",
+    "reka-ui": "^2.10.3",
+    "vue": "^3.5.41"
+  },
+  "peerDependencies": {
+    "@nuxt/icon": "^1.0.0",
+    "@nuxt/kit": "^3.0.0 || ^4.0.0"
+  },
+  "peerDependenciesMeta": {
+    "@nuxt/icon": {
+      "optional": true
+    },
+    "@nuxt/kit": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@babel/core": "^7.29.7",
+    "@babel/eslint-parser": "^7.29.7",
+    "@babel/preset-env": "^7.29.7",
+    "@iconify-json/ph": "^1.2.2",
+    "@nuxt/icon": "^1.15.0",
+    "@openreachtech/eslint-config": "^3.0.2",
+    "@openreachtech/jest-constructor-spy": "^1.1.0",
+    "@openreachtech/jest-deep-containing": "^1.0.1",
+    "@types/jest": "^30.0.0",
+    "@vue/test-utils": "^2.4.11",
+    "@vue/vue3-jest": "^29.2.6",
+    "babel-jest": "^29.7.0",
+    "core-js": "^3.50.0",
+    "eslint": "^9.39.5",
+    "eslint-plugin-eslint-comments": "^3.2.0",
+    "eslint-plugin-vue": "^9.33.0",
+    "globals": "^17.11.0",
+    "jest": "^29.7.0",
+    "jest-environment-jsdom": "^29.7.0",
+    "nuxt": "^3.21.11",
+    "typescript": "^5.9.3",
+    "vue-tsc": "^3.3.9",
+    "whatwg-fetch": "^3.6.20"
+  },
+  "overrides": {
+    "brace-expansion": "^5.0.9",
+    "js-yaml": "^4.3.1"
+  }
+}