Automatic checking of all MagicMirror² modules

KristjanESPERANTO

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

Just out of interest, which image does it select as the thumbnail?

If the script doesn’t find an image with ‘screenshot’ or ‘example’ at the beginning of the name it takes the first it finds .

The prerequisite for the whole thing is that a free license is specified in the package.json. If there is no package.json and no free license, no image will be searched.

Stats were great, fixed most of the issues identified in my modules.

Nice, thank you! I just updated the list and a lot of issues disappeared 👏

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

I don’t know how to make that happen in my text editor

On my keyboard it’s just +

and its useless

I think it’s worth striving to call things by their proper names, so I don’t find the test useless. Feel free to just ignore it :-)

there is no need for a package,json… as this module does all its work inside the modulename.js there is no functional requirement

You are right, functionally there is no need for this. However, the file is a good source of information that is interesting for the website - e.g. keywords.

MMM-Alexa

Do you know if the original module (https://github.com/sakirtemel/MMM-alexa) still works? Otherwise I should mark it as outdated.

and one of my modules (the only one I have ever posted) is not present in the master list , and I did not remove it. MMM-SleepWake

I’ve added it now :-)

sdetweil

@KristjanESPERANTO I have no info on MMM-Alexa or why i forked it

KristjanESPERANTO

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

and this is misleading

There is no package.json. We need this file to gather information about the module.

I added ‘for the website’ at the end of the sentence. I hope that this is clearer.

Thanks for the feedback :-)

sdetweil

@KristjanESPERANTO I have no website.

KristjanESPERANTO

@sdetweil Yes, I mean this website: https://kristjanesperanto.github.io/MagicMirror-3rd-Party-Modules/. Information from the package.json files is used there.

BKeyport

@KristjanESPERANTO “This” instead of “The” perhaps?

KristjanESPERANTO

@BKeyport Good suggestion :-) But what do you think of this:

No keywords in 'package.json'. We would use them as tags on the module list website.

BKeyport

@KristjanESPERANTO Kinda awkward, honestly.

KristjanESPERANTO

@BKeyport Sorry, I tend to use the logic of my native language in my English sentences 😅

BKeyport

@KristjanESPERANTO I figured that’s what it was. Not a big deal - everyone here don’t speak english properly, even us native speakers. 🤣`

KristjanESPERANTO

@BKeyport 😆

I thought “This” doesn’t fit so well because the sentence is on the page with the issues and not on the page of the modules where the keywords are used. Is the following issue messages less awkward? Do you have another idea?

There are no keywords in 'package.json'. We would use them as tags on the module list page.

There is no 'package.json'. We need this file to gather information about the module for the module list page.

BKeyport

@KristjanESPERANTO

There is no package.json. We need this file to gather information about the module for this website

is what I meant.

Jalibu

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

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

Just out of interest, which image does it select as the thumbnail?

If the script doesn’t find an image with ‘screenshot’ or ‘example’ at the beginning of the name it takes the first it finds .

Hi @KristjanESPERANTO does it expect the example.png in a specific folder (such as img/ or /) or can it also lookup in docs/?

sdetweil

@KristjanESPERANTO and, this impacts my scripts as i use package.json as the indicator for doing an npm install in the module folder.

KristjanESPERANTO

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

Hi @KristjanESPERANTO does it expect the example.png in a specific folder (such as img/ or /) or can it also lookup in docs/?

No, you can put it where ever you want :-)

KristjanESPERANTO

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

@KristjanESPERANTO and, this impacts my scripts as i use package.json as the indicator for doing an npm install in the module folder.

There are some modules that only have devDependencies, so your script already makes unnecessary npm install calls. Can you adjust your trigger and check whether dependencies are set in the package.json?

MZ-BER

Great work @KristjanESPERANTO. Really, really like this. Is there a way to also publish the github stars and # of forks? I also would love if there is a way to “like” a module.

MMRIZE

I suggest you and the community expand package.json to regularise the details of the module. (recommended but optional)
For example;

{
  "name": "mmm-something",
  "version": "1.0.0",
  ...
  "mm" : {
    "communityId" : "johndoe",
    "community" : "MagicMirror forum",
    "screenshot" : "https://somewhere.com/screenshot.png",
    "install" : "https://github.com/johndoe/mmm-something/README.md#installation",
    "update" : "...",
    "email" : "johndoe@somewhere",
    "required: {
      "mm" : "2.25",
      "node" : "18.0"
    },
    "notice" : [
      "This will not work in Windows.",
      "Pre-dependency required. Please readme."
    ]
  }
}

The fields are my imagination. Maybe the community can reach an agreement on rules.

mumblebaj

@KristjanESPERANTO My MMM-SweepClock doesn’t have a package.json either as all work done in the MMM-SweepClock.js file. I can add one for completeness and conformity. I also notice I did not have an image. I usually name my images image-1.png etc. so the main image is generally the first one.

sdetweil

@KristjanESPERANTO oh, and one more thing… my MMM-SleepWake module does not have any UI… so there is no photo…