WebAssembly / WebAssembly/component-model

Enable WIT gates to take user-defined strings as arguments

Open
#388 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Following #377, we'd like to be able to write @deprecated with a message parameter containing a user-defined string, like this:

package local:demo;

interface host {
  @deprecated(version = "1.1.0", message = "please use function `bar` instead")
  @since(version = "1.0.0")
  foo: func(msg: string);
  
  @since(version = "1.1.0")
  bar: func(msg: string);
}

That's currently not possible because we don't yet have a string syntax for WIT (did I get that right?). Given that @message was optional we decided to punt on that instead. I'm filing this issue to make sure we keep track that this is a feature we'd like to add, but are currently blocked on figuring out how we want to handle strings.

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 by reviewing issue #377 and the linked discussion about WIT string syntax. Determine how user-defined strings should be represented as gate arguments, including the deprecated message example, and define the syntax and behavior needed for that example to be accepted.

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.