break-stuff/cem-tools

[Custom Element VS Code Integration] `descriptionSrc` configuration docs

Closed this issue · 3 comments

arieffikhrie commented

I have CEM file that in the module it do have another custom properties that i added as part of description, so i need to use specific property for it, in the README file on this vs-code-integration package,

cem-tools/packages/vs-code-integration/README.md

Line 100 in 94d8a4f

descriptionSrc?: "description" | "summary" | string;

it does have the options for the descriptionSrc and it does show the type of "description" | "summary" | string, but it actually only accept "description" | "summary", based on this base type

cem-tools/tools/configurations/src/config.ts

Line 7 in 94d8a4f

descriptionSrc?: "description" | "summary";

So it would return typescript error that it does not allow any string property that i want to use.

Can you update the type to be something like this

export interface BaseOptions {
  // ...
  /** The property name from the component object that you would like to use for the description of your component */
  descriptionSrc?: "description" | "summary" | ( string & {}) ;

or you can take a look on the type-fest package on LiteraUnion https://github.com/sindresorhus/type-fest/blob/main/source/literal-union.d.ts

break-stuff commented

I think we should be able to accommodate this.

break-stuff commented

I just deployed a change for this. Let me know if you run into any issues.

  • 👍1
arieffikhrie commented

It works now, thanks, no more @ts-ignore for me 😅

  • 🎉1