initial

Author: LekoArts

.eslintignore

@@ -0,0 +1,15 @@
+node_modules
+dist
+public
+.cache
+*.log
+gatsby-types.d.ts
+dist
+
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions

.eslintrc.js

@@ -0,0 +1,104 @@
+/**
+ * This config is used when you run `lint` or `lint:fix`.
+ * It is basic, adjust as you see fit! You can of course use your own configuration.
+ * @see https://eslint.org/
+ */
+module.exports = {
+  env: {
+    node: true,
+    jest: true,
+  },
+  extends: [`eslint:recommended`, `plugin:@typescript-eslint/recommended`, `plugin:prettier/recommended`],
+  parser: `@typescript-eslint/parser`,
+  plugins: [`@typescript-eslint`, `prettier`],
+  root: true,
+  rules: {
+    // Use backtick for quotes
+    quotes: `off`,
+    "@typescript-eslint/quotes": [
+      2,
+      `backtick`,
+      {
+        avoidEscape: true,
+      },
+    ],
+    // Do not use trailing comma
+    "prettier/prettier": [
+      `error`,
+      {
+        trailingComma: `es5`,
+        semi: false,
+        singleQuote: false,
+        printWidth: 120,
+      },
+    ],
+    "@typescript-eslint/array-type": [`error`, { default: `generic` }],
+    "@typescript-eslint/ban-types": [
+      `error`,
+      {
+        extendDefaults: true,
+        types: {
+          "{}": {
+            fixWith: `Record<string, unknown>`,
+          },
+          object: {
+            fixWith: `Record<string, unknown>`,
+          },
+        },
+      },
+    ],
+    "@typescript-eslint/naming-convention": [
+      `error`,
+      {
+        selector: `default`,
+        format: [`camelCase`],
+        leadingUnderscore: `allow`,
+        trailingUnderscore: `allow`,
+      },
+      {
+        selector: `variable`,
+        format: [`camelCase`, `UPPER_CASE`],
+        leadingUnderscore: `allow`,
+        trailingUnderscore: `allow`,
+      },
+      {
+        selector: `typeLike`,
+        format: [`PascalCase`],
+      },
+      {
+        selector: `parameter`,
+        format: [`camelCase`],
+        leadingUnderscore: `allow`,
+      },
+      {
+        selector: `memberLike`,
+        modifiers: [`private`],
+        format: [`camelCase`],
+        leadingUnderscore: `require`,
+      },
+      {
+        selector: `objectLiteralProperty`,
+        format: null,
+      },
+      {
+        selector: `interface`,
+        format: [`PascalCase`],
+        prefix: [`I`],
+      },
+    ],
+  },
+  overrides: [
+    {
+      files: [`site/src/pages/*.tsx`],
+      rules: {
+        "@typescript-eslint/naming-convention": 0,
+      },
+    },
+    {
+      files: [`plugin/src/plugin-options-schema.ts`],
+      rules: {
+        "@typescript-eslint/naming-convention": 0,
+      },
+    },
+  ],
+}

.gitignore

@@ -0,0 +1,14 @@
+node_modules
+dist
+public
+.cache
+*.log
+gatsby-types.d.ts
+
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions

.yarn/plugins/@yarnpkg/plugin-interactive-tools.cjs

@@ -0,0 +1,9 @@
+nodeLinker: node-modules
+
+plugins:
+  - path: .yarn/plugins/@yarnpkg/plugin-typescript.cjs
+    spec: "@yarnpkg/plugin-typescript"
+  - path: .yarn/plugins/@yarnpkg/plugin-interactive-tools.cjs
+    spec: "@yarnpkg/plugin-interactive-tools"
+
+yarnPath: .yarn/releases/yarn-3.3.1.cjs

.yarn/plugins/@yarnpkg/plugin-typescript.cjs

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Gatsbyjs
+
+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.

.yarn/releases/yarn-3.3.1.cjs

