Microsoft/monaco-editor

[Bug] monaco.languages.Command.id should be typed as optional

Open

#3,468 opened on Dec 18, 2022

View on GitHub
 (0 comments) (0 reactions) (0 assignees)JavaScript (1,283 forks)batch import
editor-corefeature-requesthelp wanted

Repository metrics

Stars
 (14,836 stars)
PR merge metrics
 (Avg merge 6h 26m) (15 merged PRs in 30d)

Description

Reproducible in vscode.dev or in VS Code Desktop?

  • Not reproducible in vscode.dev or VS Code Desktop

Reproducible in the monaco editor playground?

Monaco Editor Playground Code

// https://microsoft.github.io/monaco-editor/playground.html#extending-language-services-codelens-provider-example

Reproduction Steps

Experiment with removing id: commandId, and notice the label is no longer clickable

Actual (Problematic) Behavior

Whether or not an id is present in the code lens command controls whether or not the label is clickable or not. Typing indicate that id is required, however: https://microsoft.github.io/monaco-editor/api/interfaces/monaco.languages.Command.html.

Expected Behavior

monaco.languages.Command.id should be id?: string or id: string | undefined.

Additional Context

This came up on CompilerExplorer (https://godbolt.org) when we converted a js file to ts.

Contributor guide

Research direction
Locate the type definition for `Command` in the monaco editor source, specifically the `id` property, and change its type from `id: string` to `id?: string`.
Tech stack
typescript
Domain
api
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
Under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScriptGit
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
85