feat: add initial intellisense

.eslintignore

@@ -1,3 +1,4 @@
 !/.github
 !/.*.js
 /CHANGELOG.md
+/out/

.eslintrc

@@ -1,6 +1,11 @@
 {
   "root": true,
   "extends": "@1stg",
+  "rules": {
+    "no-undef": "off",
+    "import/no-unresolved": "off",
+    "jsdoc/no-undefined-types": "off"
+  },
   "overrides": [
     {
       "files": [

.gitignore

@@ -1,7 +1,6 @@
 *.log
 *.tsbuildinfo
 .*cache
-!/.vscode
 /.vscode-test
-lib
 node_modules
+/out/

.vscode/launch.json

@@ -10,7 +10,29 @@
       "type": "extensionHost",
       "request": "launch",
       "runtimeExecutable": "${execPath}",
-      "args": ["--extensionDevelopmentPath=${workspaceFolder}"]
+      "args": [
+        "--extensionDevelopmentPath=${workspaceFolder}",
+        "${workspaceFolder}/test/fixture.mdx"
+      ],
+      "presentation": {
+        "hidden": true
+      }
+    },
+    {
+      "name": "Debug language server",
+      "type": "node",
+      "request": "attach",
+      "port": 6009,
+      "presentation": {
+        "hidden": true
+      }
+    }
+  ],
+  "compounds": [
+    {
+      "preLaunchTask": "build",
+      "name": "Extension + Language server",
+      "configurations": ["Run Extension", "Debug language server"]
     }
   ]
 }

package.json

@@ -49,23 +49,30 @@
   },
   "license": "MIT",
   "private": true,
+  "workspaces": [
+    "packages/*"
+  ],
   "packageManager": "yarn@1.22.19",
   "engines": {
     "vscode": ">=1.0.0"
   },
+  "main": "out/language-client.js",
   "keywords": [
     "mdx",
     "Markdown",
     "Markdown React"
   ],
   "scripts": {
+    "build": "esbuild @mdx-js/language-client @mdx-js/language-server --bundle --platform=node --target=node16 --format=cjs --external:vscode --outdir=out",
     "lint": "eslint . --cache -f friendly",
-    "prepare": "patch-package && simple-git-hooks && yarn-deduplicate --strategy fewer || exit 0"
+    "prepare": "patch-package && simple-git-hooks && yarn-deduplicate --strategy fewer || exit 0",
+    "vscode:prepublish": "yarn build --minify"
   },
   "devDependencies": {
     "@1stg/common-config": "^7.1.1",
     "@changesets/changelog-github": "^0.4.6",
     "@changesets/cli": "^2.24.4",
+    "esbuild": "^0.15.0",
     "patch-package": "^6.4.7",
     "typescript": "^4.7.4",
     "yarn-deduplicate": "^5.0.2"
@@ -74,6 +81,9 @@
     "prettier": "^2.7.1"
   },
   "icon": "assets/mdx.png",
