Make liquid-html-parser ESM-compatible for @ohm-js/wasm #1114
+149
−152
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Update tsconfig.json for ES2020 target and node20 module system. Add explicit moduleResolution: node to codemirror-language-client and lang-jsonc packages. This is preliminary configuration work for ESM compatibility. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
charlespwd
force-pushed
the
cp-esm-rejig
branch
from
f5559e6 to
68d4049
Compare
Replace ohm-js with @ohm-js/wasm for browser compatibility.
Key changes:
- Add @ohm-js/wasm dependency
- Update imports to use @ohm-js/wasm and @ohm-js/wasm/compat
- Replace toAST() with new AstBuilder(mappings).toAst() pattern
- Update CST mapping functions for WASM CST structure:
- Use opt.when({ Some:..., None:... }) for optional nodes
- Use iter.when() for iteration nodes
- Adjust numeric indices for non-flattened Opt nodes
- Use res.use() for MatchResult lifetime management
- Update CstNode types and AstBuilder generics
This enables the parser to work in browser environments where
CommonJS require() is not available.
Co-Authored-By: Patrick Dubroy <pdubroy@gmail.com>
Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
The @ohm-js/wasm Compiler module references process.env.OHM_DEBUG for debug logging. This doesn't exist in browser environments, causing "process is not defined" errors when the extension activates. Add DefinePlugin entries for both browserClientConfig and browserServerConfig to set this to false at build time. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
charlespwd
force-pushed
the
cp-esm-rejig
branch
from
68d4049 to
1de4881
Compare
The previous ESM commit (542561b) configured TypeScript but left the source files using CommonJS patterns. This commit completes the migration: - Add `"type": "module"` to package.json (required for Node.js to recognize .js files as ESM) - Add .js extensions to all relative imports (required by ESM spec) - Convert grammar loader from CommonJS require() to ESM import - Rename shims.js to shims.cjs (build script uses CommonJS) - Update shims to generate `export default` instead of `module.exports` - Exclude grammar folder from TypeScript build (prevents overwrite error) Without `"type": "module"`, TypeScript's node20 module setting defaults to CommonJS output based on the package.json type field. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
The CI build failed because TypeScript tried to emit the grammar JS file back to its source location. This happened because: 1. Root tsconfig has `allowJs: true` 2. TypeScript processed the imported grammar file as input 3. With ESM, the grammar file is in the module graph Fix by: - Set `allowJs: false` in tsconfig.build.json to prevent TS from processing the .js file as an input - Generate a .d.ts alongside the .js in shims.cjs to provide types Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
The previous commits attempted a full ESM migration for liquid-html-parser which broke downstream CommonJS consumers (ERR_REQUIRE_ESM error). Revert to CommonJS output while keeping @ohm-js/wasm imports. This works because: 1. TypeScript's module:node20 outputs CommonJS when there's no "type":"module" 2. Node.js can require() ESM packages from CommonJS code (internal handling) 3. Webpack bundles both CJS and ESM seamlessly Key reversions: - Remove "type": "module" from package.json - Revert grammar.ts to use require() for grammar file - Revert shims.cjs to generate module.exports - Remove .js extensions from relative imports - Remove allowJs:false and .d.ts generation This reverts commits 39c29d8 and 75093c7. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Resolves ESM/CJS incompatibility so liquid-html-parser can consume the ESM-only @ohm-js/wasm package.
Key Changes
module: "ESNext",moduleResolution: "bundler")res.use()patterns: Replace globaluse()calls with resource-scopedres.use()for grammar loadingprocess.env.OHM_DEBUGin browser bundle to prevent runtime errorsTest Results
Context
Builds on Patrick's PR #1070 work for browser test infrastructure.