Merge pull request #283 from intuit/lint

lint mdx files

Author: hipstersmoothie

packages/eslint-config/index.js

@@ -228,6 +228,25 @@ module.exports = {
         '@typescript-eslint/no-explicit-any': 0,
         '@typescript-eslint/ban-ts-ignore': 0
       }
+    },
+    {
+      files: ['*.mdx'],
+      parser: 'eslint-mdx',
+      plugins: ['mdx'],
+      globals: {
+        React: true
+      },
+      rules: {
+        'import/no-extraneous-dependencies': 0,
+        // This is how we use jsx in mdx
+        'no-unused-expressions': 0,
+        // in mdx it's already in scope
+        'react/react-in-jsx-scope': 0,
+        // jsx is allowed in mdx
+        'react/jsx-filename-extension': 0,
+        // No exported function in MDX
+        "jsdoc/require-jsdoc": 0
+      }
     }
   ].filter(Boolean)
 };

packages/eslint-config/package.json

@@ -27,6 +27,7 @@
     "eslint-plugin-jest": "23.13.2",
     "eslint-plugin-jsdoc": "27.0.4",
     "eslint-plugin-jsx-a11y": "6.2.3",
+    "eslint-plugin-mdx": "1.7.0",
     "eslint-plugin-no-explicit-type-exports": "0.11.2",
     "eslint-plugin-prettier": "3.1.3",
     "eslint-plugin-react": "7.20.0",

plugins/lint/src/utils/lintUtils.ts

@@ -64,15 +64,15 @@ async function lintJS(args: LintArgs): Promise<number> {
     fix: args.fix,
     cache: !args.noCache && !bustCache,
     cacheLocation,
-    extensions: ['ts', 'tsx', 'js', 'jsx'],
+    extensions: ['ts', 'tsx', 'js', 'jsx', 'mdx'],
     ignorePath: path.join(__dirname, '../../.eslintignore'),
     reportUnusedDisableDirectives: true
   });
 
   const lintFiles = isRoot ? getPackageFolders() : ['src'];
 
   const report = linter.executeOnFiles(
-    args.files ? files(args, 'ts|tsx|js|jsx') : lintFiles
+    args.files ? files(args, 'ts|tsx|js|jsx|mdx') : lintFiles
   );
 
   if (args.fix) {
@@ -182,7 +182,7 @@ async function lintCSS(args: LintArgs): Promise<number> {
       };
     });
 
-    logger.trace('Stylelint Results', JSON.stringify(results, null, 2));
+    logger.trace('Stylelint Results', results);
 
     if (hasError) {
       logger.error('Project contains CSS errors', cssFormatter(results));