Automatic checking of all MagicMirror² modules

karsten13

from the results:

.gitlab-ci.yml: Change file extention from .yml to .yaml: https://yaml.org/faq.html.

In this case the .gitlab-ci.yml is the default name of the gitlab pipeline definition file (users can change this but 99% will not) so if you really want to check yml vs. yaml you need a whitelist …

karsten13

@KristjanESPERANTO

there was a discussion long ago here about 3rd party modules because the current format is very ugly.

So maybe this could be also a starting point to have the module list as e.g. yaml output with all current stuff and your analysis results. With such an input it would be possible to generate a website (as mentioned in the above issue, examples how this could look were https://tiny-helpers.dev/ or https://www.electronjs.org/apps) …

KristjanESPERANTO

@karsten13 said in Automatic checking of all MagicMirror² modules:

if you really want to check yml vs. yaml

Yeah, I’ll drop this test for now.

maybe this could be also a starting point to have the module list as e.g. yaml output with all current stuff and your analysis results.

Interesting direction. I’ll take a look at it 🙂

karsten13

@KristjanESPERANTO

it would be better to reveal the last update date or the number of unresolved issues

as most modules are hosted on github: You can get such info’s over their api.

As example you can look at https://api.github.com/repos/MichMich/MagicMirror

KristjanESPERANTO

@karsten13 said in Automatic checking of all MagicMirror² modules:

as most modules are hosted on github: You can get such info’s over their api.

Wow. That’s really nice! There are certainly some things that can be put to good use.

After you showed me the examples, I tinkered a bit with a simple frontend (without dependencies): check it out. I just have to fill it with real data.

karsten13

@KristjanESPERANTO said in Automatic checking of all MagicMirror² modules:

After you showed me the examples, I tinkered a bit with a simple frontend (without dependencies): check it out. I just have to fill it with real data.

cool, exactly what I thougth of …

looking at your example json

  {
    "name": "MMM-PublicTransportHafas",
    "image": "https://raw.githubusercontent.com/KristjanESPERANTO/MMM-PublicTransportHafas/main/img/Goerdelerring_all.png",
    "maintainer": "KristjanESPERANTO",
    "link": "https://github.com/KristjanESPERANTO/MMM-PublicTransportHafas",
    "category": "Traffic",
    "tags": ["Schedule", "Public Transport", "Traffic", "HAFAS"],
    "text": "This module displays real-time departure times for public transportation.",
    "description": "Stay informed about the upcoming departures from your local public transit stations."
  },

there are only a few things which are not available via github api (image, category).

category and tags are similar, do we still need a category?

tags are similar to api topics (may without magicmirror key words)

MMRIZE

One of the most popular modules MMM-Remote-Control uses similar JSON as a module-list.
And MMM-Remote-Control-Repository are serving that JSON file for MMM-Remote-Control.
However, if it is possible to serve a similar JSON URI, it could be a good replacement.

KristjanESPERANTO

@karsten13 said in Automatic checking of all MagicMirror² modules:

category and tags are similar, do we still need a category?

Good point! The mass of tags will certainly become a bit confusing. We could replace the category links in the menu by a few selected tags or we highlight certain tags so that they are more noticeable. I think I’ll try it in this direction.

@MMRIZE said in Automatic checking of all MagicMirror² modules:

MMM-Remote-Control uses similar JSON as a module-list.

You’re right, it would be cool to get compatibility with MMM-Remote-Control. Thanks for the hint!

KristjanESPERANTO

I made some progress: https://kristjanesperanto.github.io/MagicMirror-3rd-Party-Modules/

There’s still a lot on the to-do list and some things aren’t working quite smoothly yet. But the website is now filled with data from all modules from the wiki.

When changes are made in the wiki, it doesn’t take much effort to update the data in this project - I just have to run a few scripts. Furthermore, no manual work is necessary.

KristjanESPERANTO

@karsten13 said in Automatic checking of all MagicMirror² modules:

You can get such info’s over their api.

Unfortunately the API blocks me when I make queries for almost 1000 modules in a short time 🤪

I now take the tags from keywords in the package.json.