https://github.com/baybreezy/strapi-plugin-gen-types

Generate types for the different collections, single types & components found in your application
https://github.com/baybreezy/strapi-plugin-gen-types

strapi-plugin strapi5

Last synced: 3 months ago
JSON representation

Generate types for the different collections, single types & components found in your application

• Host: GitHub
• URL: https://github.com/baybreezy/strapi-plugin-gen-types
• Owner: BayBreezy
• License: mit
• Created: 2024-09-27T02:13:15.000Z (4 months ago)
• Default Branch: main
• Last Pushed: 2024-11-14T03:52:16.000Z (3 months ago)
• Last Synced: 2024-11-14T03:55:25.859Z (3 months ago)
• Topics: strapi-plugin, strapi5
• Language: TypeScript
• Homepage: https://www.npmjs.com/package/strapi-plugin-gen-types
• Size: 1.67 MB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE.md

Awesome Lists containing this project

README

        


# Strapi Plugin Gen Types

Generate types for the different collections, single types & components found in your application.

![Screenshot of Gen Types UI in Strapi Admin Panel](/screenshot.jpeg)

> This plugin is still in development. Please use with caution.

> This plugin will not run in production. It is only meant to be used in development.

## Installation

```bash

yarn add strapi-plugin-gen-types

```

```bash

npm install strapi-plugin-gen-types

```

## Configuration

You can configure the plugin by updating the `config/plugins.ts` file in your Strapi project.

The following options are available:

- `outputLocation` - The location where the types will be generated. Default: `src/genTypes`

- `singleFile` - Whether to generate a single file for all types or separate files for each collection. Default: `false`

```typescript

// config/plugins.ts

export default ({ env }) => ({

  "gen-types": {

    enabled: true,

    config: {

      outputLocation: "myTypes.ts",

      // If this is true, then the outputLocation should be the location to a .ts file

      singleFile: true,

    },

  },

});

```

The plugin will generate types for the collections found in the `api` folder of your Strapi project.

It will also add a few extra interfaces like `User`, `Role`, `Media` etc.

## Admin UI

The plugin will add a new menu item `Generated Types`. This page will show the generated interfaces.

You can expand each interface to see the fields and their types.

Clicking on the copy button will copy the interface to your clipboard.

## License

MIT

## Contributing

I am super new to React. I prefer Nuxt. I am not sure if how I implemented the Admin UI is the best way to do it. I would appreciate any help in improving it. Thanks.

Just fork the repo and create a PR. I will be happy to merge it.