astro-font-loader 0.1.1 → 0.1.2

package/README.md

@@ -17,3 +17,99 @@ yarn add astro-font-loader
 # Using pnpm
 pnpm add astro-font-loader
 ```
+
+## How It Works
+
+1. **Setup Phase**: During Astro's config setup, the integration:
+   - Locates the specified font packages in your `node_modules`
+   - Applies the filter function (if provided) to select fonts
+   - Prepares the list of fonts to be copied
+
+2. **Build Phase**: After Astro completes the build:
+   - Copies the filtered font files to the output directory
+   - Transforms CSS imports to reference the copied fonts
+   - Ensures fonts are available in your production build
+
+## Usage
+
+### Basic Setup
+
+Add the integration to your `astro.config.mjs` or `astro.config.ts` file:
+
+```typescript
+import { defineConfig } from 'astro/config';
+import { fontsIntegration } from 'astro-font-loader';
+
+export default defineConfig({
+  site: 'https://example.com',
+  integrations: [
+    fontsIntegration({
+      packages: ["@company/design-system-fonts"],
+    }),
+  ],
+});
+```
+
+### Filtering Fonts
+
+Use the `filter` option to selectively include only specific fonts from your font packages. This is useful when you have a large font library but only need certain fonts for your project:
+
+```typescript
+import { defineConfig } from 'astro/config';
+import { fontsIntegration } from 'astro-font-loader';
+
+// Define a filter function to select specific fonts
+const fontFilter = (filename: string) => {
+  const name = filename.toLowerCase();
+  return name.includes("hatton") || 
+         name.includes("berkeleymono");
+};
+
+export default defineConfig({
+  site: 'https://example.com',
+  integrations: [
+    fontsIntegration({
+      packages: ["@company/design-system-fonts"],
+      filter: fontFilter,
+    }),
+  ],
+});
+```
+
+### Custom Output Directory
+
+By default, fonts are copied to a `fonts` directory in your build output. You can customize this:
+
+```typescript
+fontsIntegration({
+  packages: ["@company/design-system-fonts"],
+  filter: fontFilter,
+  outputDir: "assets/fonts", // Custom output directory
+})
+```
+
+### Multiple Font Packages
+
+You can load fonts from multiple packages:
+
+```typescript
+fontsIntegration({
+  packages: [
+    "@company/design-system-fonts",
+    "@fontsource/roboto",
+    "@custom/typefaces"
+  ],
+  filter: (filename) => {
+    // Only include specific fonts from all packages
+    const name = filename.toLowerCase();
+    return name.includes("hatton") ||
+           name.includes("berkeleymono") ||
+           name.includes("roboto-400");
+  },
+})
+```
+
+## Additional Documentation
+
+* [API Reference](./docs/API.md)
+* [Examples](./docs/EXAMPLES.md)

package/dist/fonts/index.d.ts

@@ -1,6 +1,6 @@
 import { getAvailableFonts } from "./available.ts";
-import type { FontsPackageInfo } from "./fontInfo.js";
-import { getFontsPackageInfo } from "./package.js";
-export type { FontsPackageInfo };
+import type { FontInfo, FontsPackageInfo } from "./fontInfo.ts";
+import { getFontsPackageInfo } from "./package.ts";
+export type { FontInfo, FontsPackageInfo };
 export { getFontsPackageInfo, getAvailableFonts };
 //# sourceMappingURL=index.d.ts.map

package/dist/fonts/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/fonts/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AACtD,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAEnD,YAAY,EAAE,gBAAgB,EAAE,CAAC;AAEjC,OAAO,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/fonts/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,gBAAgB,CAAC;AACnD,OAAO,KAAK,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAC;AAChE,OAAO,EAAE,mBAAmB,EAAE,MAAM,cAAc,CAAC;AAEnD,YAAY,EAAE,QAAQ,EAAE,gBAAgB,EAAE,CAAC;AAE3C,OAAO,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,CAAC"}

package/dist/index.d.ts

@@ -1,5 +1,7 @@
-export { getFontsCss } from "./css/index.ts";
 export { fontsIntegration } from "./integration.ts";
-export { getFontsPackageInfo, getAvailableFonts } from "./fonts/index.ts";
 export type { FontsIntegrationOptions } from "./integration.ts";
+export { getFontsCss } from "./css/index.ts";
+export type { GetFontsCssOptions } from "./css/get.ts";
+export { getFontsPackageInfo, getAvailableFonts } from "./fonts/index.ts";
+export type { FontInfo, FontsPackageInfo } from "./fonts/index.ts";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAC1E,YAAY,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACpD,YAAY,EAAE,uBAAuB,EAAE,MAAM,kBAAkB,CAAC;AAEhE,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,YAAY,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAEvD,OAAO,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC;AAC1E,YAAY,EAAE,QAAQ,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC"}

package/dist/index.js

@@ -1,4 +1,4 @@
-export { getFontsCss } from "./css/index.js";
 export { fontsIntegration } from "./integration.js";
+export { getFontsCss } from "./css/index.js";
 export { getFontsPackageInfo, getAvailableFonts } from "./fonts/index.js";
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAC7C,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AACpD,OAAO,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAC;AAGpD,OAAO,EAAE,WAAW,EAAE,MAAM,gBAAgB,CAAC;AAG7C,OAAO,EAAE,mBAAmB,EAAE,iBAAiB,EAAE,MAAM,kBAAkB,CAAC"}

package/package.json

@@ -4,15 +4,21 @@
 	"author": "Mikey Sleevi <development@frogman.simplelogin.com>",
 	"license": "MIT",
 	"type": "module",
-	"version": "0.1.1",
-	"main": "src/index.ts",
-	"types": "dist/index.d.ts",
+	"version": "0.1.2",
+	"engines": {
+		"node": ">=18.0.0"
+	},
+	"main": "./dist/index.js",
+	"module": "./dist/index.js",
+	"types": "./dist/index.d.ts",
 	"exports": {
 		".": {
 			"types": "./dist/index.d.ts",
-			"import": "./dist/index.js"
+			"import": "./dist/index.js",
+			"default": "./dist/index.js"
 		}
 	},
+	"sideEffects": false,
 	"files": [
 		"dist"
 	],
@@ -35,7 +41,8 @@
 		"build": "tsc",
 		"test": "node --import tsx --test tests/**/*.test.ts",
 		"lint": "prettier --check . && eslint .",
-		"lint:fix": "prettier --write . && eslint . --fix"
+		"lint:fix": "prettier --write . && eslint . --fix",
+		"clean": "rm -rf dist"
 	},
 	"devDependencies": {
 		"@tsconfig/recommended": "^1.0.13",

package/src/index.ts

@@ -1,4 +0,0 @@
-export { getFontsCss } from "./css/index.ts";
-export { fontsIntegration } from "./integration.ts";
-export { getFontsPackageInfo, getAvailableFonts } from "./fonts/index.ts";
-export type { FontsIntegrationOptions } from "./integration.ts";