[docs/feat] npm run tauri add tauri-plugin-custom for community plugins

[marcomq]

Describe the problem

So - I'm not sure if this is a bug, a feature request or something where the documentation could be improved.

I'm trying to write a plugin for tauri and I was trying to add it via npm run tauri add tauri-plugin-python
I registered the plugin tauri-plugin-python in crates.io and the npm package as tauri-plugin-python-api in npmjs.com.

But when trying to add it via npm run tauri add tauri-plugin-python, it tries to install @tauri-apps/plugin-python.
According to the cli code, @tauri-apps/plugin-... just seems to be the only scope for npm packages:
https://github.com/tauri-apps/tauri/blob/f86e2387c96b7872a7ca661fd8c22136b2932402/crates/tauri-cli/src/add.rs#L54C7-L54C15
According to the documentation, you should still call the plugin js package tauri-plugin-...-api. And it is recommended to use npm-scopes. But it seems that the only supported scope is @tauri-apps.

I guess some good and often used community plugins are manually moved to @tauri-apps
So the default way is to perform manual steps for community plugins and calling cargo add ... and npm install ... instead of npm run tauri add...

Is this correct (just asking)?

Edit:

Reproduction
Run npm run tauri add tauri-plugin-python or another community plugin. It is always trying to use an npm package fro @tauri-apps/...
Therefore, it is required to perform manual steps instead of just performing tauri add to add community plugins. This needs to be documented.

Expected behavior
Adding additional parameter --community so that community plugins can also be added via npm run tauri add ... --community which performs the same steps for community plugins as for official ones.

[FabianLars]

I guess some good and often used community plugins are manually moved to @tauri-apps

well, not really. at least not anymore (for now).

So the default way is to perform manual steps for community plugins and calling cargo add ... and npm install ... instead of npm run tauri add...

Yep

---

iirc we want tauri add to be more agnostic but didn't work towards it. now the main question is how, just by a naming scheme?

[marcomq]

Thx for the feedback. This helps a lot :)
So - I would probably add additional documentation with steps that need to be performed to install the plugin. Usually, I prefer to write code instead of documentation.

Would it help to add some parameter --inofficial so you could run
tauri add my_plugin --inofficial?

I wasn't sure if it would be easy to read and modify the tauri code, so I tried and tested it locally first.
I created fork and added a change: marcomq@db2ab14
I could create a PR
dev...marcomq:tauri:dev

I guess I would still need to create a feature request first and sign my git commit properly. It would also be fine if I rename this parameter to something else.
Should I somehow change this issue or just create a new GH issue with a feature request?

[FabianLars]

Would it help to add some parameter --inofficial so you could run
tauri add my_plugin --inofficial?

My first idea would be --community but i really hate naming things x)

I wasn't sure if it would be easy to read and modify the tauri code, so I tried and tested it locally first.
I created fork and added a change: marcomq@db2ab14
I could create a PR
dev...marcomq:tauri:dev

looks good on first glance

and sign my git commit properly

that would indeed be a requirement for the PR to be merged.

Should I somehow change this issue or just create a new GH issue with a feature request?

Changed it already :)

[marcomq]

Thx.
I just created #12246