@ripple-ts/language-server 0.3.17 → 0.3.19

package/CHANGELOG.md

@@ -1,5 +1,34 @@
 # @ripple-ts/language-server
 
+## 0.3.19
+
+### Patch Changes
+
+- [#877](https://github.com/Ripple-TS/ripple/pull/877)
+  [`7610ef8`](https://github.com/Ripple-TS/ripple/commit/7610ef84847bb77cc83488a902ecb6f96594e113)
+  Thanks [@leonidaz](https://github.com/leonidaz)! - Convert the Ripple language
+  server, TypeScript plugin, and VS Code extension codebases from CommonJS source
+  files to ESM source files, while publishing built dist entrypoints instead of
+  source files.
+
+  This updates package metadata such as `type: module` and dist-based `main`
+  paths, replaces `require` and `module.exports` usage with `import` and `export`,
+  and adds tsdown bundling configs that emit CommonJS dist output plus a
+  dist/package.json that forces `type: commonjs`.
+
+  Development builds also include sourcemaps.
+
+- Updated dependencies
+  [[`7610ef8`](https://github.com/Ripple-TS/ripple/commit/7610ef84847bb77cc83488a902ecb6f96594e113)]:
+  - @ripple-ts/typescript-plugin@0.3.19
+
+## 0.3.18
+
+### Patch Changes
+
+- Updated dependencies []:
+  - @ripple-ts/typescript-plugin@0.3.18
+
 ## 0.3.17
 
 ### Patch Changes

package/README.md

@@ -29,8 +29,8 @@ are also specialized plugins for popular editors.
 
 #### VS Code
 
-Use the [official
-extension](https://marketplace.visualstudio.com/items?itemName=Ripple-TS.ripple-ts-vscode-plugin
+Use the
+[official extension](https://marketplace.visualstudio.com/items?itemName=Ripple-TS.ripple-ts-vscode-plugin)
 It uses this language server internally.
 
 #### WebStorm/IntelliJ

package/bin/language-server.js

@@ -1,5 +1,5 @@
 #!/usr/bin/env node
 
-const { createRippleLanguageServer } = require('../src/server.js');
+import { createRippleLanguageServer } from '../src/server.js';
 
 createRippleLanguageServer();

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@ripple-ts/language-server",
-  "version": "0.3.17",
+  "version": "0.3.19",
   "description": "Language Server Protocol implementation for Ripple",
-  "main": "index.js",
+  "main": "dist/server.js",
+  "type": "module",
   "bin": {
     "ripple-language-server": "bin/language-server.js"
   },
@@ -19,9 +20,11 @@
     "volar-service-typescript": "0.0.70",
     "vscode-languageserver-textdocument": "^1.0.12",
     "vscode-uri": "^3.1.0",
-    "@ripple-ts/typescript-plugin": "0.3.17"
+    "@ripple-ts/typescript-plugin": "0.3.19",
+    "@tsrx/core": "0.0.4"
   },
   "devDependencies": {
+    "tsdown": "^0.20.3",
     "@tsrx/ripple": "0.0.5"
   },
   "peerDependencies": {
@@ -29,5 +32,8 @@
   },
   "publishConfig": {
     "access": "public"
+  },
+  "scripts": {
+    "build": "tsdown"
   }
 }

package/src/autoInsertPlugin.js

@@ -1,6 +1,6 @@
 /** @import { LanguageServicePlugin } from '@volar/language-server' */
 
-const { getVirtualCode, createLogging, is_ripple_document } = require('./utils.js');
+import { getVirtualCode, createLogging, is_ripple_document } from './utils.js';
 
 const { log } = createLogging('[Ripple Auto-Insert Plugin]');
 
@@ -32,7 +32,7 @@ const VOID_ELEMENTS = new Set([
  * Handles auto-closing tags when typing '>' after a tag name
  * @returns {LanguageServicePlugin}
  */
-function createAutoInsertPlugin() {
+export function createAutoInsertPlugin() {
 	return {
 		name: 'ripple-auto-insert',
 		capabilities: {
@@ -161,7 +161,3 @@ function createAutoInsertPlugin() {
 		},
 	};
 }
-
-module.exports = {
-	createAutoInsertPlugin,
-};

package/src/compileErrorDiagnosticPlugin.js

@@ -1,20 +1,19 @@
 /**
  * @import {Diagnostic, Range, LanguageServicePlugin, LanguageServiceContext, Position, Mapper} from '@volar/language-server';
  * @import {TextDocument} from 'vscode-languageserver-textdocument';
- * @import {TSRXVirtualCode} from '@ripple-ts/typescript-plugin/src/language.js';
+ * @import {TSRXVirtualCodeInstance} from '@ripple-ts/typescript-plugin/src/language.js';
  */
-// @ts-expect-error: ESM type import is fine
 /** @import {TSRXCompileError} from '@tsrx/ripple'; */
 
-const { getVirtualCode, createLogging } = require('./utils.js');
+import { getVirtualCode, createLogging } from './utils.js';
 
 const { log } = createLogging('[Ripple Compile Error Diagnostic Plugin]');
-const { DiagnosticSeverity } = require('@volar/language-server');
+import { DiagnosticSeverity } from '@volar/language-server';
 
 /**
  * @returns {LanguageServicePlugin}
  */
-function createCompileErrorDiagnosticPlugin() {
+export function createCompileErrorDiagnosticPlugin() {
 	log('Creating Ripple diagnostic plugin...');
 
 	return {
@@ -63,7 +62,7 @@ function createCompileErrorDiagnosticPlugin() {
 
 /**
  * @param {TSRXCompileError} error
- * @param {TSRXVirtualCode} virtualCode
+ * @param {TSRXVirtualCodeInstance} virtualCode
  * @param {Mapper | undefined} sourceMap
  * @param {TextDocument} document
  * @returns {Diagnostic}
@@ -154,7 +153,3 @@ function get_end_offset_from_error(error, start_offset) {
 function get_start_offset_from_error(error) {
 	return error.pos ?? 0;
 }
-
-module.exports = {
-	createCompileErrorDiagnosticPlugin,
-};

package/src/completionPlugin.js

@@ -1,13 +1,13 @@
 /** @import { LanguageServicePlugin, TextEdit, CompletionItem } from '@volar/language-server'; */
 
-const { CompletionItemKind, InsertTextFormat } = require('@volar/language-server');
-const {
+import { CompletionItemKind, InsertTextFormat } from '@volar/language-server';
+import {
 	getVirtualCode,
 	createLogging,
 	isInsideImport,
 	isInsideExport,
 	is_ripple_document,
-} = require('./utils.js');
+} from './utils.js';
 
 const { log } = createLogging('[Ripple Completion Plugin]');
 
@@ -361,7 +361,7 @@ const RIPPLE_IMPORTS = [
 /**
  * @returns {LanguageServicePlugin}
  */
-function createCompletionPlugin() {
+export function createCompletionPlugin() {
 	return {
 		name: 'ripple-completion-enhancer',
 		capabilities: {
@@ -506,7 +506,3 @@ function createCompletionPlugin() {
 		},
 	};
 }
-
-module.exports = {
-	createCompletionPlugin,
-};

package/src/definitionPlugin.js

@@ -1,18 +1,15 @@
 /** @import { LanguageServicePlugin, LocationLink } from '@volar/language-server'; */
-// @ts-expect-error type-only import from ESM module into CJS is fine
 /** @import { DefinitionLocation } from '@tsrx/ripple'; */
 
-const { TextDocument } = require('vscode-languageserver-textdocument');
-const { getVirtualCode, createLogging, getWordFromPosition } = require('./utils.js');
-const path = require('path');
-const fs = require('fs');
-
-const {
+import { TextDocument } from 'vscode-languageserver-textdocument';
+import { getVirtualCode, createLogging, getWordFromPosition } from './utils.js';
+import path from 'path';
+import {
 	normalizeFileNameOrUri,
 	getRippleDirForFile,
 	getCachedTypeDefinitionFile,
 	getCachedTypeMatches,
-} = require('@ripple-ts/typescript-plugin/src/language.js');
+} from '@ripple-ts/typescript-plugin/src/language.js';
 
 const { log } = createLogging('[Ripple Definition Plugin]');
 /** @type {string | undefined} */
@@ -21,7 +18,7 @@ let ripple_dir;
 /**
  * @returns {LanguageServicePlugin}
  */
-function createDefinitionPlugin() {
+export function createDefinitionPlugin() {
 	return {
 		name: 'ripple-definition',
 		capabilities: {
@@ -140,7 +137,9 @@ function createDefinitionPlugin() {
 						const loc = /** @type {DefinitionLocation} */ (def.location);
 
 						const embeddedCode = loc.embeddedId
-							? virtualCode.embeddedCodes?.find(({ id }) => id === loc.embeddedId)
+							? virtualCode.embeddedCodes?.find(
+									(/** @type {{ id: string }} */ { id }) => id === loc.embeddedId,
+								)
 							: undefined;
 
 						if (embeddedCode) {
@@ -207,7 +206,3 @@ function createDefinitionPlugin() {
 		},
 	};
 }
-
-module.exports = {
-	createDefinitionPlugin,
-};

package/src/documentHighlightPlugin.js

@@ -1,7 +1,7 @@
 /** @import { LanguageServicePlugin } from '@volar/language-server' */
 /** @import { LanguageServicePluginInstance } from '@volar/language-server' */
 
-const { getVirtualCode, getWordFromPosition, createLogging } = require('./utils.js');
+import { getVirtualCode, getWordFromPosition, createLogging } from './utils.js';
 const { log } = createLogging('[Ripple Document Highlight Plugin]');
 
 /**
@@ -9,7 +9,7 @@ const { log } = createLogging('[Ripple Document Highlight Plugin]');
  * Provides word highlighting (grey background) for custom Ripple keywords like 'pending'
  * @returns {LanguageServicePlugin}
  */
-function createDocumentHighlightPlugin() {
+export function createDocumentHighlightPlugin() {
 	return {
 		name: 'ripple-document-highlight',
 		capabilities: {
@@ -116,7 +116,3 @@ function createDocumentHighlightPlugin() {
 		},
 	};
 }
-
-module.exports = {
-	createDocumentHighlightPlugin,
-};

package/src/hoverPlugin.js

@@ -5,20 +5,20 @@
 	MarkupContent,
 } from '@volar/language-server'; */
 
-const {
+import {
 	getVirtualCode,
 	createLogging,
 	getWordFromPosition,
 	concatMarkdownContents,
 	deobfuscateIdentifiers,
-} = require('./utils.js');
+} from './utils.js';
 
 const { log, logError } = createLogging('[Ripple Hover Plugin]');
 
 /**
  * @returns {LanguageServicePlugin}
  */
-function createHoverPlugin() {
+export function createHoverPlugin() {
 	return {
 		name: 'ripple-hover',
 		capabilities: {
@@ -144,7 +144,3 @@ function createHoverPlugin() {
 		},
 	};
 }
-
-module.exports = {
-	createHoverPlugin,
-};

package/src/server.js

@@ -1,28 +1,28 @@
 /** @import {CompilerOptions} from 'typescript' */
 
-const { createLogging } = require('./utils.js');
-const {
+import { createLogging } from './utils.js';
+import {
 	createConnection,
 	createServer,
 	createTypeScriptProject,
-} = require('@volar/language-server/node');
-const { createCompileErrorDiagnosticPlugin } = require('./compileErrorDiagnosticPlugin.js');
-const { createDefinitionPlugin } = require('./definitionPlugin.js');
-const { createHoverPlugin } = require('./hoverPlugin.js');
-const { createCompletionPlugin } = require('./completionPlugin.js');
-const { createAutoInsertPlugin } = require('./autoInsertPlugin.js');
-const { createTypeScriptDiagnosticFilterPlugin } = require('./typescriptDiagnosticPlugin.js');
-const { createDocumentHighlightPlugin } = require('./documentHighlightPlugin.js');
-const {
+} from '@volar/language-server/node';
+import { createCompileErrorDiagnosticPlugin } from './compileErrorDiagnosticPlugin.js';
+import { createDefinitionPlugin } from './definitionPlugin.js';
+import { createHoverPlugin } from './hoverPlugin.js';
+import { createCompletionPlugin } from './completionPlugin.js';
+import { createAutoInsertPlugin } from './autoInsertPlugin.js';
+import { createTypeScriptDiagnosticFilterPlugin } from './typescriptDiagnosticPlugin.js';
+import { createDocumentHighlightPlugin } from './documentHighlightPlugin.js';
+import {
 	getRippleLanguagePlugin,
 	resolveConfig,
-} = require('@ripple-ts/typescript-plugin/src/language.js');
-const { createTypeScriptServices } = require('./typescriptService.js');
-const { create: createCssService } = require('volar-service-css');
+} from '@ripple-ts/typescript-plugin/src/language.js';
+import { createTypeScriptServices } from './typescriptService.js';
+import { create as createCssService } from 'volar-service-css';
 
 const { log, logError } = createLogging('[Ripple Language Server]');
 
-function createRippleLanguageServer() {
+export function createRippleLanguageServer() {
 	const connection = createConnection();
 	const server = createServer(connection);
 
@@ -124,7 +124,7 @@ function createRippleLanguageServer() {
 
 		// Register file watchers for TypeScript/JavaScript files so the language
 		// server is notified when they change on disk. Without this, changes to
-		// .ts files that are imported by .ripple files are not detected, causing
+		// .ts files that are imported by .tsrx files are not detected, causing
 		// stale diagnostics until the server is restarted.
 		try {
 			await server.fileWatcher.watchFiles([
@@ -156,7 +156,3 @@ function createRippleLanguageServer() {
 
 	return { connection, server };
 }
-
-module.exports = {
-	createRippleLanguageServer,
-};

package/src/typescriptDiagnosticPlugin.js

@@ -8,7 +8,7 @@
 @import {TextDocument} from 'vscode-languageserver-textdocument';
  */
 
-const { getVirtualCode, createLogging, deobfuscateIdentifiers } = require('./utils.js');
+import { getVirtualCode, createLogging, deobfuscateIdentifiers } from './utils.js';
 
 const { log, logError } = createLogging('[Ripple TypeScript Diagnostic Plugin]');
 
@@ -93,7 +93,7 @@ function processDiagnostics(document, context, diagnostics) {
  * to work correctly, as volar matches diagnostics by pluginIndex.
  * @returns {LanguageServicePlugin}
  */
-function createTypeScriptDiagnosticFilterPlugin() {
+export function createTypeScriptDiagnosticFilterPlugin() {
 	log('Creating TypeScript diagnostic filter plugin...');
 
 	return {
@@ -137,7 +137,3 @@ function createTypeScriptDiagnosticFilterPlugin() {
 		},
 	};
 }
-
-module.exports = {
-	createTypeScriptDiagnosticFilterPlugin,
-};

package/src/typescriptService.js

@@ -3,8 +3,18 @@
  * @import {TextDocument} from 'vscode-languageserver-textdocument'
  */
 
-// Monkey-patch getUserPreferences before requiring the main module
+import { createRequire } from 'node:module';
+
+// Monkey-patch getUserPreferences to inject Ripple-specific defaults.
+// We use createRequire to get the raw CJS module.exports object, bypassing
+// the bundler's __toESM wrapper which interferes with property assignment.
+// volar-service-typescript is also externalized (via regex in tsdown config)
+// so that its internal consumers (semantic.js, codeAction.js, etc.) load
+// getUserPreferences from the same Node module cache entry we patch here.
+const require = createRequire(import.meta.url);
 const getUserPreferencesModule = require('volar-service-typescript/lib/configs/getUserPreferences');
+const { create } = require('volar-service-typescript');
+
 const originalGetUserPreferences = getUserPreferencesModule.getUserPreferences;
 
 /**
@@ -24,23 +34,16 @@ getUserPreferencesModule.getUserPreferences = async function (context, document)
 	return {
 		preferTypeOnlyAutoImports: true,
 		...origPreferences,
-		...tsConfig?.preferences,
-		...rippleConfig?.preferences,
+		.../** @type {any} */ (tsConfig)?.preferences,
+		.../** @type {any} */ (rippleConfig)?.preferences,
 	};
 };
 
-// Now require the main module which will use our patched getUserPreferences
-const { create } = require('volar-service-typescript');
-
 /**
  * Create TypeScript services with Ripple-specific enhancements.
  * @param {typeof import('typescript')} ts
  * @returns {ReturnType<typeof create>}
  */
-function createTypeScriptServices(ts) {
+export function createTypeScriptServices(ts) {
 	return create(ts);
 }
-
-module.exports = {
-	createTypeScriptServices,
-};

package/src/utils.js

@@ -1,16 +1,15 @@
 /** @import { TextDocument } from 'vscode-languageserver-textdocument' */
 /** @import { LanguageServiceContext, Mapper, SourceScript } from '@volar/language-server' */
-/** @typedef {import('@ripple-ts/typescript-plugin/src/language.js').TSRXVirtualCode} TSRXVirtualCode */
-// @ts-expect-error: ESM type import is fine
+/** @import {TSRXVirtualCodeInstance} from '@ripple-ts/typescript-plugin/src/language.js'; */
 /** @import { isIdentifierObfuscated, deobfuscateIdentifier, IDENTIFIER_OBFUSCATION_PREFIX } from '@tsrx/core' */
 
-const { URI } = require('vscode-uri');
-const {
+import { URI } from 'vscode-uri';
+import {
 	createLogging,
 	getWordFromPosition,
 	charAllowedWordRegex,
 	DEBUG,
-} = require('@ripple-ts/typescript-plugin/src/utils.js');
+} from '@ripple-ts/typescript-plugin/src/utils.js';
 
 const IMPORT_EXPORT_REGEX = {
 	import: {
@@ -24,7 +23,7 @@ const IMPORT_EXPORT_REGEX = {
 	from: /from\s*['"][^'"]*['"]\s*;?/,
 };
 
-const RIPPLE_EXTENSIONS = ['.ripple', '.rsrx', '.tsrx'];
+export const RIPPLE_EXTENSIONS = ['.tsrx'];
 
 /** @type {typeof isIdentifierObfuscated} */
 let is_identifier_obfuscated;
@@ -58,7 +57,7 @@ function escapeRegExp(source) {
  * @param {string} text
  * @returns {string}
  */
-function deobfuscateIdentifiers(text) {
+export function deobfuscateIdentifiers(text) {
 	return text.replace(obfuscated_identifier_regex, (match) => deobfuscate_identifier(match));
 }
 
@@ -66,7 +65,7 @@ function deobfuscateIdentifiers(text) {
  * @param  {...string} contents
  * @returns string
  */
-function concatMarkdownContents(...contents) {
+export function concatMarkdownContents(...contents) {
 	return contents.join('\n\n<br>\n\n---\n\n<br><br>\n\n');
 }
 
@@ -76,20 +75,20 @@ function concatMarkdownContents(...contents) {
  * @param {TextDocument} document
  * @returns
 	{{
- 		virtualCode: TSRXVirtualCode;
+ 		virtualCode: TSRXVirtualCodeInstance;
 		sourceUri: URI;
 		sourceScript: SourceScript<URI> | undefined;
 		sourceMap: Mapper | undefined;
 	}}
  */
-function getVirtualCode(document, context) {
+export function getVirtualCode(document, context) {
 	const uri = URI.parse(document.uri);
 	const decoded = /** @type {[documentUri: URI, embeddedCodeId: string]} */ (
 		context.decodeEmbeddedDocumentUri(uri)
 	);
 	const [sourceUri, virtualCodeId] = decoded;
 	const sourceScript = context.language.scripts.get(sourceUri);
-	const virtualCode = /** @type {TSRXVirtualCode} */ (
+	const virtualCode = /** @type {TSRXVirtualCodeInstance} */ (
 		sourceScript?.generated?.embeddedCodes.get(virtualCodeId)
 	);
 
@@ -139,7 +138,7 @@ function isInsideImportOrExport(type, text, start) {
  * @param {number} start
  * @returns {boolean}
  */
-function isInsideImport(text, start) {
+export function isInsideImport(text, start) {
 	return isInsideImportOrExport('import', text, start);
 }
 
@@ -148,7 +147,7 @@ function isInsideImport(text, start) {
  * @param {number} start
  * @returns {boolean}
  */
-function isInsideExport(text, start) {
+export function isInsideExport(text, start) {
 	return isInsideImportOrExport('export', text, start);
 }
 
@@ -156,19 +155,8 @@ function isInsideExport(text, start) {
  * @param {string} document_uri
  * @returns {boolean}
  */
-function is_ripple_document(document_uri) {
+export function is_ripple_document(document_uri) {
 	return RIPPLE_EXTENSIONS.some((extension) => document_uri.endsWith(extension));
 }
 
-module.exports = {
-	RIPPLE_EXTENSIONS,
-	getVirtualCode,
-	getWordFromPosition,
-	is_ripple_document,
-	isInsideImport,
-	isInsideExport,
-	createLogging,
-	concatMarkdownContents,
-	deobfuscateIdentifiers,
-	DEBUG,
-};
+export { createLogging, getWordFromPosition, DEBUG };

package/tsconfig.json

@@ -1,8 +1,9 @@
 {
   "compilerOptions": {
-    "module": "node16",
-    "moduleResolution": "node16",
-    "target": "es2020",
+    "module": "esnext",
+    "moduleResolution": "bundler",
+    "target": "esnext",
+    "lib": ["esnext"],
     "allowJs": true,
     "checkJs": true,
     "noEmit": true,

package/tsconfig.typecheck.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./tsconfig.json",
+  "compilerOptions": {
+    "lib": ["esnext", "dom", "dom.iterable"],
+    "skipLibCheck": true
+  }
+}

package/tsdown.config.js

@@ -0,0 +1,41 @@
+import { defineConfig } from 'tsdown';
+import fs from 'fs';
+import path from 'path';
+import { fileURLToPath } from 'url';
+
+const dirname = path.dirname(fileURLToPath(import.meta.url));
+const isDev = process.env.NODE_ENV !== 'production';
+const ROOT_EXTERNAL_PACKAGES = [
+	'@tsrx/react',
+	'@tsrx/ripple',
+	'@tsrx/core',
+	'typescript',
+	'vscode-uri',
+	// need this for monkey patching
+	'volar-service-typescript',
+	/* also definitely need it for monkey patching */
+	/^volar-service-typescript(?:\/.*)?$/,
+];
+
+export default defineConfig({
+	inlineOnly: false,
+	entry: ['src/server.js', 'bin/language-server.js'],
+	format: ['cjs'],
+	outExtensions: () => ({ js: '.js' }),
+	platform: 'node',
+	target: 'node20',
+	outDir: 'dist',
+	sourcemap: isDev,
+	outputOptions: {
+		legalComments: 'inline',
+		minify: false,
+	},
+	external: [...ROOT_EXTERNAL_PACKAGES],
+	clean: true,
+	noExternal: /.+/,
+	hooks: {
+		'build:done': () => {
+			fs.writeFileSync(path.join(dirname, 'dist', 'package.json'), '{"type":"commonjs"}\n');
+		},
+	},
+});

package/index.js

@@ -1 +0,0 @@
-module.exports = require('./src/server');