Merge branch 'main' into mutate

Author: odama626

.github/workflows/pipeline.yml

@@ -1,8 +1,9 @@
 name: Pipeline
 
 on:
-  - push
-  - pull_request
+  pull_request:
+  push:
+    branches: main
 
 jobs:
   build:
@@ -113,7 +114,7 @@ jobs:
       - name: Test
         run: pnpm test
 
-  integration-build:
+  integration-sveltekit:
     runs-on: ${{ matrix.os }}
 
     strategy:
@@ -145,5 +146,41 @@ jobs:
 
       - run: pnpm i
 
-      - name: Build Integration
+      - name: Build SvelteKit Integration
         run: pnpm play:build
+
+  integration-nextjs:
+    runs-on: ${{ matrix.os }}
+
+    strategy:
+      matrix:
+        node-version: [16.x]
+        os: [ubuntu-latest, windows-latest, macos-latest]
+      fail-fast: false
+
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: Install pnpm
+        uses: pnpm/action-setup@v2.2.2
+        with:
+          version: ^7.3.0
+          run_install: false
+
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          registry-url: https://registry.npmjs.org/
+          cache: 'pnpm'
+
+      - name: Set an escape hatch exclusive to this monorepo
+        id: escape_hatch
+        run: |
+          echo "FLATBREAD_CI=true" >> $GITHUB_ENV
+
+      - run: pnpm i
+
+      - name: Build Next.js integration
+        # TODO: extract the Flatbread build to a separate job that this job can depend on
+        run: pnpm build && cd examples/nextjs && pnpm build

.gitignore

