WebAssembly / WebAssembly/component-model

Should WIT keywords be escaped in the Canonical ABI?

Open
#87 4 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
WebAssembly
Stars
1.4k
Forks
130
Avg merge
2d 1h
Merged PRs (30d)
15

Description

Currently, the Canonical ABI is defined to simply insert function names as-is:

https://github.com/WebAssembly/component-model/blob/4d412d98372222979a7d5531cbb42c08961f596d/design/mvp/canonical-abi/definitions.py#L1109-L1112

It's the same for field names, param names, etc.

This means that functions which happen to have the same name as WIT keywords won't be escaped, and will be inserted directly.

Should they be %-escaped, to align with WIT? Or is it fine for the Canonical ABI to be different here?

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with design/mvp/canonical-abi/definitions.py at lines 1109-1112, then compare how function, field, and parameter names are represented with WIT keyword escaping. Determine whether the Canonical ABI should percent-escape these names and document the resolved behavior in the specification.

Written by the indexing model from the issue text.

Assessment

Tech stack
wasm
Domain
compilers
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.