extend eslint to lint mdx files, snippets. enable in vscode

.eslintrc.json

@@ -1,15 +1,45 @@
 {
+  "$schema": "https://json.schemastore.org/eslintrc.json",
   "extends": [
     "next/core-web-vitals",
     "plugin:@typescript-eslint/recommended",
+    "plugin:mdx/recommended",
     "prettier" // prettier should always come last
   ],
-  "parser": "@typescript-eslint/parser",
   "plugins": ["@typescript-eslint", "prettier"],
+  "parser": "@typescript-eslint/parser",
   "rules": {
-    "react-hooks/exhaustive-deps": "error",
     "@typescript-eslint/no-explicit-any": "warn",
+    "@typescript-eslint/no-unused-vars": "error",
     "no-unused-vars": "off",
-    "@typescript-eslint/no-unused-vars": "error"
-  }
+    "react-hooks/exhaustive-deps": "error"
+  },
+  "overrides": [
+    {
+      "files": ["*.ts", "*.tsx"],
+      "parser": "@typescript-eslint/parser",
+      "parserOptions": {
+        "project": ["./tsconfig.json"]
+      }
+    },
+    {
+      "files": ["*.mdx"],
+      "extends": ["plugin:mdx/overrides"],
+      "settings": {
+        "mdx/code-blocks": true
+      },
+      "rules": {
+        // for mdx shortcodes, and snippets
+        "react/jsx-no-undef": ["off"]
+      }
+    },
+    {
+      // disable type-aware linting for MDX TS virtual files (code snippets)
+      "files": ["**/*.mdx/*.ts"],
+      "extends": ["plugin:@typescript-eslint/disable-type-checked"],
+      "rules": {
+        "@typescript-eslint/no-unused-vars": "warn"
+      }
+    }
+  ]
 }

.github/CODEOWNERS

@@ -9,80 +9,83 @@
 /src/pages/console/  @dbanksdesign  @aws-amplify/documentation-team 
 
 #Analytics
-/src/**/**/analytics @renebrandel @dbanksdesign @aws-amplify/documentation-team 
+/src/**/**/analytics @hdworld11 @dbanksdesign @aws-amplify/documentation-team 
 
 #Auth
-/src/**/**/auth @renebrandel @dbanksdesign @aws-amplify/documentation-team 
-/src/**/**/authz @renebrandel @dbanksdesign @aws-amplify/documentation-team 
-/src/**/**/authentication @renebrandel @dbanksdesign @aws-amplify/documentation-team 
+/src/**/**/auth @josefaidt @aws-amplify/documentation-team 
+/src/**/**/authz @josefaidt @renebrandel @aws-amplify/documentation-team 
+/src/**/**/authentication @renebrandel @josefaidt @aws-amplify/documentation-team 
 
 #Client Configuration
-/src/**/**/client-configuration @renebrandel @dbanksdesign @hdworld11 @aws-amplify/documentation-team 
-/src/**/**/configuration @renebrandel @dbanksdesign @hdworld11 @aws-amplify/documentation-team 
+/src/**/**/client-configuration @renebrandel @josefaidt @hdworld11 @aws-amplify/documentation-team 
+/src/**/**/configuration @renebrandel @josefaidt @hdworld11 @aws-amplify/documentation-team 
 
 #Common
-/src/fragments/common @renebrandel @dbanksdesign @aws-amplify/documentation-team 
-/src/fragments/lib/common @renebrandel @dbanksdesign @aws-amplify/documentation-team 
+/src/fragments/common @renebrandel @hdworld11 @josefaidt @dbanksdesign @aws-amplify/documentation-team 
+/src/fragments/lib/common @renebrandel @hdworld11 @josefaidt @dbanksdesign @aws-amplify/documentation-team 
 
 #Data
-/src/**/**/datastore @renebrandel @dbanksdesign @aws-amplify/documentation-team 
-/src/**/**/data @renebrandel @dbanksdesign @aws-amplify/documentation-team 
+/src/**/**/datastore @renebrandel @aws-amplify/documentation-team 
+/src/**/**/data @renebrandel @aws-amplify/documentation-team 
 
 #Debugging
-/src/fragments/**/debugging @renebrandel @dbanksdesign @aws-amplify/documentation-team 
+/src/fragments/**/debugging @josefaidt @aws-amplify/documentation-team 
 
 #Geo
-/src/**/**/geo @renebrandel @dbanksdesign @aws-amplify/documentation-team 
+/src/**/**/geo @hdworld11 @aws-amplify/documentation-team 
 
 #Getting Started
-/src/**/start @renebrandel @dbanksdesign @aws-amplify/documentation-team 
+/src/**/start @renebrandel @hdworld11 @josefaidt @dbanksdesign @aws-amplify/documentation-team 
 
 #GraphQL API
