add image support (#76)

README.md

@@ -25,14 +25,13 @@ Yayfetch is a tool similar to screenfetch, it just displays info about your comp
 
 ## Usage
 
-
 `npx yayfetch@latest` - returns info about your system(`@latest` should be added, cause sometimes npx can display a cached version)
 
-*or* install it globally:
+_or_ install it globally:
 
 `npm install -g yayfetch` and then just call `yayfetch`
 
-### Flag-defined features
+## Flag-defined features
 
 `-p` or `--pick` - first asks you what information you want to display, then displays it
 
@@ -52,11 +51,11 @@ Yayfetch is a tool similar to screenfetch, it just displays info about your comp
 
 `--config <path_to_file>` - specify a file path to a custom config. See [here](#example-config)
 
-### Config-specific features
+## Config-specific features
 
 Some more advanced features are almost impossible to implement through flags(to be quite honest, some are already pushing it e.g. `--custom-lines`).
 
-- Custom ASCIIs
+- ### Custom ASCIIs
 
 To customize the ASCIIs just define `"ascii"` line in the config. It should be an `Array<string>` with path(s) to the ASCII(s).
 
@@ -68,7 +67,34 @@ Example:
 }
 ```
 
-- Line Animations
+- ### Custom images
+
+You can also defined iamges instead of ASCIIs, by defining `images` field. Note that this flag is mutually exclusive with `ascii` flag.
+Uses [terminal-image](https://github.com/sindresorhus/terminal-image) underneath, so refer to it when specifying `options`.
+
+```ts
+interface ImageOptions {
+  path: string;
+  options?: {
+    width?: string | number | undefined;
+    height?: string | number | undefined;
+    preserveAspectRatio?: boolean | undefined;
+  };
+}
+```
+
+Example:
+
+```json
+{
+  "image": {
+    "path": "./path/to/file.img",
+    "options": { "preserveAspectRatio": false }
+  }
+}
+```
+
+- ### Line Animations
 
 Output can be animated by `line-animations` flag in the config file. It should be an `AnimationOptions` object.
 

package.json

@@ -46,6 +46,7 @@
     "inquirer": "^7.0.0",
     "log-update": "^4.0.0",
     "systeminformation": "^5.6.4",
+    "terminal-image": "^1.2.1",
     "yargs": "^14.2.0"
   },
   "devDependencies": {

src/yayfetch.ts

@@ -3,6 +3,7 @@
 import os from 'os';
 import yargs from 'yargs';
 import inquirer from 'inquirer';
+import terminalImage from 'terminal-image';
 import {
   DisplayAndGraphicsCard,
   MemoryInfoInterface,
@@ -237,6 +238,16 @@ yargs
       const customLines: string | object = enhancedArgv['custom-lines'];
       const animations: AnimationOptions = enhancedArgv['line-animations'];
 
+      interface ImageOptions {
+        path: string;
+        options?: {
+          width?: string | number | undefined;
+          height?: string | number | undefined;
+          preserveAspectRatio?: boolean | undefined;
+        };
+      }
+      const imageObj: ImageOptions = enhancedArgv['image'];
+
       const customASCIIs: string[] = enhancedArgv['ascii'];
 
       let customASCIIsParsed;
@@ -246,6 +257,11 @@ yargs
         );
       }
 
+      let image;
+      if (imageObj) {
+        image = await terminalImage.file(imageObj.path, imageObj.options);
+      }
+
       /* Get device data */
       let infoToPrint: string[];
       if (enhancedArgv.p || enhancedArgv.pick) {
@@ -284,16 +300,23 @@ yargs
       }
 
       if (coloredBoxes && !animations) {
-        console.warn('Colored boxes will not show when using animations');
-        /* Empty string to ensure space between boxes */
+        /* Empty string to ensure space between text and boxes */
         infoToPrint = [...infoToPrint, '', getColoredBoxes()];
       }
 
-      const asciis = showLogo
-        ? (customASCIIsParsed || [yayfetchASCII]).map((e) =>
-            normalizeASCII(e, 2)
-          )
-        : [];
+      const asciis =
+        (image && [
+          image
+            .split('\n')
+            .map((e) => `${e.trim()}  `)
+            .join('\n')
+            .replace(/^\s*$(?:\r\n?|\n)/gm, ''),
+        ]) ||
+        (showLogo
+          ? (customASCIIsParsed || [yayfetchASCII]).map((e) =>
+              normalizeASCII(e, 2)
+            )
+          : []);
       const joinedInfo = infoToPrint.join('\n');
 
       if (animations) {

tests/__tests__/image_testfile.json

@@ -0,0 +1,5 @@
+{
+  "image": {
+    "path": "./tests/images/doggy.jpg"
+  }
+}