chore: use short JSDOC type notation in configs (remix-run#3482)

xSyki · Jun 21, 2022 · a2ce6f7 · a2ce6f7
1 parent 3c11daa
commit a2ce6f7
Show file tree

Hide file tree

Showing 86 changed files with 88 additions and 250 deletions.
diff --git 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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -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
@@ -1,6 +1,4 @@
-/**
- * @type {import('@remix-run/dev').AppConfig}
- */
+/** @type {import('@remix-run/dev').AppConfig} */
 module.exports = {
   ignoredRouteFiles: ["**/.*"],
   // appDirectory: "app",