@@ -1,7 +1,6 @@
 # packages & build files
 **/node_modules
 **/dist/**
-examples
 
 # temp files
 **.swp

README.md

@@ -60,7 +60,7 @@ package.json
 In reference to that structure, set up a `flatbread.config.js` in the root of your project:
 
 ```js
-import { defineConfig, markdownTransformer, filesystem } from 'flatbread';
+import { defineConfig, transformerMarkdown, sourceFilesystem } from 'flatbread';
 
 const transformerConfig = {
   markdown: {
@@ -69,8 +69,8 @@ const transformerConfig = {
   },
 };
 export default defineConfig({
-  source: filesystem(),
-  transformer: markdownTransformer(transformerConfig),
+  source: sourceFilesystem(),
+  transformer: transformerMarkdown(transformerConfig),
 
   content: [
     {
@@ -251,7 +251,7 @@ Limits the number of returned entries to the specified amount. Accepts an intege
 
 ## Query within your app ❓❓
 
-[Check out the playground for an example](https://github.com/FlatbreadLabs/flatbread/tree/main/playground) of using Flatbread with SvelteKit to safely shoot off GraphQL queries using a static (or node) adapter.
+[Check out the example integrations](https://github.com/FlatbreadLabs/flatbread/tree/main/playground) of using Flatbread with frameworks like SvelteKit and Next.js.
 
 ## Field overrides
 
@@ -306,8 +306,10 @@ Clone the entire monorepo! Once you've installed dependencies with `pnpm -w i`,
 
 This will run a dev server across packages in the monorepo
 
+You may need to seed this with a `pnpm build` first, as there can be a race condition with parallel type generation. After that, you can automatically & incrementally build changes with:
+
 ```bash
-pnpm -w dev
+pnpm dev
 ```
 
 ## **working on a package** ⚒️
@@ -317,13 +319,12 @@ Open another **terminal** tab.
 | ☝️ Keep the dev server running in your other tab |
 | ------------------------------------------------ |
 
-### Option 1: use the Playground as a demo project
+### Option 1: use the SvelteKit example as a demo project
 
 This allows you to work in the full context of a Flatbread instance as an end-user would, except you can tinker with the `packages` internals.
 
 ```bash
-cd playground
-pnpm dev
+pnpm play
 ```
 
 This is a good option when you want to test without creating temporary clutter per-package that you wouldn't want to commit.
@@ -344,14 +345,12 @@ node dist/index.mjs # ya need Node v16+
 
 ## **build for production** 📦
 
-This will use `tsup` to build each package linked in the monorepo unless opted out per-package.
+This will use `tsup` to build each package linked in the monorepo except the integration examples.
 
 ```bash
 pnpm build
 ```
 
 # 📓 Sidenotes
 
-The transpiled TS files in the [`playground`](https://github.com/FlatbreadLabs/flatbread/tree/main/playground) are being tracked in the repo to appease the Vite gods so I can develop quicker. As the project progresses, I'll likely yeet those outta here.
-
 Huge shoutouts to [@antfu](https://github.com/antfu/) and [@sveltejs/kit](https://github.com/sveltejs/kit) for both having invaluable reference points to guide me through learning more advanced Node, Typescript, and monorepo design all in parallel during this project.

examples/nextjs/.eslintrc.json

@@ -0,0 +1,3 @@
+{
+  "extends": "next/core-web-vitals"
+}

examples/nextjs/.gitignore

@@ -0,0 +1,35 @@
+# See https://help.github.com/articles/ignoring-files/ for more about ignoring files.
+
+# dependencies
+/node_modules
+/.pnp
+.pnp.js
+
+# testing
+/coverage
+
+# next.js
+/.next/
+/out/
+
+# production
+/build
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnpm-debug.log*
+
+# local env files
+.env*.local
+
+# vercel
+.vercel
+
+# typescript
+*.tsbuildinfo

examples/nextjs/README.md

@@ -0,0 +1,34 @@
+This is a [Next.js](https://nextjs.org/) project bootstrapped with [`create-next-app`](https://github.com/vercel/next.js/tree/canary/packages/create-next-app).
+
+## Getting Started
+
+First, run the development server:
+
+```bash
+npm run dev
+# or
+yarn dev
+```
+
+Open [http://localhost:3000](http://localhost:3000) with your browser to see the result.
+
+You can start editing the page by modifying `pages/index.tsx`. The page auto-updates as you edit the file.
+
+[API routes](https://nextjs.org/docs/api-routes/introduction) can be accessed on [http://localhost:3000/api/hello](http://localhost:3000/api/hello). This endpoint can be edited in `pages/api/hello.ts`.
+
+The `pages/api` directory is mapped to `/api/*`. Files in this directory are treated as [API routes](https://nextjs.org/docs/api-routes/introduction) instead of React pages.
+
+## Learn More
+
+To learn more about Next.js, take a look at the following resources:
+
+- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js features and API.
+- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+
+You can check out [the Next.js GitHub repository](https://github.com/vercel/next.js/) - your feedback and contributions are welcome!
+
+## Deploy on Vercel
+
+The easiest way to deploy your Next.js app is to use the [Vercel Platform](https://vercel.com/new?utm_medium=default-template&filter=next.js&utm_source=create-next-app&utm_campaign=create-next-app-readme) from the creators of Next.js.
+
+Check out our [Next.js deployment documentation](https://nextjs.org/docs/deployment) for more details.

examples/nextjs/flatbread.config.ts

@@ -0,0 +1,35 @@
+import {
+  transformerMarkdown,
+  sourceFilesystem,
+  type FlatbreadConfig,
+} from 'flatbread';
+
+const transformerConfig = {
+  markdown: {
+    gfm: true,
+    externalLinks: true,
+  },
+};
+const config = {
+  source: sourceFilesystem(),
+  transformer: transformerMarkdown(transformerConfig),
+
+  content: [
+    {
+      path: '../../packages/flatbread/content/posts',
+      collection: 'Post',
+      refs: {
+        authors: 'Author',
+      },
+    },
+    {
+      path: '../../packages/flatbread/content/authors',
+      collection: 'Author',
+      refs: {
+        friend: 'Author',
+      },
+    },
+  ],
+} as FlatbreadConfig;
+
+export default config;

examples/nextjs/next-env.d.ts

@@ -0,0 +1,5 @@
+/// <reference types="next" />
+/// <reference types="next/image-types/global" />
+
+// NOTE: This file should not be edited
+// see https://nextjs.org/docs/basic-features/typescript for more information.

examples/nextjs/next.config.js

@@ -0,0 +1,7 @@
+/** @type {import('next').NextConfig} */
+const nextConfig = {
+  reactStrictMode: true,
+  swcMinify: true,
+};
+
+module.exports = nextConfig;

examples/nextjs/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "nextjs",
+  "version": "0.1.0",
+  "private": true,
+  "scripts": {
+    "dev": "flatbread start -- next dev",
+    "build": "flatbread start -- next build",
+    "start": "next start",
+    "lint": "next lint"
+  },
+  "dependencies": {
+    "flatbread": "workspace:*",
+    "next": "12.2.3",
+    "react": "18.2.0",
+    "react-dom": "18.2.0"
+  },
+  "devDependencies": {
+    "@types/node": "16.11.45",
+    "@types/react": "18.0.15",
+    "@types/react-dom": "18.0.6",
+    "eslint": "7.32.0",
+    "eslint-config-next": "12.2.3",
+    "typescript": "4.7.4"
+  }
+}