You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Is this a feature relevant to companion itself, and not a module?
I believe this to be a feature for companion, not a module
Is there an existing issue for this?
I have searched the existing issues
Describe the feature
There are many differences between existing boilerplate and generic modules. Some of them use "require" others "import", some of them use "index.js" others "main.js" as entry point. So it's not really clear for beginners. For example "config.js" file is used to declare config fields in generic-tcpudp module but this file doesn't exist in the "template-js" structure (conf fields are declared in the "main.js" file) ...
Usecases
. Use boilerplate as starting module development point
. Same folder/structure from boilerplate to generic modules
. Clearest module dev for beginners
. copy features from generic modules to in dev module
The text was updated successfully, but these errors were encountered:
dewiweb
changed the title
provide cleaner boilerplate to start v3 module development
provide clean boilerplate to start v3 module development
Apr 16, 2024
dewiweb
changed the title
provide clean boilerplate to start v3 module development
[Request]provide clean boilerplate to start v3 module development
Apr 16, 2024
Naturally there are many modules in the wild using different variations. It depends heavily on the developer and on the needs of the module if you e.g. want to externalise some functions to different files or keep it all together. So the template shows both possibilities.
Is this a feature relevant to companion itself, and not a module?
Is there an existing issue for this?
Describe the feature
There are many differences between existing boilerplate and generic modules. Some of them use "require" others "import", some of them use "index.js" others "main.js" as entry point. So it's not really clear for beginners. For example "config.js" file is used to declare config fields in generic-tcpudp module but this file doesn't exist in the "template-js" structure (conf fields are declared in the "main.js" file) ...
Usecases
. Use boilerplate as starting module development point
. Same folder/structure from boilerplate to generic modules
. Clearest module dev for beginners
. copy features from generic modules to in dev module
The text was updated successfully, but these errors were encountered: