Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/The-Commit-Company/frappe-types
Typescript type definition generator for Frappe DocTypes
https://github.com/The-Commit-Company/frappe-types
frappe-framework typescript
Last synced: 2 months ago
JSON representation
Typescript type definition generator for Frappe DocTypes
- Host: GitHub
- URL: https://github.com/The-Commit-Company/frappe-types
- Owner: The-Commit-Company
- License: mit
- Created: 2022-09-12T02:55:28.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-13T06:16:55.000Z (6 months ago)
- Last Synced: 2024-05-15T20:07:38.394Z (6 months ago)
- Topics: frappe-framework, typescript
- Language: Python
- Homepage:
- Size: 73.2 KB
- Stars: 42
- Watchers: 5
- Forks: 18
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-frappe - TypeScript Type generator - Typescript type definition generator for Frappe DocTypes. (Uncategorized / Uncategorized)
README
## Frappe Typescript Type Generator
Typescript type definition generator for Frappe DocTypes.
## Usage
To use the app, install it on your local development bench:
```bash
$ bench get-app https://github.com/The-Commit-Company/frappe-types
$ bench --site mysite.test install-app frappe_types
```
After installing the app, search for "Type Generation Settings" in Desk using the Awesomebar. You need to add the app name and path where you want to save your Typescript type definition files. frappe-types will only run on those app whose app name and path are added in these settings.
That's it.
Now whenever you create or update any DocType on your local machine, the app will generate `.ts` files under at the following path: `app/src/types//.ts`.
## Features
1. Supports most Frappe field types
2. Runs automatically whenever you save/update a DocType
3. Adds JSDoc comments for every field in the interface
4. Support CLI command to run type generation on existing DocTypes without having to update them.
## CLI Command
You can also run the type generation command from the bench CLI. This will generate types for all DocTypes in the system.
This CLI Command works for all frappe-bench apps, and can generate types of any DocType .
1. Generate types for DocType.
```bash
$ bench --site generate-types-for-doctype --app --doctype [--generate_child_tables] [--custom_fields]
# or just Answer the prompts
$ bench --site generate-types-for-doctype
```
2. Generate types for Module.
```bash
$ bench --site generate-types-for-module --app --module [--generate_child_tables]
# or just Answer the prompts
$ bench --site generate-types-for-module
```
Note: No need to mention --site if current site is same site where module/doctype existed app installed in that site.
1. `--app` - the app name included in `Type Generation Settings` doctype and where you want to save type files.
2. `--doctype` - the doctype name for which you want to generate types.
3. `--module` - the module name for which you want to generate types.
4. `--generate_child_tables` - if you want to generate types for child tables of the doctype (default=False).
5. `--custom_fields` - if you want to generate types for custom fields of the doctype (Default=False).
## Example
Let's say you create a DocType in a module called "Project Management" called "Projects" and Child Table called "Project User Table" with the following fields:
The app will automatically create a file called `Projects.ts` and `ProjectUserTable.ts` at the path `/types/ProjectManagement` like this:
(Notice that spaces in the Module and DocType names will be removed)
## Where can you use this?
If you are developing custom Frappe apps with a Frappe backend and a frontend single-page app using React/Vue/other frameworks, you can use this app to generate TypeScript definitions to be used in your frontend app.
## What features will we add next?
1. Looking at how to improve speed so that DocType saving does not take a lot of time.
## Maintainers
| Maintainer | GitHub | Social |
| -------------- | ----------------------------------------------- | ---------------------------------------------------------------- |
| Nikhil Kothari | [nikkothari22](https://github.com/nikkothari22) | [@nik_kothari22](https://twitter.com/nik_kothari22) |
| Sumit Jain | [sumitjain236](https://github.com/sumitjain236) | [@sumit_jain](https://www.linkedin.com/in/sumit-jain-66bb5719a/) |
#### License
MIT