@@ -0,0 +1,43 @@
+# creating-source-plugin-tutorial (WIP)
+
+Companion project for the "Creating a Source Plugin" Gatsby tutorial.
+
+## Prerequisites
+
+You'll need to have these tools installed:
+
+- Node.js (v18 or newer)
+- Git
+- Yarn
+
+You can also follow [Part 0: Set Up Your Development Environment](https://www.gatsbyjs.com/docs/tutorial/part-0/) for more detailed instructions.
+
+## Usage
+
+1. Clone this project
+1. `yarn` to install dependencies
+1. `yarn test` to run unit tests
+1. `yarn lint:fix` to run linting
+
+### Development
+
+1. `yarn develop:deps` to build & serve the API at http://localhost:4000, and to also watch the source plugin for changes
+1. `yarn develop:site` in another terminal window to run `gatsby develop` for the test site
+
+If you make changes to the source plugin you will need to restart the `site` server to see the changes reflected in the site.
+
+### Build
+
+1. `yarn start:api` to build and serve the API at http://localhost:4000
+1. `yarn build` in another terminal window to build the production plugin and site
+1. `yarn serve:site` to serve the Gatsby site at http://localhost:9000. You should see an overview of all posts
+
+## Project structure
+
+This project includes three directories:
+
+- `api` is the example mock backend API you will source from
+- `plugin` is the example source plugin
+- `site` is the example site
+
+The source plugin consumes the API, and the site uses the source plugin.

.yarnrc.yml

@@ -0,0 +1,3 @@
+# api
+
+An example GraphQL API that is used for sourcing data.

LICENSE

@@ -0,0 +1,22 @@
+{
+  "name": "api",
+  "version": "0.1.0",
+  "description": "Example API to source from",
+  "main": "./dist/index.js",
+  "scripts": {
+    "clean": "del-cli dist",
+    "build": "tsc",
+    "develop": "tsc -w & nodemon -q -w dist dist/index.js",
+    "serve": "node ./dist/index.js"
+  },
+  "license": "MIT",
+  "dependencies": {
+    "graphql": "^16.6.0",
+    "graphql-yoga": "^3.3.0"
+  },
+  "devDependencies": {
+    "del-cli": "^5.0.0",
+    "nodemon": "^2.0.20",
+    "typescript": "^4.9.4"
+  }
+}

README.md

@@ -0,0 +1,71 @@
+export interface IAuthor {
+  id: number
+  name: string
+}
+
+export const authors = [
+  {
+    id: 1,
+    name: `Jay Gatsby`,
+  },
+  {
+    id: 2,
+    name: `Daisy Buchanan`,
+  },
+] satisfies Array<IAuthor>
+
+export const postIds: Array<number> = [1, 2, 3]
+
+export interface IPostImage {
+  url: string
+  alt: string
+  width: number
+  height: number
+}
+
+export interface IPost {
+  id: number
+  slug: string
+  title: string
+  image: IPostImage
+  author: string
+}
+
+export const posts = [
+  {
+    id: postIds[0],
+    slug: `post-1`,
+    title: `The first post`,
+    image: {
+      url: `https://images.unsplash.com/photo-1615751072497-5f5169febe17?fm=jpg`,
+      alt: `brown and white long coated dog`,
+      width: 3024,
+      height: 4032,
+    },
+    author: `Jay Gatsby`,
+  },
+  {
+    id: postIds[1],
+    slug: `post-2`,
+    title: `The second post`,
+    image: {
+      url: `https://images.unsplash.com/photo-1591160690555-5debfba289f0?fm=jpg`,
+      alt: `golden retriever puppy on focus`,
+      width: 5394,
+      height: 6743,
+    },
+    author: `Jay Gatsby`,
+  },
+  {
+    id: postIds[2],
+    slug: `post-3`,
+    title: `The third post`,
+    image: {
+      url: `https://images.unsplash.com/photo-1547525623-c7d42c20284c?fm=jpg`,
+      alt: `long fur white dog on grass`,
+      width: 4000,
+      height: 6000,
+    },
+    author: `Daisy Buchanan`,
+  },
+] satisfies Array<IPost>

api/README.md

@@ -0,0 +1,74 @@
+import fs from "fs"
+import path from "path"
+import { createSchema, createYoga } from "graphql-yoga"
+import { createServer } from "node:http"
+import { authors, posts, postIds, IAuthor, IPost } from "./data"
+
+const typeDefsPath = path.resolve(__dirname, `../src/schema.graphql`)
+const typeDefs = fs.readFileSync(typeDefsPath, `utf-8`)
+
+export const schema = createSchema({
+  typeDefs,
+  resolvers: {
+    Query: {
+      authors: () => authors,
+      posts: () => posts,
+    },
+    Author: {
+      id: (parent: IAuthor) => parent.id,
+      name: (parent: IAuthor) => parent.name,
+    },
+    Post: {
+      id: (parent: IPost) => parent.id,
+      slug: (parent: IPost) => parent.slug,
+      title: (parent: IPost) => parent.title,
+      author: (parent: IPost) => parent.author,
+    },
+    Mutation: {
+      createPost: (_, { slug, title }) => {
+        const post = {
+          id: postIds.length + 1,
+          slug,
+          title,
+          image: {
+            url: `https://images.unsplash.com/photo-1615751072497-5f5169febe17?fm=jpg`,
+            alt: `brown and white long coated dog`,
+            width: 3024,
+            height: 4032,
+          },
+          author: `Jay Gatsby`,
+        }
+        posts.push(post)
+        return post
+      },
+      updatePost: (_, { id, title }) => {
+        const postIndex = posts.findIndex((post) => id === post.id)
+
+        if (postIndex === null) {
+          return null
+        }
+        posts[postIndex] = { ...posts[postIndex], title }
+
+        return posts[postIndex]
+      },
+      deletePost: (_, { id }) => {
+        const postIndex = posts.findIndex((post) => id === post.id)
+
+        if (postIndex === null) {
+          return null
+        }
+        const post = posts[postIndex]
+        posts.splice(postIndex, 1)
+
+        return post
+      },
+    },
+  },
+})
+
+const yoga = createYoga({ schema })
+const server = createServer(yoga)
+
+server.listen(4000, () => {
+  console.info(`Server is running at http://localhost:4000/graphql`)
+})