webxdc / webxdc_docs

Documentation for Webxdc
https://docs.webxdc.org
10 stars 4 forks source link

Transfer webxdc-docs "webxdc.d.ts" to webxdc-types repo #76

Closed hpk42 closed 12 months ago

hpk42 commented 1 year ago

There are two typescript sources for webxdc:

People who use typescript probably also use npm most of the time and in any case, it's better to have the single authoritative place in our webxdc-types repo, and point to it from the webxdc-docs, instead of inlining it into the repo. As i am not myself much into typescript i'd prefer if @Simon-Laux or @Septias (both of which are TS users/likers) could do a PR. (others like @ralphtheninja and @ansuz or @r10s or @webratte are not using typescript asfaik, not sure about @adbenitez and @WofWca ). Tasks:

CC @faassen

adbenitez commented 1 year ago

I use typescrypt in some projects, it is more a situational thing depending in the project I am porting to webxdc, and sometimes if it from scratch and appropriate I also like to use typescrypt because it makes development easier for a non-advanced web developer like me (type checking/linting to avoid messing up and easy import of CSS, vite makes it quite easy to build typescrypt without any configuration)

would love to see this project as main source for types so copying the webxdc.d.ts file in every project can be avoided

WofWca commented 1 year ago

I agree, the file must be easily accessible with package managers. It's similar to webxdc.js in webxdc/hello.

I do use TS, and when I don't, then I use JSDoc.

hpk42 commented 12 months ago

all tasks are done, webxdc-types are available and linked from current webxdc-docs and the inlined copy of types is removed.