Quick fix proposal: declare property for jsdoc types

From https://github.com/Microsoft/vscode/issues/44824

Search Terms

• quick fix / code action
• jsdoc / jsdocs

Suggestion

Introduce a new refactoring that introduces a property into a jsdoc type. For example, for the js:

//@ts-check

/**
 * @param {{ }} arg
 */
function doStuff(arg) {
    console.log(arg.noSuch);
}

A quick fix on noSuch would add this property to the type of arg:

//@ts-check

/**
 * @param {{noSuch: object }} arg
 */
function doStuff(arg) {
    console.log(arg.noSuch);
}

A similar refactoring already exists for typescript:

interface IFoo {
    a: number
}

function doStuff(arg: IFoo) {
    console.log(arg.noSuch);
}

Use Cases

Improve experience using ts-check, especially if using complex types

Other cases to consider

typedef

//@ts-check

/**
 * @typedef {{ a: number}} IFoo
 */

/**
 * 
 * @param {IFoo} arg 
 */
function doStuff(arg) {
    console.log(arg.noSuch);
}

Augments

/**
 * @augments {Component<{}>}
 */
class Binek extends Component {
	render() {
		console.log(this.props.noSuch)
	}
}

Inizia con il refactoring TypeScript esistente per aggiungere una proprietà all’interfaccia e con il problema collegato di VS Code, quindi confrontane il comportamento con gli esempi di parametri JSDoc, typedef e augments qui riportati. Il lavoro è completato quando un quick fix può aggiungere la proprietà mancante al tipo JSDoc pertinente coprendo i casi elencati.