material-icon-theme 3.7.1 → 4.14.0

package/src/scripts/icons/checks/checkIconUsage.ts

@@ -1,110 +1,141 @@
-import * as fs from 'fs';
-import * as path from 'path';
-import { DefaultIcon, FolderIcon, FolderTheme } from '../../../models/index';
-import { fileIcons, folderIcons, highContrastVersion, languageIcons, lightVersion, openedFolder } from './../../../icons';
-import * as painter from './../../helpers/painter';
-
-/**
- * Defines the folder where all icon files are located.
- */
-const folderPath = path.join('icons');
-
-/**
- * Defines an array with all icons that can be found in the file system.
- */
-const availableIcons: { [s: string]: string } = {};
-
-/**
- * Get all icon file names from the file system.
- */
-const fsReadAllIconFiles = (err: Error, files: string[]) => {
-    if (err) {
-        throw Error(err.message);
-    }
-
-    files.forEach(file => {
-        const fileName = file;
-        const iconName = path.parse(file).name;
-        availableIcons[iconName] = fileName;
-    });
-
-    checkUsageOfAllIcons();
-    handleErrors();
-};
-
-const checkUsageOfAllIcons = () => {
-    const usedFileIcons: string[] = getAllUsedFileIcons();
-    const usedFolderIcons: string[] = getAllUsedFolderIcons();
-    const usedLanguageIcons: string[] = getAllUsedLanguageIcons();
-
-    [].concat(
-        usedFileIcons,
-        usedFolderIcons,
-        usedLanguageIcons
-    ).forEach(icon => {
-        delete availableIcons[icon];
-    });
-};
-
-const handleErrors = () => {
-    const amountOfUnusedIcons = Object.keys(availableIcons).length;
-    if (amountOfUnusedIcons === 0) {
-        console.log('> Material Icon Theme:', painter.green(`Passed icon usage checks!`));
-    } else {
-        console.log(`> Material Icon Theme: ` + painter.red(`${amountOfUnusedIcons} unused icon(s):`));
-        Object.keys(availableIcons).forEach(icon => {
-            console.log(painter.red(`- ${availableIcons[icon]}`));
-        });
-        throw new Error('Found unused icon files!');
-    }
-};
-
-// read from the file system
-export const check = () => fs.readdir(folderPath, fsReadAllIconFiles);
-
-const getAllUsedFileIcons = (): string[] => {
-    const icons = [
-        fileIcons.defaultIcon.name,
-        fileIcons.defaultIcon.light ? fileIcons.defaultIcon.name + lightVersion : undefined,
-        fileIcons.defaultIcon.highContrast ? fileIcons.defaultIcon.name + highContrastVersion : undefined,
-        ...fileIcons.icons.map(icon => icon.name),
-        ...fileIcons.icons.filter(icon => icon.light).map(icon => icon.name + lightVersion),
-        ...fileIcons.icons.filter(icon => icon.highContrast).map(icon => icon.name + highContrastVersion)
-    ];
-    return icons;
-};
-
-const getAllUsedFolderIcons = (): string[] => {
-    const icons = folderIcons.map(
-        theme => theme.name === 'none' ? [] : getAllFolderIcons(theme)
-    ).reduce((a, b) => a.concat(b));
-    return icons.map(icon => {
-        return [
-            icon.name,
-            icon.name + openedFolder,
-            icon.light ? icon.name + lightVersion : undefined,
-            icon.light ? icon.name + openedFolder + lightVersion : undefined,
-            icon.highContrast ? icon.name + highContrastVersion : undefined,
-            icon.highContrast ? icon.name + openedFolder + highContrastVersion : undefined
-        ];
-    }).filter(icon => icon !== undefined)
-        .reduce((a, b) => a.concat(b));
-};
-
-const getAllFolderIcons = (theme: FolderTheme): (FolderIcon | DefaultIcon)[] => {
-    const icons = theme.icons ? theme.icons : [];
-    return [
-        theme.defaultIcon,
-        theme.rootFolder,
-        ...icons
-    ].filter(icon => icon !== undefined); // filter undefined root folder icons
-};
-
-const getAllUsedLanguageIcons = (): string[] => {
-    const icons = [
-        ...languageIcons.map(lang => lang.icon.name),
-        ...languageIcons.filter(lang => lang.icon.light).map(lang => lang.icon.name + lightVersion),
-        ...languageIcons.filter(lang => lang.icon.highContrast).map(lang => lang.icon.name + highContrastVersion),
-    ];
-    return icons;
-};
+import * as fs from 'fs';
+import * as path from 'path';
+import { DefaultIcon, FolderIcon, FolderTheme } from '../../../models/index';
+import {
+  fileIcons,
+  folderIcons,
+  highContrastColorFileEnding,
+  languageIcons,
+  lightColorFileEnding,
+  openedFolder,
+} from './../../../icons';
+import * as painter from './../../helpers/painter';
+
+/**
+ * Defines the folder where all icon files are located.
+ */
+const folderPath = path.join('icons');
+
+/**
+ * Defines an array with all icons that can be found in the file system.
+ */
+const availableIcons: { [s: string]: string } = {};
+
+/**
+ * Get all icon file names from the file system.
+ */
+const fsReadAllIconFiles = (
+  error: NodeJS.ErrnoException | null,
+  files: string[]
+) => {
+  if (error) {
+    throw Error(error.message);
+  }
+
+  files.forEach((file) => {
+    const fileName = file;
+    const iconName = path.parse(file).name;
+    availableIcons[iconName] = fileName;
+  });
+
+  checkUsageOfAllIcons();
+  handleErrors();
+};
+
+const checkUsageOfAllIcons = () => {
+  const usedFileIcons: string[] = getAllUsedFileIcons();
+  const usedFolderIcons: string[] = getAllUsedFolderIcons();
+  const usedLanguageIcons: string[] = getAllUsedLanguageIcons();
+
+  [...usedFileIcons, ...usedFolderIcons, ...usedLanguageIcons].forEach(
+    (icon) => {
+      delete availableIcons[icon];
+    }
+  );
+};
+
+const handleErrors = () => {
+  const amountOfUnusedIcons = Object.keys(availableIcons).length;
+  if (amountOfUnusedIcons === 0) {
+    console.log(
+      '> Material Icon Theme:',
+      painter.green('Passed icon usage checks!')
+    );
+  } else {
+    console.log(
+      '> Material Icon Theme: ' +
+        painter.red(`${amountOfUnusedIcons} unused icon(s):`)
+    );
+    Object.keys(availableIcons).forEach((icon) => {
+      console.log(painter.red(`- ${availableIcons[icon]}`));
+    });
+    throw new Error('Found unused icon files!');
+  }
+};
+
+// read from the file system
+export const check = () => fs.readdir(folderPath, fsReadAllIconFiles);
+
+const getAllUsedFileIcons = (): string[] => {
+  return [
+    fileIcons.defaultIcon.name,
+    fileIcons.defaultIcon.light
+      ? fileIcons.defaultIcon.name + lightColorFileEnding
+      : '',
+    fileIcons.defaultIcon.highContrast
+      ? fileIcons.defaultIcon.name + highContrastColorFileEnding
+      : '',
+    ...fileIcons.icons.map((icon) => icon.name),
+    ...fileIcons.icons
+      .filter((icon) => icon.light)
+      .map((icon) => icon.name + lightColorFileEnding),
+    ...fileIcons.icons
+      .filter((icon) => icon.highContrast)
+      .map((icon) => icon.name + highContrastColorFileEnding),
+  ].filter((f) => f !== '');
+};
+
+const getAllUsedFolderIcons = (): string[] => {
+  const icons = folderIcons
+    .map((theme) => (theme.name === 'none' ? [] : getAllFolderIcons(theme)))
+    .reduce((a, b) => a.concat(b));
+  return icons
+    .map((icon) => {
+      return [
+        icon.name,
+        icon.name + openedFolder,
+        icon.light ? icon.name + lightColorFileEnding : '',
+        icon.light ? icon.name + openedFolder + lightColorFileEnding : '',
+        icon.highContrast ? icon.name + highContrastColorFileEnding : '',
+        icon.highContrast
+          ? icon.name + openedFolder + highContrastColorFileEnding
+          : '',
+      ];
+    })
+    .filter((icon) => icon !== undefined)
+    .reduce((a, b) => a.concat(b));
+};
+
+const getAllFolderIcons = (
+  theme: FolderTheme
+): (FolderIcon | DefaultIcon)[] => {
+  const icons = theme.icons || [];
+  const allFolderIcons = [theme.defaultIcon, ...icons];
+  if (theme.rootFolder) {
+    allFolderIcons.push(theme.rootFolder);
+  }
+  return allFolderIcons;
+};
+
+const getAllUsedLanguageIcons = (): string[] => {
+  const icons = [
+    ...languageIcons.map((lang) => lang.icon.name),
+    ...languageIcons
+      .filter((lang) => lang.icon.light)
+      .map((lang) => lang.icon.name + lightColorFileEnding),
+    ...languageIcons
+      .filter((lang) => lang.icon.highContrast)
+      .map((lang) => lang.icon.name + highContrastColorFileEnding),
+  ];
+  return icons;
+};

