Module Setup and Structure
This section describes the files and file structure necessary to create a module repository.
Essential Files
- File Structure
- companion/HELP.md
- companion/manifest.json
- node_modules folder
- src/main.ts (or main.js, for the JavaScript template)
- .gitignore
- LICENSE
- package.json
- README.md
- Additional files for good practices
- Next steps
manifest.json file
Code Quality Configs
- Installation
- Prettier config
- ESLint config
- Enabling linting on commit
- Running the linter on push
- Customising the rules
- Upgrading to @companion-module/tools v2.x