+  "activationEvents": [
+    "onLanguage:mdx"
+  ],
   "contributes": {
     "languages": [
       {

packages/language-client/index.js

@@ -0,0 +1,33 @@
+import { LanguageClient, TransportKind } from 'vscode-languageclient/node.js'
+
+/**
+ * @type {LanguageClient}
+ */
+let client
+
+/**
+ * @param {import('vscode').ExtensionContext} context
+ */
+export async function activate(context) {
+  /**
+   * @type {import('vscode-languageclient/node.js').NodeModule}
+   */
+  const run = {
+    module: context.asAbsolutePath('out/language-server.js'),
+    transport: TransportKind.ipc,
+  }
+
+  client = new LanguageClient(
+    'MDX',
+    { run, debug: { ...run, options: { execArgv: ['--inspect=6009'] } } },
+    { documentSelector: [{ scheme: 'file', language: 'mdx' }] },
+  )
+
+  await client.start()
+}
+
+export async function deactivate() {
+  if (client) {
+    await client.stop()
+  }
+}

packages/language-client/package.json

@@ -0,0 +1,9 @@
+{
+  "name": "@mdx-js/language-client",
+  "version": "0.0.0",
+  "type": "module",
+  "devDependencies": {
+    "@types/vscode": "^1.0.0",
+    "vscode-languageclient": "^8.0.0"
+  }
+}

packages/language-client/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "checkJs": true,
+    "module": "node16",
+    "noEmit": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "paths": {
+      "@mdx-js/language-service": ["../language-service/index.js"]
+    }
+  }
+}

packages/language-server/index.js

@@ -0,0 +1,36 @@
+import { createMDXLanguageService } from '@mdx-js/language-service'
+import {
+  createConnection,
+  ProposedFeatures,
+  TextDocuments,
+  TextDocumentSyncKind,
+} from 'vscode-languageserver/node.js'
+import { TextDocument } from 'vscode-languageserver-textdocument'
+
+const connection = createConnection(ProposedFeatures.all)
+const documents = new TextDocuments(TextDocument)
+const languageService = createMDXLanguageService()
+
+connection.onInitialize(() => {
+  languageService.initialize()
+
+  return {
+    capabilities: {
+      textDocumentSync: TextDocumentSyncKind.Full,
+      definitionProvider: true,
+    },
+  }
+})
+
+connection.onDefinition(params => {
+  const doc = documents.get(params.textDocument.uri)
+
+  if (!doc) {
+    return []
+  }
+
+  return languageService.doLocationLinks(doc, params.position)
+})
+
+connection.listen()
+documents.listen(connection)

packages/language-server/package.json

@@ -0,0 +1,10 @@
+{
+  "name": "@mdx-js/language-server",
+  "version": "0.0.0",
+  "type": "module",
+  "dependencies": {
+    "@mdx-js/language-service": "0.0.0",
+    "vscode-languageserver": "^8.0.0",
+    "vscode-languageserver-textdocument": "^1.0.0"
+  }
+}

packages/language-server/tsconfig.json

@@ -0,0 +1,12 @@
+{
+  "compilerOptions": {
+    "checkJs": true,
+    "module": "node16",
+    "noEmit": true,
+    "skipLibCheck": true,
+    "strict": true,
+    "paths": {
+      "@mdx-js/language-service": ["../language-service/index.js"]
+    }
+  }
+}

packages/language-service/index.js

@@ -0,0 +1,5 @@
+/**
+ * @typedef {import('./lib/index.js').MDXLanguageService} MDXLanguageService
+ */
+
+export { createMDXLanguageService } from './lib/index.js'

packages/language-service/lib/index.js

@@ -0,0 +1,32 @@
+/**
+ * @typedef {import('vscode-languageserver-textdocument').TextDocument} TextDocument
+ * @typedef {import('vscode-languageserver-types').LocationLink} LocationLink
+ * @typedef {import('vscode-languageserver-types').Position} Position
+ * @typedef {object} MDXLanguageService
+ * @property {() => void} initialize
+ * Initialize the language service.
+ * @property {(document: TextDocument, position: Position) => LocationLink[]} doLocationLinks
+ * Provide document links
+ */
+
+import remarkMdx from 'remark-mdx'
+import remarkParse from 'remark-parse'
+import { unified } from 'unified'
+
+import { provideLocationLinks } from './location-links.js'
+
+/**
+ * Create an MDX language service
+ *
+ * @returns {MDXLanguageService} The MDX language service.
+ */
+export function createMDXLanguageService() {
+  const processor = unified().use(remarkParse).use(remarkMdx)
+
+  return {
+    // eslint-disable-next-line no-empty-function
+    initialize() {},
+    doLocationLinks: (document, position) =>
+      provideLocationLinks(document, position, processor),
+  }
+}

packages/language-service/lib/location-links.js

@@ -0,0 +1,70 @@
+/**
+ * @typedef {import('unified').Processor<import('mdast').Root>} Processor
+ * @typedef {import('mdast').Definition} Definition
+ * @typedef {import('mdast').LinkReference} LinkReference
+ * @typedef {import('vscode-languageserver-types').LocationLink} LocationLink
+ * @typedef {import('vscode-languageserver-types').Position} Position
+ * @typedef {import('vscode-languageserver-textdocument').TextDocument} TextDocument
+ */
+
+import { fromPosition } from 'unist-util-lsp'
+import { visit } from 'unist-util-visit'
+
+/**
+ * @param {TextDocument} document
+ * @param {Position} position
+ * @param {Processor} processor
+ * @returns {LocationLink[]} A list of document links.
+ */
+export function provideLocationLinks(document, position, processor) {
+  const text = document.getText()
+  const ast = processor.parse(text)
+  /** @type {LinkReference | undefined} */
+  let reference
+  /** @type {Map<string, Definition>} */
+  const definitions = new Map()
+  const positionOffset = document.offsetAt(position)
+
+  visit(
+    ast,
+    ['definition', 'linkReference'],
+    /**
+     * @param {Definition | LinkReference} node
+     */
+    node => {
+      const nodePos = node.position
+      if (node.type === 'linkReference') {
+        if (
+          nodePos &&
+          positionOffset >= /** @type {number} */ (nodePos.start.offset) &&
+          positionOffset <= /** @type {number} */ (nodePos.end.offset)
+        ) {
+          reference = node
+        }
+      } else if (!definitions.has(node.identifier) && nodePos) {
+        definitions.set(node.identifier, node)
+      }
+    },
+  )
+
+  if (!reference) {
+    return []
+  }
+
+  const definition = definitions.get(reference.identifier)
+
+  if (!definition?.position) {
+    return []
+  }
+
+  return [
+    {
+      originSelectionRange: reference.position
+        ? fromPosition(reference.position)
+        : undefined,
+      targetUri: document.uri,
+      targetRange: fromPosition(definition.position),
+      targetSelectionRange: fromPosition(definition.position),
+    },
+  ]
+}

packages/language-service/package.json

@@ -0,0 +1,16 @@
+{
+  "name": "@mdx-js/language-service",
+  "version": "0.0.0",
+  "type": "module",
+  "exports": "./index.js",
+  "dependencies": {
+    "@mdx-js/mdx": "^2.0.0",
+    "remark-mdx": "^2.0.0",
+    "remark-parse": "^10.0.0",
+    "unified": "^10.0.0",
+    "unist-util-lsp": "^1.0.0",
+    "unist-util-visit": "^4.0.0",
+    "vscode-languageserver-textdocument": "^1.0.0",
+    "vscode-languageserver-types": "^3.0.0"
+  }
+}

packages/language-service/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "checkJs": true,
+    "module": "node16",
+    "noEmit": true,
+    "skipLibCheck": true,
+    "strict": true
+  }
+}