WIP 0.0.28

.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

.changeset/config.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "https://unpkg.com/@changesets/[email protected]/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "linked": [["@contentlayer/*", "contentlayer", "next-contentlayer"]],
+  "access": "public",
+  "baseBranch": "main",
+  "updateInternalDependencies": "patch",
+  "ignore": ["examples-*"]
+}

.github/workflows/ci.yml

@@ -12,49 +12,29 @@ jobs:
         os: [ubuntu-latest]
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v2
-        with:
-          submodules: true
-      - uses: actions/setup-node@v1
-        with:
-          node-version: ${{ matrix.node-version }}
-          cache: yarn
-      - run: yarn install
+      - uses: schickling-actions/checkout-and-install@main
       - run: yarn lint:check
 
   test:
     strategy:
       matrix:
         node-version: [16.x]
+        # Note tests are currently not run in Windows because the path seperator on Windows invalidates the test results 🙈
         os: [ubuntu-latest]
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v2
-        with:
-          submodules: true
-      - uses: actions/setup-node@v2
-        with:
-          node-version: ${{ matrix.node-version }}
-          cache: yarn
-      - run: yarn install
+      - uses: schickling-actions/checkout-and-install@main
       - run: yarn build
       - run: yarn test
 
   build-example-starter:
     strategy:
       matrix:
         node-version: [16.x]
-        os: [ubuntu-latest]
+        os: [ubuntu-latest, windows-latest]
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v2
-        with:
-          submodules: true
-      - uses: actions/setup-node@v2
-        with:
-          node-version: ${{ matrix.node-version }}
-          cache: yarn
-      - run: yarn install
+      - uses: schickling-actions/checkout-and-install@main
       - run: yarn build
       - run: yarn build
         working-directory: examples/starter
@@ -63,17 +43,10 @@ jobs:
     strategy:
       matrix:
         node-version: [16.x]
-        os: [ubuntu-latest]
+        os: [ubuntu-latest, windows-latest]
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v2
-        with:
-          submodules: true
-      - uses: actions/setup-node@v2
-        with:
-          node-version: ${{ matrix.node-version }}
-          cache: yarn
-      - run: yarn install
+      - uses: schickling-actions/checkout-and-install@main
       - run: yarn build
       - run: yarn build
         working-directory: examples/playground-azimuth
@@ -82,17 +55,10 @@ jobs:
     strategy:
       matrix:
         node-version: [16.x]
-        os: [ubuntu-latest]
+        os: [ubuntu-latest, windows-latest]
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v2
-        with:
-          submodules: true
-      - uses: actions/setup-node@v2
-        with:
-          node-version: ${{ matrix.node-version }}
-          cache: yarn
-      - run: yarn install
+      - uses: schickling-actions/checkout-and-install@main
       - run: yarn build
       - run: yarn build
         working-directory: examples/gatsby-docs
@@ -101,17 +67,10 @@ jobs:
     strategy:
       matrix:
         node-version: [16.x]
-        os: [ubuntu-latest]
+        os: [ubuntu-latest, windows-latest]
     runs-on: ${{ matrix.os }}
     steps:
-      - uses: actions/checkout@v2
-        with:
-          submodules: true
-      - uses: actions/setup-node@v2
-        with:
-          node-version: ${{ matrix.node-version }}
-          cache: yarn
-      - run: yarn install
+      - uses: schickling-actions/checkout-and-install@main
       - run: yarn build
       - run: yarn build
         working-directory: examples/mdx

examples/gatsby-docs/contentlayer.config.ts

@@ -1,8 +1,9 @@
-// import rehypeShiki from '@leafac/rehype-shiki'
-// import { createRequire } from 'module'
+import rehypeShiki from '@stefanprobst/rehype-shiki'
+
+import { createRequire } from 'module'
 import { defineDocumentType, makeSource, defineNestedType, FieldDef } from 'contentlayer/source-files'
-// import * as path from 'path'
-// import * as shiki from 'shiki'
+import * as path from 'path'
+import * as shiki from 'shiki'
 
 const Example = defineNestedType(() => ({
   name: 'Example',
@@ -55,22 +56,19 @@ const Tutorial = defineDocumentType(() => ({
 }))
 
 export default makeSource(async () => {
-  // TODO re-enable once this is fixed https://github.com/leafac/rehype-shiki/issues/2
-
-  // const require = createRequire(import.meta.url)
-  // const shikiPath = (dir: string) => path.join(require.resolve('shiki'), '..', '..', dir, path.sep)
-  // const highlighter = await shiki.getHighlighter({
-  //   paths: { languages: shikiPath('languages'), themes: shikiPath('themes') },
-  //   theme: 'github-light',
-  // })
+  const require = createRequire(import.meta.url)
+  const shikiPkgPath = (dir: string) => path.join(require.resolve('shiki'), '..', '..', dir, path.sep)
+  const highlighter = await shiki.getHighlighter({
+    paths: { languages: shikiPkgPath('languages'), themes: shikiPkgPath('themes') },
+    theme: 'github-light',
+  })
 
   return {
     contentDirPath: 'gatsby/docs',
-    // contentDirPath: path.join(process.cwd(), 'gatsby', 'docs'),
     documentTypes: [Reference, HowTo, Conceptual, Tutorial],
     onUnknownDocuments: 'skip-ignore',
     markdown: {
-      // rehypePlugins: [[rehypeShiki as any, { highlighter }]],
+      rehypePlugins: [[rehypeShiki, { highlighter }]],
     },
   }
 })

examples/gatsby-docs/package.json

@@ -7,18 +7,19 @@
     "start": "next start"
   },
   "dependencies": {
-    "next": "^11.1.2",
+    "next": "^12.0.2",
     "react": "^17.0.2",
     "react-dom": "^17.0.2"
   },
   "devDependencies": {
     "@leafac/rehype-shiki": "^1.3.1",
+    "@stefanprobst/rehype-shiki": "^2.0.4",
     "@types/react": "^17.0.21",
     "@types/react-dom": "^17.0.9",
     "contentlayer": "workspace:*",
     "eslint-config-next": "^11.0.1",
     "next-contentlayer": "workspace:*",
     "shiki": "^0.9.4",
-    "typescript": "^4.4.3"
+    "typescript": "^4.4.4"
   }
-}
+}

examples/mdx/README.md

@@ -0,0 +1,6 @@
+## Usage
+
+```sh
+curl https://codeload.github.com/contentlayerdev/contentlayer/tar.gz/main | \
+  tar -xz --strip=2 contentlayer-main/examples/mdx
+```

examples/mdx/contentlayer.config.ts

@@ -5,13 +5,11 @@ const Doc = defineDocumentType(() => ({
   filePathPattern: '**/*.mdx',
   bodyType: 'mdx',
   fields: {
-    title: { type: 'string' },
+    title: { type: 'string', required: true },
   },
 }))
 
