Scaffold multi-package workspace. (#6850)

Author: anthonyshew

.github/workflows/build.yml

@@ -136,4 +136,4 @@ jobs:
           (matrix.os == 'ubuntu-latest') &&
           ((github.event_name == 'push') || (github.event_name == 'pull_request_target'))
         run: |
-          npm run sync-orama
+          cd apps/site && npm run sync-orama

.github/workflows/lighthouse.yml

@@ -106,7 +106,7 @@ jobs:
           # Run as a separate file so we do not have to inline all of our formatting logic.
           # See https://github.com/actions/github-script#run-a-separate-file for more info.
           script: |
-            const { formatLighthouseResults } = await import('${{github.workspace}}/scripts/lighthouse/index.mjs')
+            const { formatLighthouseResults } = await import('${{github.workspace}}/apps/site/scripts/lighthouse/index.mjs')
             await formatLighthouseResults({core})
 
       - name: Add Comment to PR

.github/workflows/lint-and-tests.yml

@@ -45,9 +45,8 @@ jobs:
         # This step is responsible for providing a reusable string that can be used within other steps and jobs
         # that use the `turbo` cli command as a way of easily providing shared arguments to the `turbo` command
         id: turborepo_arguments
-        # See https://turbo.build/repo/docs/reference/command-line-reference/run#--cache-dir
         # See https://turbo.build/repo/docs/reference/command-line-reference/run#--force
-        run: echo "turbo_args=--force=true --cache-dir=.turbo/cache" >> "$GITHUB_OUTPUT"
+        run: echo "turbo_args=--force=true" >> "$GITHUB_OUTPUT"
 
   lint:
     # This Job should run either on `merge_groups` or `push` events
@@ -126,11 +125,7 @@ jobs:
             github.event.pull_request.head.ref != 'chore/crowdin')
         # We want to enforce that the actual `turbo@latest` package is used instead of a possible hijack from the user
         # the `${{ needs.base.outputs.turbo_args }}` is a string substitution happening from the base job
-        run: npx --package=turbo@latest -- turbo lint:js lint:md lint:css prettier ${{ needs.base.outputs.turbo_args }}
-
-      - name: Run `tsc build`
-        # We want to ensure that the whole codebase is passing and successfully compiles with TypeScript
-        run: npx --package=typescript@latest -- tsc --build .
+        run: npx --package=turbo@latest -- turbo lint check-types prettier ${{ needs.base.outputs.turbo_args }}
 
       - name: Save Lint Cache
         # We only want to save caches on `push` events or `pull_request_target` events
@@ -227,6 +222,7 @@ jobs:
         # sha reference has no stable git tag reference or URL. see https://github.com/chromaui/chromatic-cli/issues/797
         uses: chromaui/action@5f6574e351eb055223ae8ea9e1a734d1d695ea9c
         with:
+          workingDir: apps/site
           buildScriptName: storybook:build
           projectToken: ${{ secrets.CHROMATIC_PROJECT_TOKEN }}
           exitOnceUploaded: true

.husky/pre-commit

@@ -5,4 +5,4 @@
 npx lint-staged
 
 # verify typescript staged files
-npx tsc --build .
+npx tsc --build apps/site

.lintstagedrc.json

@@ -1,5 +1,8 @@
 {
-  "**/*.{js,mjs,ts,tsx,md,mdx}": ["eslint --fix", "prettier --check --write"],
+  "**/*.{js,mjs,ts,tsx,md,mdx}": [
+    "turbo run lint:lint-staged --",
+    "prettier --check --write"
+  ],
   "**/*.css": ["stylelint --allow-empty-input", "prettier --write"],
   "**/*.{json,yml}": ["prettier --check --write"]
 }

COLLABORATOR_GUIDE.md

