From a2ce6f77b6cc1e0b245fcadbd1027ddaac1da240 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Micha=C3=ABl=20De=20Boey?= Date: Tue, 21 Jun 2022 02:09:55 +0200 Subject: [PATCH] chore: use short JSDOC type notation in configs (#3482) --- docs/api/conventions.md | 10 +++------- docs/guides/migrating-react-router-app.md | 1 + docs/pages/gotchas.md | 1 + docs/prettier.config.js | 4 +--- examples/basic/remix.config.js | 4 +--- examples/blog-tutorial/remix.config.js | 4 +--- examples/bullmq-task-queue/remix.config.js | 4 +--- examples/catch-boundary/remix.config.js | 4 +--- examples/chakra-ui/remix.config.js | 4 +--- examples/client-only-components/remix.config.js | 4 +--- examples/client-side-validation/remix.config.js | 4 +--- examples/collected-notes/remix.config.js | 4 +--- examples/combobox-resource-route/remix.config.js | 4 +--- examples/dark-mode/remix.config.js | 4 +--- examples/dataloader/remix.config.js | 4 +--- examples/emotion/remix.config.js | 4 +--- examples/file-and-cloudinary-upload/remix.config.js | 4 +--- examples/firebase-auth-firestore/remix.config.js | 4 +--- examples/form-to-notion-db/remix.config.js | 4 +--- examples/framer-motion/remix.config.js | 4 +--- examples/framer-route-animation/remix.config.js | 4 +--- examples/gdpr-cookie-consent/remix.config.js | 4 +--- examples/google-analytics/remix.config.js | 4 +--- examples/graphql-api/remix.config.js | 4 +--- examples/image-resize/remix.config.js | 4 +--- examples/infinite-scrolling/remix.config.js | 4 +--- examples/io-ts-formdata-decoding/remix.config.js | 4 +--- examples/ioredis/remix.config.js | 4 +--- examples/jokes/remix.config.js | 4 +--- examples/mantine/remix.config.js | 4 +--- examples/msw/remix.config.js | 4 +--- examples/multiple-forms/remix.config.js | 4 +--- examples/multiple-params/remix.config.js | 4 +--- examples/newsletter-signup/remix.config.js | 4 +--- examples/nprogress/remix.config.js | 4 +--- examples/on-demand-hydration/remix.config.js | 4 +--- examples/outlet-form-rerender/remix.config.js | 4 +--- examples/pathless-routes/remix.config.js | 4 +--- examples/pm-app/remix.config.js | 4 +--- examples/quirrel/remix.config.js | 4 +--- examples/react-spring/remix.config.js | 4 +--- examples/redis-upstash-session/remix.config.js | 4 +--- examples/remix-auth-auth0/remix.config.js | 4 +--- examples/remix-auth-form/remix.config.js | 4 +--- examples/remix-auth-github/remix.config.js | 4 +--- examples/remix-auth-supabase-github/remix.config.js | 4 +--- examples/remix-auth-supabase/remix.config.js | 4 +--- examples/route-modal/remix.config.js | 4 +--- examples/routes-gen/remix.config.js | 4 +--- examples/rust/remix.config.js | 4 +--- examples/sanity/remix.config.js | 4 +--- examples/sass/remix.config.js | 4 +--- examples/search-input/remix.config.js | 4 +--- examples/session-flash/remix.config.js | 4 +--- examples/sharing-loader-data/remix.config.js | 4 +--- examples/socket.io/remix.config.js | 4 +--- examples/stitches/remix.config.js | 4 +--- examples/strapi/remix.config.js | 4 +--- examples/stripe-integration/remix.config.js | 4 +--- examples/styled-components/remix.config.js | 4 +--- examples/styletron/remix.config.js | 4 +--- examples/supabase-subscription/remix.config.js | 4 +--- examples/tailwindcss/remix.config.js | 4 +--- examples/template/remix.config.js | 4 +--- examples/tiptap-collab-editing/remix.config.js | 4 +--- examples/toast-message/remix.config.js | 4 +--- .../turborepo-vercel/apps/remix-app/remix.config.js | 4 +--- examples/twind/remix.config.js | 4 +--- examples/usematches-loader-data/remix.config.js | 4 +--- integration/helpers/cf-template/remix.config.js | 4 +--- integration/helpers/deno-template/remix.config.js | 1 + integration/helpers/node-template/remix.config.js | 4 +--- .../fixtures/replace-remix-imports/remix.config.js | 4 +--- .../remix-dev/__tests__/fixtures/stack/remix.config.js | 4 +--- packages/remix-eslint-config/index.js | 4 +--- prettier.config.js | 4 +--- scripts/playground/template/remix.config.js | 4 +--- templates/arc/remix.config.js | 4 +--- templates/cloudflare-pages/remix.config.js | 4 +--- templates/cloudflare-workers/remix.config.js | 4 +--- templates/deno/remix.config.js | 1 + templates/express/remix.config.js | 4 +--- templates/fly/remix.config.js | 4 +--- templates/netlify/remix.config.js | 4 +--- templates/remix/remix.config.js | 4 +--- templates/vercel/remix.config.js | 4 +--- 86 files changed, 88 insertions(+), 250 deletions(-) diff --git a/docs/api/conventions.md b/docs/api/conventions.md index e306793366b..7d658f36da9 100644 --- a/docs/api/conventions.md +++ b/docs/api/conventions.md @@ -12,9 +12,7 @@ A lot of Remix APIs aren't imported from the `"@remix-run/*"` packages, but are This file has a few build and development configuration options, but does not actually run on your server. ```tsx filename=remix.config.js -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { appDirectory: "app", assetsBuildDirectory: "public/build", @@ -143,10 +141,8 @@ A list of regex patterns that determines if a module is transpiled and included For example, the `unified` ecosystem is all ESM-only. Let's also say we're using a `@sindresorhus/slugify` which is ESM-only as well. Here's how you would be able to consume those packages in a CJS app without having to use dynamic imports: -```ts filename=remix.config.js lines=[10-15] -/** - * @type {import('@remix-run/dev').AppConfig} - */ +```ts filename=remix.config.js lines=[8-13] +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { appDirectory: "app", assetsBuildDirectory: "public/build", diff --git a/docs/guides/migrating-react-router-app.md b/docs/guides/migrating-react-router-app.md index a9e119cade4..d279c64ea8c 100644 --- a/docs/guides/migrating-react-router-app.md +++ b/docs/guides/migrating-react-router-app.md @@ -332,6 +332,7 @@ Further configuration is optional, but the following may be helpful to optimize Every Remix app accepts a `remix.config.js` file in the project root. While its settings are optional, we recommend you include a few of them for clarity's sake. See the [docs on configuration][docs-on-configuration] for more information about all available options. ```js filename=remix.config.js +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { appDirectory: "app", ignoredRouteFiles: ["**/.*"], diff --git a/docs/pages/gotchas.md b/docs/pages/gotchas.md index 2af1d7b06df..2cf87afbd65 100644 --- a/docs/pages/gotchas.md +++ b/docs/pages/gotchas.md @@ -109,6 +109,7 @@ To fix it, add the ESM package to the `serverDependenciesToBundle` option in you In our case here we're using the `dot-prop` package, so we would do it like this: ```js filename=remix.config.js +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { serverDependenciesToBundle: ["dot-prop"], // ... diff --git a/docs/prettier.config.js b/docs/prettier.config.js index 0b8c6ae9879..8bfa6089dae 100644 --- a/docs/prettier.config.js +++ b/docs/prettier.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('prettier').Options} - */ +/** @type {import('prettier').Options} */ module.exports = { ...require("../prettier.config"), printWidth: 60, diff --git a/examples/basic/remix.config.js b/examples/basic/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/basic/remix.config.js +++ b/examples/basic/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/blog-tutorial/remix.config.js b/examples/blog-tutorial/remix.config.js index 457709942de..a2074b02762 100644 --- a/examples/blog-tutorial/remix.config.js +++ b/examples/blog-tutorial/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { cacheDirectory: "./node_modules/.cache/remix", ignoredRouteFiles: ["**/.*", "**/*.css", "**/*.test.{js,jsx,ts,tsx}"], diff --git a/examples/bullmq-task-queue/remix.config.js b/examples/bullmq-task-queue/remix.config.js index ac0bfe1456a..631de93af3c 100644 --- a/examples/bullmq-task-queue/remix.config.js +++ b/examples/bullmq-task-queue/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev/config').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { appDirectory: "app", browserBuildDirectory: "public/build", diff --git a/examples/catch-boundary/remix.config.js b/examples/catch-boundary/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/catch-boundary/remix.config.js +++ b/examples/catch-boundary/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/chakra-ui/remix.config.js b/examples/chakra-ui/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/chakra-ui/remix.config.js +++ b/examples/chakra-ui/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/client-only-components/remix.config.js b/examples/client-only-components/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/client-only-components/remix.config.js +++ b/examples/client-only-components/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/client-side-validation/remix.config.js b/examples/client-side-validation/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/client-side-validation/remix.config.js +++ b/examples/client-side-validation/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/collected-notes/remix.config.js b/examples/collected-notes/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/collected-notes/remix.config.js +++ b/examples/collected-notes/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/combobox-resource-route/remix.config.js b/examples/combobox-resource-route/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/combobox-resource-route/remix.config.js +++ b/examples/combobox-resource-route/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/dark-mode/remix.config.js b/examples/dark-mode/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/dark-mode/remix.config.js +++ b/examples/dark-mode/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/dataloader/remix.config.js b/examples/dataloader/remix.config.js index 35d7d6b4b37..6675ae232e3 100644 --- a/examples/dataloader/remix.config.js +++ b/examples/dataloader/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], serverBuildDirectory: "server/build", diff --git a/examples/emotion/remix.config.js b/examples/emotion/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/emotion/remix.config.js +++ b/examples/emotion/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/file-and-cloudinary-upload/remix.config.js b/examples/file-and-cloudinary-upload/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/file-and-cloudinary-upload/remix.config.js +++ b/examples/file-and-cloudinary-upload/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/firebase-auth-firestore/remix.config.js b/examples/firebase-auth-firestore/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/firebase-auth-firestore/remix.config.js +++ b/examples/firebase-auth-firestore/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/form-to-notion-db/remix.config.js b/examples/form-to-notion-db/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/form-to-notion-db/remix.config.js +++ b/examples/form-to-notion-db/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/framer-motion/remix.config.js b/examples/framer-motion/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/framer-motion/remix.config.js +++ b/examples/framer-motion/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/framer-route-animation/remix.config.js b/examples/framer-route-animation/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/framer-route-animation/remix.config.js +++ b/examples/framer-route-animation/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/gdpr-cookie-consent/remix.config.js b/examples/gdpr-cookie-consent/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/gdpr-cookie-consent/remix.config.js +++ b/examples/gdpr-cookie-consent/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/google-analytics/remix.config.js b/examples/google-analytics/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/google-analytics/remix.config.js +++ b/examples/google-analytics/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/graphql-api/remix.config.js b/examples/graphql-api/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/graphql-api/remix.config.js +++ b/examples/graphql-api/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/image-resize/remix.config.js b/examples/image-resize/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/image-resize/remix.config.js +++ b/examples/image-resize/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/infinite-scrolling/remix.config.js b/examples/infinite-scrolling/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/infinite-scrolling/remix.config.js +++ b/examples/infinite-scrolling/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/io-ts-formdata-decoding/remix.config.js b/examples/io-ts-formdata-decoding/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/io-ts-formdata-decoding/remix.config.js +++ b/examples/io-ts-formdata-decoding/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/ioredis/remix.config.js b/examples/ioredis/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/ioredis/remix.config.js +++ b/examples/ioredis/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/jokes/remix.config.js b/examples/jokes/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/jokes/remix.config.js +++ b/examples/jokes/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/mantine/remix.config.js b/examples/mantine/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/mantine/remix.config.js +++ b/examples/mantine/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/msw/remix.config.js b/examples/msw/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/msw/remix.config.js +++ b/examples/msw/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/multiple-forms/remix.config.js b/examples/multiple-forms/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/multiple-forms/remix.config.js +++ b/examples/multiple-forms/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/multiple-params/remix.config.js b/examples/multiple-params/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/multiple-params/remix.config.js +++ b/examples/multiple-params/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/newsletter-signup/remix.config.js b/examples/newsletter-signup/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/newsletter-signup/remix.config.js +++ b/examples/newsletter-signup/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/nprogress/remix.config.js b/examples/nprogress/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/nprogress/remix.config.js +++ b/examples/nprogress/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/on-demand-hydration/remix.config.js b/examples/on-demand-hydration/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/on-demand-hydration/remix.config.js +++ b/examples/on-demand-hydration/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/outlet-form-rerender/remix.config.js b/examples/outlet-form-rerender/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/outlet-form-rerender/remix.config.js +++ b/examples/outlet-form-rerender/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/pathless-routes/remix.config.js b/examples/pathless-routes/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/pathless-routes/remix.config.js +++ b/examples/pathless-routes/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/pm-app/remix.config.js b/examples/pm-app/remix.config.js index 3f41e8dae27..b089e89db43 100644 --- a/examples/pm-app/remix.config.js +++ b/examples/pm-app/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/quirrel/remix.config.js b/examples/quirrel/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/quirrel/remix.config.js +++ b/examples/quirrel/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/react-spring/remix.config.js b/examples/react-spring/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/react-spring/remix.config.js +++ b/examples/react-spring/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/redis-upstash-session/remix.config.js b/examples/redis-upstash-session/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/redis-upstash-session/remix.config.js +++ b/examples/redis-upstash-session/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/remix-auth-auth0/remix.config.js b/examples/remix-auth-auth0/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/remix-auth-auth0/remix.config.js +++ b/examples/remix-auth-auth0/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/remix-auth-form/remix.config.js b/examples/remix-auth-form/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/remix-auth-form/remix.config.js +++ b/examples/remix-auth-form/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/remix-auth-github/remix.config.js b/examples/remix-auth-github/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/remix-auth-github/remix.config.js +++ b/examples/remix-auth-github/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/remix-auth-supabase-github/remix.config.js b/examples/remix-auth-supabase-github/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/remix-auth-supabase-github/remix.config.js +++ b/examples/remix-auth-supabase-github/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/remix-auth-supabase/remix.config.js b/examples/remix-auth-supabase/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/remix-auth-supabase/remix.config.js +++ b/examples/remix-auth-supabase/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/route-modal/remix.config.js b/examples/route-modal/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/route-modal/remix.config.js +++ b/examples/route-modal/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/routes-gen/remix.config.js b/examples/routes-gen/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/routes-gen/remix.config.js +++ b/examples/routes-gen/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/rust/remix.config.js b/examples/rust/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/rust/remix.config.js +++ b/examples/rust/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/sanity/remix.config.js b/examples/sanity/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/sanity/remix.config.js +++ b/examples/sanity/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/sass/remix.config.js b/examples/sass/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/sass/remix.config.js +++ b/examples/sass/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/search-input/remix.config.js b/examples/search-input/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/search-input/remix.config.js +++ b/examples/search-input/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/session-flash/remix.config.js b/examples/session-flash/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/session-flash/remix.config.js +++ b/examples/session-flash/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/sharing-loader-data/remix.config.js b/examples/sharing-loader-data/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/sharing-loader-data/remix.config.js +++ b/examples/sharing-loader-data/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/socket.io/remix.config.js b/examples/socket.io/remix.config.js index 7fdb0411255..fd9331ed1a8 100644 --- a/examples/socket.io/remix.config.js +++ b/examples/socket.io/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], serverBuildDirectory: "server/build", diff --git a/examples/stitches/remix.config.js b/examples/stitches/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/stitches/remix.config.js +++ b/examples/stitches/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/strapi/remix.config.js b/examples/strapi/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100755 --- a/examples/strapi/remix.config.js +++ b/examples/strapi/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/stripe-integration/remix.config.js b/examples/stripe-integration/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/stripe-integration/remix.config.js +++ b/examples/stripe-integration/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/styled-components/remix.config.js b/examples/styled-components/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/styled-components/remix.config.js +++ b/examples/styled-components/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/styletron/remix.config.js b/examples/styletron/remix.config.js index 1755894599a..ecf1253bfc8 100644 --- a/examples/styletron/remix.config.js +++ b/examples/styletron/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: [".*"], // appDirectory: "app", diff --git a/examples/supabase-subscription/remix.config.js b/examples/supabase-subscription/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/supabase-subscription/remix.config.js +++ b/examples/supabase-subscription/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/tailwindcss/remix.config.js b/examples/tailwindcss/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/tailwindcss/remix.config.js +++ b/examples/tailwindcss/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/template/remix.config.js b/examples/template/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/template/remix.config.js +++ b/examples/template/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/tiptap-collab-editing/remix.config.js b/examples/tiptap-collab-editing/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/tiptap-collab-editing/remix.config.js +++ b/examples/tiptap-collab-editing/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/toast-message/remix.config.js b/examples/toast-message/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/toast-message/remix.config.js +++ b/examples/toast-message/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/turborepo-vercel/apps/remix-app/remix.config.js b/examples/turborepo-vercel/apps/remix-app/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/turborepo-vercel/apps/remix-app/remix.config.js +++ b/examples/turborepo-vercel/apps/remix-app/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/examples/twind/remix.config.js b/examples/twind/remix.config.js index fbdc21f9882..ceaf8bf66da 100644 --- a/examples/twind/remix.config.js +++ b/examples/twind/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], appDirectory: "app", diff --git a/examples/usematches-loader-data/remix.config.js b/examples/usematches-loader-data/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/examples/usematches-loader-data/remix.config.js +++ b/examples/usematches-loader-data/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/integration/helpers/cf-template/remix.config.js b/integration/helpers/cf-template/remix.config.js index 684d139d7d2..a4fac89855c 100644 --- a/integration/helpers/cf-template/remix.config.js +++ b/integration/helpers/cf-template/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { serverBuildTarget: "cloudflare-workers", server: "./server.js", diff --git a/integration/helpers/deno-template/remix.config.js b/integration/helpers/deno-template/remix.config.js index 4dde611cb5c..d621422e56f 100644 --- a/integration/helpers/deno-template/remix.config.js +++ b/integration/helpers/deno-template/remix.config.js @@ -1,3 +1,4 @@ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { serverBuildTarget: "deno", server: "./server.ts", diff --git a/integration/helpers/node-template/remix.config.js b/integration/helpers/node-template/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/integration/helpers/node-template/remix.config.js +++ b/integration/helpers/node-template/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/packages/remix-dev/__tests__/fixtures/replace-remix-imports/remix.config.js b/packages/remix-dev/__tests__/fixtures/replace-remix-imports/remix.config.js index a83517ba5f8..63891ac2ab2 100644 --- a/packages/remix-dev/__tests__/fixtures/replace-remix-imports/remix.config.js +++ b/packages/remix-dev/__tests__/fixtures/replace-remix-imports/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { cacheDirectory: "./node_modules/.cache/remix", ignoredRouteFiles: [".*", "**/*.css", "**/*.test.{js,jsx,ts,tsx}"], diff --git a/packages/remix-dev/__tests__/fixtures/stack/remix.config.js b/packages/remix-dev/__tests__/fixtures/stack/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/packages/remix-dev/__tests__/fixtures/stack/remix.config.js +++ b/packages/remix-dev/__tests__/fixtures/stack/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/packages/remix-eslint-config/index.js b/packages/remix-eslint-config/index.js index d165d347bf6..541702546f8 100644 --- a/packages/remix-eslint-config/index.js +++ b/packages/remix-eslint-config/index.js @@ -18,9 +18,7 @@ const OFF = 0; // const WARN = 1; // const ERROR = 2; -/** - * @type {import("eslint").Linter.Config} - */ +/** @type {import('eslint').Linter.Config} */ const config = { parser: "@babel/eslint-parser", parserOptions: { diff --git a/prettier.config.js b/prettier.config.js index 6588ba1fea5..27cca4c3daf 100644 --- a/prettier.config.js +++ b/prettier.config.js @@ -1,4 +1,2 @@ -/** - * @type {import('prettier').Options} - */ +/** @type {import('prettier').Options} */ module.exports = {}; diff --git a/scripts/playground/template/remix.config.js b/scripts/playground/template/remix.config.js index 457709942de..a2074b02762 100644 --- a/scripts/playground/template/remix.config.js +++ b/scripts/playground/template/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { cacheDirectory: "./node_modules/.cache/remix", ignoredRouteFiles: ["**/.*", "**/*.css", "**/*.test.{js,jsx,ts,tsx}"], diff --git a/templates/arc/remix.config.js b/templates/arc/remix.config.js index b71b584d437..48474bad323 100644 --- a/templates/arc/remix.config.js +++ b/templates/arc/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { serverBuildTarget: "arc", server: "./server.js", diff --git a/templates/cloudflare-pages/remix.config.js b/templates/cloudflare-pages/remix.config.js index d6a4bdc58ed..7d8260a36a7 100644 --- a/templates/cloudflare-pages/remix.config.js +++ b/templates/cloudflare-pages/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { serverBuildTarget: "cloudflare-pages", server: "./server.js", diff --git a/templates/cloudflare-workers/remix.config.js b/templates/cloudflare-workers/remix.config.js index 684d139d7d2..a4fac89855c 100644 --- a/templates/cloudflare-workers/remix.config.js +++ b/templates/cloudflare-workers/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { serverBuildTarget: "cloudflare-workers", server: "./server.js", diff --git a/templates/deno/remix.config.js b/templates/deno/remix.config.js index 4dde611cb5c..d621422e56f 100644 --- a/templates/deno/remix.config.js +++ b/templates/deno/remix.config.js @@ -1,3 +1,4 @@ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { serverBuildTarget: "deno", server: "./server.ts", diff --git a/templates/express/remix.config.js b/templates/express/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/templates/express/remix.config.js +++ b/templates/express/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/templates/fly/remix.config.js b/templates/fly/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/templates/fly/remix.config.js +++ b/templates/fly/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/templates/netlify/remix.config.js b/templates/netlify/remix.config.js index 5ca3e23baf5..b450a13c3e4 100644 --- a/templates/netlify/remix.config.js +++ b/templates/netlify/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { serverBuildTarget: "netlify", server: "./server.js", diff --git a/templates/remix/remix.config.js b/templates/remix/remix.config.js index 260b82c7cb1..adf2a0b5d3e 100644 --- a/templates/remix/remix.config.js +++ b/templates/remix/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { ignoredRouteFiles: ["**/.*"], // appDirectory: "app", diff --git a/templates/vercel/remix.config.js b/templates/vercel/remix.config.js index 042147b678f..3a84dd6ccd7 100644 --- a/templates/vercel/remix.config.js +++ b/templates/vercel/remix.config.js @@ -1,6 +1,4 @@ -/** - * @type {import('@remix-run/dev').AppConfig} - */ +/** @type {import('@remix-run/dev').AppConfig} */ module.exports = { serverBuildTarget: "vercel", // When running locally in development mode, we use the built in remix