-const contentLayerConfig = makeSource({
-  contentDirPath: 'docs',
+export default makeSource({
+  contentDirPath: 'content',
   documentTypes: [Doc],
 })
-
-export default contentLayerConfig

examples/mdx/package.json

@@ -9,14 +9,13 @@
   },
   "dependencies": {
     "contentlayer": "latest",
-    "mdx-bundler": "^6.0.2",
-    "next": "11.1.2",
+    "next": "12.0.2",
     "next-contentlayer": "latest",
     "react": "17.0.2",
     "react-dom": "17.0.2"
   },
   "devDependencies": {
     "@types/react": "17.0.20",
-    "typescript": "4.4.3"
+    "typescript": "4.4.4"
   }
 }

examples/mdx/pages/[[...slug]].tsx

@@ -1,16 +1,16 @@
 import { GetStaticPaths, InferGetStaticPropsType } from 'next'
-import { getMDXComponent } from 'mdx-bundler/client'
+import { useMDXComponent } from 'next-contentlayer/hooks'
 
 import { allDocs } from '.contentlayer/data'
-import { useMemo } from 'react'
 import { Button } from '../components/Button'
+import { Doc } from '.contentlayer/types'
 
 const mdxComponents = {
   Button,
 }
 
-const DocPage: React.FC<InferGetStaticPropsType<typeof getStaticProps>> = ({ doc, navInfo }) => {
-  const MDXContent = useMemo(() => getMDXComponent(doc.body.code), [doc.body.code])
+const DocPage: React.FC<StaticProps> = ({ doc, navInfo }) => {
+  const MDXContent = useMDXComponent(doc.body.code)
 
   return (
     <div>
@@ -29,9 +29,14 @@ const DocPage: React.FC<InferGetStaticPropsType<typeof getStaticProps>> = ({ doc
 
 export default DocPage
 
-export const getStaticProps = ({ params: { slug = [] } }) => {
+type StaticProps = {
+  doc: Doc
+  navInfo: { title: string; path: string }[]
+}
+
+export const getStaticProps = ({ params: { slug = [] } }): { props: StaticProps } => {
   const pagePath = slug.join('/')
-  const doc = allDocs.find((doc) => doc._raw.flattenedPath === pagePath)
+  const doc = allDocs.find((doc) => doc._raw.flattenedPath === pagePath)!
 
   const navInfo = allDocs.map((_) => ({ title: _.title, path: `/${_._raw.flattenedPath}` }))
 

examples/mdx/tsconfig.json

@@ -4,15 +4,16 @@
     "lib": ["dom", "dom.iterable", "esnext"],
     "allowJs": true,
     "skipLibCheck": true,
-    "strict": false,
+    "strict": true,
     "forceConsistentCasingInFileNames": true,
     "noEmit": true,
     "esModuleInterop": true,
     "module": "esnext",
     "moduleResolution": "node",
     "resolveJsonModule": true,
     "isolatedModules": true,
-    "jsx": "preserve"
+    "jsx": "preserve",
+    "incremental": true
   },
   "include": ["next-env.d.ts", "**/*.ts", "**/*.tsx"],
   "exclude": ["node_modules"]

examples/playground-azimuth-colocated/package.json

@@ -9,7 +9,7 @@
   "dependencies": {
     "date-fns": "^2.24.0",
     "marked": "^3.0.4",
-    "next": "^11.1.2",
+    "next": "^12.0.2",
     "react": "^17.0.2",
     "react-dom": "^17.0.2",
     "react-helmet": "^6.1.0",
@@ -24,6 +24,6 @@
     "contentlayer": "workspace:*",
     "contentlayer-stackbit-yaml-generator": "workspace:*",
     "next-contentlayer": "workspace:*",
-    "typescript": "^4.4.3"
+    "typescript": "^4.4.4"
   }
 }

examples/playground-azimuth-contentful/package.json

@@ -9,7 +9,7 @@
   "dependencies": {
     "date-fns": "^2.24.0",
     "marked": "^3.0.4",
-    "next": "^11.1.2",
+    "next": "^12.0.2",
     "react": "^17.0.2",
     "react-dom": "^17.0.2",
     "react-helmet": "^6.1.0",
@@ -25,6 +25,6 @@
     "contentlayer": "workspace:*",
     "contentlayer-stackbit-yaml-generator": "workspace:*",
     "next-contentlayer": "workspace:*",
-    "typescript": "^4.4.3"
+    "typescript": "^4.4.4"
   }
 }

examples/playground-azimuth-sanity/package.json

@@ -1,4 +1,5 @@
 {
+  "name": "example-azimuth-sanity-monorepo",
   "private": true,
   "workspaces": [
     "./web",

examples/playground-azimuth-sanity/web/package.json

@@ -12,7 +12,7 @@
     "contentlayer": "workspace:*",
     "date-fns": "^2.24.0",
     "marked": "^3.0.4",
-    "next": "^11.1.2",
+    "next": "^12.0.2",
     "react": "^17.0.2",
     "react-dom": "^17.0.2",
     "react-helmet": "^6.1.0",
@@ -24,6 +24,6 @@
     "@types/react": "^17.0.21",
     "@types/react-dom": "^17.0.9",
     "@types/react-helmet": "^6.1.2",
-    "typescript": "^4.4.3"
+    "typescript": "^4.4.4"
   }
 }

examples/playground-azimuth/package.json

@@ -9,7 +9,7 @@
   "dependencies": {
     "date-fns": "^2.24.0",
     "marked": "^3.0.4",
-    "next": "^11.1.2",
+    "next": "^12.0.2",
     "react": "^17.0.2",
     "react-dom": "^17.0.2",
     "react-helmet": "^6.1.0",
@@ -24,6 +24,6 @@
     "contentlayer": "workspace:*",
     "contentlayer-stackbit-yaml-generator": "workspace:*",
     "next-contentlayer": "workspace:*",
-    "typescript": "^4.4.3"
+    "typescript": "^4.4.4"
   }
 }

examples/playground-contentful-starter/package.json

@@ -9,7 +9,7 @@
   },
   "dependencies": {
     "date-fns": "^2.24.0",
-    "next": "^11.1.2",
+    "next": "^12.0.2",
     "react": "17.0.2",
     "react-dom": "17.0.2"
   },
@@ -19,6 +19,6 @@
     "contentlayer": "latest",
     "next-contentlayer": "latest",
     "rehype-highlight": "^5.0.0",
-    "typescript": "^4.4.3"
+    "typescript": "^4.4.4"
   }
 }