Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

バックエンドから出力されたapi.jsonを使ってmisskey-jsの型生成を行いたい #12410

Closed
samunohito opened this issue Nov 22, 2023 · 3 comments · Fixed by #12434
Assignees
Labels
packages/backend Server side specific issue/PR packages/misskey-js

Comments

@samunohito
Copy link
Member

samunohito commented Nov 22, 2023

(機能要望?とは違う気もするので空テンプレートで失礼します)

概要

今現在、misskey-jsの型定義は以下の問題を抱えています。

  • そもそも型定義が存在しない(TODOになっているものがいくつか)
  • 使う分しか実装されておらず歯抜けになっている
  • バックエンドに追従できていない

JavaScriptにトランスパイルされるためエラーとはなりませんが…補完が効かないこと、IDE上でエラー扱いされることなど、開発体験はあまり良くありません。そこで、api.jsonから型定義を生成し、それをmisskey-jsに取り込んで使用できるようにすることを提案したいです。

以下の過去issue解決により、上記も現実的になっていると思うので…

#12311
#12402

対象者

Misskey本体のフロントエンドを改修する開発者、またはmisskey-jsを使うサードパーティアプリ開発者各位

@syuilo syuilo added packages/misskey-js packages/backend Server side specific issue/PR labels Nov 22, 2023
@samunohito
Copy link
Member Author

書くの忘れてた
実装は自分がやるつもりでいます

@tai-cha
Copy link
Contributor

tai-cha commented Nov 22, 2023

related
#11440
#10752

@tamaina
Copy link
Contributor

tamaina commented Nov 24, 2023

( #10752 をやりたかったけど根気と速度がなくて諦めた

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
packages/backend Server side specific issue/PR packages/misskey-js
Projects
None yet
Development

Successfully merging a pull request may close this issue.

4 participants