shellfie 1.2.8 → 1.3.0

package/README.md

@@ -1,20 +1,20 @@
 # shellfie 🤳🏽
 
-create beautiful terminal screenshots programmatically
+<img src="./shellfies/logo.png" />
 
 # install
 ```bash
-yarn add shellfie
+npm install shellfie
 ```
 
 # the holy trinity ▽
-`shellfie` respects the holy trinity: the lib, the service, and the cli.   
+`shellfie` respects the holy trinity: the lib, the service, and the holy cli.   
   - [shellfie](https://github.com/tool3/shellfie)   
   - [shellfied](https://github.com/tool3/shellfied)   
   - [shellfie-cli](https://github.com/tool3/shellfie-cli)   
 
 # usage
-```js
+```javascript
 const data = [
     '\x1b[105mSHELLFIE\\x1b[0m🤳',
     '\x1b[38;5;225mthe easiest way',
@@ -95,15 +95,15 @@ outputs:
   **type**: `number`   
   **description**: viewport height
 
-  # examples
-  ```js
-  await shellfie(["\x1b[32mGreen line", "\x1b[31;1mRED bold"], { name: 'small', viewport: { width: 200, height: 200 } });
-  ```   
+# examples
+```javascript
+await shellfie(["\x1b[32mGreen line", "\x1b[31;1mRED bold"], { name: 'small', viewport: { width: 200, height: 200 } });
+```   
 
 <img src="./shellfies/small.png" />   
 
 
-```js
+```javascript
 const testResults = [
     "yarn run v1.22.5",
     "$ mocha --no-timeouts tests/ --colors",
@@ -129,6 +129,43 @@ const testResults = [
     "Done in 19.60s.",
 ];
 await shellfie(testResults, { name: 'fira', style: { fontFamily: 'Fira Code', fontWeight: 'bold' } });
+await shellfie(testResults, { name: 'monospace', style: { fontFamily: 'monospace' } });
+await shellfie(testResults, { name: 'monaco', style: { fontFamily: 'Monaco' } });
 ```   
 
 <img src="./shellfies/fira.png" />
+<img src="./shellfies/monospace.png" />
+<img src="./shellfies/monaco.png" />
+
+### raw mode
+```javascript
+const string = `    
+cristal     ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■
+teen        ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■
+mind        ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■
+morning     ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■
+vice        ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■
+passion     ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■
+fruit       ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■
+instagram   ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■
+atlas       ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■
+retro       ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■
+summer      ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■
+pastel      ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■
+rainbow     ■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■■
+  `
+await shellfie(string, { name: 'gradient', mode: 'raw', viewport: {width: 600, height: 350} });
+```
+<img src="./shellfies/gradient.png" />
+
+### bash colors
+```javascript
+const shellfie = require('shellfie');
+let backgroundColors = '';
+for (let i = 0; i < 255; i++) {
+    backgroundColors += `\x1b[48;5;${i}m ${i}\x1b[0m`;
+}
+await shellfie(backgroundColors, { name: 'background', viewport: {width: 500, height: 400} });
+```
+
+<img src="./shellfies/background.png" />

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shellfie",
-  "version": "1.2.8",
+  "version": "1.3.0",
   "description": "create beautiful terminal screenshots programmatically",
   "main": "shellfie.js",
   "directories": {

package/shellfie.js

@@ -21,7 +21,6 @@ async function shellfie(data, config) {
 
         // inject js scripts
         const localModules = __dirname + '/node_modules';
-        console.log(localModules);
         await page.addScriptTag({ path: require.resolve('xterm/lib/xterm.js') });
         await page.addScriptTag({ path: require.resolve('xterm-addon-fit/lib/xterm-addon-fit.js') });