Automatic saving of types in files when the schema is changed #29

jclaveau · 2023-07-09T08:08:55Z

Add GENERATE_TYPES_SYNCED_TS_FILES="my-synced-types.d.ts, my-second-synced-types.d.ts" to your .env (support for several files is for not fully configured monorepos like in my case)
Create/udate/delete a collection, a field or a relation
The file(s) will be updated almost instantly

This PR required some refacto

Change the extebsion type to a bundle
Slice getCollections in 2 layers to be usable with data from a module (api) and from a hook (services)
I also added support for automatic extensions reloading of the server during dev

Out of scope (IMHO)

Python files

Remaining non blocking problem:

baseUrl is not taken in consideration with the recreated extension's (as a bundle one) tsconfig.json
I'm still not sure if I prefer to use nodemon or EXTENSIONS_AUTO_RELOAD="true", please tell me your feeling!

Hoping you'll have time for a review,
Thank you for your work!

…es on creat/update/delete of collections, fields or relations Add a hook saving types in files List files to save to in an environment va factorize data gathering between the admin module and the hook closed maltejur#27

Example with Directus env var (may be faster but fuzzy log) Example with nodemon (more readable but may be slower) Add sample env.GENERATE_TYPES_SYNCED_TS_FILES to the dev project

Also adds a disclaimer to the generated types files maltejur#27

maltejur · 2023-07-09T20:11:34Z

Hi, this looks great, thanks already! I am currently not at home, so it may take some days/a week until I can review this.

jclaveau · 2023-07-10T09:24:42Z

Hi, this looks great, thanks already! I am currently not at home, so it may take some days/a week until I can review this.

No hurry, i'm using my fork with some other fixes meanwhile

maltejur

I have gone ahead and reformatted your pull request with prettier, that way we don't have stuff like using tabs for indentation in one place and spaces in a different one. Before submitting any new changes, could you also run prettier . -w first?

Another thing, when testing your changes with yarn dev:project, I am getting the following error when visiting the Directus interface:

When I disable the extension through the following change, it works flawlessly again

--- a/dev.sh
+++ b/dev.sh
@@ -35,9 +35,6 @@ fi
 
 echo "-> Building and linking extension"
 
-(cd .. && yarn directus-extension link ./dev/extensions)
-(cd .. && yarn dev &)
-
 echo
 echo "-> Starting dev server"
 echo "   You can log in with:"

Could you try to figure out what is causing this?

maltejur · 2023-07-14T18:26:13Z

dev.sh

@@ -40,3 +46,4 @@ echo "     pw:    admin"
 echo

 yarn directus start
+# yarn dev:nodemon # using nodemon produces more readable log than EXTENSIONS_AUTO_RELOAD="true"


Lets use nodemon then

maltejur · 2023-07-14T18:43:21Z

src/extension-module.admin/routes/oas.vue

+import generateOasTypes from "../../lib/generate-types/oas";
+import languages from "../lib/languages";


Is there any particular reason you turned these into relative imports?

jclaveau added 7 commits July 7, 2023 13:19

refactor(extension)!: Transform the extension as a "bundle"

6706fc3

refactor: rename extensions folders

52f1fea

chore(package): add author and contributors sections to package.json

4bf4a69

chore: autoreload extensions in dev project when rebuilt

ee16b82

Example with Directus env var (may be faster but fuzzy log) Example with nodemon (more readable but may be slower) Add sample env.GENERATE_TYPES_SYNCED_TS_FILES to the dev project

chore: Fix an error during extension dev watch and missing nodemon args

1a0a076

feat(synced-files): sync type files when directus starts

fc37e37

Also adds a disclaimer to the generated types files maltejur#27

jclaveau mentioned this pull request Jul 9, 2023

Automatic saving of types in files when the schema is changed (reopened) #28

Closed

maltejur added 2 commits July 14, 2023 20:40

Merge remote-tracking branch 'origin/master' into automatic_sync_ts_file

5059747

format files with prettier

f79e32e

maltejur force-pushed the automatic_sync_ts_file branch from d5b7db6 to f79e32e Compare July 14, 2023 18:41

maltejur requested changes Jul 14, 2023

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Automatic saving of types in files when the schema is changed #29

Automatic saving of types in files when the schema is changed #29

jclaveau commented Jul 9, 2023

maltejur commented Jul 9, 2023

jclaveau commented Jul 10, 2023

maltejur left a comment

maltejur Jul 14, 2023

maltejur Jul 14, 2023

		import generateOasTypes from "../../lib/generate-types/oas";
		import languages from "../lib/languages";

Automatic saving of types in files when the schema is changed #29

Are you sure you want to change the base?

Automatic saving of types in files when the schema is changed #29

Conversation

jclaveau commented Jul 9, 2023

This PR required some refacto

Out of scope (IMHO)

Remaining non blocking problem:

maltejur commented Jul 9, 2023

jclaveau commented Jul 10, 2023

maltejur left a comment

Choose a reason for hiding this comment

maltejur Jul 14, 2023

Choose a reason for hiding this comment

maltejur Jul 14, 2023

Choose a reason for hiding this comment