etc/Sharkey
0
0
Fork 0
mirror of https://activitypub.software/TransFem-org/Sharkey synced 2024-12-01 18:27:29 +00:00
Code Issues Projects Releases Packages Wiki Activity
Sharkey/packages/misskey-js/generator
History
4censord 0a8cb21e9b
Run eslint with caching 
This reduces the time for subsequent lints significantly.
e.g. for `package/frontend`, the first run takes ~10min.
With the cache, every subsequent run takes only a few seconds.
2024-09-14 00:58:02 +02:00
..
src feat(misskey-js): multipart/form-dataのリクエストに対応 (#14147) 2024-07-07 14:08:18 +09:00
.gitignore バックエンドが生成するapi.jsonからmisskey-jsの型を作成する (#12434) 2023-12-02 21:00:05 +09:00
eslint.config.js update deps (#14057) 2024-07-02 11:38:34 +09:00
package.json Run eslint with caching 2024-09-14 00:58:02 +02:00
README.md バックエンドが生成するapi.jsonからmisskey-jsの型を作成する (#12434) 2023-12-02 21:00:05 +09:00
tsconfig.json バックエンドが生成するapi.jsonからmisskey-jsの型を作成する (#12434) 2023-12-02 21:00:05 +09:00

README.md

misskey-js向け型生成モジュール

バックエンドが吐き出すOpenAPI準拠のapi.jsonからmisskey-jsで使用される型エイリアスを生成するためのモジュールです。 このモジュールはmisskey-jsそのものにバンドルされることは想定しておらず、生成物をmisskey-jsのsrc配下にコピーして使用することを想定しています。

使い方

まず、Misskeyのバックエンドからapi.jsonを取得する必要があります。任意のMisskeyインスタンスの/api-docからダウンロードしても良いですし、 backendモジュール配下でpnpm generate-api-jsonを実行しても良いでしょう。

api.jsonを入手したら、このファイルがあるディレクトリに置いてください。

その後、以下コマンドを実行します。

pnpm generate

上記を実行することで、./builtディレクトリ配下にtsファイルが生成されます。