lifeart / lifeart/els-addon-docs

@argument completion with Typescript AddOn in Visual Studio Code

Open
#19 23 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
8
Forks
0
PR merge metrics
No merged PRs in 30d

Description

I have a component I'm developing leveraging ember-cli-typescript and ember-cli-addon-docs using the YUIDoc generator.

I'm following the YUIDoc spec to document my arguments in my interface like this:
```typescript
interface MyComponentArgs extends BaseComponentArgs {
/**
* A Custom CSS class to be added to the base component classes.
* @argument class
* @type {String}
* @public
*/
class: string;
}
```
(open to syntax corrections if there are any)

## My issue:
When in Visual Studio Code, I can type `<` and see the component name autocompletion, but when I go to then type `@` to get access to the autocomplete menu for the arguments of the component, none of the arguments appear.

**Example:** *(while in VSCode)*
```handlebars

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

Reproduce the missing argument completion in Visual Studio Code using the TypeScript interface and YUIDoc annotations shown in the issue. Start by tracing the Ember Language Server Addon Docs completion provider, and consider the issue done when typing @ after

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript, vscode
Domain
developer-experience, tooling
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.