0a8cb21e9b
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. |
||
---|---|---|
.. | ||
src | ||
.gitignore | ||
README.md | ||
eslint.config.js | ||
package.json | ||
tsconfig.json |
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ファイルが生成されます。