@rooted-adapters/git-pages 1.0.0-alpha.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Marvin Brouwer
+
+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/dist/index.d.mts

@@ -0,0 +1,36 @@
+import { AdapterRoutes } from "@rooted/adapter";
+import { Plugin } from "vite";
+
+//#region src/index.d.mts
+/**
+ * Options for {@link gitPagesAdapter}.
+ */
+type GitPagesAdapterOptions = {
+  /**
+   * Manual route list for projects that don't use `generateRouteManifest`.
+   * See {@link AdapterRoutes}.
+   */
+  routes?: AdapterRoutes;
+};
+/**
+ * Base adapter for git-hosted static pages.
+ *
+ * Writes the standard static HTML files and a `404.html` SPA shell fallback.
+ * Suitable for any git-based page host following the [git-pages.org](https://git-pages.org/) standard.
+ *
+ * Platform-specific adapters (GitHub Pages, GitLab Pages, Codeberg Pages) extend this adapter.
+ *
+ * @example `vite.config.ts`
+ * ```ts
+ * import { rootedManifest } from '@rooted/application'
+ * import { gitPagesAdapter } from '@rooted-adapters/git-pages'
+ *
+ * export default rootedManifest({
+ *   plugins: [gitPagesAdapter()],
+ * })
+ * ```
+ */
+declare function gitPagesAdapter(options?: GitPagesAdapterOptions): Plugin;
+//#endregion
+export { GitPagesAdapterOptions, gitPagesAdapter };
+//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguZC5tdHMiLCJuYW1lcyI6W10sInNvdXJjZXMiOlsiLi4vc3JjL2luZGV4Lm10cyJdLCJtYXBwaW5ncyI6Ijs7Ozs7O0FBUUE7S0FBWSxzQkFBQTs7OztBQTBCWjtFQXJCQyxNQUFBLEdBQVMsYUFBQTtBQUFBOzs7Ozs7Ozs7Ozs7Ozs7Ozs7O2lCQXFCTSxlQUFBLENBQWdCLE9BQUEsR0FBVSxzQkFBQSxHQUF5QixNQUFBIn0=

package/dist/index.mjs

@@ -0,0 +1,30 @@
+import { staticAdapter } from "@rooted/adapter";
+//#region src/index.mts
+/**
+* Base adapter for git-hosted static pages.
+*
+* Writes the standard static HTML files and a `404.html` SPA shell fallback.
+* Suitable for any git-based page host following the [git-pages.org](https://git-pages.org/) standard.
+*
+* Platform-specific adapters (GitHub Pages, GitLab Pages, Codeberg Pages) extend this adapter.
+*
+* @example `vite.config.ts`
+* ```ts
+* import { rootedManifest } from '@rooted/application'
+* import { gitPagesAdapter } from '@rooted-adapters/git-pages'
+*
+* export default rootedManifest({
+*   plugins: [gitPagesAdapter()],
+* })
+* ```
+*/
+function gitPagesAdapter(options) {
+	return staticAdapter({
+		name: "rooted:git-pages",
+		routes: options?.routes
+	});
+}
+//#endregion
+export { gitPagesAdapter };
+
+//# sourceMappingURL=data:application/json;charset=utf-8;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXgubWpzIiwibmFtZXMiOltdLCJzb3VyY2VzIjpbIi4uL3NyYy9pbmRleC5tdHMiXSwic291cmNlc0NvbnRlbnQiOlsiaW1wb3J0IHsgc3RhdGljQWRhcHRlciB9IGZyb20gJ0Byb290ZWQvYWRhcHRlcidcblxuaW1wb3J0IHR5cGUgeyBBZGFwdGVyUm91dGVzIH0gZnJvbSAnQHJvb3RlZC9hZGFwdGVyJ1xuaW1wb3J0IHR5cGUgeyBQbHVnaW4gfSBmcm9tICd2aXRlJ1xuXG4vKipcbiAqIE9wdGlvbnMgZm9yIHtAbGluayBnaXRQYWdlc0FkYXB0ZXJ9LlxuICovXG5leHBvcnQgdHlwZSBHaXRQYWdlc0FkYXB0ZXJPcHRpb25zID0ge1xuXHQvKipcblx0ICogTWFudWFsIHJvdXRlIGxpc3QgZm9yIHByb2plY3RzIHRoYXQgZG9uJ3QgdXNlIGBnZW5lcmF0ZVJvdXRlTWFuaWZlc3RgLlxuXHQgKiBTZWUge0BsaW5rIEFkYXB0ZXJSb3V0ZXN9LlxuXHQgKi9cblx0cm91dGVzPzogQWRhcHRlclJvdXRlc1xufVxuXG4vKipcbiAqIEJhc2UgYWRhcHRlciBmb3IgZ2l0LWhvc3RlZCBzdGF0aWMgcGFnZXMuXG4gKlxuICogV3JpdGVzIHRoZSBzdGFuZGFyZCBzdGF0aWMgSFRNTCBmaWxlcyBhbmQgYSBgNDA0Lmh0bWxgIFNQQSBzaGVsbCBmYWxsYmFjay5cbiAqIFN1aXRhYmxlIGZvciBhbnkgZ2l0LWJhc2VkIHBhZ2UgaG9zdCBmb2xsb3dpbmcgdGhlIFtnaXQtcGFnZXMub3JnXShodHRwczovL2dpdC1wYWdlcy5vcmcvKSBzdGFuZGFyZC5cbiAqXG4gKiBQbGF0Zm9ybS1zcGVjaWZpYyBhZGFwdGVycyAoR2l0SHViIFBhZ2VzLCBHaXRMYWIgUGFnZXMsIENvZGViZXJnIFBhZ2VzKSBleHRlbmQgdGhpcyBhZGFwdGVyLlxuICpcbiAqIEBleGFtcGxlIGB2aXRlLmNvbmZpZy50c2BcbiAqIGBgYHRzXG4gKiBpbXBvcnQgeyByb290ZWRNYW5pZmVzdCB9IGZyb20gJ0Byb290ZWQvYXBwbGljYXRpb24nXG4gKiBpbXBvcnQgeyBnaXRQYWdlc0FkYXB0ZXIgfSBmcm9tICdAcm9vdGVkLWFkYXB0ZXJzL2dpdC1wYWdlcydcbiAqXG4gKiBleHBvcnQgZGVmYXVsdCByb290ZWRNYW5pZmVzdCh7XG4gKiAgIHBsdWdpbnM6IFtnaXRQYWdlc0FkYXB0ZXIoKV0sXG4gKiB9KVxuICogYGBgXG4gKi9cbmV4cG9ydCBmdW5jdGlvbiBnaXRQYWdlc0FkYXB0ZXIob3B0aW9ucz86IEdpdFBhZ2VzQWRhcHRlck9wdGlvbnMpOiBQbHVnaW4ge1xuXHRyZXR1cm4gc3RhdGljQWRhcHRlcih7IG5hbWU6ICdyb290ZWQ6Z2l0LXBhZ2VzJywgcm91dGVzOiBvcHRpb25zPy5yb3V0ZXMgfSlcbn1cbiJdLCJtYXBwaW5ncyI6Ijs7Ozs7Ozs7Ozs7Ozs7Ozs7Ozs7QUFrQ0EsU0FBZ0IsZ0JBQWdCLFNBQTBDO0NBQ3pFLE9BQU8sY0FBYztFQUFFLE1BQU07RUFBb0IsUUFBUSxTQUFTO0VBQVEsQ0FBQyJ9

