📦 Orbital Shell Modules

[franck-gaspoz]

this topic is about shell modules

• there is a module template project that helps to make a new module: OrbitalShell-Module-Template
• clone this project to make a new module and replace properties {Module...}
• or use a command that is integrated to the shell to generate a new module project on dev machine:
  
  tools-shell-new-module {projectModuleRepositoryUrl} [-i {moduleSettingsFile}] [-s]

[franck-gaspoz]

Make a new module (dotnet module project) with the shell command module generator

cd myProjectsFolder
new-module MyModule https://github.com/OrbitalShell/My-Module.git -i MyModule/module-settings.json -s

these lines tells the shell to:

• generates a dotnet module project from the module project template repository (https://github.com/OrbitalShell/OrbitalShell-Module-Template.git)
• module ID is 'ModuleId' , this is the name of the .net project, prefix of the main class, ...
• https://github.com/OrbitalShell/My-Module.git is the exisiting or future repository of the new module project. if it exists, it is connected and populated from the generated project repo (it must initialy ⚠️ contains a single file that will be deleted later)
• -i indicates a location of a json file containing generator settings. in this case, we use the defaults settings provided in the template project.
• -s indicates to skip any errors to try performing the maximum operations

the command perform these operations:

• generates a dotnet project
• clone the module project repository
• setup template properties
• connect the repository to it's new location
• restore packages and build the project

# let's open the project with vscode and let's develop
code .