Migrate to integration template with build step

.changeset/blue-cycles-swim.md

@@ -0,0 +1,18 @@
+---
+"astro-pages": minor
+---
+
+- Added a build step and restructured the package.
+- The `astro-integration-kit` plugin was removed, use the utility instead
+- All exports from `astro-pages/plugins` and `astro-pages/utils` have been removed, import from `astro-pages` instead:
+
+```ts
+// Use the types
+import type { Option, IntegrationOption } from 'astro-pages';
+
+// Use the Astro integration
+import addPageDirIntegration from 'astro-pages';
+
+// Use the utility (inside an Astro integration)
+import { addPageDir } from 'astro-pages';
+```

.github/workflows/build.yml

@@ -0,0 +1,25 @@
+name: Build
+
+on: [pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+
+      - name: Setup PNPM
+        run: corepack enable && pnpm -v
+
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 18.19.0
+          cache: pnpm
+
+      - name: Install dependencies
+        run: pnpm install --frozen-lockfile
+
+      - name: Build
+        run: pnpm --filter astro-pages build

.github/workflows/release.yml

@@ -27,6 +27,9 @@ jobs:
       - name: Install Dependencies
         run: pnpm install
 
+      - name: Build
+        run: pnpm --filter astro-pages build
+
       - name: Create Release Pull Request or Publish to npm
         id: changesets
         uses: changesets/action@v1

.gitignore

@@ -1,22 +1 @@
-# build output
-dist/
-
-# generated types
-.astro/
-
-# dependencies
-node_modules/
-
-# logs
-npm-debug.log*
-yarn-debug.log*
-yarn-error.log*
-pnpm-debug.log*
-
-
-# environment variables
-.env
-.env.production
-
-# macOS-specific files
-.DS_Store
+node_modules

.vscode/settings.json

@@ -0,0 +1,3 @@
+{
+	"editor.defaultFormatter": "biomejs.biome"
+}

README.md

@@ -7,7 +7,7 @@ Add custom file based routing directories in Astro
 
 ### Examples
 
-#### Integration
+#### Astro Integration
 
 ```ts
 // astro.config.mjs
@@ -53,37 +53,3 @@ export default function(options): AstroIntegration {
   }
 }
 ```
-
-#### Astro Integration Kit Plugin
-
-```ts
-// package/index.ts
-import { defineIntegration } from "astro-integration-kit";
-import addPageDirPlugin from "astro-pages/plugins/astro-integration-kit.ts";
-
-export default defineIntegration({
-    name: "my-integration",
-    plugins: [addPageDirPlugin],
-    setup() {
-        return {
-            "astro:config:setup": ({ addPageDir }) => {
-
-              const pageConfig = {
-                cwd: import.meta.url,
-                dir: "pages"
-              }
-
-              const { 
-                pages,
-                injectPages 
-              } = addPageDir(pageConfig)
-
-              // Injects pages inside 'package/pages'
-              injectPages()
-
-            }
-        }
-    }
-})
-```
-

biome.json

@@ -6,7 +6,10 @@
 	"linter": {
 		"enabled": true,
 		"rules": {
-			"recommended": true
+			"recommended": true,
+			"suspicious": {
+				"noExplicitAny": "warn"
+			}
 		}
 	},
 	"files": {

package.json

@@ -1,19 +1,21 @@
 {
-	"name": "package-root",
+	"name": "root",
 	"private": true,
-	"version": "0.0.1",
-	"description": "",
-	"packageManager": "[email protected]",
+	"packageManager": "[email protected]",
+	"engines": {
+		"node": ">=18.19.0"
+	},
 	"scripts": {
+		"package:dev": "pnpm --filter astro-pages dev",
 		"playground:dev": "pnpm --filter playground dev",
+		"dev": "pnpm --stream -r -parallel dev",
 		"changeset": "changeset",
+		"release": "node scripts/release.mjs",
 		"lint": "biome check .",
 		"lint:fix": "biome check --apply ."
 	},
-	"license": "MIT",
 	"devDependencies": {
-		"@biomejs/biome": "^1.6.2",
-		"@changesets/cli": "^2.27.1",
-		"astro": "^4.5.9"
+		"@biomejs/biome": "1.6.4",
+		"@changesets/cli": "^2.27.1"
 	}
 }

package/.gitignore

@@ -0,0 +1 @@
+dist

package/README.md

@@ -147,39 +147,6 @@ export default function(options): AstroIntegration {
 }
 ```
 
-**Use as a [`astro-integration-kit`](https://astro-integration-kit.netlify.app/getting-started/installation/) plugin**
-
-```js
-// package/index.ts
-import { defineIntegration } from "astro-integration-kit";
-import addPageDirPlugin from "astro-pages/plugins/astro-integration-kit.ts";
-
-export default defineIntegration({
-    name: "my-integration",
-    plugins: [addPageDirPlugin],
-    setup() {
-        return {
-            "astro:config:setup": ({ addPageDir }) => {
-
-              const pageConfig = {
-                cwd: import.meta.url,
-                dir: "pages"
-              }
-
-              const { 
-                pages,
-                injectPages 
-              } = addPageDir(pageConfig)
-
-              // Injects pages inside 'package/pages'
-              injectPages()
-
-            }
-        }
-    }
-})
-```
-
 ## `Option` Reference
 
 ### `dir`

package/package.json

@@ -12,20 +12,28 @@
 	},
 	"bugs": "https://github.com/brycerussell/astro-pages/issues",
 	"homepage": "https://github.com/brycerussell/astro-pages",
-	"scripts": {},
+	"publishConfig": {
+		"access": "public"
+	},
 	"type": "module",
+	"sideEffects": false,
 	"exports": {
-		".": "./index.ts",
-		"./utils/*": "./utils/*",
-		"./plugins/*": "./plugins/*",
-		"./types": "./types.ts"
+		".": {
+			"types": "./dist/index.d.ts",
+			"default": "./dist/index.js"
+		}
+	},
+	"files": ["dist"],
+	"scripts": {
+		"dev": "tsup --watch",
+		"build": "tsup"
 	},
 	"peerDependencies": {
-		"astro": ">=3",
-		"astro-integration-kit": ">=0.1.0"
+		"astro": ">=3"
 	},
 	"devDependencies": {
-		"@types/node": "^20.11.30"
+		"@types/node": "^20.11.30",
+		"tsup": "^8.0.2"
 	},
 	"dependencies": {
 		"fast-glob": "^3.3.2"

package/src/index.ts

@@ -0,0 +1,8 @@
+import integration from "./integration.js";
+import addPageDir, { type IntegrationOption, type Option } from "./utility.js";
+
+export type { IntegrationOption, Option };
+
+export { addPageDir };
+
+export default integration;

package/index.ts → package/src/integration.ts

@@ -1,10 +1,7 @@
 import type { AstroIntegration } from "astro";
-import type { IntegrationOption, Option, Prettify } from "./types";
-import { GLOB_PAGES, addPageDir } from "./utils/add-page-dir";
+import addPageDir, { type IntegrationOption, type Option } from "./utility.js";
 
-export default function (
-	...options: (string | Prettify<Option>)[]
-): AstroIntegration {
+export default function (...options: (string | Option)[]): AstroIntegration {
 	return {
 		name: "astro-pages",
 		hooks: {
@@ -38,5 +35,3 @@ export default function (
 		},
 	};
 }
-
-export { addPageDir, GLOB_PAGES };