fontaine 0.1.3 → 0.2.0

package/README.md

@@ -52,6 +52,8 @@ const options = {
   fallbacks: ['BlinkMacSystemFont', 'Segoe UI', 'Helvetica Neue', 'Arial', 'Noto Sans'],
   // You may need to resolve assets like `/fonts/Roboto.woff2` to a particular directory
   resolvePath: (id) => 'file:///path/to/public/dir' + id,
+  // overrideName: (originalName) => `${name} override`
+  // sourcemap: false
 }
 
 // Vite
@@ -67,6 +69,23 @@ export default {
     return config
   },
 }
+
+// Docusaurus plugin - to be provided to the plugins option of docusaurus.config.js
+// n.b. you'll likely need to require fontaine rather than importing it
+const fontaine = require('fontaine')
+
+function fontainePlugin(_context, _options) {
+  return {
+    name: 'fontaine-plugin',
+    configureWebpack(_config, _isServer) {
+      return {
+        plugins: [
+          fontaine.FontaineTransform.webpack(options),
+        ],
+      };
+    },
+  };
+}
 ```
 
 > **Note**

package/dist/index.cjs

@@ -98,9 +98,10 @@ const FontaineTransform = unplugin.createUnplugin(
   (options) => {
     const cssContext = options.css = options.css || {};
     cssContext.value = "";
-    options.resolvePath = options.resolvePath || ((id) => id);
+    const resolvePath = options.resolvePath || ((id) => id);
+    const overrideName = options.overrideName || generateOverrideName;
     function readMetricsFromId(path, importer) {
-      const resolvedPath = pathe.isAbsolute(importer) && path.startsWith(".") ? pathe.join(importer, path) : options.resolvePath(path);
+      const resolvedPath = pathe.isAbsolute(importer) && path.startsWith(".") ? pathe.join(importer, path) : resolvePath(path);
       return readMetrics(resolvedPath);
     }
     return {
@@ -124,7 +125,7 @@ const FontaineTransform = unplugin.createUnplugin(
           const metrics = await getMetricsForFamily(family) || source && await readMetricsFromId(source, id).catch(() => null);
           if (metrics) {
             const fontFace = generateFontFace(metrics, {
-              name: generateOverrideName(family),
+              name: overrideName(family),
               fallbacks: options.fallbacks
             });
             cssContext.value += fontFace;

package/dist/index.d.ts

@@ -7,6 +7,8 @@ interface FontaineTransformOptions {
     };
     fallbacks: string[];
     resolvePath?: (path: string) => string | URL;
+    /** this should produce an unquoted font family name */
+    overrideName?: (name: string) => string;
     sourcemap?: boolean;
 }
 declare const FontaineTransform: unplugin.UnpluginInstance<FontaineTransformOptions>;

package/dist/index.mjs

@@ -96,9 +96,10 @@ const FontaineTransform = createUnplugin(
   (options) => {
     const cssContext = options.css = options.css || {};
     cssContext.value = "";
-    options.resolvePath = options.resolvePath || ((id) => id);
+    const resolvePath = options.resolvePath || ((id) => id);
+    const overrideName = options.overrideName || generateOverrideName;
     function readMetricsFromId(path, importer) {
-      const resolvedPath = isAbsolute(importer) && path.startsWith(".") ? join(importer, path) : options.resolvePath(path);
+      const resolvedPath = isAbsolute(importer) && path.startsWith(".") ? join(importer, path) : resolvePath(path);
       return readMetrics(resolvedPath);
     }
     return {
@@ -122,7 +123,7 @@ const FontaineTransform = createUnplugin(
           const metrics = await getMetricsForFamily(family) || source && await readMetricsFromId(source, id).catch(() => null);
           if (metrics) {
             const fontFace = generateFontFace(metrics, {
-              name: generateOverrideName(family),
+              name: overrideName(family),
               fallbacks: options.fallbacks
             });
             cssContext.value += fontFace;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "fontaine",
-  "version": "0.1.3",
+  "version": "0.2.0",
   "description": "Automatic font fallback based on font metrics",
   "repository": "unjs/fontaine",
   "keywords": [
@@ -83,5 +83,5 @@
   "resolutions": {
     "fontaine": "link:."
   },
-  "packageManager": "pnpm@7.13.4"
+  "packageManager": "pnpm@7.13.5"
 }