test: add more unit and e2e tests

JounQin · JounQin · commit d2cd98e4ae21 · 2019-08-10T22:34:45.000+08:00
diff --git a/packages/eslint-mdx/src/helper.ts b/packages/eslint-mdx/src/helper.ts
@@ -28,7 +28,7 @@ export const JSX_TYPES: JsxTypes = ['JSXElement', 'JSXFragment']
 export const isJsxNode = (node: { type: string }): node is JsxNode =>
   JSX_TYPES.includes(node.type as JsxType)
 
-export const normalizeParser = (parser: ParserOptions['parser']) => {
+export const normalizeParser = (parser?: ParserOptions['parser']) => {
   if (parser) {
     if (typeof parser === 'string') {
       // eslint-disable-next-line @typescript-eslint/no-require-imports
diff --git a/packages/eslint-mdx/src/regexp.ts b/packages/eslint-mdx/src/regexp.ts
@@ -42,6 +42,6 @@ export const COMMENT_CONTENT_REGEX = new RegExp(
 export const isOpenTag = (text: string) => OPEN_TAG_REGEX.test(text)
 export const isCloseTag = (text: string) => CLOSE_TAG_REGEX.test(text)
 export const isOpenCloseTag = (text: string) => OPEN_CLOSE_TAG_REGEX.test(text)
-export const isSelfClosingTag = (text: string) =>
-  SELF_CLOSING_TAG_REGEX.test(text)
+// prettier-ignore
+export const isSelfClosingTag = (text: string) => SELF_CLOSING_TAG_REGEX.test(text)
 export const isComment = (text: string) => COMMENT_REGEX.test(text)
diff --git a/packages/eslint-mdx/src/traverse.ts b/packages/eslint-mdx/src/traverse.ts
@@ -33,18 +33,18 @@ export class Traverse {
         } else {
           if (isCloseTag(rawText)) {
             offset--
-          } else if (
+          }
+          // prettier-ignore
+          /* istanbul ignore next */
+          else if (
             !isComment(rawText) &&
             !isSelfClosingTag(rawText) &&
             !isOpenCloseTag(rawText)
           ) {
+            // should never happen, just for robustness
             const { start } = node.position
             throw Object.assign(
-              new SyntaxError(
-                `'Unknown node type: ${JSON.stringify(
-                  node.type,
-                )}, text: ${JSON.stringify(rawText)}`,
-              ),
+              new SyntaxError('unknown jsx node: ' + JSON.stringify(rawText)),
               {
                 lineNumber: start.line,
                 column: start.column,
@@ -78,7 +78,9 @@ export class Traverse {
   }
 
   traverse(node: Node, parent?: Parent) {
+    /* istanbul ignore if */
     if (!node) {
+      // should never happen, just for robustness
       return
     }
 
diff --git a/packages/eslint-plugin-mdx/src/index.ts b/packages/eslint-plugin-mdx/src/index.ts
@@ -1,3 +1,5 @@
+/* istanbul ignore file */
+
 import { parse as oParse, parseForESLint as oParseForESLint } from 'eslint-mdx'
 
 import * as configs from './configs'
@@ -13,11 +15,17 @@ const warn = () =>
     'parse from this plugin is deprecated, please use parser `eslint-mdx` directly',
   )
 
+/**
+ * @deprecated
+ */
 export const parse = (code: string, options?: Linter.ParserOptions) => {
   warn()
   return oParse(code, options)
 }
 
+/**
+ * @deprecated
+ */
 export const parseForESLint = (
   code: string,
   options?: Linter.ParserOptions,
diff --git a/packages/eslint-plugin-mdx/src/rules/index.ts b/packages/eslint-plugin-mdx/src/rules/index.ts
@@ -1,13 +1,13 @@
 import { noJsxHtmlComments } from './no-jsx-html-comments'
-import { noUnEscapedEntities } from './no-unescaped-entities'
-import { noUnUsedExpressions } from './no-unused-expressions'
+import { noUnescapedEntities } from './no-unescaped-entities'
+import { noUnusedExpressions } from './no-unused-expressions'
 
 export * from './types'
 
-export { noJsxHtmlComments, noUnEscapedEntities, noUnUsedExpressions }
+export { noJsxHtmlComments, noUnescapedEntities, noUnusedExpressions }
 
 export const rules = {
   'no-jsx-html-comments': noJsxHtmlComments,
-  'no-unescaped-entities': noUnEscapedEntities,
-  'no-unused-expressions': noUnUsedExpressions,
+  'no-unescaped-entities': noUnescapedEntities,
+  'no-unused-expressions': noUnusedExpressions,
 }
diff --git a/packages/eslint-plugin-mdx/src/rules/no-unescaped-entities.ts b/packages/eslint-plugin-mdx/src/rules/no-unescaped-entities.ts
@@ -2,7 +2,7 @@
 /// <reference path="../../typings.d.ts" />
 
 import { isJsxNode, openTag } from 'eslint-mdx'
-import reactNoUnEscapedEntities from 'eslint-plugin-react/lib/rules/no-unescaped-entities'
+import reactNoUnescapedEntities from 'eslint-plugin-react/lib/rules/no-unescaped-entities'
 
 import { NodeWithParent } from './types'
 
@@ -37,8 +37,8 @@ const DEFAULTS: EscapeEntity[] = [
 
 const EXPRESSION = 'Literal, JSXText'
 
-export const noUnEscapedEntities: Rule.RuleModule = {
-  ...reactNoUnEscapedEntities,
+export const noUnescapedEntities: Rule.RuleModule = {
+  ...reactNoUnescapedEntities,
   create(context) {
     const configuration = context.options[0] || {}
     const entities: EscapeEntity[] = configuration.forbid || DEFAULTS
@@ -73,7 +73,9 @@ export const noUnEscapedEntities: Rule.RuleModule = {
                 .join('\n')
                 .search(openTag)
 
+        /* istanbul ignore if */
         if (firstLineOffset < 0) {
+          // should never happen, just for robustness
           firstLineOffset = 0
         }
 
diff --git a/packages/eslint-plugin-mdx/src/rules/no-unused-expressions.ts b/packages/eslint-plugin-mdx/src/rules/no-unused-expressions.ts
@@ -1,17 +1,17 @@
 // eslint-disable-next-line @typescript-eslint/triple-slash-reference
 /// <reference path="../../typings.d.ts" />
 
-import esLintNoUnUsedExpressions from 'eslint/lib/rules/no-unused-expressions'
+import esLintNoUnusedExpressions from 'eslint/lib/rules/no-unused-expressions'
 import { isJsxNode } from 'eslint-mdx'
 
 import { ExpressionStatementWithParent } from './types'
 
 import { Rule } from 'eslint'
 
-export const noUnUsedExpressions: Rule.RuleModule = {
-  ...esLintNoUnUsedExpressions,
+export const noUnusedExpressions: Rule.RuleModule = {
+  ...esLintNoUnusedExpressions,
   create(context) {
-    const esLintRuleListener = esLintNoUnUsedExpressions.create(context)
+    const esLintRuleListener = esLintNoUnusedExpressions.create(context)
     return {
       ExpressionStatement(node: ExpressionStatementWithParent) {
         if (isJsxNode(node.expression) && node.parent.type === 'Program') {
diff --git a/packages/eslint-plugin-mdx/typings.d.ts b/packages/eslint-plugin-mdx/typings.d.ts
@@ -1,11 +1,11 @@
 declare module 'eslint/lib/rules/no-unused-expressions' {
   import { Rule } from 'eslint'
-  const noUnUsedExpressions: Rule.RuleModule
-  export = noUnUsedExpressions
+  const esLintNoUnusedExpressions: Rule.RuleModule
+  export = esLintNoUnusedExpressions
 }
 
 declare module 'eslint-plugin-react/lib/rules/no-unescaped-entities' {
   import { Rule } from 'eslint'
-  const reactNoUnEscapedEntities: Rule.RuleModule
-  export = reactNoUnEscapedEntities
+  const reactNoUnescapedEntities: Rule.RuleModule
+  export = reactNoUnescapedEntities
 }
diff --git a/test/__snapshots__/fixtures.test.ts.snap b/test/__snapshots__/fixtures.test.ts.snap
@@ -32,5 +32,20 @@ exports[`fixtures should match all snapshots: no-jsx-html-comments.mdx 1`] = `
 
 <header>Header{/** JSX HTML comment */}</header>
 <main>Main Content</main>
+
+Inline <header>Header<!-- JSX HTML comment --></header>
+
+<main>Main Content</main>
+"
+`;
+
+exports[`fixtures should match all snapshots: no-unescaped-entities.mdx 1`] = `
+"<header> &apos; </header>
+<main> > </main>
+
+Header <header> &apos; </header>
+Main <main> > </main>
 "
 `;
+
+exports[`fixtures should match all snapshots: parser.mdx 1`] = `undefined`;
diff --git a/test/fixtures.test.ts b/test/fixtures.test.ts
@@ -11,8 +11,8 @@ describe('fixtures', () => {
   it('should match all snapshots', () => {
     cli
       .executeOnFiles(['test/fixtures/*.mdx'])
-      .results.forEach(({ filePath, output }) =>
-        expect(output).toMatchSnapshot(basename(filePath)),
+      .results.forEach(({ filePath, output, source }) =>
+        expect(output || source).toMatchSnapshot(basename(filePath)),
       )
   })
 })
diff --git a/test/fixtures/basic.mdx b/test/fixtures/basic.mdx
@@ -1,6 +1,6 @@
 import Basic from './basic'
 
-export const meta = {
+export const meta={
   title: 'Blog Post',
 }
 
@@ -16,9 +16,7 @@ Lorem ipsum dolor sit amet, consectetur adipiscing **elit**. Ut ac lobortis <b>v
 }
 ```
 
-<Basic>
-  {/* This is a comment */}
-</Basic>
+<Basic>{/* This is a comment */}</Basic>
 
 ## Subtitle
 
diff --git a/test/fixtures/no-jsx-html-comments.mdx b/test/fixtures/no-jsx-html-comments.mdx
@@ -2,3 +2,6 @@
 
 <header>Header<!-- JSX HTML comment --></header>
 <main>Main Content</main>
+
+Inline <header>Header<!-- JSX HTML comment --></header>
+<main>Main Content</main>
diff --git a/test/fixtures/no-unescaped-entities.mdx b/test/fixtures/no-unescaped-entities.mdx
@@ -0,0 +1,5 @@
+<header> &apos; </header>
+<main> > </main>
+
+Header <header> &apos; </header>
+Main <main> > </main>
diff --git a/test/fixtures/parser.mdx b/test/fixtures/parser.mdx
@@ -0,0 +1,3 @@
+# Title
+
+Header <header>
diff --git a/test/helper.ts b/test/helper.ts
@@ -0,0 +1,12 @@
+import { DEFAULT_PARSER_OPTIONS, ParserOptions } from 'eslint-mdx'
+
+import { RuleTester } from 'eslint'
+
+export const parser = require.resolve('eslint-mdx')
+export const ruleTester = new RuleTester()
+export const parserOptions: ParserOptions = {
+  ...DEFAULT_PARSER_OPTIONS,
+  comment: true,
+  filePath: 'test.mdx',
+  tokens: true,
+}
diff --git a/test/no-unescaped-entities.test.ts b/test/no-unescaped-entities.test.ts
@@ -0,0 +1,62 @@
+import { noUnescapedEntities } from '@rxts/eslint-plugin-mdx'
+
+import { parser, parserOptions, ruleTester } from './helper'
+
+const filename = 'no-unescaped-entities.mdx'
+
+ruleTester.run('no-unescaped-entities', noUnescapedEntities, {
+  valid: [
+    {
+      code: '<header> &apos; </header>',
+      parser,
+      parserOptions,
+      filename,
+    },
+    {
+      code: `# Title\n\n## Header <header> &apos; </header>\nMain<main></main>`,
+      parser,
+      parserOptions,
+      filename,
+    },
+  ],
+  invalid: [
+    {
+      code: '<main> > </main>',
+      parser,
+      parserOptions,
+      filename,
+      errors: [
+        {
+          message: '`>` can be escaped with `&gt;`.',
+        },
+      ],
+    },
+    {
+      code: 'Main <main> > </main>',
+      parser,
+      parserOptions,
+      filename,
+      errors: [
+        {
+          message: '`>` can be escaped with `&gt;`.',
+        },
+      ],
+    },
+    {
+      code: 'Main <main> & </main>',
+      parser,
+      parserOptions,
+      options: [
+        {
+          forbid: ['&'],
+        },
+      ],
+      filename,
+      errors: [
+        {
+          message: 'HTML entity, `&` , must be escaped.',
+        },
+      ],
+    },
+  ],
+})
diff --git a/test/no-unused-expressions.test.ts b/test/no-unused-expressions.test.ts
@@ -0,0 +1,28 @@
+import { noUnusedExpressions } from '@rxts/eslint-plugin-mdx'
+
+import { parser, parserOptions, ruleTester } from './helper'
+
+ruleTester.run('no-unused-expressions', noUnusedExpressions, {
+  valid: [
+    {
+      code: '<header>Header</header>',
+      parser,
+      parserOptions,
+      filename: 'no-unused-expressions.mdx',
+    },
+  ],
+  invalid: [
+    {
+      code: 'if(0) 0',
+      parser,
+      parserOptions,
+      filename: 'no-unused-expressions.js',
+      errors: [
+        {
+          message:
+            'Expected an assignment or function call and instead saw an expression.',
+        },
+      ],
+    },
+  ],
+})
diff --git a/test/parser.test.ts b/test/parser.test.ts