package/package.json

@@ -0,0 +1,58 @@
+{
+  "name": "@rooted-adapters/git-pages",
+  "version": "1.0.0-alpha.0",
+  "description": "Base adapter for git-hosted static pages (GitHub Pages, GitLab Pages, Codeberg Pages)",
+  "keywords": [
+    "web-components",
+    "typescript",
+    "rooted"
+  ],
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/Marvin-Brouwer/rooted.git",
+    "directory": "packages/adapters/git-pages"
+  },
+  "homepage": "https://github.com/Marvin-Brouwer/rooted#readme",
+  "bugs": "https://github.com/Marvin-Brouwer/rooted/issues",
+  "sideEffects": false,
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public",
+    "provenance": true
+  },
+  "files": [
+    "dist",
+    "readme.md"
+  ],
+  "engines": {
+    "node": ">=22.0.0",
+    "pnpm": ">=10.0.0"
+  },
+  "exports": {
+    ".": {
+      "import": "./dist/index.mjs",
+      "types": "./dist/index.d.mts"
+    }
+  },
+  "peerDependencies": {
+    "vite": ">= 8.0.1",
+    "@rooted/adapter": "^1.0.0-alpha.0"
+  },
+  "devDependencies": {
+    "@types/node": "^25.6.2",
+    "tsx": "^4.21.0",
+    "typescript": "^6.0.3",
+    "vite": "^8.0.12",
+    "@rooted/adapter": "^1.0.0-alpha.0",
+    "@rooted/development": "0.1.0",
+    "@rooted/tsdown": "^0.1.0"
+  },
+  "scripts": {
+    "build": "pnpm build:ci",
+    "build:dev": "pnpm build:ci",
+    "build:ci": "tsdown",
+    "watch": "tsdown --watch --no-clean",
+    "clean": "rm -rf dist"
+  }
+}

package/readme.md

@@ -0,0 +1,28 @@
+# [`@rooted-adapters/git-pages`](https://www.npmjs.com/package/@rooted-adapters/git-pages)
+
+Base adapter for git-hosted static pages. Part of the [`@rooted/*`](https://github.com/Marvin-Brouwer/rooted#rooted) framework.
+
+Works for any git page host following the [git-pages.org](https://git-pages.org/) standard. Platform-specific adapters (GitHub Pages, GitLab Pages, Codeberg Pages) extend this one.
+
+> [!IMPORTANT]
+> This package is still in alpha.
+
+```sh
+pnpm add -D @rooted-adapters/git-pages
+```
+
+```ts
+// vite.config.mts
+import { rootedManifest } from '@rooted/application'
+import { generateRouteManifest } from '@rooted/router/manifest'
+import { gitPagesAdapter } from '@rooted-adapters/git-pages'
+
+export default rootedManifest({
+  plugins: [
+    generateRouteManifest({ glob: './src/**/_routes.mts', routeManifestPath: './src/_routes.g.mts' }),
+    gitPagesAdapter(),
+  ],
+})
+```
+
+More in the [adapters guide](https://github.com/Marvin-Brouwer/rooted/blob/main/docs/guide/adapters.md).