From 4b546bfb13346fdbaf0fca4e8041ddba35d23f47 Mon Sep 17 00:00:00 2001 From: Thomas Raffray Date: Fri, 27 Sep 2024 19:58:46 +0200 Subject: [PATCH] fix(cli): remix detection (#4972) # What Some remix templates doesn't package a `vite.config.*` file at their root. It's the case for the recommended starter "stack" templates: blues-stack, indie-stack and grunge-stack. As recommended in a TODO comment, it's more suitable to check for a `@remix-run/*` dependency in the package dependencies. # How - decouple vite and remix checks - retrieve the `package.json` - allow passing a `cwd` to the retrieval method - remove the "empty config file list" that can be empty for a remix stack - check that the `package.json` contains a `@remix-run/*` dependency # Test Added a fixture by running `npx create-remix@latest --template remix-run/indie-stack` in the [frameworks](/Fluf22/shadcn-ui/tree/fix/cli-remix-detection/packages/cli/test/fixtures/frameworks) folder and named it `remix-indie-stack`, if ever we want another stack as a fixture later --- Fixes shadcn-ui/ui#4967 --- .changeset/good-toes-greet.md | 5 + .gitignore | 7 +- packages/shadcn/src/utils/get-package-info.ts | 11 +- packages/shadcn/src/utils/get-project-info.ts | 27 ++- .../remix-indie-stack/.dockerignore | 7 + .../frameworks/remix-indie-stack/.env.example | 2 + .../frameworks/remix-indie-stack/.eslintrc.js | 136 +++++++++++ .../.github/ISSUE_TEMPLATE/bug_report.yml | 41 ++++ .../.github/ISSUE_TEMPLATE/config.yml | 21 ++ .../.github/PULL_REQUEST_TEMPLATE.md | 14 ++ .../remix-indie-stack/.github/dependabot.yml | 6 + .../.github/workflows/deploy.yml | 144 +++++++++++ .../.github/workflows/format-repo.yml | 46 ++++ .../.github/workflows/lint-repo.yml | 33 +++ .../.github/workflows/no-response.yml | 34 +++ .../frameworks/remix-indie-stack/.gitignore | 18 ++ .../remix-indie-stack/.gitpod.Dockerfile | 9 + .../frameworks/remix-indie-stack/.gitpod.yml | 48 ++++ .../frameworks/remix-indie-stack/.npmrc | 1 + .../remix-indie-stack/.prettierignore | 7 + .../frameworks/remix-indie-stack/Dockerfile | 61 +++++ .../frameworks/remix-indie-stack/LICENSE.md | 22 ++ .../frameworks/remix-indie-stack/README.md | 183 ++++++++++++++ .../remix-indie-stack/app/db.server.ts | 9 + .../remix-indie-stack/app/entry.client.tsx | 18 ++ .../remix-indie-stack/app/entry.server.tsx | 120 +++++++++ .../app/models/note.server.ts | 52 ++++ .../app/models/user.server.ts | 63 +++++ .../frameworks/remix-indie-stack/app/root.tsx | 42 ++++ .../remix-indie-stack/app/routes/_index.tsx | 141 +++++++++++ .../app/routes/healthcheck.tsx | 25 ++ .../remix-indie-stack/app/routes/join.tsx | 171 +++++++++++++ .../remix-indie-stack/app/routes/login.tsx | 180 ++++++++++++++ .../remix-indie-stack/app/routes/logout.tsx | 9 + .../app/routes/notes.$noteId.tsx | 70 ++++++ .../app/routes/notes._index.tsx | 12 + .../app/routes/notes.new.tsx | 109 +++++++++ .../remix-indie-stack/app/routes/notes.tsx | 70 ++++++ .../remix-indie-stack/app/session.server.ts | 97 ++++++++ .../remix-indie-stack/app/singleton.server.ts | 13 + .../remix-indie-stack/app/tailwind.css | 3 + .../remix-indie-stack/app/utils.test.ts | 13 + .../frameworks/remix-indie-stack/app/utils.ts | 76 ++++++ .../remix-indie-stack/cypress.config.ts | 26 ++ .../remix-indie-stack/cypress/.eslintrc.js | 6 + .../remix-indie-stack/cypress/e2e/smoke.cy.ts | 51 ++++ .../cypress/fixtures/example.json | 5 + .../cypress/support/commands.ts | 98 ++++++++ .../cypress/support/create-user.ts | 48 ++++ .../cypress/support/delete-user.ts | 37 +++ .../remix-indie-stack/cypress/support/e2e.ts | 17 ++ .../remix-indie-stack/cypress/tsconfig.json | 28 +++ .../frameworks/remix-indie-stack/fly.toml | 52 ++++ .../remix-indie-stack/mocks/README.md | 7 + .../remix-indie-stack/mocks/index.js | 15 ++ .../frameworks/remix-indie-stack/package.json | 93 +++++++ .../remix-indie-stack/postcss.config.js | 6 + .../remix-indie-stack/prettier.config.js | 4 + .../20220713162558_init/migration.sql | 31 +++ .../prisma/migrations/migration_lock.toml | 3 + .../remix-indie-stack/prisma/schema.prisma | 38 +++ .../remix-indie-stack/prisma/seed.ts | 53 ++++ .../remix-indie-stack/public/favicon.ico | Bin 0 -> 16958 bytes .../remix-indie-stack/remix.config.js | 6 + .../remix-indie-stack/remix.env.d.ts | 2 + .../remix-indie-stack/remix.init/gitignore | 10 + .../remix-indie-stack/remix.init/index.js | 227 ++++++++++++++++++ .../remix-indie-stack/remix.init/package.json | 11 + .../frameworks/remix-indie-stack/start.sh | 9 + .../remix-indie-stack/tailwind.config.ts | 9 + .../remix-indie-stack/test/setup-test-env.ts | 4 + .../remix-indie-stack/tsconfig.json | 28 +++ .../remix-indie-stack/vitest.config.ts | 15 ++ .../test/utils/get-project-info.test.ts | 12 + 74 files changed, 3113 insertions(+), 14 deletions(-) create mode 100644 .changeset/good-toes-greet.md create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.dockerignore create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.env.example create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.eslintrc.js create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.github/ISSUE_TEMPLATE/bug_report.yml create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.github/ISSUE_TEMPLATE/config.yml create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.github/PULL_REQUEST_TEMPLATE.md create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.github/dependabot.yml create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.github/workflows/deploy.yml create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.github/workflows/format-repo.yml create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.github/workflows/lint-repo.yml create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.github/workflows/no-response.yml create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.gitignore create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.gitpod.Dockerfile create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.gitpod.yml create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.npmrc create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.prettierignore create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/Dockerfile create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/LICENSE.md create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/README.md create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/db.server.ts create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/entry.client.tsx create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/entry.server.tsx create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/models/note.server.ts create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/models/user.server.ts create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/root.tsx create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/routes/_index.tsx create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/routes/healthcheck.tsx create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/routes/join.tsx create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/routes/login.tsx create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/routes/logout.tsx create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/routes/notes.$noteId.tsx create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/routes/notes._index.tsx create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/routes/notes.new.tsx create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/routes/notes.tsx create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/session.server.ts create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/singleton.server.ts create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/tailwind.css create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/utils.test.ts create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/utils.ts create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/cypress.config.ts create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/cypress/.eslintrc.js create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/cypress/e2e/smoke.cy.ts create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/cypress/fixtures/example.json create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/cypress/support/commands.ts create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/cypress/support/create-user.ts create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/cypress/support/delete-user.ts create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/cypress/support/e2e.ts create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/cypress/tsconfig.json create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/fly.toml create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/mocks/README.md create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/mocks/index.js create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/package.json create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/postcss.config.js create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/prettier.config.js create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/prisma/migrations/20220713162558_init/migration.sql create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/prisma/migrations/migration_lock.toml create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/prisma/schema.prisma create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/prisma/seed.ts create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/public/favicon.ico create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/remix.config.js create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/remix.env.d.ts create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/remix.init/gitignore create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/remix.init/index.js create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/remix.init/package.json create mode 100755 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/start.sh create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/tailwind.config.ts create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/test/setup-test-env.ts create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/tsconfig.json create mode 100644 packages/shadcn/test/fixtures/frameworks/remix-indie-stack/vitest.config.ts diff --git a/.changeset/good-toes-greet.md b/.changeset/good-toes-greet.md new file mode 100644 index 00000000000..e3dad3d5213 --- /dev/null +++ b/.changeset/good-toes-greet.md @@ -0,0 +1,5 @@ +--- +"shadcn": patch +--- + +update remix detection diff --git a/.gitignore b/.gitignore index 24c1ac82436..865a3fd3be3 100644 --- a/.gitignore +++ b/.gitignore @@ -33,4 +33,9 @@ yarn-error.log* .turbo .contentlayer -tsconfig.tsbuildinfo \ No newline at end of file +tsconfig.tsbuildinfo + +# ide +.idea +.fleet +.vscode diff --git a/packages/shadcn/src/utils/get-package-info.ts b/packages/shadcn/src/utils/get-package-info.ts index c7f4961927e..946aaf403e6 100644 --- a/packages/shadcn/src/utils/get-package-info.ts +++ b/packages/shadcn/src/utils/get-package-info.ts @@ -2,8 +2,13 @@ import path from "path" import fs from "fs-extra" import { type PackageJson } from "type-fest" -export function getPackageInfo() { - const packageJsonPath = path.join("package.json") +export function getPackageInfo( + cwd: string = "", + shouldThrow: boolean = true +): PackageJson | null { + const packageJsonPath = path.join(cwd, "package.json") - return fs.readJSONSync(packageJsonPath) as PackageJson + return fs.readJSONSync(packageJsonPath, { + throws: shouldThrow, + }) as PackageJson } diff --git a/packages/shadcn/src/utils/get-project-info.ts b/packages/shadcn/src/utils/get-project-info.ts index f728e20569c..cd1f47ce8fa 100644 --- a/packages/shadcn/src/utils/get-project-info.ts +++ b/packages/shadcn/src/utils/get-project-info.ts @@ -6,6 +6,7 @@ import { getConfig, resolveConfigPaths, } from "@/src/utils/get-config" +import { getPackageInfo } from "@/src/utils/get-package-info" import fg from "fast-glob" import fs from "fs-extra" import { loadConfig } from "tsconfig-paths" @@ -36,6 +37,7 @@ export async function getProjectInfo(cwd: string): Promise { tailwindConfigFile, tailwindCssFile, aliasPrefix, + packageJson, ] = await Promise.all([ fg.glob("**/{next,vite,astro}.config.*|gatsby-config.*|composer.json", { cwd, @@ -47,6 +49,7 @@ export async function getProjectInfo(cwd: string): Promise { getTailwindConfigFile(cwd), getTailwindCssFile(cwd), getTsConfigAliasPrefix(cwd), + getPackageInfo(cwd, false), ]) const isUsingAppDir = await fs.pathExists( @@ -63,10 +66,6 @@ export async function getProjectInfo(cwd: string): Promise { aliasPrefix, } - if (!configFiles.length) { - return type - } - // Next.js. if (configFiles.find((file) => file.startsWith("next.config."))?.length) { type.framework = isUsingAppDir @@ -94,13 +93,21 @@ export async function getProjectInfo(cwd: string): Promise { return type } - // Vite and Remix. - // They both have a vite.config.* file. + // Remix. + if ( + Object.keys(packageJson?.dependencies ?? {}).find((dep) => + dep.startsWith("@remix-run/") + ) + ) { + type.framework = FRAMEWORKS["remix"] + return type + } + + // Vite. + // Some Remix templates also have a vite.config.* file. + // We'll assume that it got caught by the Remix check above. if (configFiles.find((file) => file.startsWith("vite.config."))?.length) { - // We'll assume that if the project has an app dir, it's a Remix project. - // Otherwise, it's a Vite project. - // TODO: Maybe check for `@remix-run/react` in package.json? - type.framework = isUsingAppDir ? FRAMEWORKS["remix"] : FRAMEWORKS["vite"] + type.framework = FRAMEWORKS["vite"] return type } diff --git a/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.dockerignore b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.dockerignore new file mode 100644 index 00000000000..91077d0621d --- /dev/null +++ b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.dockerignore @@ -0,0 +1,7 @@ +/node_modules +*.log +.DS_Store +.env +/.cache +/public/build +/build diff --git a/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.env.example b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.env.example new file mode 100644 index 00000000000..0d0e0d65e4b --- /dev/null +++ b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.env.example @@ -0,0 +1,2 @@ +DATABASE_URL="file:./data.db?connection_limit=1" +SESSION_SECRET="super-duper-s3cret" diff --git a/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.eslintrc.js b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.eslintrc.js new file mode 100644 index 00000000000..9381f33520b --- /dev/null +++ b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.eslintrc.js @@ -0,0 +1,136 @@ +/** + * This is intended to be a basic starting point for linting in the Indie Stack. + * It relies on recommended configs out of the box for simplicity, but you can + * and should modify this configuration to best suit your team's needs. + */ + +/** @type {import('eslint').Linter.Config} */ +module.exports = { + root: true, + parserOptions: { + ecmaVersion: "latest", + sourceType: "module", + ecmaFeatures: { + jsx: true, + }, + }, + env: { + browser: true, + commonjs: true, + es6: true, + }, + + // Base config + extends: ["eslint:recommended"], + + overrides: [ + // React + { + files: ["**/*.{js,jsx,ts,tsx}"], + plugins: ["react", "jsx-a11y"], + extends: [ + "plugin:react/recommended", + "plugin:react/jsx-runtime", + "plugin:react-hooks/recommended", + "plugin:jsx-a11y/recommended", + "prettier", + ], + settings: { + react: { + version: "detect", + }, + formComponents: ["Form"], + linkComponents: [ + { name: "Link", linkAttribute: "to" }, + { name: "NavLink", linkAttribute: "to" }, + ], + }, + rules: { + "react/jsx-no-leaked-render": [ + "warn", + { validStrategies: ["ternary"] }, + ], + }, + }, + + // Typescript + { + files: ["**/*.{ts,tsx}"], + plugins: ["@typescript-eslint", "import"], + parser: "@typescript-eslint/parser", + settings: { + "import/internal-regex": "^~/", + "import/resolver": { + node: { + extensions: [".ts", ".tsx"], + }, + typescript: { + alwaysTryTypes: true, + }, + }, + }, + extends: [ + "plugin:@typescript-eslint/recommended", + "plugin:@typescript-eslint/stylistic", + "plugin:import/recommended", + "plugin:import/typescript", + "prettier", + ], + rules: { + "import/order": [ + "error", + { + alphabetize: { caseInsensitive: true, order: "asc" }, + groups: ["builtin", "external", "internal", "parent", "sibling"], + "newlines-between": "always", + }, + ], + }, + }, + + // Markdown + { + files: ["**/*.md"], + plugins: ["markdown"], + extends: ["plugin:markdown/recommended-legacy", "prettier"], + }, + + // Jest/Vitest + { + files: ["**/*.test.{js,jsx,ts,tsx}"], + plugins: ["jest", "jest-dom", "testing-library"], + extends: [ + "plugin:jest/recommended", + "plugin:jest-dom/recommended", + "plugin:testing-library/react", + "prettier", + ], + env: { + "jest/globals": true, + }, + settings: { + jest: { + // we're using vitest which has a very similar API to jest + // (so the linting plugins work nicely), but it means we have to explicitly + // set the jest version. + version: 28, + }, + }, + }, + + // Cypress + { + files: ["cypress/**/*.ts"], + plugins: ["cypress"], + extends: ["plugin:cypress/recommended", "prettier"], + }, + + // Node + { + files: [".eslintrc.js", "mocks/**/*.js"], + env: { + node: true, + }, + }, + ], +}; diff --git a/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.github/ISSUE_TEMPLATE/bug_report.yml b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 00000000000..55a66fb642b --- /dev/null +++ b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,41 @@ +name: 🐛 Bug Report +description: Something is wrong with the Stack. +body: + - type: markdown + attributes: + value: >- + Thank you for helping to improve Remix! + + Our bandwidth on maintaining these stacks is limited. As a team, we're + currently focusing our efforts on Remix itself. The good news is you can + fork and adjust this stack however you'd like and start using it today + as a custom stack. Learn more from + [the Remix Stacks docs](https://remix.run/stacks). + + If you'd still like to report a bug, please fill out this form. We can't + promise a timely response, but hopefully when we have the bandwidth to + work on these stacks again we can take a look. Thanks! + + - type: input + attributes: + label: Have you experienced this bug with the latest version of the template? + validations: + required: true + - type: textarea + attributes: + label: Steps to Reproduce + description: Steps to reproduce the behavior. + validations: + required: true + - type: textarea + attributes: + label: Expected Behavior + description: A concise description of what you expected to happen. + validations: + required: true + - type: textarea + attributes: + label: Actual Behavior + description: A concise description of what you're experiencing. + validations: + required: true diff --git a/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.github/ISSUE_TEMPLATE/config.yml b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 00000000000..da966200473 --- /dev/null +++ b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1,21 @@ +blank_issues_enabled: false +contact_links: + - name: Get Help + url: https://github.com/remix-run/remix/discussions/new?category=q-a + about: + If you can't get something to work the way you expect, open a question in + the Remix discussions. + - name: Feature Request + url: https://github.com/remix-run/remix/discussions/new?category=ideas + about: + We appreciate you taking the time to improve Remix with your ideas, but we + use the Remix Discussions for this instead of the issues tab 🙂. + - name: 💬 Remix Discord Channel + url: https://rmx.as/discord + about: Interact with other people using Remix 💿 + - name: 💬 New Updates (Twitter) + url: https://twitter.com/remix_run + about: Stay up to date with Remix news on twitter + - name: 🍿 Remix YouTube Channel + url: https://rmx.as/youtube + about: Are you a tech lead or wanting to learn more about Remix in depth? Checkout the Remix YouTube Channel diff --git a/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.github/PULL_REQUEST_TEMPLATE.md b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 00000000000..024f9d8e239 --- /dev/null +++ b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,14 @@ + diff --git a/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.github/dependabot.yml b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.github/dependabot.yml new file mode 100644 index 00000000000..253bcb76bad --- /dev/null +++ b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.github/dependabot.yml @@ -0,0 +1,6 @@ +version: 2 +updates: + - package-ecosystem: github-actions + directory: / + schedule: + interval: daily diff --git a/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.github/workflows/deploy.yml b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.github/workflows/deploy.yml new file mode 100644 index 00000000000..8f7ec3ce3f6 --- /dev/null +++ b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.github/workflows/deploy.yml @@ -0,0 +1,144 @@ +name: 🚀 Deploy + +on: + push: + branches: + - main + - dev + pull_request: + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +permissions: + actions: write + contents: read + +jobs: + lint: + name: ⬣ ESLint + runs-on: ubuntu-latest + steps: + - name: ⬇️ Checkout repo + uses: actions/checkout@v4 + + - name: ⎔ Setup node + uses: actions/setup-node@v4 + with: + cache: npm + cache-dependency-path: ./package.json + node-version: 18 + + - name: 📥 Install deps + run: npm install + + - name: 🔬 Lint + run: npm run lint + + typecheck: + name: ʦ TypeScript + runs-on: ubuntu-latest + steps: + - name: ⬇️ Checkout repo + uses: actions/checkout@v4 + + - name: ⎔ Setup node + uses: actions/setup-node@v4 + with: + cache: npm + cache-dependency-path: ./package.json + node-version: 18 + + - name: 📥 Install deps + run: npm install + + - name: 🔎 Type check + run: npm run typecheck --if-present + + vitest: + name: ⚡ Vitest + runs-on: ubuntu-latest + steps: + - name: ⬇️ Checkout repo + uses: actions/checkout@v4 + + - name: ⎔ Setup node + uses: actions/setup-node@v4 + with: + cache: npm + cache-dependency-path: ./package.json + node-version: 18 + + - name: 📥 Install deps + run: npm install + + - name: ⚡ Run vitest + run: npm run test -- --coverage + + cypress: + name: ⚫️ Cypress + runs-on: ubuntu-latest + steps: + - name: ⬇️ Checkout repo + uses: actions/checkout@v4 + + - name: 🏄 Copy test env vars + run: cp .env.example .env + + - name: ⎔ Setup node + uses: actions/setup-node@v4 + with: + cache: npm + cache-dependency-path: ./package.json + node-version: 18 + + - name: 📥 Install deps + run: npm install + + - name: 🛠 Setup Database + run: npx prisma migrate reset --force + + - name: ⚙️ Build + run: npm run build + + - name: 🌳 Cypress run + uses: cypress-io/github-action@v6 + with: + start: npm run start:mocks + wait-on: http://localhost:8811 + env: + PORT: 8811 + + deploy: + name: 🚀 Deploy + runs-on: ubuntu-latest + needs: [lint, typecheck, vitest, cypress] + # only deploy main/dev branch on pushes + if: ${{ (github.ref == 'refs/heads/main' || github.ref == 'refs/heads/dev') && github.event_name == 'push' }} + + steps: + - name: ⬇️ Checkout repo + uses: actions/checkout@v4 + + - name: 👀 Read app name + uses: SebRollen/toml-action@v1.2.0 + id: app_name + with: + file: fly.toml + field: app + + - name: 🎈 Setup Fly + uses: superfly/flyctl-actions/setup-flyctl@v1 + + - name: 🚀 Deploy Staging + if: ${{ github.ref == 'refs/heads/dev' }} + run: flyctl deploy --remote-only --build-arg COMMIT_SHA=${{ github.sha }} --app ${{ steps.app_name.outputs.value }}-staging + env: + FLY_API_TOKEN: ${{ secrets.FLY_API_TOKEN }} + + - name: 🚀 Deploy Production + if: ${{ github.ref == 'refs/heads/main' }} + run: flyctl deploy --remote-only --build-arg COMMIT_SHA=${{ github.sha }} --app ${{ steps.app_name.outputs.value }} + env: + FLY_API_TOKEN: ${{ secrets.FLY_API_TOKEN }} diff --git a/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.github/workflows/format-repo.yml b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.github/workflows/format-repo.yml new file mode 100644 index 00000000000..240b0eccf0b --- /dev/null +++ b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.github/workflows/format-repo.yml @@ -0,0 +1,46 @@ +name: 👔 Format + +on: + push: + branches: + - main + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +jobs: + format: + if: github.repository == 'remix-run/indie-stack' + runs-on: ubuntu-latest + + steps: + - name: ⬇️ Checkout repo + uses: actions/checkout@v4 + + - name: ⎔ Setup node + uses: actions/setup-node@v4 + with: + cache: npm + cache-dependency-path: ./package.json + node-version: 18 + + - name: 📥 Install deps + run: npm install + + - name: 👔 Format + run: npm run format:repo + + - name: 💪 Commit + run: | + git config --local user.email "github-actions[bot]@users.noreply.github.com" + git config --local user.name "github-actions[bot]" + + git add . + if [ -z "$(git status --porcelain)" ]; then + echo "💿 no formatting changed" + exit 0 + fi + git commit -m "chore: format" + git push + echo "💿 pushed formatting changes https://github.com/$GITHUB_REPOSITORY/commit/$(git rev-parse HEAD)" diff --git a/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.github/workflows/lint-repo.yml b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.github/workflows/lint-repo.yml new file mode 100644 index 00000000000..b2d38564dde --- /dev/null +++ b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.github/workflows/lint-repo.yml @@ -0,0 +1,33 @@ +name: ⬣ Lint repository + +on: + push: + branches: + - main + - dev + pull_request: + +concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true + +jobs: + lint: + name: ⬣ Lint repo + runs-on: ubuntu-latest + steps: + - name: ⬇️ Checkout repo + uses: actions/checkout@v4 + + - name: ⎔ Setup node + uses: actions/setup-node@v4 + with: + cache: npm + cache-dependency-path: ./package.json + node-version: 18 + + - name: 📥 Install deps + run: npm install + + - name: 🔬 Lint + run: npm run lint diff --git a/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.github/workflows/no-response.yml b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.github/workflows/no-response.yml new file mode 100644 index 00000000000..96426f67109 --- /dev/null +++ b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.github/workflows/no-response.yml @@ -0,0 +1,34 @@ +name: 🥺 No Response + +on: + schedule: + # Schedule for five minutes after the hour, every hour + - cron: "5 * * * *" + +permissions: + issues: write + pull-requests: write + +jobs: + stale: + if: github.repository == 'remix-run/indie-stack' + runs-on: ubuntu-latest + steps: + - name: 🥺 Handle Ghosting + uses: actions/stale@v9 + with: + days-before-close: 10 + close-issue-message: > + This issue has been automatically closed because we haven't received a + response from the original author 🙈. This automation helps keep the issue + tracker clean from issues that are unactionable. Please reach out if you + have more information for us! 🙂 + close-pr-message: > + This PR has been automatically closed because we haven't received a + response from the original author 🙈. This automation helps keep the issue + tracker clean from PRs that are unactionable. Please reach out if you + have more information for us! 🙂 + # don't automatically mark issues/PRs as stale + days-before-stale: -1 + stale-issue-label: needs-response + stale-pr-label: needs-response diff --git a/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.gitignore b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.gitignore new file mode 100644 index 00000000000..d5f63bb4432 --- /dev/null +++ b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.gitignore @@ -0,0 +1,18 @@ +# We don't want lockfiles in stacks, as people could use a different package manager +# This part will be removed by `remix.init` +bun.lockb +package-lock.json +pnpm-lock.yaml +pnpm-lock.yml +yarn.lock + +node_modules + +/build +/public/build +.env + +/cypress/screenshots +/cypress/videos +/prisma/data.db +/prisma/data.db-journal diff --git a/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.gitpod.Dockerfile b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.gitpod.Dockerfile new file mode 100644 index 00000000000..e52ca2d64b6 --- /dev/null +++ b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.gitpod.Dockerfile @@ -0,0 +1,9 @@ +FROM gitpod/workspace-full + +# Install Fly +RUN curl -L https://fly.io/install.sh | sh +ENV FLYCTL_INSTALL="/home/gitpod/.fly" +ENV PATH="$FLYCTL_INSTALL/bin:$PATH" + +# Install GitHub CLI +RUN brew install gh diff --git a/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.gitpod.yml b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.gitpod.yml new file mode 100644 index 00000000000..f07c56287f4 --- /dev/null +++ b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.gitpod.yml @@ -0,0 +1,48 @@ +# https://www.gitpod.io/docs/config-gitpod-file + +image: + file: .gitpod.Dockerfile + +ports: + - port: 3000 + onOpen: notify + +tasks: + - name: Restore .env file + command: | + if [ -f .env ]; then + # If this workspace already has a .env, don't override it + # Local changes survive a workspace being opened and closed + # but they will not persist between separate workspaces for the same repo + + echo "Found .env in workspace" + else + # There is no .env + if [ ! -n "${ENV}" ]; then + # There is no $ENV from a previous workspace + # Default to the example .env + echo "Setting example .env" + + cp .env.example .env + else + # After making changes to .env, run this line to persist it to $ENV + # eval $(gp env -e ENV="$(base64 .env | tr -d '\n')") + # + # Environment variables set this way are shared between all your workspaces for this repo + # The lines below will read $ENV and print a .env file + + echo "Restoring .env from Gitpod" + + echo "${ENV}" | base64 -d | tee .env > /dev/null + fi + fi + + - init: npm install + command: npm run setup && npm run dev + +vscode: + extensions: + - ms-azuretools.vscode-docker + - esbenp.prettier-vscode + - dbaeumer.vscode-eslint + - bradlc.vscode-tailwindcss diff --git a/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.npmrc b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.npmrc new file mode 100644 index 00000000000..521a9f7c077 --- /dev/null +++ b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.npmrc @@ -0,0 +1 @@ +legacy-peer-deps=true diff --git a/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.prettierignore b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.prettierignore new file mode 100644 index 00000000000..8cb6bcbdbb0 --- /dev/null +++ b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/.prettierignore @@ -0,0 +1,7 @@ +node_modules + +/build +/public/build +.env + +/app/styles/tailwind.css diff --git a/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/Dockerfile b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/Dockerfile new file mode 100644 index 00000000000..093ace785bf --- /dev/null +++ b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/Dockerfile @@ -0,0 +1,61 @@ +# base node image +FROM node:18-bullseye-slim as base + +# set for base and all layer that inherit from it +ENV NODE_ENV production + +# Install openssl for Prisma +RUN apt-get update && apt-get install -y openssl sqlite3 + +# Install all node_modules, including dev dependencies +FROM base as deps + +WORKDIR /myapp + +ADD package.json .npmrc ./ +RUN npm install --include=dev + +# Setup production node_modules +FROM base as production-deps + +WORKDIR /myapp + +COPY --from=deps /myapp/node_modules /myapp/node_modules +ADD package.json .npmrc ./ +RUN npm prune --omit=dev + +# Build the app +FROM base as build + +WORKDIR /myapp + +COPY --from=deps /myapp/node_modules /myapp/node_modules + +ADD prisma . +RUN npx prisma generate + +ADD . . +RUN npm run build + +# Finally, build the production image with minimal footprint +FROM base + +ENV DATABASE_URL=file:/data/sqlite.db +ENV PORT="8080" +ENV NODE_ENV="production" + +# add shortcut for connecting to database CLI +RUN echo "#!/bin/sh\nset -x\nsqlite3 \$DATABASE_URL" > /usr/local/bin/database-cli && chmod +x /usr/local/bin/database-cli + +WORKDIR /myapp + +COPY --from=production-deps /myapp/node_modules /myapp/node_modules +COPY --from=build /myapp/node_modules/.prisma /myapp/node_modules/.prisma + +COPY --from=build /myapp/build /myapp/build +COPY --from=build /myapp/public /myapp/public +COPY --from=build /myapp/package.json /myapp/package.json +COPY --from=build /myapp/start.sh /myapp/start.sh +COPY --from=build /myapp/prisma /myapp/prisma + +ENTRYPOINT [ "./start.sh" ] diff --git a/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/LICENSE.md b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/LICENSE.md new file mode 100644 index 00000000000..8ed8d952958 --- /dev/null +++ b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/LICENSE.md @@ -0,0 +1,22 @@ +MIT License + +Copyright (c) Remix Software Inc. 2021 +Copyright (c) Shopify Inc. 2022-2023 + +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. diff --git a/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/README.md b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/README.md new file mode 100644 index 00000000000..fa24ab98b38 --- /dev/null +++ b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/README.md @@ -0,0 +1,183 @@ +# Remix Indie Stack + +![The Remix Indie Stack](https://repository-images.githubusercontent.com/465928257/a241fa49-bd4d-485a-a2a5-5cb8e4ee0abf) + +Learn more about [Remix Stacks](https://remix.run/stacks). + +```sh +npx create-remix@latest --template remix-run/indie-stack +``` + +## What's in the stack + +- [Fly app deployment](https://fly.io) with [Docker](https://www.docker.com/) +- Production-ready [SQLite Database](https://sqlite.org) +- Healthcheck endpoint for [Fly backups region fallbacks](https://fly.io/docs/reference/configuration/#services-http_checks) +- [GitHub Actions](https://github.com/features/actions) for deploy on merge to production and staging environments +- Email/Password Authentication with [cookie-based sessions](https://remix.run/utils/sessions#md-createcookiesessionstorage) +- Database ORM with [Prisma](https://prisma.io) +- Styling with [Tailwind](https://tailwindcss.com/) +- End-to-end testing with [Cypress](https://cypress.io) +- Local third party request mocking with [MSW](https://mswjs.io) +- Unit testing with [Vitest](https://vitest.dev) and [Testing Library](https://testing-library.com) +- Code formatting with [Prettier](https://prettier.io) +- Linting with [ESLint](https://eslint.org) +- Static Types with [TypeScript](https://typescriptlang.org) + +Not a fan of bits of the stack? Fork it, change it, and use `npx create-remix --template your/repo`! Make it your own. + +## Quickstart + +Click this button to create a [Gitpod](https://gitpod.io) workspace with the project set up and Fly pre-installed + +[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/remix-run/indie-stack/tree/main) + +## Development + +- First run this stack's `remix.init` script and commit the changes it makes to your project. + + ```sh + npx remix init + git init # if you haven't already + git add . + git commit -m "Initialize project" + ``` + +- Initial setup: + + ```sh + npm run setup + ``` + +- Start dev server: + + ```sh + npm run dev + ``` + +This starts your app in development mode, rebuilding assets on file changes. + +The database seed script creates a new user with some data you can use to get started: + +- Email: `rachel@remix.run` +- Password: `racheliscool` + +### Relevant code: + +This is a pretty simple note-taking app, but it's a good example of how you can build a full stack app with Prisma and Remix. The main functionality is creating users, logging in and out, and creating and deleting notes. + +- creating users, and logging in and out [./app/models/user.server.ts](app/models/user.server.ts) +- user sessions, and verifying them [./app/session.server.ts](app/session.server.ts) +- creating, and deleting notes [./app/models/note.server.ts](app/models/note.server.ts) + +## Deployment + +This Remix Stack comes with two GitHub Actions that handle automatically deploying your app to production and staging environments. + +Prior to your first deployment, you'll need to do a few things: + +- [Install Fly](https://fly.io/docs/getting-started/installing-flyctl/) + +- Sign up and log in to Fly + + ```sh + fly auth signup + ``` + + > **Note:** If you have more than one Fly account, ensure that you are signed into the same account in the Fly CLI as you are in the browser. In your terminal, run `fly auth whoami` and ensure the email matches the Fly account signed into the browser. + +- Create two apps on Fly, one for staging and one for production: + + ```sh + fly apps create indie-stack-template + fly apps create indie-stack-template-staging + ``` + + > **Note:** Make sure this name matches the `app` set in your `fly.toml` file. Otherwise, you will not be able to deploy. + + - Initialize Git. + + ```sh + git init + ``` + +- Create a new [GitHub Repository](https://repo.new), and then add it as the remote for your project. **Do not push your app yet!** + + ```sh + git remote add origin + ``` + +- Add a `FLY_API_TOKEN` to your GitHub repo. To do this, go to your user settings on Fly and create a new [token](https://web.fly.io/user/personal_access_tokens/new), then add it to [your repo secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets) with the name `FLY_API_TOKEN`. + +- Add a `SESSION_SECRET` to your fly app secrets, to do this you can run the following commands: + + ```sh + fly secrets set SESSION_SECRET=$(openssl rand -hex 32) --app indie-stack-template + fly secrets set SESSION_SECRET=$(openssl rand -hex 32) --app indie-stack-template-staging + ``` + + If you don't have openssl installed, you can also use [1Password](https://1password.com/password-generator) to generate a random secret, just replace `$(openssl rand -hex 32)` with the generated secret. + +- Create a persistent volume for the sqlite database for both your staging and production environments. Run the following: + + ```sh + fly volumes create data --size 1 --app indie-stack-template + fly volumes create data --size 1 --app indie-stack-template-staging + ``` + +Now that everything is set up you can commit and push your changes to your repo. Every commit to your `main` branch will trigger a deployment to your production environment, and every commit to your `dev` branch will trigger a deployment to your staging environment. + +### Connecting to your database + +The sqlite database lives at `/data/sqlite.db` in your deployed application. You can connect to the live database by running `fly ssh console -C database-cli`. + +### Getting Help with Deployment + +If you run into any issues deploying to Fly, make sure you've followed all of the steps above and if you have, then post as many details about your deployment (including your app name) to [the Fly support community](https://community.fly.io). They're normally pretty responsive over there and hopefully can help resolve any of your deployment issues and questions. + +## GitHub Actions + +We use GitHub Actions for continuous integration and deployment. Anything that gets into the `main` branch will be deployed to production after running tests/build/etc. Anything in the `dev` branch will be deployed to staging. + +## Testing + +### Cypress + +We use Cypress for our End-to-End tests in this project. You'll find those in the `cypress` directory. As you make changes, add to an existing file or create a new file in the `cypress/e2e` directory to test your changes. + +We use [`@testing-library/cypress`](https://testing-library.com/cypress) for selecting elements on the page semantically. + +To run these tests in development, run `npm run test:e2e:dev` which will start the dev server for the app as well as the Cypress client. Make sure the database is running in docker as described above. + +We have a utility for testing authenticated features without having to go through the login flow: + +```ts +cy.login(); +// you are now logged in as a new user +``` + +We also have a utility to auto-delete the user at the end of your test. Just make sure to add this in each test file: + +```ts +afterEach(() => { + cy.cleanupUser(); +}); +``` + +That way, we can keep your local db clean and keep your tests isolated from one another. + +### Vitest + +For lower level tests of utilities and individual components, we use `vitest`. We have DOM-specific assertion helpers via [`@testing-library/jest-dom`](https://testing-library.com/jest-dom). + +### Type Checking + +This project uses TypeScript. It's recommended to get TypeScript set up for your editor to get a really great in-editor experience with type checking and auto-complete. To run type checking across the whole project, run `npm run typecheck`. + +### Linting + +This project uses ESLint for linting. That is configured in `.eslintrc.js`. + +### Formatting + +We use [Prettier](https://prettier.io/) for auto-formatting in this project. It's recommended to install an editor plugin (like the [VSCode Prettier plugin](https://marketplace.visualstudio.com/items?itemName=esbenp.prettier-vscode)) to get auto-formatting on save. There's also a `npm run format` script you can run to format all files in the project. diff --git a/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/db.server.ts b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/db.server.ts new file mode 100644 index 00000000000..ac5701faa51 --- /dev/null +++ b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/db.server.ts @@ -0,0 +1,9 @@ +import { PrismaClient } from "@prisma/client"; + +import { singleton } from "./singleton.server"; + +// Hard-code a unique key, so we can look up the client when this module gets re-imported +const prisma = singleton("prisma", () => new PrismaClient()); +prisma.$connect(); + +export { prisma }; diff --git a/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/entry.client.tsx b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/entry.client.tsx new file mode 100644 index 00000000000..186cd934498 --- /dev/null +++ b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/entry.client.tsx @@ -0,0 +1,18 @@ +/** + * By default, Remix will handle hydrating your app on the client for you. + * You are free to delete this file if you'd like to, but if you ever want it revealed again, you can run `npx remix reveal` ✨ + * For more information, see https://remix.run/docs/en/main/file-conventions/entry.client + */ + +import { RemixBrowser } from "@remix-run/react"; +import { startTransition, StrictMode } from "react"; +import { hydrateRoot } from "react-dom/client"; + +startTransition(() => { + hydrateRoot( + document, + + + , + ); +}); diff --git a/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/entry.server.tsx b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/entry.server.tsx new file mode 100644 index 00000000000..78d4f1e2408 --- /dev/null +++ b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/entry.server.tsx @@ -0,0 +1,120 @@ +/** + * By default, Remix will handle generating the HTTP Response for you. + * You are free to delete this file if you'd like to, but if you ever want it revealed again, you can run `npx remix reveal` ✨ + * For more information, see https://remix.run/docs/en/main/file-conventions/entry.server + */ + +import { PassThrough } from "node:stream"; + +import type { EntryContext } from "@remix-run/node"; +import { createReadableStreamFromReadable } from "@remix-run/node"; +import { RemixServer } from "@remix-run/react"; +import { isbot } from "isbot"; +import { renderToPipeableStream } from "react-dom/server"; + +const ABORT_DELAY = 5_000; + +export default function handleRequest( + request: Request, + responseStatusCode: number, + responseHeaders: Headers, + remixContext: EntryContext, +) { + return isbot(request.headers.get("user-agent")) + ? handleBotRequest( + request, + responseStatusCode, + responseHeaders, + remixContext, + ) + : handleBrowserRequest( + request, + responseStatusCode, + responseHeaders, + remixContext, + ); +} + +function handleBotRequest( + request: Request, + responseStatusCode: number, + responseHeaders: Headers, + remixContext: EntryContext, +) { + return new Promise((resolve, reject) => { + const { abort, pipe } = renderToPipeableStream( + , + { + onAllReady() { + const body = new PassThrough(); + + responseHeaders.set("Content-Type", "text/html"); + + resolve( + new Response(createReadableStreamFromReadable(body), { + headers: responseHeaders, + status: responseStatusCode, + }), + ); + + pipe(body); + }, + onShellError(error: unknown) { + reject(error); + }, + onError(error: unknown) { + responseStatusCode = 500; + console.error(error); + }, + }, + ); + + setTimeout(abort, ABORT_DELAY); + }); +} + +function handleBrowserRequest( + request: Request, + responseStatusCode: number, + responseHeaders: Headers, + remixContext: EntryContext, +) { + return new Promise((resolve, reject) => { + const { abort, pipe } = renderToPipeableStream( + , + { + onShellReady() { + const body = new PassThrough(); + + responseHeaders.set("Content-Type", "text/html"); + + resolve( + new Response(createReadableStreamFromReadable(body), { + headers: responseHeaders, + status: responseStatusCode, + }), + ); + + pipe(body); + }, + onShellError(error: unknown) { + reject(error); + }, + onError(error: unknown) { + console.error(error); + responseStatusCode = 500; + }, + }, + ); + + setTimeout(abort, ABORT_DELAY); + }); +} diff --git a/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/models/note.server.ts b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/models/note.server.ts new file mode 100644 index 00000000000..f385491a2ff --- /dev/null +++ b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/models/note.server.ts @@ -0,0 +1,52 @@ +import type { User, Note } from "@prisma/client"; + +import { prisma } from "~/db.server"; + +export function getNote({ + id, + userId, +}: Pick & { + userId: User["id"]; +}) { + return prisma.note.findFirst({ + select: { id: true, body: true, title: true }, + where: { id, userId }, + }); +} + +export function getNoteListItems({ userId }: { userId: User["id"] }) { + return prisma.note.findMany({ + where: { userId }, + select: { id: true, title: true }, + orderBy: { updatedAt: "desc" }, + }); +} + +export function createNote({ + body, + title, + userId, +}: Pick & { + userId: User["id"]; +}) { + return prisma.note.create({ + data: { + title, + body, + user: { + connect: { + id: userId, + }, + }, + }, + }); +} + +export function deleteNote({ + id, + userId, +}: Pick & { userId: User["id"] }) { + return prisma.note.deleteMany({ + where: { id, userId }, + }); +} diff --git a/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/models/user.server.ts b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/models/user.server.ts new file mode 100644 index 00000000000..42be9b7fbe3 --- /dev/null +++ b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/models/user.server.ts @@ -0,0 +1,63 @@ +import type { Password, User } from "@prisma/client"; +import bcrypt from "bcryptjs"; + +import { prisma } from "~/db.server"; + +export type { User } from "@prisma/client"; + +export async function getUserById(id: User["id"]) { + return prisma.user.findUnique({ where: { id } }); +} + +export async function getUserByEmail(email: User["email"]) { + return prisma.user.findUnique({ where: { email } }); +} + +export async function createUser(email: User["email"], password: string) { + const hashedPassword = await bcrypt.hash(password, 10); + + return prisma.user.create({ + data: { + email, + password: { + create: { + hash: hashedPassword, + }, + }, + }, + }); +} + +export async function deleteUserByEmail(email: User["email"]) { + return prisma.user.delete({ where: { email } }); +} + +export async function verifyLogin( + email: User["email"], + password: Password["hash"], +) { + const userWithPassword = await prisma.user.findUnique({ + where: { email }, + include: { + password: true, + }, + }); + + if (!userWithPassword || !userWithPassword.password) { + return null; + } + + const isValid = await bcrypt.compare( + password, + userWithPassword.password.hash, + ); + + if (!isValid) { + return null; + } + + // eslint-disable-next-line @typescript-eslint/no-unused-vars + const { password: _password, ...userWithoutPassword } = userWithPassword; + + return userWithoutPassword; +} diff --git a/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/root.tsx b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/root.tsx new file mode 100644 index 00000000000..426fac3533c --- /dev/null +++ b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/root.tsx @@ -0,0 +1,42 @@ +import { cssBundleHref } from "@remix-run/css-bundle"; +import type { LinksFunction, LoaderFunctionArgs } from "@remix-run/node"; +import { json } from "@remix-run/node"; +import { + Links, + LiveReload, + Meta, + Outlet, + Scripts, + ScrollRestoration, +} from "@remix-run/react"; + +import { getUser } from "~/session.server"; +import stylesheet from "~/tailwind.css"; + +export const links: LinksFunction = () => [ + { rel: "stylesheet", href: stylesheet }, + ...(cssBundleHref ? [{ rel: "stylesheet", href: cssBundleHref }] : []), +]; + +export const loader = async ({ request }: LoaderFunctionArgs) => { + return json({ user: await getUser(request) }); +}; + +export default function App() { + return ( + + + + + + + + + + + + + + + ); +} diff --git a/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/routes/_index.tsx b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/routes/_index.tsx new file mode 100644 index 00000000000..d266ff726eb --- /dev/null +++ b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/routes/_index.tsx @@ -0,0 +1,141 @@ +import type { MetaFunction } from "@remix-run/node"; +import { Link } from "@remix-run/react"; + +import { useOptionalUser } from "~/utils"; + +export const meta: MetaFunction = () => [{ title: "Remix Notes" }]; + +export default function Index() { + const user = useOptionalUser(); + return ( +
+
+
+
+
+ Sonic Youth On Stage +
+
+
+

+ + Indie Stack + +

+

+ Check the README.md file for instructions on how to get this + project deployed. +

+
+ {user ? ( + + View Notes for {user.email} + + ) : ( +
+ + Sign up + + + Log In + +
+ )} +
+ + Remix + +
+
+
+ +
+
+ {[ + { + src: "https://user-images.githubusercontent.com/1500684/157764397-ccd8ea10-b8aa-4772-a99b-35de937319e1.svg", + alt: "Fly.io", + href: "https://fly.io", + }, + { + src: "https://user-images.githubusercontent.com/1500684/157764395-137ec949-382c-43bd-a3c0-0cb8cb22e22d.svg", + alt: "SQLite", + href: "https://sqlite.org", + }, + { + src: "https://user-images.githubusercontent.com/1500684/157764484-ad64a21a-d7fb-47e3-8669-ec046da20c1f.svg", + alt: "Prisma", + href: "https://prisma.io", + }, + { + src: "https://user-images.githubusercontent.com/1500684/157764276-a516a239-e377-4a20-b44a-0ac7b65c8c14.svg", + alt: "Tailwind", + href: "https://tailwindcss.com", + }, + { + src: "https://user-images.githubusercontent.com/1500684/157764454-48ac8c71-a2a9-4b5e-b19c-edef8b8953d6.svg", + alt: "Cypress", + href: "https://www.cypress.io", + }, + { + src: "https://user-images.githubusercontent.com/1500684/157772386-75444196-0604-4340-af28-53b236faa182.svg", + alt: "MSW", + href: "https://mswjs.io", + }, + { + src: "https://user-images.githubusercontent.com/1500684/157772447-00fccdce-9d12-46a3-8bb4-fac612cdc949.svg", + alt: "Vitest", + href: "https://vitest.dev", + }, + { + src: "https://user-images.githubusercontent.com/1500684/157772662-92b0dd3a-453f-4d18-b8be-9fa6efde52cf.png", + alt: "Testing Library", + href: "https://testing-library.com", + }, + { + src: "https://user-images.githubusercontent.com/1500684/157772934-ce0a943d-e9d0-40f8-97f3-f464c0811643.svg", + alt: "Prettier", + href: "https://prettier.io", + }, + { + src: "https://user-images.githubusercontent.com/1500684/157772990-3968ff7c-b551-4c55-a25c-046a32709a8e.svg", + alt: "ESLint", + href: "https://eslint.org", + }, + { + src: "https://user-images.githubusercontent.com/1500684/157773063-20a0ed64-b9f8-4e0b-9d1e-0b65a3d4a6db.svg", + alt: "TypeScript", + href: "https://typescriptlang.org", + }, + ].map((img) => ( + + {img.alt} + + ))} +
+
+
+
+ ); +} diff --git a/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/routes/healthcheck.tsx b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/routes/healthcheck.tsx new file mode 100644 index 00000000000..53168b88299 --- /dev/null +++ b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/routes/healthcheck.tsx @@ -0,0 +1,25 @@ +// learn more: https://fly.io/docs/reference/configuration/#services-http_checks +import type { LoaderFunctionArgs } from "@remix-run/node"; + +import { prisma } from "~/db.server"; + +export const loader = async ({ request }: LoaderFunctionArgs) => { + const host = + request.headers.get("X-Forwarded-Host") ?? request.headers.get("host"); + + try { + const url = new URL("/", `http://${host}`); + // if we can connect to the database and make a simple query + // and make a HEAD request to ourselves, then we're good. + await Promise.all([ + prisma.user.count(), + fetch(url.toString(), { method: "HEAD" }).then((r) => { + if (!r.ok) return Promise.reject(r); + }), + ]); + return new Response("OK"); + } catch (error: unknown) { + console.log("healthcheck ❌", { error }); + return new Response("ERROR", { status: 500 }); + } +}; diff --git a/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/routes/join.tsx b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/routes/join.tsx new file mode 100644 index 00000000000..f1ea5660686 --- /dev/null +++ b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/routes/join.tsx @@ -0,0 +1,171 @@ +import type { + ActionFunctionArgs, + LoaderFunctionArgs, + MetaFunction, +} from "@remix-run/node"; +import { json, redirect } from "@remix-run/node"; +import { Form, Link, useActionData, useSearchParams } from "@remix-run/react"; +import { useEffect, useRef } from "react"; + +import { createUser, getUserByEmail } from "~/models/user.server"; +import { createUserSession, getUserId } from "~/session.server"; +import { safeRedirect, validateEmail } from "~/utils"; + +export const loader = async ({ request }: LoaderFunctionArgs) => { + const userId = await getUserId(request); + if (userId) return redirect("/"); + return json({}); +}; + +export const action = async ({ request }: ActionFunctionArgs) => { + const formData = await request.formData(); + const email = formData.get("email"); + const password = formData.get("password"); + const redirectTo = safeRedirect(formData.get("redirectTo"), "/"); + + if (!validateEmail(email)) { + return json( + { errors: { email: "Email is invalid", password: null } }, + { status: 400 }, + ); + } + + if (typeof password !== "string" || password.length === 0) { + return json( + { errors: { email: null, password: "Password is required" } }, + { status: 400 }, + ); + } + + if (password.length < 8) { + return json( + { errors: { email: null, password: "Password is too short" } }, + { status: 400 }, + ); + } + + const existingUser = await getUserByEmail(email); + if (existingUser) { + return json( + { + errors: { + email: "A user already exists with this email", + password: null, + }, + }, + { status: 400 }, + ); + } + + const user = await createUser(email, password); + + return createUserSession({ + redirectTo, + remember: false, + request, + userId: user.id, + }); +}; + +export const meta: MetaFunction = () => [{ title: "Sign Up" }]; + +export default function Join() { + const [searchParams] = useSearchParams(); + const redirectTo = searchParams.get("redirectTo") ?? undefined; + const actionData = useActionData(); + const emailRef = useRef(null); + const passwordRef = useRef(null); + + useEffect(() => { + if (actionData?.errors?.email) { + emailRef.current?.focus(); + } else if (actionData?.errors?.password) { + passwordRef.current?.focus(); + } + }, [actionData]); + + return ( +
+
+
+
+ +
+ + {actionData?.errors?.email ? ( +
+ {actionData.errors.email} +
+ ) : null} +
+
+ +
+ +
+ + {actionData?.errors?.password ? ( +
+ {actionData.errors.password} +
+ ) : null} +
+
+ + + +
+
+ Already have an account?{" "} + + Log in + +
+
+
+
+
+ ); +} diff --git a/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/routes/login.tsx b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/routes/login.tsx new file mode 100644 index 00000000000..c61981c81fa --- /dev/null +++ b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/routes/login.tsx @@ -0,0 +1,180 @@ +import type { + ActionFunctionArgs, + LoaderFunctionArgs, + MetaFunction, +} from "@remix-run/node"; +import { json, redirect } from "@remix-run/node"; +import { Form, Link, useActionData, useSearchParams } from "@remix-run/react"; +import { useEffect, useRef } from "react"; + +import { verifyLogin } from "~/models/user.server"; +import { createUserSession, getUserId } from "~/session.server"; +import { safeRedirect, validateEmail } from "~/utils"; + +export const loader = async ({ request }: LoaderFunctionArgs) => { + const userId = await getUserId(request); + if (userId) return redirect("/"); + return json({}); +}; + +export const action = async ({ request }: ActionFunctionArgs) => { + const formData = await request.formData(); + const email = formData.get("email"); + const password = formData.get("password"); + const redirectTo = safeRedirect(formData.get("redirectTo"), "/"); + const remember = formData.get("remember"); + + if (!validateEmail(email)) { + return json( + { errors: { email: "Email is invalid", password: null } }, + { status: 400 }, + ); + } + + if (typeof password !== "string" || password.length === 0) { + return json( + { errors: { email: null, password: "Password is required" } }, + { status: 400 }, + ); + } + + if (password.length < 8) { + return json( + { errors: { email: null, password: "Password is too short" } }, + { status: 400 }, + ); + } + + const user = await verifyLogin(email, password); + + if (!user) { + return json( + { errors: { email: "Invalid email or password", password: null } }, + { status: 400 }, + ); + } + + return createUserSession({ + redirectTo, + remember: remember === "on" ? true : false, + request, + userId: user.id, + }); +}; + +export const meta: MetaFunction = () => [{ title: "Login" }]; + +export default function LoginPage() { + const [searchParams] = useSearchParams(); + const redirectTo = searchParams.get("redirectTo") || "/notes"; + const actionData = useActionData(); + const emailRef = useRef(null); + const passwordRef = useRef(null); + + useEffect(() => { + if (actionData?.errors?.email) { + emailRef.current?.focus(); + } else if (actionData?.errors?.password) { + passwordRef.current?.focus(); + } + }, [actionData]); + + return ( +
+
+
+
+ +
+ + {actionData?.errors?.email ? ( +
+ {actionData.errors.email} +
+ ) : null} +
+
+ +
+ +
+ + {actionData?.errors?.password ? ( +
+ {actionData.errors.password} +
+ ) : null} +
+
+ + + +
+
+ + +
+
+ Don't have an account?{" "} + + Sign up + +
+
+
+
+
+ ); +} diff --git a/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/routes/logout.tsx b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/routes/logout.tsx new file mode 100644 index 00000000000..1ee2c8a97d5 --- /dev/null +++ b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/routes/logout.tsx @@ -0,0 +1,9 @@ +import type { ActionFunctionArgs } from "@remix-run/node"; +import { redirect } from "@remix-run/node"; + +import { logout } from "~/session.server"; + +export const action = async ({ request }: ActionFunctionArgs) => + logout(request); + +export const loader = async () => redirect("/"); diff --git a/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/routes/notes.$noteId.tsx b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/routes/notes.$noteId.tsx new file mode 100644 index 00000000000..3edd6ff2604 --- /dev/null +++ b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/routes/notes.$noteId.tsx @@ -0,0 +1,70 @@ +import type { ActionFunctionArgs, LoaderFunctionArgs } from "@remix-run/node"; +import { json, redirect } from "@remix-run/node"; +import { + Form, + isRouteErrorResponse, + useLoaderData, + useRouteError, +} from "@remix-run/react"; +import invariant from "tiny-invariant"; + +import { deleteNote, getNote } from "~/models/note.server"; +import { requireUserId } from "~/session.server"; + +export const loader = async ({ params, request }: LoaderFunctionArgs) => { + const userId = await requireUserId(request); + invariant(params.noteId, "noteId not found"); + + const note = await getNote({ id: params.noteId, userId }); + if (!note) { + throw new Response("Not Found", { status: 404 }); + } + return json({ note }); +}; + +export const action = async ({ params, request }: ActionFunctionArgs) => { + const userId = await requireUserId(request); + invariant(params.noteId, "noteId not found"); + + await deleteNote({ id: params.noteId, userId }); + + return redirect("/notes"); +}; + +export default function NoteDetailsPage() { + const data = useLoaderData(); + + return ( +
+

{data.note.title}

+

{data.note.body}

+
+
+ +
+
+ ); +} + +export function ErrorBoundary() { + const error = useRouteError(); + + if (error instanceof Error) { + return
An unexpected error occurred: {error.message}
; + } + + if (!isRouteErrorResponse(error)) { + return

Unknown Error

; + } + + if (error.status === 404) { + return
Note not found
; + } + + return
An unexpected error occurred: {error.statusText}
; +} diff --git a/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/routes/notes._index.tsx b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/routes/notes._index.tsx new file mode 100644 index 00000000000..aa858a994d7 --- /dev/null +++ b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/routes/notes._index.tsx @@ -0,0 +1,12 @@ +import { Link } from "@remix-run/react"; + +export default function NoteIndexPage() { + return ( +

+ No note selected. Select a note on the left, or{" "} + + create a new note. + +

+ ); +} diff --git a/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/routes/notes.new.tsx b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/routes/notes.new.tsx new file mode 100644 index 00000000000..48dd52de7f4 --- /dev/null +++ b/packages/shadcn/test/fixtures/frameworks/remix-indie-stack/app/routes/notes.new.tsx @@ -0,0 +1,109 @@ +import type { ActionFunctionArgs } from "@remix-run/node"; +import { json, redirect } from "@remix-run/node"; +import { Form, useActionData } from "@remix-run/react"; +import { useEffect, useRef } from "react"; + +import { createNote } from "~/models/note.server"; +import { requireUserId } from "~/session.server"; + +export const action = async ({ request }: ActionFunctionArgs) => { + const userId = await requireUserId(request); + + const formData = await request.formData(); + const title = formData.get("title"); + const body = formData.get("body"); + + if (typeof title !== "string" || title.length === 0) { + return json( + { errors: { body: null, title: "Title is required" } }, + { status: 400 }, + ); + } + + if (typeof body !== "string" || body.length === 0) { + return json( + { errors: { body: "Body is required", title: null } }, + { status: 400 }, + ); + } + + const note = await createNote({ body, title, userId }); + + return redirect(`/notes/${note.id}`); +}; + +export default function NewNotePage() { + const actionData = useActionData(); + const titleRef = useRef(null); + const bodyRef = useRef(null); + + useEffect(() => { + if (actionData?.errors?.title) { + titleRef.current?.focus(); + } else if (actionData?.errors?.body) { + bodyRef.current?.focus(); + } + }, [actionData]); + + return ( +
+
+ + {actionData?.errors?.title ? ( +
+ {actionData.errors.title} +
+ ) : null} +
+ +
+