misskey/packages/misskey-js/generator
dependabot[bot] e8206aecc3
chore(deps-dev): bump the typescript-eslint group across 1 directory with 2 updates
Bumps the typescript-eslint group with 2 updates in the / directory: [@typescript-eslint/eslint-plugin](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/eslint-plugin) and [@typescript-eslint/parser](https://github.com/typescript-eslint/typescript-eslint/tree/HEAD/packages/parser).


Updates `@typescript-eslint/eslint-plugin` from 7.1.0 to 8.14.0
- [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases)
- [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/eslint-plugin/CHANGELOG.md)
- [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v8.14.0/packages/eslint-plugin)

Updates `@typescript-eslint/parser` from 7.1.0 to 8.14.0
- [Release notes](https://github.com/typescript-eslint/typescript-eslint/releases)
- [Changelog](https://github.com/typescript-eslint/typescript-eslint/blob/main/packages/parser/CHANGELOG.md)
- [Commits](https://github.com/typescript-eslint/typescript-eslint/commits/v8.14.0/packages/parser)

---
updated-dependencies:
- dependency-name: "@typescript-eslint/eslint-plugin"
  dependency-type: direct:development
  update-type: version-update:semver-major
  dependency-group: typescript-eslint
- dependency-name: "@typescript-eslint/parser"
  dependency-type: direct:development
  update-type: version-update:semver-major
  dependency-group: typescript-eslint
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-11-18 06:49:15 +00:00
..
src fix(misskey-js): content-typeはapplication/jsonでないもののみを記録するように (#14508) 2024-09-06 17:22:45 +09:00
.gitignore バックエンドが生成するapi.jsonからmisskey-jsの型を作成する (#12434) 2023-12-02 21:00:05 +09:00
README.md バックエンドが生成する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 chore(deps-dev): bump the typescript-eslint group across 1 directory with 2 updates 2024-11-18 06:49:15 +00: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ファイルが生成されます。