-/src/**/**/api-graphql @renebrandel @dbanksdesign @aws-amplify/documentation-team 
-/src/**/**/graphqlapi @renebrandel @dbanksdesign @aws-amplify/documentation-team 
-/src/**/cli-legacy/graphql-transformer @renebrandel @dbanksdesign @aws-amplify/documentation-team 
-/src/fragments/sdk/api/**/graphql.mdx @renebrandel @dbanksdesign @aws-amplify/documentation-team 
+/src/**/**/api-graphql @renebrandel @aws-amplify/documentation-team 
+/src/**/**/graphqlapi @renebrandel @aws-amplify/documentation-team 
+/src/**/cli-legacy/graphql-transformer @renebrandel @aws-amplify/documentation-team 
+/src/fragments/sdk/api/**/graphql.mdx @renebrandel @aws-amplify/documentation-team 
 
 #In-App Messaging
-/src/**/**/in-app-messaging @renebrandel @dbanksdesign @aws-amplify/documentation-team 
+/src/**/**/in-app-messaging @hdworld11 @aws-amplify/documentation-team 
 
 #Info
-/src/fragments/**/info @renebrandel @dbanksdesign @aws-amplify/documentation-team 
+/src/fragments/**/info @renebrandel @hdworld11 @josefaidt @dbanksdesign @aws-amplify/documentation-team 
 
 #Interactions
-/src/**/**/interactions @renebrandel @dbanksdesign @aws-amplify/documentation-team 
+/src/**/**/interactions @josefaidt @aws-amplify/documentation-team 
 
 #Logging
-/src/fragments/lib/logging @renebrandel @dbanksdesign @aws-amplify/documentation-team 
+/src/fragments/lib/logging @hdworld11 @aws-amplify/documentation-team 
 
 #Predictions
-/src/**/**/predictions @renebrandel @dbanksdesign @aws-amplify/documentation-team 
+/src/**/**/predictions @hdworld11 @dbanksdesign @aws-amplify/documentation-team 
 
 #Project Setup
-/src/**/**/project-setup @renebrandel @dbanksdesign @hdworld11 @aws-amplify/documentation-team 
+/src/**/**/project-setup @renebrandel @josefaidt @dbanksdesign @hdworld11 @aws-amplify/documentation-team 
 
 #PubSub
-/src/**/**/pubsub @renebrandel @dbanksdesign @aws-amplify/documentation-team 
+/src/**/**/pubsub @renebrandel @aws-amplify/documentation-team 
 
 #Push Notifications
-/src/**/**/push-notifications @renebrandel @dbanksdesign @aws-amplify/documentation-team 
+/src/**/**/push-notifications @hdworld11 @dbanksdesign @aws-amplify/documentation-team 
 
 #Rest API
-/src/**/**/api-rest @renebrandel @dbanksdesign @aws-amplify/documentation-team 
-/src/**/**/restapi @renebrandel @dbanksdesign @aws-amplify/documentation-team 
-/src/fragments/sdk/api/**/rest.mdx @renebrandel @dbanksdesign @aws-amplify/documentation-team 
+/src/**/**/api-rest @josefaidt @aws-amplify/documentation-team 
+/src/**/**/restapi @josefaidt @aws-amplify/documentation-team 
+/src/fragments/sdk/api/**/rest.mdx @josefaidt @aws-amplify/documentation-team 
 
 #SSR
-/src/fragments/lib/ssr @renebrandel @dbanksdesign @aws-amplify/documentation-team 
+/src/fragments/lib/ssr @renebrandel @josefaidt @dbanksdesign @aws-amplify/documentation-team 
 
 #Storage
 /src/**/**/storage @hdworld11 @aws-amplify/documentation-team 
 
 #Troubleshooting
-/src/fragments/lib/troubleshooting @renebrandel @dbanksdesign @aws-amplify/documentation-team 
+/src/fragments/lib/troubleshooting @josefaidt @aws-amplify/documentation-team 
 
 #Utilities
-/src/**/**/utilities @renebrandel @dbanksdesign @aws-amplify/documentation-team 
+/src/**/**/utilities @josefaidt @aws-amplify/documentation-team 
+
+#Gen2
+/src/pages/gen2 @ykethan @jay2113 @chrisbonifacio @aspittel @renebrandel @swaminator @dbanksdesign @josefaidt @ErikCH @arundna @hdworld11
 
 #Docs Engineering
 /src/components @aws-amplify/documentation-team

.prettierignore

@@ -8,5 +8,3 @@ public
 README-assets
 yarn.lock
 redirects.json
-*.md
-*.mdx

.remarkrc

@@ -0,0 +1,8 @@
+{
+  "plugins": [
+    "preset-lint-consistent",
+    "preset-lint-markdown-style-guide",
+    "preset-lint-recommended",
+    "preset-prettier"
+  ]
+}

.vscode/extensions.json

@@ -3,7 +3,7 @@
   // Extension identifier format: ${publisher}.${name}. Example: vscode.csharp
 
   // List of extensions which should be recommended for users of this workspace.
-  "recommendations": ["esbenp.prettier-vscode", "dbaeumer.vscode-eslint"],
+  "recommendations": ["esbenp.prettier-vscode", "dbaeumer.vscode-eslint", "unifiedjs.vscode-remark"],
   // List of extensions recommended by VS Code that should not be recommended for users of this workspace.
   "unwantedRecommendations": []
 }

