novacbn / gmodproj Goto Github PK

Requested by #6

gmodproj add <...packages> - Adds and installs new dependencies.

Proposed gmodproj add workflow:

• gmodproj clones the package repository.
  • commit hashes and semver commit tags can be specified e.g. gmodproj add 1.0.0@git://my.domain/package
• Reads the package's .gmodmanifest and stores the package's source code within CACHE/PROJECTAUTHOR/PROJECTNAME/COMMITHASH for later installations
• Clones package from gmodproj's cache by commit hash into project's packages folder as packages/PROJECTAUTHOR/PROJECTNAME
• Stores package by commit hash, commit tag(if applies), and url in .gmodpackages.
• Alias for GitHub based repositories via github://USERNAME/PROJECTNAME

Proposed gmodproj install workflow:

• Read project's .gmodpackages file and installs all uninstalled repositories.

As a macOS user,
In order to build `gmodproj` from source,
I need the ability to bootstrap the build process with a binary release for the Darwin platform.

I'm really interested in building an addon with gmodproj and Moonscript, and I'd be happy to contribute given some guidance.

gmodproj docs <file> [theme] [directory] - Reads documentation from JSON file exported via gmodproj export and generates a static HTML site.

(consideration: include functionality within gmodproj or standalone CLI tool?)

(alternatively: generate markdown files that contain metadata, to work with other software)

REJECTED: External or gmodproj app <app> applications should handle this.

Garry's Mod seems to not want to autorun a script with a name containing two dots. I have changed my .gmodprojmanifest so the first dot is now a dash in the generated filenames, and it autoruns as expected.

gmodproj install - Read's project's .gmodpackages file and installs all uninstalled repositories.

gmodproj export [file] - Reads comments in source code for utilizing the gmodproj documentation format. Exporting as JSON to the specified file (or documentation.json by default)