Improve recipe packaging script

This commit will improve the usability of the packaging script, especially for beginners.

It will output better error messages if there are any problems with the recipe. It will also add more tests to improve detecting those problems.
This way, more problems can be detected before even needing to create a PR.

5 files changed, 247 insertions, 122 deletions

diff --git a/scripts/add_github.js b/scripts/add_github.js
index 543e347..4a5cfce 100644
--- a/scripts/add_github.js
+++ b/scripts/add_github.js
@@ -6,6 +6,7 @@ const targz = require('targz');
 const fs = require('fs-extra');
 const path = require('path');
 const GitUrlParse = require("git-url-parse");
+const packageRecipe = require('./api/package');
 
 // Helper: Download file to filesystem
 const downloadFile = (async (url, path) => {
@@ -30,7 +31,7 @@ const decompress = (src, dest) => {
           dest
       }, function (err) {
           if (err) {
-              console.log('Error while decompressing recipe:', err);
+              console.log('⚠️ Could not add your recipe: There was an error while decompressing your GitHub repository file: ', err);
           }
           resolve();
       });
@@ -40,7 +41,11 @@ const decompress = (src, dest) => {
 const repo = process.argv[2];
 
 if (!repo || !/https:\/\/github\.com\/[^\/]+\/[^\/]+\/?/gi.test(repo)) {
-  console.log("Please provide a valid repository URL");
+  console.log(`⚠️ Could not add your recipe: The GitHub URL you provided doesn't seem to be valid.
+You should use this command like "yarn github https://github.com/user/repo".
+Please make sure you provide a URL in the format "https://github.com/user/repo"
+For more information about this script visit https://github.com/getferdi/recipes/blob/master/docs/integration.md#publishing
+If you want to package a local recipe, please use "yarn package" instead.`);
   return;
 }
 
@@ -54,24 +59,24 @@ const compressed = path.join(__dirname, 'tmp.tar.gz');
 
 // Let us work in an async environment
 (async () => {
-  console.log("Creating temporary directory");
+  console.log("[Info] Creating temporary directory");
 
   await fs.ensureDir(tempDir);
   await fs.ensureDir(recipeSrc);
   await fs.ensureDir(recipeSrcTmp);
 
-  console.log("Downloading " + repo);
+  console.log("[Info] Downloading " + repo);
   
   await downloadFile(
     `https://github.com/${repoInfo.owner}/${repoInfo.name}/archive/master.tar.gz`,
     compressed
   );
 
-  console.log("Decompressing tarball");
+  console.log("[Info] Decompressing repository");
 
   await decompress(compressed, tempDir);
 
-  console.log("Moving directories");
+  console.log("[Info] Moving 'recipe_src' to 'recipe_src_tmp'");
 
   await fs.move(recipeSrc, recipeSrcTmp, {overwrite: true});
   await fs.move(
@@ -80,18 +85,21 @@ const compressed = path.join(__dirname, 'tmp.tar.gz');
     {overwrite: true}
   );
 
-  console.log("Adding to repository");
-  require('./package.js');
-  console.log("Continuing in 1.5 seconds");
+  console.log("[Info] Packaging your recipe");
+  try {
+    await packageRecipe();
+  } catch(e) {
+    return;
+  }
 
-  setTimeout(async () => {
-    console.log("Deleting downloaded files");
+  console.log("[Info] Deleting temporarydownloaded repository");
 
-    await fs.remove(compressed);
-    await fs.remove(recipeSrc);
-  
-    console.log("Moving back recipe folder");
-  
-    await fs.move(recipeSrcTmp, recipeSrc);
-  }, 1500);
+  await fs.remove(compressed);
+  await fs.remove(recipeSrc);
+
+  console.log("[Info] Moving back 'recipe_src_tmp' to 'recipe_src'");
+
+  await fs.move(recipeSrcTmp, recipeSrc);
+
+  console.log(`✅ Successfully packaged the recipe from your GitHub repository`);
 })();
\ No newline at end of file
diff --git a/scripts/api/package.js b/scripts/api/package.js
new file mode 100644
index 0000000..2d265f6
--- /dev/null
+++ b/scripts/api/package.js
@@ -0,0 +1,204 @@
+/**
+ * Package recipe into tar.gz file
+ */
+const targz = require('targz');
+const fs = require('fs-extra');
+const path = require('path');
+const sizeOf = require('image-size');
+const semver = require('semver');
+
+// Publicly availible link to this repository's uncompressed folder
+// Used for generating public icon URLs
+const repo = 'https://cdn.jsdelivr.net/gh/getferdi/recipes/uncompressed/';
+
+// Helper: Compress src folder into dest file
+const compress = (src, dest) => new Promise((resolve, reject) => {
+  targz.compress({
+    src,
+    dest,
+    tar: {
+      // Don't package .DS_Store files
+      ignore: function(name) {
+          return path.basename(name) === '.DS_Store'
+      }
+    },
+  }, (err) => {
+    if (err) {
+      reject(err);
+    } else {
+      resolve(dest);
+    }
+  });
+});
+// Let us work in an async environment
+module.exports = async () => {
+  // Create paths to important files
+  const recipeSrc = path.join(__dirname, '../recipe_src');
+  const packageJson = path.join(recipeSrc, 'package.json');
+  const svgIcon = path.join(recipeSrc, 'icon.svg');
+  const pngIcon = path.join(recipeSrc, 'icon.png');
+  const allJson = path.join(__dirname, '../../', 'all.json');
+  let all = await fs.readJson(allJson);
+
+  // Check that package.json exists
+  if (!await fs.pathExists(packageJson)) {
+    console.log(`⚠️ Could not add your recipe: Please add your recipe to ${recipeSrc} and make sure that folder contains a "package.json".
+For more information on how to add your recipe visit https://github.com/getferdi/recipes/blob/master/docs/integration.md`);
+    return;
+  }
+
+  // Check that icons exist
+  const hasSvg = await fs.pathExists(svgIcon);
+  const hasPng = await fs.pathExists(pngIcon);
+  if (!hasSvg && !hasPng) {
+    console.log(`⚠️ Could not add your recipe: Please make sure your recipe contains an icon.png and an icon.svg file.
+Those icons should be the logo of the recipe you are trying to add.
+Please also make sure that your icons are 1024x1024px in size.
+For more information about recipe icons visit https://github.com/getferdi/recipes/blob/master/docs/integration.md#icons`);
+    return;
+  } else if (!hasSvg) {
+    console.log(`⚠️ Could not add your recipe: Please make sure your recipe contains an icon.svg file.
+Your recipe already contains an "icon.png" but it also requires an "icon.svg" to display properly.
+Please also make sure that your icons are 1024x1024px in size.
+For more information about recipe icons visit https://github.com/getferdi/recipes/blob/master/docs/integration.md#icons`);
+    return;
+  } else if (!hasPng) {
+    console.log(`⚠️ Could not add your recipe: Please make sure your recipe contains an icon.png file.
+Your recipe already contains an "icon.svg" but it also requires an "icon.png" to display properly.
+Please also make sure that your icons are 1024x1024px in size.
+For more information about recipe icons visit https://github.com/getferdi/recipes/blob/master/docs/integration.md#icons`);
+    return;
+  }
+
+  // Check that icons have the right dimensions
+  const pngSize = sizeOf(pngIcon);
+  const pngHasRightSize = pngSize.width === 1024 && pngSize.height === 1024;
+  const svgSize = sizeOf(svgIcon);
+  const svgHasRightSize = svgSize.width === 1024 && svgSize.height === 1024;
+  if (!pngHasRightSize && !svgHasRightSize) {
+    console.log(`⚠️ Could not add your recipe: Icons require to be 1024x1024px in size.
+Both your "icon.png" and "icon.svg" don't seem to have the right size.
+You can use software like Photoshop, GIMP or Photopea (https://www.photopea.com/) to resize your icons.
+For more information about recipe icons visit https://github.com/getferdi/recipes/blob/master/docs/integration.md#icons`);
+    return;
+  } else if (!pngHasRightSize) {
+    console.log(`⚠️ Could not add your recipe: "icon.png" should be to be 1024x1024px in size.
+Please make sure that your "icon.png" has the right size of 1024x1024px in size.
+You can use software like Photoshop, GIMP or Photopea (https://www.photopea.com/) to resize your icons.
+For more information about recipe icons visit https://github.com/getferdi/recipes/blob/master/docs/integration.md#icons`);
+    return;
+  } else if (!svgHasRightSize) {
+    console.log(`⚠️ Could not add your recipe: "icon.svg" should be to be 1024x1024px in size.
+Please make sure that your "icon.svg" has the right size of 1024x1024px in size.
+You can use software like Photoshop, GIMP or Photopea (https://www.photopea.com/) to resize your icons.
+For more information about recipe icons visit https://github.com/getferdi/recipes/blob/master/docs/integration.md#icons`);
+    return;
+  }
+
+  // Read package.json
+  const config = await fs.readJson(packageJson)
+
+  // Make sure it contains all required fields
+  if (!config) {
+    console.log(`⚠️ Could not add your recipe: We could not read or parse your "package.json" configuration.
+Please make sure your "package.json" contains valid JSON.
+For more information about the package.json file visit https://github.com/getferdi/recipes/blob/master/docs/configuration.md`);
+    return;
+  }
+  let configErrors = [];
+  if (!config.id) {
+    configErrors.push("Your package.json contains no 'id' field. This field should contain a unique ID made of lowercase letters (a-z) and hyphens (-)");
+  } else if (!/^[a-z._\-]+$/.test(config.id)) {
+    configErrors.push("Your package.json defines an invalid recipe ID. Please make sure the 'id' field only contains lowercase letters (a-z) and hyphens (-)");
+  }
+  if (!config.name) {
+    configErrors.push("Your package.json contains no 'name' field. This field should contain the name of the service (e.g. 'Google Keep')");
+  }
+  if (!config.version) {
+    configErrors.push("Your package.json contains no 'version' field. This field should contain the a semver-compatible version number for your recipe (e.g. '1.0.0')");
+  }
+  if (!config.config || typeof config.config !== "object") {
+    configErrors.push("Your package.json contains no 'config' object. This field should contain a configuration for your service.");
+  } else if (!config.config.serviceURL) {
+    configErrors.push("Your package.json contains a 'config' object with no 'serviceURL' field. This field should contain the URL of your service.");
+  }
+
+  if (configErrors.length > 0) {
+    console.log(`⚠️ Could not add your recipe: There were errors in your package.json:
+${configErrors.reduce((str, err) => `${str}\n${err}`)}
+For more information about the package.json file visit https://github.com/getferdi/recipes/blob/master/docs/configuration.md`);
+    return;
+  }
+
+  // Index of the current recipe in all.json
+  const packageIndex = all.findIndex(e => e.id === config.id)
+
+  if (packageIndex !== -1) {
+    const currentVersion = config.version;
+    const repoVersion = all[packageIndex].version;
+
+    if (semver.gte(repoVersion, currentVersion)) {
+      console.log(`⚠️ Could not add your recipe: It looks like your recipe is using the same version number as the current recipe.
+Please make sure to increase the version number inside your "package.json" everytime you want to repackage (e.g. '1.0.0' to '1.0.1').
+If you don't increase your version number, Ferdi cannot detect that you have made changes to the recipe.
+For more information about versioning of recipes visit https://github.com/getferdi/recipes/blob/master/docs/configuration.md#config-flags`);
+      return;
+    }
+  }
+
+  if (!await fs.exists(path.join(recipeSrc, 'webview.js'))) {
+    console.log(`⚠️ Could not add your recipe: It looks like your recipe doesn't contain a "webview.js" file.
+Please make sure to create that file and add your features to it.
+For more information about the webview.js file visit https://github.com/getferdi/recipes/blob/master/docs/integration.md#webviewjs and https://github.com/getferdi/recipes/blob/master/docs/frontend_api.md`);
+    return;
+  }
+  if (!await fs.exists(path.join(recipeSrc, 'index.js'))) {
+    console.log(`⚠️ Could not add your recipe: It looks like your recipe doesn't contain a "index.js" file.
+Please make sure to create that file and add your features to it. For most recipes it is enough to simply add the basic template found at https://github.com/getferdi/recipes/blob/master/docs/integration.md#indexjs
+For more information about the webview.js file visit https://github.com/getferdi/recipes/blob/master/docs/integration.md#indexjs and https://github.com/getferdi/recipes/blob/master/docs/backend_api.md`);
+    return;
+  }
+
+  // Package to .tar.gz
+  console.log(`[Info] Packaging ${config.id}...`);
+  compress(recipeSrc, path.join(__dirname, '../../', 'archives', `${config.id}.tar.gz`));
+
+  // Copy recipe src folder to /uncompressed/:id folder
+  console.log('[Info] Copying to uncompressed recipes');
+  await fs.copy('recipe_src', path.join(__dirname, '../../', 'uncompressed', `${config.id}`));
+
+  // Add recipe to all.json
+  console.log('[Info] Adding to all.json');
+  const packageInfo = {
+    "author": config.author || '',
+    "featured": false,
+    "id": config.id,
+    "name": config.name,
+    "version": config.version || '1.0.0',
+    "icons": {
+      "png": `${repo}${config.id}/icon.png`,
+      "svg": `${repo}${config.id}/icon.svg`,
+    },
+  };
+  // Check if package ID already exists
+  if (packageIndex !== -1) {
+    console.log('[Info] Recipe with ID already exists - overwriting');
+    all[packageIndex] = packageInfo;
+  } else {
+    console.log('[Info] No recipe with ID found - creating new.');
+    all.push(packageInfo);
+  }
+
+  // Sort package list alphabetically
+  all = all.sort((a, b) => {
+    var textA = a.id.toLowerCase();
+    var textB = b.id.toLowerCase();
+    return (textA < textB) ? -1 : (textA > textB) ? 1 : 0;
+  });
+  await fs.writeJson(allJson, all, {
+    spaces: 2,
+    EOL: '\n',
+  });
+
+  console.log(`✅ Successfully packaged and added new recipe "${config.id}"`);
+};
\ No newline at end of file
diff --git a/scripts/package.js b/scripts/package.js
index a241edc..3726407 100644
--- a/scripts/package.js
+++ b/scripts/package.js
@@ -1,108 +1,6 @@
 /**
  * Package recipe into tar.gz file
  */
-const targz = require('targz');
-const fs = require('fs-extra');
-const path = require('path');
+const packageRecipe = require('./api/package');
 
-console.log('Ferdi Recipe Packager v1.0.0');
-
-// Publicly availible link to this repository's uncompressed folder
-// Used for generating public icon URLs
-const repo = 'https://cdn.jsdelivr.net/gh/getferdi/recipes/uncompressed/';
-
-// Helper: Compress src folder into dest file
-const compress = (src, dest) => new Promise((resolve, reject) => {
-  targz.compress({
-    src,
-    dest,
-    tar: {
-      // Don't package .DS_Store files
-      ignore: function(name) {
-          return path.basename(name) === '.DS_Store'
-      }
-    },
-  }, (err) => {
-    if (err) {
-      reject(err);
-    } else {
-      resolve(dest);
-    }
-  });
-});
-
-// Create paths to important files
-const recipeSrc = path.join(__dirname, 'recipe_src');
-const packageJson = path.join(recipeSrc, 'package.json');
-const svgIcon = path.join(recipeSrc, 'icon.svg');
-const pngIcon = path.join(recipeSrc, 'icon.png');
-const allJson = path.join('../', 'all.json');
-
-// Let us work in an async environment
-(async () => {
-  // Check that package.json exists
-  if (!await fs.pathExists(packageJson)) {
-    console.log(`Error: Please add your recipe to ${recipeSrc}. (package.json not found)`);
-    return;
-  }
-  // Check that icons exist
-  if (!await fs.pathExists(svgIcon) || !await fs.pathExists(pngIcon)) {
-    console.log(`Error: Please make sure your recipe contains an icon.png and an icon.svg file.`);
-    return;
-  }
-
-  // Read package.json
-  const config = await fs.readJson(packageJson)
-
-  // Make sure it contains all required fields
-  if (!config || !config.id || !config.name || !config.config) {
-    console.log(`Error: Your package.json does not contain all required fields. 
-Please make sure it contains: id, name, config`);
-    return;
-  }
-
-  // Package to .tar.gz
-  console.log(`Packaging ${config.id}...`);
-  compress(recipeSrc, path.join('../', 'archives', `${config.id}.tar.gz`));
-
-  // Copy recipe src folder to /uncompressed/:id folder
-  console.log('Copying to uncompressed recipes');
-  await fs.copy('recipe_src', path.join('../', 'uncompressed', `${config.id}`));
-
-  // Add recipe to all.json
-  console.log('Adding to all.json');
-  const packageInfo = {
-    "author": config.author || '',
-    "featured": false,
-    "id": config.id,
-    "name": config.name,
-    "version": config.version || '1.0.0',
-    "icons": {
-      "png": `${repo}${config.id}/icon.png`,
-      "svg": `${repo}${config.id}/icon.svg`,
-    },
-  };
-  let all = await fs.readJson(allJson);
-  // Check if package ID already exists
-  const packageIndex = all.findIndex(e => e.id === config.id)
-  if (packageIndex !== -1) {
-    console.log('Package with ID already exists - overwriting');
-    all[packageIndex] = packageInfo;
-  } else {
-    console.log('No package with ID found - creating new.');
-    all.push(packageInfo);
-  }
-
-  // Sort package list alphabetically
-  all = all.sort((a, b) => {
-    var textA = a.id.toLowerCase();
-    var textB = b.id.toLowerCase();
-    return (textA < textB) ? -1 : (textA > textB) ? 1 : 0;
-  });
-  await fs.writeJson(allJson, all, {
-    spaces: 2,
-    EOL: '\n',
-  });
-
-  console.log(`Successfully packaged and added new package ${config.id}`);
-})();
\ No newline at end of file
+packageRecipe();
\ No newline at end of file
diff --git a/scripts/package.json b/scripts/package.json
index b82f946..77d5f2f 100644
--- a/scripts/package.json
+++ b/scripts/package.json
@@ -10,6 +10,7 @@
     "dir-compare": "^1.7.3",
     "fs-extra": "^8.1.0",
     "git-url-parse": "^11.1.2",
+    "image-size": "^0.8.3",
     "node-fetch": "^2.6.0",
     "semver": "^6.3.0",
     "targz": "^1.0.1"
diff --git a/scripts/yarn.lock b/scripts/yarn.lock
index 5f3a5c8..8007f08 100644
--- a/scripts/yarn.lock
+++ b/scripts/yarn.lock
@@ -141,6 +141,13 @@ graceful-fs@^4.1.6, graceful-fs@^4.2.0:
   resolved "https://registry.yarnpkg.com/graceful-readlink/-/graceful-readlink-1.0.1.tgz#4cafad76bc62f02fa039b2f94e9a3dd3a391a725"
   integrity sha1-TK+tdrxi8C+gObL5Tpo906ORpyU=
 
+image-size@^0.8.3:
+  version "0.8.3"
+  resolved "https://registry.yarnpkg.com/image-size/-/image-size-0.8.3.tgz#f0b568857e034f29baffd37013587f2c0cad8b46"
+  integrity sha512-SMtq1AJ+aqHB45c3FsB4ERK0UCiA2d3H1uq8s+8T0Pf8A3W4teyBQyaFaktH6xvZqh+npwlKU7i4fJo0r7TYTg==
+  dependencies:
+    queue "6.0.1"
+
 inherits@~2.0.3:
   version "2.0.4"
   resolved "https://registry.yarnpkg.com/inherits/-/inherits-2.0.4.tgz#0fa2c64f932917c3433a0ded55363aae37416b7c"
@@ -237,6 +244,13 @@ pump@^1.0.0:
     end-of-stream "^1.1.0"
     once "^1.3.1"
 
+queue@6.0.1:
+  version "6.0.1"
+  resolved "https://registry.yarnpkg.com/queue/-/queue-6.0.1.tgz#abd5a5b0376912f070a25729e0b6a7d565683791"
+  integrity sha512-AJBQabRCCNr9ANq8v77RJEv73DPbn55cdTb+Giq4X0AVnNVZvMHlYp7XlQiN+1npCZj1DuSmaA2hYVUUDgxFDg==
+  dependencies:
+    inherits "~2.0.3"
+
 readable-stream@^2.3.0, readable-stream@^2.3.5:
   version "2.3.6"
   resolved "https://registry.yarnpkg.com/readable-stream/-/readable-stream-2.3.6.tgz#b11c27d88b8ff1fbe070643cf94b0c79ae1b0aaf"