package/src/scripts/icons/checks/index.ts

@@ -1,7 +1,7 @@
-import * as checkAvailability from './checkIconAvailability';
-import * as checkIconConflicts from './checkIconConflicts';
-import * as checkIconUsage from './checkIconUsage';
-
-checkAvailability.check();
-checkIconUsage.check();
-checkIconConflicts.check();
+import * as checkAvailability from './checkIconAvailability';
+import * as checkIconConflicts from './checkIconConflicts';
+import * as checkIconUsage from './checkIconUsage';
+
+checkAvailability.check();
+checkIconUsage.check();
+checkIconConflicts.check();

package/src/scripts/icons/generateJson.ts

@@ -1,10 +1,11 @@
-/**
- * This file is only a script file that should only be executed by the npm scripts.
- */
-import { createIconFile } from './../../icons/index';
-
-try {
-    createIconFile();
-} catch (error) {
-    throw Error(error);
-}
+/**
+ * This file is meant to be executed exclusively by npm scripts.
+ */
+import { createIconFile } from './../../icons/index';
+
+try {
+  createIconFile();
+} catch (error) {
+  console.error(error);
+  throw Error('Could not create icon file!');
+}

package/src/scripts/preview/index.ts

@@ -1,24 +1,40 @@
-import { fileIcons } from './../../icons/fileIcons';
-import { folderIcons } from './../../icons/folderIcons';
-import { generatePreview } from './preview';
-
-const filterDuplicates = (icons: string[]) => {
-    return [...new Set(icons)];
-};
-
-const basicFileIcons = fileIcons.icons
-    .map(i => ({ iconName: i.name, label: i.name }));
-
-const folderThemes = filterDuplicates(folderIcons.map(theme => {
-    const folders = [];
-    if (theme.defaultIcon.name !== '') {
-        folders.push(theme.defaultIcon.name);
-    }
-    if (theme.icons && theme.icons.length > 0) {
-        folders.push(...theme.icons.map(i => i.name));
-    }
-    return [].concat(...folders);
-}).reduce((a, b) => a.concat(b))).map(i => ({ iconName: i, label: i.replace('folder-', '') }));
-
-generatePreview('fileIcons', basicFileIcons, 5, []);
-generatePreview('folderIcons', folderThemes, 5, []);
+import { fileIcons } from './../../icons/fileIcons';
+import { folderIcons } from './../../icons/folderIcons';
+import { languageIcons } from './../../icons/languageIcons';
+import { generatePreview } from './preview';
+
+const filterDuplicates = (icons: string[]) => {
+  return [...new Set(icons)];
+};
+
+const basicFileIcons = filterDuplicates(
+  fileIcons.icons
+    .map((i) => i.name)
+    // merge language icons
+    .concat(languageIcons.map((i) => i.icon.name))
+).map((i) => ({ iconName: i, label: i }));
+
+const folderThemes = filterDuplicates(
+  folderIcons
+    .map((theme) => {
+      const folders = [];
+      if (theme.icons && theme.icons.length > 0) {
+        folders.push(...theme.icons.map((i) => i.name));
+      }
+      return [...folders];
+    })
+    .reduce((a, b) => a.concat(b))
+).map((i) => ({ iconName: i, label: i.replace('folder-', '') }));
+
+generatePreview('fileIcons', basicFileIcons, 5, [
+  'virtual',
+  'powerpoint',
+  'word',
+  'credits',
+]);
+generatePreview('folderIcons', folderThemes, 5, [
+  'folder-aurelia',
+  'folder-phpmailer',
+  'folder-syntax',
+  'folder-ansible',
+]);

