Converting GitHub repository names into plugin folder names on a site

[james]

View in #programming on Slack

@classicpress196: i have my plugins in folders prefixed “azrcrv”; is this bad?

@jnylen: sounds like another matter of opinion - but I think that’s a good idea for grouping all of your code together under a common convention, and also for brand recognition

@classicpress196: that’s largely why i did it
for WP i used the full azurecurve

@jnylen: one thing we haven’t settled yet is the naming convention for plugins installed from github
on github you have azurecurve/plugin-repo-name and that needs to be converted into a single folder somehow

@classicpress196: mm. i’d potentially end up with azurecurve-azrcrv-series-index
unless just the repo name element was used
but then you have the risk of collisions

@jnylen: right - we could pick something like cp__azurecurve__series-index as the default, but allow overriding that if the resulting slug is unique
so you’d just have to say “I want the folder name azrcrv-series-index for this plugin” and you’d be fine

@classicpress196: ah ok

@jnylen: details TBD
but I don’t think that’s something we had considered yet

@classicpress196: happy to help bounce ideas around when you’re at that stage

@jnylen: yeah, that would be good

[james]

View in #programming on Slack

@classicpress196: retaining the folder name will be important as I have some checks to see if another plugin is loaded and it does it using the is_plugin_active which passes in foldername/filename
just remembered that

@jnylen: ah, using a specific plugin slug?

@classicpress196: yes

@jnylen: good point

@classicpress196: for example, i integrated my series index with toggle show/hide so that I can only maintain one toggle code

[anon71687268]

I’ve been thinking a lot about this lately. Currently, installing from GitHub the plugin directory name is suffixed with -master. I can work around it, but…it’s wonky.

Also, as it turns out, @azurecurve and I have both created a “post index” plugin. I believe his directory was prefixed with his vendor prefix, but, I think he was planning on doing away with it going forward. This may get problematic once we have multiples of each type of plugin available, so, I think i’m going to revert to using the vendor prefix on my directories.

Thoughts?

[azurecurve]

I’m keeping the folder prefix, as it lets me accurately check that the plugin is installed.

I’ve been removing/avoiding duplicate code and integrating the plugins instead. For example, Series Index integrated with Toggle Show/Hide and Call-out Boxes with Icons.

[azurecurve]

As a follow up, I think the directory should prevent duplicate names/folders as they could cause problems for users.

[anon71687268]

I wouldn’t be sad if directory prefixes were fully required.

One thing I don’t want to see is grandfathering in of names/slugs that were unexpected. Think TechGasp who brazenly uses tens of high profile company names in their plugins. And Yoast, which uses wordpress-seo as a slug when wordpress is a forbidden term. These should have been given a 30-90 day window to update or get nixed.