.vscode/settings.json

@@ -9,7 +9,23 @@
   "[typescript]": {
     "editor.defaultFormatter": "esbenp.prettier-vscode"
   },
-  "[mdx]": {
-    "editor.wordWrap": "on"
-  }
+  "eslint.enable": true,
+  "eslint.probe": [
+    "javascript",
+    "javascriptreact",
+    "typescript",
+    "typescriptreact",
+    "html",
+    "markdown",
+    "mdx"
+  ],
+  "eslint.validate": [
+    "javascript",
+    "javascriptreact",
+    "typescript",
+    "typescriptreact",
+    "html",
+    "markdown",
+    "mdx"
+  ]
 }

next.config.mjs

@@ -24,6 +24,9 @@ const nextJSConfig = () => {
     distDir: 'client/www/next-build',
     env: {
       BUILD_ENV: process.env.BUILD_ENV,
+      ALGOLIA_APP_ID: process.env.ALGOLIA_APP_ID,
+      ALGOLIA_API_KEY: process.env.ALGOLIA_API_KEY,
+      ALGOLIA_INDEX_NAME: process.env.ALGOLIA_INDEX_NAME,
       nextImageExportOptimizer_imageFolderPath: 'public',
       nextImageExportOptimizer_exportFolderPath: 'out',
       nextImageExportOptimizer_quality: '75',

package.json

@@ -38,7 +38,7 @@
     "@types/node": "^12.12.9",
     "@types/react": "^18.0.0",
     "@types/url-parse": "^1.4.3",
-    "@typescript-eslint/eslint-plugin": "^6.13.1",
+    "@typescript-eslint/eslint-plugin": "^7.2.0",
     "axios": "^1.3.4",
     "classnames": "^2.3.2",
     "cross-env": "^7.0.3",
@@ -47,7 +47,7 @@
     "eslint": "8.54.0",
     "eslint-config-next": "14.0.3",
     "eslint-config-prettier": "^9.0.0",
-    "eslint-plugin-next": "^0.0.0",
+    "eslint-plugin-mdx": "^3.1.5",
     "eslint-plugin-prettier": "^5.0.1",
     "fs-extra": "^9.0.1",
     "git-jiggy": "1.1.1",
@@ -58,14 +58,19 @@
     "lint-staged": "^14.0.0",
     "next-bundle-analyzer": "^0.6.7",
     "prettier": "^3.0.3",
-    "puppeteer": "^20.8.2",
+    "puppeteer": "^22.2.0",
     "rehype": "^11.0.0",
     "rehype-img-size": "^1.0.1",
     "rehype-mdx-code-props": "^2.0.0",
     "remark": "^14.0.2",
     "remark-gfm": "^3.0.0",
+    "remark-lint": "^9.1.2",
     "remark-mdx": "^2.3.0",
     "remark-mdx-searchable": "^0.1.3",
+    "remark-preset-lint-consistent": "^5.1.2",
+    "remark-preset-lint-markdown-style-guide": "^5.1.3",
+    "remark-preset-lint-recommended": "^6.1.3",
+    "remark-preset-prettier": "^2.0.1",
     "rollup-plugin-node-polyfills": "^0.2.1",
     "sass": "^1.54.8",
     "serve": "^14.2.1",
@@ -80,22 +85,21 @@
     "@babel/core": "^7.23.2",
     "@babel/traverse": "^7.23.2",
     "loader-utils": "2.0.4",
-    "minimatch": "3.1.2",
     "decode-uri-component": "0.2.1",
     "fast-xml-parser": "4.2.5",
     "semver": "7.5.2",
     "tough-cookie": "4.1.3",
     "aws-cdk-lib": "2.80.0",
     "prismjs": "^1.27.0",
     "@adobe/css-tools": "4.3.2",
-    "follow-redirects": "^1.15.4",
+    "follow-redirects": "^1.15.6",
     "ip": "2.0.1",
     "sharp": "0.32.6"
-  }, 
+  },
   "scripts": {
     "clean": "rm -rf node_modules yarn.lock",
     "refresh": "yarn clean && yarn",
-    "test": "jest",
+    "test": "jest --coverage",
     "dev": "yarn prebuild && next dev",
     "spellcheck": "cspell \"src/**/*.mdx\" --no-progress",
     "spellcheck-diff": "git diff --name-only --cached | awk \"/src.*\\.mdx/{print}\" | npx cspell --no-must-find-files --file-list stdin",
@@ -106,6 +110,13 @@
     "prepare": "husky install",
     "analyze": "ANALYZE=true yarn next-build",
     "prebuild": "node src/directory/generateDirectory.mjs && node src/directory/generateFlatDirectory.mjs",
-    "lint": "next lint"
+    "lint": "next lint",
+    "lint:content": "eslint --ext mdx src"
+  },
+  "lint-staged": {
+    "**/*.(ts|tsx|js|css|mjs|mdx)": [
+      "eslint",
+      "prettier --list-different"
+    ]
   }
 }