Update master-ko (deep-merge package.json, keep local files including README.md)

Author: minchodang

.gitignore

@@ -3,15 +3,8 @@
 # dependencies
 /node_modules
 /.pnp
-.yarn/*
-!.yarn/patches
-!.yarn/releases
-!.yarn/plugins
-!.yarn/sdks
-!.yarn/versions
 .pnp.*
 
-
 # testing
 /coverage
 
@@ -33,6 +26,7 @@ yarn-error.log*
 .idea
 .cache/
 package-lock.json
+.vscode
 tsconfig.tsbuildinfo
 .next/
 

.nvmrc

@@ -0,0 +1 @@
+20.18.1

.prettierignore

@@ -0,0 +1,4 @@
+pnpm-lock.yaml
+.cache/
+.contentlayer/
+.next/

.prettierrc

@@ -1,4 +1,5 @@
 {
+  "$schema": "https://json.schemastore.org/prettierrc",
   "endOfLine": "lf",
   "semi": false,
   "singleQuote": false,

CONTRIBUTING.md

@@ -12,25 +12,52 @@ Here is a quick guide to doing code contributions to the library.
 
 3. Install packages by running:
 
-   > yarn
+   ```shellscript
+   pnpm install
+   ```
 
 4. Startup a local version of the docs
 
-   > yarn start
+   ```shellscript
+   pnpm run dev
+   ```
 
 5. Ensure your code is formatted properly
 
-   > yarn format
+   ```shellscript
+   pnpm run format
+   ```
 
 6. Push your branch: `git push -u origin your-meaningful-branch-name`
 
 7. Submit a pull request to the upstream react-hook-form repository.
 
 8. Choose a descriptive title and describe your changes briefly.
 
+## Testing production build
+
+To test the documentation production site on your local machine,
+first execute the build script:
+
+```shellscript
+pnpm run build
+```
+
+Then start a local server which serves the file created by executing
+
+```shellscript
+pnpm run start
+```
+
 ## Coding style
 
-Please follow the coding style of the project. React Hook Form uses prettier. If possible, enable the prettier plugin in your editor to get real-time feedback. The formatting can be run manually with the following command: `yarn format`
+Please follow the coding style of the project.
+React Hook Form uses prettier.
+If possible, enable the prettier plugin in your editor to get real-time feedback. The formatting can be run manually with the following command:
+
+```shellscript
+pnpm run format:fix
+```
 
 ## License
 

changes.diff

@@ -4,6 +4,7 @@ import remarkGfm from "remark-gfm"
 import rehypeMdxCodeProps from "rehype-mdx-code-props"
 import emoji from "remark-emoji"
 import * as sidebar from "./src/components/Menu/MenuLinks"
+import type { Pages } from "./src/types/types"
 
 export const Doc = defineDocumentType(() => ({
   name: "Doc",
@@ -33,13 +34,22 @@ export const Doc = defineDocumentType(() => ({
       type: "string",
       resolve: (doc) => doc._raw.flattenedPath.split("/").slice(1).join("/"),
     },
+
+    /**
+     * Can't define value different from primitives, so hardcoding the correct type
+     * @see https://github.com/contentlayerdev/contentlayer/issues/149
+     */
     segment: {
-      type: "list",
+      type: "string[]" as "list",
       resolve: (doc) => doc._raw.flattenedPath.split("/"),
     },
     pages: {
-      type: "list",
-      resolve: (doc) => sidebar[doc.sidebar] ?? [],
+      type: "json",
+      resolve: (doc) => {
+        // added explicit type casting to keep track of this data structure
+        // in case in the future contentlayer will support values different than primitives
+        return sidebar[doc.sidebar] as unknown as Pages
+      },
     },
   },
 }))

contentlayer.config.ts

@@ -0,0 +1,67 @@
+// @ts-check
+import tseslint from "typescript-eslint"
+import { FlatCompat } from "@eslint/eslintrc"
+import eslintPluginJsxA11y from "eslint-plugin-jsx-a11y"
+import eslintPluginReact from "eslint-plugin-react"
+
+const compat = new FlatCompat({
+  baseDirectory: import.meta.dirname,
+})
+
+export default tseslint.config(
+  tseslint.configs.recommendedTypeChecked,
+
+  ...compat.config({
+    extends: ["next"],
+    rules: {
+      // react
+      "react/prop-types": "off",
+      "react/no-unescaped-entities": "off",
+      "react/jsx-curly-brace-presence": "warn",
+
+      // jsx-ally is already included in next-js so
+      // we are adding only recommended rules directly here
+      ...eslintPluginJsxA11y.flatConfigs.recommended.rules,
+      "jsx-a11y/no-onchange": "warn",
+
+      // import
+      "import/no-anonymous-default-export": "off",
+
+      // next
+      "@next/next/no-img-element": "off",
+    },
+  }),
+
+  // @ts-expect-error eslintPluginReact.configs.flat, but runtime is always defined
+  eslintPluginReact.configs.flat["jsx-runtime"],
+
+  {
+    linterOptions: {
+      reportUnusedDisableDirectives: "error",
+    },
+    languageOptions: {
+      parserOptions: {
+        projectService: true,
+        tsconfigRootDir: import.meta.dirname,
+      },
+    },
+    rules: {
+      // typescript
+      "@typescript-eslint/explicit-function-return-type": "off",
+      "@typescript-eslint/explicit-module-boundary-types": "off",
+      "@typescript-eslint/interface-name-prefix": "off",
+      "@typescript-eslint/no-floating-promises": "off",
+      "@typescript-eslint/restrict-template-expressions": [
+        "error",
+        {
+          allowAny: false,
+          allowBoolean: false,
+          allowNever: false,
+          allowNullish: false,
+          allowNumber: true,
+          allowRegExp: false,
+        },
+      ],
+    },
+  }
+)

eslint.config.mjs

@@ -1,5 +1,6 @@
 /// <reference types="next" />
 /// <reference types="next/image-types/global" />
+/// <reference path="./.next/types/routes.d.ts" />
 
 // NOTE: This file should not be edited
-// see https://nextjs.org/docs/basic-features/typescript for more information.
+// see https://nextjs.org/docs/pages/api-reference/config/typescript for more information.

next-env.d.ts

@@ -0,0 +1,27 @@
+import type { NextConfig } from "next"
+import { withContentlayer } from "next-contentlayer"
+import withBundleAnalyzer from "@next/bundle-analyzer"
+
+const nextConfig: NextConfig = {
+  eslint: {
+    /**
+     * Now eslint requires typecheck so we have to run build before executing lint
+     * These check are performed via `.github/workflows/ci.yml` action
+     *
+     * @see https://github.com/react-hook-form/documentation/pull/1107
+     */
+    ignoreDuringBuilds: true,
+  },
+  typescript: {
+    /** @see `eslint.ignoreDuringBuilds` comment */
+    ignoreBuildErrors: true,
+  },
+  reactStrictMode: true,
+  pageExtensions: ["ts", "tsx", "js", "jsx", "md", "mdx"],
+}
+
+const bundleAnalyzer = withBundleAnalyzer({
+  enabled: process.env.ANALYZE === "true",
+})
+
+export default bundleAnalyzer(withContentlayer(nextConfig))