https://github.com/maltejur/directus-extension-generate-types

Create types for your directus project in your favourite language.
https://github.com/maltejur/directus-extension-generate-types

Last synced: 1 day ago
JSON representation

Create types for your directus project in your favourite language.

• Host: GitHub
• URL: https://github.com/maltejur/directus-extension-generate-types
• Owner: maltejur
• License: other
• Created: 2021-10-03T16:09:51.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-09-01T14:48:40.000Z (4 months ago)
• Last Synced: 2024-12-29T19:50:09.258Z (7 days ago)
• Language: TypeScript
• Homepage:
• Size: 241 KB
• Stars: 215
• Watchers: 11
• Forks: 27
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

• awesome-directus - Generate Types - Adds a module for generating typescript types for a Directus JS-SDK connected to that Directus database. Also can generate Python or OpenAPI types. (Extensions / Community)

README

        


  
directus-extension
generate-types

  
Create types for your directus project in your favourite language.


![Screenshot_20220519_135945](https://user-images.githubusercontent.com/48161361/169288405-c1589f58-d6e4-4a91-91d6-fc9008c8dd97.png)

### Currently supports

- TypeScript

- Python Type Hints

- OpenAPI Specification

- More soon™

## How to install

1. Download the latest `index.js` from the [GitHub releases page](https://github.com/maltejur/directus-extension-generate-types/releases).

2. Put this `index.js` file into `/extensions/modules/generate-types/index.js`

3. Go into the `Project Settings` of your directus project (`/admin/settings/project`) and enable the `Generate Types` module at the bottom of the page.

## Contribute

Since I don't know all of the typing systems out there, I would greatly appreciate if you

would let me know how types for a language you know should look like, or even implement

the generation of types for that language yourself.

If you find an error or think somthing in the process of generating types for the current

languages is done in a dumb way, feel free to also open an issue.