Local ESLint rules for development

.eslintrc.js

@@ -1,4 +1,11 @@
+const path = require('path');
+
+const rulesDirPlugin = require('eslint-plugin-rulesdir');
+
+rulesDirPlugin.RULES_DIR = path.join(__dirname, 'eslint-rules');
+
 module.exports = {
+  plugins: ['rulesdir'],
   extends: ['plugin:hydrogen/recommended', 'plugin:hydrogen/typescript'],
   rules: {
     '@typescript-eslint/ban-ts-comment': 'off',
@@ -9,5 +16,6 @@ module.exports = {
     'no-case-declarations': 'off',
     // TODO: Remove jest plugin from hydrogen/eslint-plugin
     'jest/no-deprecated-functions': 'off',
+    'rulesdir/no-missing-seo': 'warn',
   },
 };

eslint-rules/no-missing-seo.js

@@ -0,0 +1,49 @@
+module.exports = {
+  meta: {
+    type: 'best-practices',
+    docs: {
+      description: 'Use hydrogen/remix-seo to validate SEO on your pages',
+    },
+    schema: [],
+  },
+  create(context) {
+    return {
+      ExportNamedDeclaration(node) {
+        if (
+          !context.getFilename().includes('routes') ||
+          node.declaration?.type !== 'VariableDeclaration'
+        ) {
+          return;
+        }
+
+        const {declarations} = node.declaration;
+        const hasHandleExport = declarations.some(
+          (declaration) => declaration.id.name === 'handle',
+        );
+
+        if (!hasHandleExport) {
+          return;
+        }
+
+        declarations.forEach((declaration) => {
+          if (declaration.id.name !== 'handle') {
+            return;
+          }
+
+          const hasSeoKey = declaration.init.properties.includes(
+            (property) => property.key.name === 'seo',
+          );
+
+          if (hasSeoKey) {
+            return;
+          }
+
+          context.report(
+            node,
+            'Ensure that all routes define an seo field on the handle export',
+          );
+        });
+      },
+    };
+  },
+};