@@ -1,5 +1,6 @@
 {
   "extends": "prettier",
+  "ignorePatterns": ["storybook-static/**"],
   "overrides": [
     {
       "files": ["public/**/*.js"],
@@ -19,6 +20,7 @@
       "plugins": ["import"],
       "extends": ["eslint:recommended", "next", "next/core-web-vitals"],
       "rules": {
+        "import/namespace": "off",
         "import/order": [
           "error",
           {
@@ -48,6 +50,10 @@
         "plugin:import/typescript"
       ],
       "parser": "@typescript-eslint/parser",
+      "parserOptions": {
+        "project": true,
+        "tsconfigRootDir": "."
+      },
       "rules": {
         "@typescript-eslint/consistent-type-imports": "error",
         "@typescript-eslint/array-type": ["error", { "default": "generic" }],

CONTRIBUTING.md

@@ -1,8 +1,7 @@
 import { cache } from 'react';
 
 import type { ClientSharedServerContext } from '@/types';
-
-import { assignClientContext } from './util/assignClientContext';
+import { assignClientContext } from '@/util/assignClientContext';
 
 // This allows us to have Server-Side Context's of the shared "contextual" data
 // which includes the frontmatter, the current pathname from the dynamic segments

.eslintrc.json renamed to apps/site/.eslintrc.json

@@ -16,8 +16,8 @@
     dark:text-white;
 
   & cite {
-    @apply text-base
-      font-regular
+    @apply font-regular
+      text-base
       not-italic;
 
     &::before {

.postcssrc.json renamed to apps/site/.postcssrc.json

@@ -1,9 +1,9 @@
 .button {
-  @apply relative
+  @apply px-4.5
+    relative
     inline-flex
     items-center
     gap-2
-    px-4.5
     py-2.5
     text-center
     font-semibold;
@@ -95,15 +95,15 @@
       shadow-sm;
 
     &::before {
-      @apply absolute
+      @apply bg-gradient-glow-backdrop
+        absolute
         left-0
         right-0
         top-0
         -z-10
         mx-auto
         h-full
         w-full
-        bg-gradient-glow-backdrop
         opacity-30
         content-[''];
     }

.remarkrc.json renamed to apps/site/.remarkrc.json

@@ -10,13 +10,13 @@
       p-4;
 
     & > code {
-      @apply grid
+      @apply font-ibm-plex-mono
+        font-regular
+        grid
         overflow-x-auto
         bg-transparent
         p-0
-        font-ibm-plex-mono
         text-sm
-        font-regular
         leading-snug
         text-neutral-400
         [counter-reset:line];
@@ -32,13 +32,13 @@
         }
 
         &:not(:empty:last-child)::after {
-          @apply absolute
+          @apply w-4.5
+            font-ibm-plex-mono
+            absolute
             left-0
             top-0
             mr-4
-            w-4.5
             text-right
-            font-ibm-plex-mono
             text-neutral-600
             [content:counter(line)]
             [counter-increment:line];

.storybook/constants.ts renamed to apps/site/.storybook/constants.ts

@@ -1,13 +1,13 @@
 .tabsList {
-  @apply mb-6
+  @apply font-open-sans
+    max-xs:hidden
+    mb-6
     mt-10
     flex
     gap-2
     border-b
     border-b-neutral-200
-    font-open-sans
-    dark:border-b-neutral-800
-    max-xs:hidden;
+    dark:border-b-neutral-800;
 
   .tabsTrigger {
     @apply border-b-2
@@ -33,9 +33,9 @@
     md:hidden;
 
   > span {
-    @apply my-6
+    @apply max-xs:flex
+      my-6
       hidden
-      w-full
-      max-xs:flex;
+      w-full;
   }
 }

.storybook/main.ts renamed to apps/site/.storybook/main.ts

@@ -1,16 +1,16 @@
 .listItem,
 .listItem:link,
 .listItem:active {
-  @apply flex
+  @apply aria-current:bg-green-600
+    aria-current:text-white
+    flex
     size-10
     items-center
     justify-center
     rounded
     px-3
     py-2.5
     text-neutral-800
-    aria-current:bg-green-600
-    aria-current:text-white
     dark:text-neutral-200;
 
   &:hover {