Congrats and knowledge sharing...

[martinscio]

Hi @salmenus, like the rest of people we're using your library, I'd like to say congrats for creating this very useful lib and thank you very much for making it available for all.

I'm pretty sure you're already busy with this and other projects but I wanted to exchange some thoughts with you. I really like how you structured the project all the patterns used, how do you named this architecture you implemented? I haven't seen anything like this in my experience. Do you have documentation that I can follow to understand in details the architecture?, apart from keep reviewing the code.

Thanks in advance for you time!
✌️

[salmenus]

Hi @martinscio

Thank you for your message and for the support.
Glad that you like it.

Quick Overview:

The project structure and build pipeline is inspired by some enterprise projects that I worked on (not public).
Here is are some high level details:

• The project pipeline requires writing some extra scripts to handle versioning, package.json generation (for dev and for distribution), etc. Those script represents some (small) extra work, but the advantage is that you have a development setup that is tailor made to the project, rather than generic build tools and config. Given the large size of the project and packages that will be generated, I decided to opt for this.
• We went for Rollup as a build pipeline because it's very configurable, and gives a lot of options for build and distribution (rollup is the main command that gets triggered when dev or build scripts start).
• We use ESBuild to transpile Typescript to JS, because it's very fast with its native implementation (you can see that in the Rollup config files).
• And we use vitest for unit tests (I initially started with Jest but I had performance issues so I switched to vitest).

Code Base and Contributing:

I will add some documentation for contributors to explain the project architecture, key parts of the code base, and how to contribute.

Given the nature of the project (vanilla Javascript + React JS in the same repo), it's slightly different from a React-only code base, and it would would indeed benefit from some explanation on the project architecture and structure.

I'll try to get that doc/explanation sorted in the next week or so.
I'll comment on this discussion once it's done.

[martinscio]

Awesome, thanks a lot for the effort of creating a doc and the "how to contribute" section too. I'll be attentive, thanks again.