fix: throw error with correct loc

mdx-js · Apr 7, 2022 · 4231a8e · 4231a8e
1 parent 68d41a1
commit 4231a8e
Show file tree

Hide file tree

Showing 10 changed files with 637 additions and 260 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -16,28 +16,17 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repo
-        uses: actions/checkout@master
+        uses: actions/checkout@v3
 
       - name: Setup Node.js ${{ matrix.node }}
-        uses: actions/setup-node@master
+        uses: actions/setup-node@v3
         with:
           node-version: ${{ matrix.node }}
+          cache: yarn
 
       - name: Link Yarn global binaries into PATH
         run: echo "$(yarn global bin)" >> $GITHUB_PATH
 
-      - name: Get yarn cache directory path
-        id: yarn-cache-dir-path
-        run: echo "::set-output name=dir::$(yarn cache dir)"
-
-      - uses: actions/cache@v2
-        id: yarn-cache # use this to check for `cache-hit` (`steps.yarn-cache.outputs.cache-hit != 'true'`)
-        with:
-          path: ${{ steps.yarn-cache-dir-path.outputs.dir }}
-          key: ${{ runner.os }}-yarn-${{ hashFiles('**/yarn.lock') }}
-          restore-keys: |
-            ${{ runner.os }}-yarn-
-
       - name: Install Dependencies
         run: yarn --frozen-lockfile
 

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -16,7 +16,7 @@ This project is a [lerna][] monorepo, so packages releasing is controlled by [le
 
 ### Release a bete next version
 
-Run `yarn release-next`
+Run `yarn build && yarn release-next`
 
 [contributing]: https://mdxjs.com/contributing
 [lerna]: https://github.com/lerna/lerna
diff --git a/package.json b/package.json
@@ -26,16 +26,17 @@
     "typecov": "type-coverage"
   },
   "devDependencies": {
-    "@1stg/lib-config": "^5.3.0",
+    "@1stg/lib-config": "^5.5.0",
     "@types/eslint": "^8.4.1",
     "@types/eslint-plugin-markdown": "^2.0.0",
     "@types/jest": "^27.4.1",
     "@types/node": "^17.0.23",
     "@types/react": "^17.0.43",
     "@types/unist": "^2.0.6",
     "lerna": "^4.0.0",
-    "react": "^17.0.2",
+    "react": "^18.0.0",
     "remark-frontmatter": "4.0.1",
+    "remark-gfm": "^3.0.1",
     "remark-lint": "^9.1.1",
     "remark-preset-lint-consistent": "^5.1.1",
     "remark-preset-lint-markdown-style-guide": "^5.1.2",
@@ -48,7 +49,7 @@
     "typescript": "^4.6.3"
   },
   "resolutions": {
-    "prettier": "^2.6.1"
+    "prettier": "^2.6.2"
   },
   "commitlint": {
     "extends": [
@@ -95,6 +96,7 @@
       "preset-lint-markdown-style-guide",
       "preset-lint-recommended",
       "preset-prettier",
+      "gfm",
       "validate-links"
     ]
   },

diff --git a/packages/eslint-mdx/package.json b/packages/eslint-mdx/package.json
@@ -34,7 +34,7 @@
     "remark-mdx": "^2.1.1",
     "remark-parse": "^10.0.1",
     "remark-stringify": "^10.0.2",
-    "synckit": "^0.6.0",
+    "synckit": "^0.7.0",
     "tslib": "^2.3.1",
     "unified": "^10.1.2"
   }

diff --git a/packages/eslint-mdx/src/parser.ts b/packages/eslint-mdx/src/parser.ts
@@ -1,6 +1,7 @@
 import path from 'path'
 
 import type { AST, Linter } from 'eslint'
+import type { VFileMessage } from 'vfile-message'
 
 import {
   arrayify,
@@ -10,9 +11,13 @@ import {
 } from './helpers'
 import { getPhysicalFilename } from './processor'
 import { traverse } from './traverse'
-import type { ParserOptions } from './types'
+import type { ParserOptions, WorkerParseResult } from './types'
 
-export const AST_PROPS = ['body', 'comments'] as const
+export const AST_PROPS = [
+  'body',
+  // disable comments temporarily -- #380
+  // 'comments'
+] as const
 
 export const DEFAULT_EXTENSIONS: readonly string[] = ['.mdx']
 export const MARKDOWN_EXTENSIONS: readonly string[] = ['.md']
@@ -59,15 +64,28 @@ export class Parser {
 
     const physicalFilename = getPhysicalFilename(filePath)
 
-    const { root, tokens, comments } = performSyncWork({
-      fileOptions: {
-        path: physicalFilename,
-        value: code,
-      },
-      physicalFilename,
-      isMdx,
-      ignoreRemarkConfig: ignoreRemarkConfig,
-    })
+    let result: WorkerParseResult
+
+    try {
+      result = performSyncWork({
+        fileOptions: {
+          path: physicalFilename,
+          value: code,
+        },
+        physicalFilename,
+        isMdx,
+        ignoreRemarkConfig: ignoreRemarkConfig,
+      })
+    } catch (err: unknown) {
+      const error = err as VFileMessage
+      throw Object.assign(new SyntaxError(error.message), {
+        lineNumber: error.line,
+        column: error.column,
+        index: /* istanbul ignore next */ error.position?.start.offset,
+      })
+    }
+
+    const { root, tokens, comments } = result
 
     this._ast = {
       ...normalizePosition(root.position),
@@ -85,7 +103,6 @@ export class Parser {
         }
 
         for (const prop of AST_PROPS) {
-          // @ts-expect-error
           this._ast[prop].push(...(node.data?.estree[prop] || []))
         }
       })

diff --git a/packages/eslint-mdx/src/worker.ts b/packages/eslint-mdx/src/worker.ts
@@ -9,7 +9,7 @@ import type { AST } from 'eslint'
 import type { EsprimaToken } from 'espree/lib/token-translator'
 import type { Comment as EsComment } from 'estree'
 import type { Options } from 'micromark-extension-mdx-expression'
-import { runAsWorker } from 'synckit'
+import { extractProperties, runAsWorker } from 'synckit'
 import type { FrozenProcessor } from 'unified'
 import type { Parent } from 'unist'
 import type { VFileMessage } from 'vfile-message'
@@ -184,7 +184,7 @@ runAsWorker(
       }
 
       return {
-        messages: JSON.parse(JSON.stringify(file.messages)) as VFileMessage[],
+        messages: file.messages.map(message => extractProperties(message)),
         content: file.toString(),
       }
     }