Clarify if users shuold git ignore *.mjs files and other files generated during codegen

[PaulRBerg]

Problem

Running envio codgen generates a look like so:

Dependency on rescript-schema
rescript: [9/9] src/S-RescriptSchema.cmj
rescript: [10/10] install.stamp
Dependency on rescript-envsafe
rescript: [5/5] src/EnvSafe.cmj
rescript: [7/7] install.stamp
Dependency on @glennsl/rescript-fetch
rescript: [12/12] src/Fetch.cmj
rescript: [17/17] install.stamp
Dependency on @rescript/react
rescript: [55/55] src/v3/ReactV3.cmj
rescript: [71/71] install.stamp
Dependency on envio
rescript: [84/84] src/sources/HyperSyncJsonApi.cmj
rescript: [111/111] install.stamp
Dependency Finished
rescript: [211/211] src/Index.cmj
>>>> Finish compiling 1284 mseconds

It is not clear whether those *.stamp, *.cmj, etc., files are generated in my own src directory or in a virtual environment somewhere else. If the former case applies, then users should git ignore those files since they are transitory.

Solution

Clarify whether users should git-ignore these paths in their own .gitignore file. Ideally, provide an example .gitignore file they could copy-paste.

[DZakh]

Do you mean that the artifacts are generated in your working src dir? If so, it's definitely a bug. Could you try the latest version or provide a reproduction example.

[PaulRBerg]

No artifacts are generated in the working directory.

This is strictly a documentation request - it would be helpful to explictly mention whether any files/extensions should be git ignored (or not).