package/src/scripts/preview/preview.ts

@@ -1,112 +1,165 @@
-import * as fs from 'fs';
-import * as path from 'path';
-import * as painter from './../helpers/painter';
-import { toTitleCase } from './../helpers/titleCase';
-import { createScreenshots } from './screenshots';
-
-const htmlDoctype = `<!DOCTYPE html>`;
-const cssFilePath = path.join('style.css');
-const styling = `<link rel="stylesheet" href="${cssFilePath}">`;
-
-const createHTMLTableHeadRow = (amount: number) => {
-    const pair = `
-        <th class="icon">Icon</th>
-        <th class="iconName">Name</th>
-    `;
-    const columns = [...Array(amount)].map(() => pair).join('');
-    return `
-        <tr>
-            ${columns}
-        </tr>
-    `;
-};
-
-const createHTMLTableBodyRows = (items: IconDefinition[][]) => {
-    let rows = '';
-    items.forEach(row => {
-        const columns = row.map(icon => `
-            <td class="icon">
-                <img src="./../../../icons/${icon.iconName}.svg" alt="${icon.label}">
-            </td>
-            <td class="iconName">${toTitleCase(icon.label)}</td>
-        `).join('');
-        const tableRow = `
-            <tr>
-                ${columns}
-            </tr>
-        `;
-        rows = rows + tableRow;
-    });
-    return rows;
-};
-
-const createHTMLTable = (headRow, bodyRows) => `
-    <table>
-        ${headRow}
-        ${bodyRows}
-    </table>
-`;
-
-const createPreviewTable = (icons: IconDefinition[][], size: number) => {
-    const table = htmlDoctype + styling + createHTMLTable(
-        createHTMLTableHeadRow(size),
-        createHTMLTableBodyRows(icons)
-    );
-    return table;
-};
-
-const savePreview = (fileName: string, size: number, icons: IconDefinition[][]) => {
-    const filePath = path.join(__dirname, fileName + '.html');
-
-    // write the html file with the icon table
-    fs.writeFileSync(filePath, createPreviewTable(icons, size));
-
-    // create the images
-    createScreenshots(filePath, fileName).then(() => {
-        console.log('> Material Icon Theme:', painter.green(`Successfully created ${fileName} preview image!`));
-    }).catch(() => {
-        throw Error(painter.red(`Error while creating ${fileName} preview image`));
-    });
-};
-
-const getIconDefinitionsMatrix = (icons: IconDefinition[], size: number, excluded: string[] = []): IconDefinition[][] => {
-    const iconList = icons
-        .sort((a, b) => a.label.localeCompare(b.label))
-        .filter(i => excluded.indexOf(i.iconName) === -1);
-
-    // list for the columns with the icons
-    const matrix: IconDefinition[][] = [];
-
-    // calculate the amount of icons per column
-    const itemsPerColumn = Math.floor(iconList.length / size);
-
-    // create the columns with the icons
-    let counter = 0;
-    for (let c = 0; c < itemsPerColumn; c++) {
-        matrix[c] = [];
-    }
-    for (let s = 0; s < size; s++) {
-        for (let i = 0; i < itemsPerColumn; i++) {
-            matrix[i][s] = iconList[counter];
-            counter++;
-        }
-    }
-
-    return matrix;
-};
-
-/**
- * Function that generates the preview image for specific icons.
- * @param name name of the preview
- * @param icons icons for the preview
- * @param size amount of table columns
- * @param excluded which icons shall be excluded
- */
-export const generatePreview = (name: string, icons: IconDefinition[], size: number, excluded: string[] = []) => {
-    savePreview(name, size, getIconDefinitionsMatrix(icons, size, excluded));
-};
-
-interface IconDefinition {
-    iconName: string;
-    label: string;
-}
+import * as fs from 'fs';
+import * as path from 'path';
+import { createScreenshot } from '../helpers/screenshots';
+import * as painter from './../helpers/painter';
+import { toTitleCase } from './../helpers/titleCase';
+
+const htmlDoctype = '<!DOCTYPE html>';
+const cssFilePath = path.join('style.css');
+const styling = `<link rel="stylesheet" href="${cssFilePath}">`;
+
+const createHTMLTableHeadRow = (amount: number) => {
+  const pair = `
+        <th class="icon">Icon</th>
+        <th class="iconName">Name</th>
+    `;
+  const columns = [...Array(amount)].map(() => pair).join('');
+  return `
+        <tr>
+            ${columns}
+        </tr>
+    `;
+};
+
+const createHTMLTableBodyRows = (items: IconDefinition[][]) => {
+  let rows = '';
+  items.forEach((row) => {
+    const columns = row
+      .map(
+        (icon) => `
+            <td class="icon">
+                <img src="./../../../icons/${icon.iconName}.svg" alt="${
+          icon.label
+        }">
+            </td>
+            <td class="iconName">${toTitleCase(icon.label)}</td>
+        `
+      )
+      .join('');
+    const tableRow = `
+            <tr>
+                ${columns}
+            </tr>
+        `;
+    rows = rows + tableRow;
+  });
+  return rows;
+};
+
+const createHTMLTable = (headRow: string, bodyRows: string) => `
+    <table>
+        ${headRow}
+        ${bodyRows}
+    </table>
+`;
+
+const createPreviewTable = (icons: IconDefinition[][], size: number) => {
+  const table =
+    htmlDoctype +
+    styling +
+    createHTMLTable(
+      createHTMLTableHeadRow(size),
+      createHTMLTableBodyRows(icons)
+    );
+  return table;
+};
+
+const savePreview = (
+  fileName: string,
+  size: number,
+  icons: IconDefinition[][]
+) => {
+  const filePath = path.join(__dirname, fileName + '.html');
+
+  // write the html file with the icon table
+  fs.writeFileSync(filePath, createPreviewTable(icons, size));
+
+  // create the image
+  createScreenshot(filePath, fileName)
+    .then(() => {
+      console.log(
+        '> Material Icon Theme:',
+        painter.green(`Successfully created ${fileName} preview image!`)
+      );
+    })
+    .catch(() => {
+      throw Error(
+        painter.red(`Error while creating ${fileName} preview image`)
+      );
+    });
+};
+
+const getIconDefinitionsMatrix = (
+  icons: IconDefinition[],
+  size: number,
+  excluded: string[] = []
+): IconDefinition[][] => {
+  const iconList = icons.sort((a, b) => a.label.localeCompare(b.label));
+  trimIconListToSize(iconList, size, excluded);
+
+  // list for the columns with the icons
+  const matrix: IconDefinition[][] = [];
+
+  // calculate the amount of icons per column
+  const itemsPerColumn = Math.floor(iconList.length / size);
+
+  // create the columns with the icons
+  let counter = 0;
+  for (let c = 0; c < itemsPerColumn; c++) {
+    matrix[c] = [];
+  }
+  for (let s = 0; s < size; s++) {
+    for (let i = 0; i < itemsPerColumn; i++) {
+      matrix[i][s] = iconList[counter];
+      counter++;
+    }
+  }
+
+  return matrix;
+};
+
+/**
+ * Function that generates the preview image for specific icons.
+ * @param name name of the preview
+ * @param icons icons for the preview
+ * @param size amount of table columns
+ * @param trimmableIcons List of icons that can possibly be trimmed
+ */
+export const generatePreview = (
+  name: string,
+  icons: IconDefinition[],
+  size: number,
+  trimmableIcons: string[] = []
+) => {
+  savePreview(
+    name,
+    size,
+    getIconDefinitionsMatrix(icons, size, trimmableIcons)
+  );
+};
+
+interface IconDefinition {
+  iconName: string;
+  label: string;
+}
+
+/**
+ * Trim the list of icons into the matrix
+ * @param iconList List of icons
+ * @param size Amount of columns
+ * @param trimmableIcons List of icons that can possibly be trimmed
+ */
+const trimIconListToSize = (
+  iconList: IconDefinition[],
+  size: number,
+  trimmableIcons: string[]
+) => {
+  while (iconList.length % size !== 0) {
+    iconList.splice(
+      iconList.findIndex(
+        (i) => i.iconName === trimmableIcons[iconList.length % size]
+      ),
+      1
+    );
+  }
+};