scripts/validate.js

   1 /* global hexo */
   2
   3 'use strict';
   4
   5 const { join } = require('path');
   6
   7 const { listDir } = require('hexo-fs');
   8 const sharp = require('sharp');
   9
  10 function difference(setA, setB) {
  11   const diff = new Set(setA);
  12   for (const elem of setB) {
  13     diff.delete(elem);
  14   }
  15   return diff;
  16 }
  17
  18 async function validateTheme() {
  19   const message = [];
  20   let isValidationPassed = true;
  21
  22   const themeData = hexo.locals.get('data').themes;
  23   const themes = new Set();
  24   for (const theme of themeData) {
  25     const name = theme.name.toLocaleLowerCase();
  26     themes.add(name);
  27   }
  28
  29   const screenshotsPath = join(hexo.source_dir, 'themes/screenshots');
  30   let screenshots = await listDir(screenshotsPath);
  31
  32   for (const filename of screenshots) {
  33     if (!filename.endsWith('.png')) {
  34       message.push(`The theme thumbnail "${filename}" is not a png image.`);
  35       isValidationPassed = false;
  36     }
  37
  38     const screenshot = join(screenshotsPath, filename);
  39
  40     const { width, height } = await sharp(screenshot).metadata();
  41     if (width !== 800 || height !== 500) {
  42       message.push(
  43         `The theme thumbnail "${filename}" is not sized in 800x500 (got ${width}x${height}).`
  44       );
  45       isValidationPassed = false;
  46     }
  47   }
  48
  49   screenshots = new Set(screenshots.map(name => name.replace('.png', '').toLocaleLowerCase()));
  50
  51   const diffThemesScreenshots = difference(themes, screenshots);
  52   const diffScreenshotsThemes = difference(screenshots, themes);
  53
  54   if (diffThemesScreenshots.size > 0) {
  55     message.push(`Theme screenshots not found: ${Array.from(diffThemesScreenshots)}.`);
  56     isValidationPassed = false;
  57   }
  58   if (diffScreenshotsThemes.size > 0) {
  59     message.push(`Theme screenshots not removed: ${Array.from(diffScreenshotsThemes)}.`);
  60     isValidationPassed = false;
  61   }
  62
  63   if (!isValidationPassed) {
  64     message.push('Theme thumbnails validation failed.');
  65   } else {
  66     message.push('Theme thumbnails validation completed.');
  67   }
  68
  69   return {
  70     path: 'validate_theme.txt',
  71     data: message.join('\n')
  72   };
  73 }
  74
  75 if (process.env.CI) hexo.extend.generator.register('validate_theme', validateTheme);