godot-package-manager/cli

Godot package manager rust client

cli's Issues

Installing from git

npm can install packages directly from git (see https://linux.how2shout.com/how-to-install-a-npm-package-directly-from-github/).

For example we can install the private repo I modified for this test with:

npm install [email protected]:razcore-rad/godot-colorpicker-presets.git[#branch/tag/commit]

And the public repo with:

https://github.com/razcore-rad/godot-colorpicker-presets.git[#branch/tag/commit]

Where the #branch, #tag, #commit specification is optional.

For example:

code/razcore-rad/godot-4-dbg via 🐍 v3.11.2 (default) 
❯ npm i [e-mail]:razcore-rad/godot-colorpicker-presets.git#npm-test

added 1 package in 4s

code/razcore-rad/godot-4-dbg via  v20.1.0 via 🐍 v3.11.2 (default) 
❯ ls node_modules/@razcore-rad/colorpicker_presets/
╭───┬──────────────────────────────────────────────────────────────────────┬──────┬────────┬───────────────╮
│ # │                                 name                                 │ type │  size  │   modified    │
├───┼──────────────────────────────────────────────────────────────────────┼──────┼────────┼───────────────┤
│ 0 │ node_modules/@razcore-rad/colorpicker_presets/LICENSE                │ file │ 1.1 KB │ 5 minutes ago │
│ 1 │ node_modules/@razcore-rad/colorpicker_presets/README.md              │ file │ 1.4 KB │ 5 minutes ago │
│ 2 │ node_modules/@razcore-rad/colorpicker_presets/addons                 │ dir  │ 4.1 KB │ 5 minutes ago │
│ 3 │ node_modules/@razcore-rad/colorpicker_presets/colorpicker_presets.gd │ file │  722 B │ 5 minutes ago │
│ 4 │ node_modules/@razcore-rad/colorpicker_presets/package.json           │ file │  669 B │ 5 minutes ago │
│ 5 │ node_modules/@razcore-rad/colorpicker_presets/plugin.cfg             │ file │  238 B │ 5 minutes ago │
│ 6 │ node_modules/@razcore-rad/colorpicker_presets/presets.hex            │ file │  288 B │ 5 minutes ago │
│ 7 │ node_modules/@razcore-rad/colorpicker_presets/project.godot          │ file │  408 B │ 5 minutes ago │
│ 8 │ node_modules/@razcore-rad/colorpicker_presets/readme                 │ dir  │ 4.1 KB │ 5 minutes ago │
╰───┴──────────────────────────────────────────────────────────────────────┴──────┴────────┴───────────────╯

code/razcore-rad/godot-4-dbg via  v20.1.0 via 🐍 v3.11.2 (default) 
❯ bat package.json
         File: package.json
     1   {
     2     "dependencies": {
     3       "@razcore-rad/colorpicker_presets": "github:razcore-rad/godot-colorpicker-presets#npm-test"
     4     }
     5   }

This is a feature request for gpm so we can use:

code/razcore-rad/godot-4-dbg via  v20.1.0 via 🐍 v3.11.2 (default) took 2s 
❯ bat godot.package
         File: godot.package
     1   packages: {
     2       @bendn/remap: 5.1.0,
     3       [email protected]:razcore-rad/godot-colorpicker-presets.git: npm-test
     4   }

Right now I'm getting this error if I run gpm update with the above godot.package file:

code/razcore-rad/godot-4-dbg via  v20.1.0 via 🐍 v3.11.2 (default) took 20s 
❯ gpm update
       Error called `Result::unwrap()` on an `Err` value: missing field `dist` at line 1 column 21 (@src/config_file.rs:63)

I also tried:

code/razcore-rad/godot-4-dbg via  v20.1.0 via 🐍 v3.11.2 (default) 
❯ bat godot.package
         File: godot.package
     1   packages: {
     2       @bendn/remap: 5.1.0,
     3       @razcore-rad/colorpicker_presets: github:razcore-rad/godot-colorpicker-presets#npm-test
     4   }

code/razcore-rad/godot-4-dbg via  v20.1.0 via 🐍 v3.11.2 (default) took 27s 
❯ gpm update
       Error called `Result::unwrap()` on an `Err` value: missing field `dist` at line 1 column 3656 (@src/config_file.rs:63)

Scoped packages are placed under a deep folder structure and global classes don't register

A bit of background: at GDQuest we're trying to find a solution for dependencies since we have a lot of assets shared between projects, including custom global classes etc.

I think we're kind of stretching the possibilities of the Godot addon-system here, but today I experimented with a few plugins and scoped NPM packages:

• https://www.npmjs.com/package/@razcore-rad/kenny_prototype_material
• https://www.npmjs.com/package/@razcore-rad/colorpicker_presets

They are installed under the @razcore-rad folder in this case and although Godot detects the plugins, I don't think the system was meant to work this way:

❯ tree -L 2 addons/
addons/
└── @razcore-rad
    ├── colorpicker_presets
    └── kenny_prototype_material

They seem to work fine if there are no global classes (class_name) definitions, but in this case kenny_prototype_material should register a resource material. This works if I move the folder one level above:

❯ tree -L 2 addons/
addons/
├── kenny_prototype_material
│   ├── ...
└── @razcore-rad
    └── colorpicker_presets

But not if it's nested under @razcore-rad.

It would be nice to install the project at @razcore-rad.addon_name instead and this should solve the scoped packages problem. What do you think of this case?