Merge pull request #2 from alienzhou/feat/multi-font

feat(font): support more font sets
alienzhou · Jun 6, 2021 · 49536b6 · 49536b6
2 parents d86745a + ac05e69
commit 49536b6
Show file tree

Hide file tree

Showing 206 changed files with 1,671 additions and 39 deletions.
diff --git a/.eslintrc.json b/.eslintrc.json
@@ -228,6 +228,7 @@
         "ignoreRestSiblings": true
       }
     ],
+    "@typescript-eslint/object-curly-spacing": "off",
     "@typescript-eslint/prefer-nullish-coalescing": "off",
     "@typescript-eslint/prefer-readonly-parameter-types": "off",
     "@typescript-eslint/promise-function-async": "off",

diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,10 +1,30 @@
+# v1.2.0
+
+## Feature
+
+Support more font families. Now you can use the `fontFamily` option to specify the type of font as below:
+
+```typescript
+import * as fontFamily from 'yoo-hoo/fonts/ansi-shadow';
+
+yo('yoo-hoo', {
+    fontFamily,
+});
+```
+
+[See more >>](./README.md#built-in-fonts)
+
+---
+
 # v1.1.0
 
 ## Feature
 
 - support print rainbow fonts 🌈
 - support padding start
 
+---
+
 # v1.0.1
 
 ## Fix
@@ -13,6 +33,8 @@
 - use a string text instead of a variable for the default font set module, so that it can work in webpack
 - codes should be numbers in the font set module
 
+---
+
 # v1.0.0
 
 Init release 🎉

diff --git a/README.md b/README.md
@@ -40,6 +40,7 @@ It will return the lines for printing. Then you can print it yourself line by li
 
 **Options:**
 
+- fontFamily: `object` Specify the font family. Optional. See more in the [Built-In Fonts Section](#built-in-fonts).
 - spacing: `number`  The number of spaces between two characters. Default `1`.
 - paddingStart: `number`  The number of spaces before the text. Default `0`.
 - maxLineWidth: `number`  The max length of lines. If exceed `maxLineWidth` following characters will get a line feed. Default `Infinity`.
@@ -53,11 +54,36 @@ It will return the lines for printing. Then you can print it yourself line by li
 For example,
 
 ```typescript
-yo('ho', { color: 'blue', spacing: 2 });
+yo('ho', {
+  color: 'blue',
+  spacing: 2,
+});
 ```
 
 Then it will print a blue `HO` with two spaces between H and O.
 
+## Built-In Fonts
+
+Below is the fonts supported for the `fontFamily` option:
+
+- default
+- anis-shadow
+- big
+- crazy
+- whimsy
+
+You can import font sets from `fonts/xxx.js` and use it. Such as below:
+
+```typescript
+import * as fontFamily from 'yoo-hoo/fonts/ansi-shadow';
+
+yo('yoo-hoo', {
+    fontFamily,
+});
+```
+
+When not receiving a `fontFamily` object, it will use the default font set.
+
 ## Characters Supported
 
 > 🤘 `yoo-hoo` can be used in **both NodeJS and browsers**.

diff --git a/example/index.ts b/example/index.ts
@@ -1,3 +1,18 @@
 import { yo } from '../lib/index';
+import * as fontFamily from '../lib/fonts/big';
+import * as fontFamily2 from '../lib/fonts/ansi-shadow';
 
-yo(process.argv[2] || 'yoo-hoo', { spacing: 1, color: 'rainbow', paddingStart: 5 });
+yo(process.argv[2] || 'yoo-hoo', {
+    color: 'green',
+    spacing: 1,
+    paddingStart: 5,
+});
+
+yo(process.argv[2] || 'ascii * art', {
+    fontFamily,
+    color: 'rainbow',
+});
+
+yo(process.argv[2] || 'alienzhou', {
+    fontFamily: fontFamily2,
+});
diff --git a/package.json b/package.json
@@ -5,7 +5,7 @@
   "main": "lib/index.js",
   "scripts": {
     "dev": "tsc --build -w tsconfig.json",
-    "example": "ts-node example/index.ts",
+    "example": "npm run build && DEBUG=yoo-hoo ts-node example/index.ts",
     "lint": "eslint \"src/**/*.ts\" --fix",
     "build": "rm -rf lib && tsc --build tsconfig.json && ts-node script/build.ts",
     "prepublishOnly": "npm run lint && npm run build"
@@ -25,6 +25,7 @@
   "author": "alienzhou <[email protected]>",
   "license": "MIT",
   "devDependencies": {
+    "@types/debug": "^4.1.5",
     "@types/node": "^14.14.9",
     "@typescript-eslint/eslint-plugin": "^4.8.1",
     "@typescript-eslint/parser": "^4.8.1",
@@ -40,6 +41,7 @@
   },
   "dependencies": {
     "chalk": "^4.1.0",
+    "debug": "^4.3.1",
     "lolcatjs": "^2.4.0"
   },
   "husky": {

diff --git a/raw/ansi-shadow/letter/a.txt b/raw/ansi-shadow/letter/a.txt
@@ -0,0 +1,7 @@
+a
+ █████╗ 
+██╔══██╗
+███████║
+██╔══██║
+██║  ██║
+╚═╝  ╚═╝
diff --git a/raw/ansi-shadow/letter/b.txt b/raw/ansi-shadow/letter/b.txt
@@ -0,0 +1,7 @@
+b
+██████╗ 
+██╔══██╗
+██████╔╝
+██╔══██╗
+██████╔╝
+╚═════╝ 
diff --git a/raw/ansi-shadow/letter/c.txt b/raw/ansi-shadow/letter/c.txt
@@ -0,0 +1,7 @@
+c
+ ██████╗
+██╔════╝
+██║     
+██║     
+╚██████╗
+ ╚═════╝
diff --git a/raw/ansi-shadow/letter/d.txt b/raw/ansi-shadow/letter/d.txt
@@ -0,0 +1,7 @@
+d
+██████╗ 
+██╔══██╗
+██║  ██║
+██║  ██║
+██████╔╝
+╚═════╝ 
diff --git a/raw/ansi-shadow/letter/e.txt b/raw/ansi-shadow/letter/e.txt
@@ -0,0 +1,7 @@
+e
+███████╗
+██╔════╝
+█████╗  
+██╔══╝  
+███████╗
+╚══════╝
diff --git a/raw/ansi-shadow/letter/f.txt b/raw/ansi-shadow/letter/f.txt
@@ -0,0 +1,7 @@
+f
+███████╗
+██╔════╝
+█████╗  
+██╔══╝  
+██║     
+╚═╝     
diff --git a/raw/ansi-shadow/letter/g.txt b/raw/ansi-shadow/letter/g.txt
@@ -0,0 +1,7 @@
+g
+ ██████╗ 
+██╔════╝ 
+██║  ███╗
+██║   ██║
+╚██████╔╝
+ ╚═════╝ 
diff --git a/raw/ansi-shadow/letter/h.txt b/raw/ansi-shadow/letter/h.txt
@@ -0,0 +1,7 @@
+h
+██╗  ██╗
+██║  ██║
+███████║
+██╔══██║
+██║  ██║
+╚═╝  ╚═╝
diff --git a/raw/ansi-shadow/letter/i.txt b/raw/ansi-shadow/letter/i.txt
@@ -0,0 +1,7 @@
+i
+██╗
+██║
+██║
+██║
+██║
+╚═╝
diff --git a/raw/ansi-shadow/letter/j.txt b/raw/ansi-shadow/letter/j.txt
@@ -0,0 +1,7 @@
+j
+     ██╗
+     ██║
+     ██║
+██   ██║
+╚█████╔╝
+ ╚════╝ 
diff --git a/raw/ansi-shadow/letter/k.txt b/raw/ansi-shadow/letter/k.txt
@@ -0,0 +1,7 @@
+k
+██╗  ██╗
+██║ ██╔╝
+█████╔╝ 
+██╔═██╗ 
+██║  ██╗
+╚═╝  ╚═╝
diff --git a/raw/ansi-shadow/letter/l.txt b/raw/ansi-shadow/letter/l.txt
@@ -0,0 +1,7 @@
+l
+██╗     
+██║     
+██║     
+██║     
+███████╗
+╚══════╝
diff --git a/raw/ansi-shadow/letter/m.txt b/raw/ansi-shadow/letter/m.txt
@@ -0,0 +1,7 @@
+m
+███╗   ███╗
+████╗ ████║
+██╔████╔██║
+██║╚██╔╝██║
+██║ ╚═╝ ██║
+╚═╝     ╚═╝
diff --git a/raw/ansi-shadow/letter/n.txt b/raw/ansi-shadow/letter/n.txt
@@ -0,0 +1,7 @@
+n
+███╗   ██╗
+████╗  ██║
+██╔██╗ ██║
+██║╚██╗██║
+██║ ╚████║
+╚═╝  ╚═══╝
diff --git a/raw/ansi-shadow/letter/o.txt b/raw/ansi-shadow/letter/o.txt
@@ -0,0 +1,7 @@
+o
+ ██████╗ 
+██╔═══██╗
+██║   ██║
+██║   ██║
+╚██████╔╝
+ ╚═════╝ 
diff --git a/raw/ansi-shadow/letter/p.txt b/raw/ansi-shadow/letter/p.txt
@@ -0,0 +1,7 @@
+p
+██████╗ 
+██╔══██╗
+██████╔╝
+██╔═══╝ 
+██║     
+╚═╝     
diff --git a/raw/ansi-shadow/letter/q.txt b/raw/ansi-shadow/letter/q.txt
@@ -0,0 +1,7 @@
+q
+ ██████╗ 
+██╔═══██╗
+██║   ██║
+██║▄▄ ██║
+╚██████╔╝
+ ╚══▀▀═╝ 
diff --git a/raw/ansi-shadow/letter/r.txt b/raw/ansi-shadow/letter/r.txt
@@ -0,0 +1,7 @@
+r
+██████╗ 
+██╔══██╗
+██████╔╝
+██╔══██╗
+██║  ██║
+╚═╝  ╚═╝
diff --git a/raw/ansi-shadow/letter/s.txt b/raw/ansi-shadow/letter/s.txt
@@ -0,0 +1,7 @@
+s
+███████╗
+██╔════╝
+███████╗
+╚════██║
+███████║
+╚══════╝
diff --git a/raw/ansi-shadow/letter/t.txt b/raw/ansi-shadow/letter/t.txt
@@ -0,0 +1,7 @@
+t
+████████╗
+╚══██╔══╝
+   ██║   
+   ██║   
+   ██║   
+   ╚═╝   
diff --git a/raw/ansi-shadow/letter/u.txt b/raw/ansi-shadow/letter/u.txt
@@ -0,0 +1,7 @@
+u
+██╗   ██╗
+██║   ██║
+██║   ██║
+██║   ██║
+╚██████╔╝
+ ╚═════╝ 
diff --git a/raw/ansi-shadow/letter/v.txt b/raw/ansi-shadow/letter/v.txt
@@ -0,0 +1,7 @@
+v
+██╗   ██╗
+██║   ██║
+██║   ██║
+╚██╗ ██╔╝
+ ╚████╔╝ 
+  ╚═══╝  
diff --git a/raw/ansi-shadow/letter/w.txt b/raw/ansi-shadow/letter/w.txt
@@ -0,0 +1,7 @@
+w
+██╗    ██╗
+██║    ██║
+██║ █╗ ██║
+██║███╗██║
+╚███╔███╔╝
+ ╚══╝╚══╝ 
diff --git a/raw/ansi-shadow/letter/x.txt b/raw/ansi-shadow/letter/x.txt
@@ -0,0 +1,7 @@
+x
+██╗  ██╗
+╚██╗██╔╝
+ ╚███╔╝ 
+ ██╔██╗ 
+██╔╝ ██╗
+╚═╝  ╚═╝
diff --git a/raw/ansi-shadow/letter/y.txt b/raw/ansi-shadow/letter/y.txt
@@ -0,0 +1,7 @@
+y
+██╗   ██╗
+╚██╗ ██╔╝
+ ╚████╔╝ 
+  ╚██╔╝  
+   ██║   
+   ╚═╝   
diff --git a/raw/ansi-shadow/letter/z.txt b/raw/ansi-shadow/letter/z.txt
@@ -0,0 +1,7 @@
+z
+███████╗
+╚══███╔╝
+  ███╔╝ 
+ ███╔╝  
+███████╗
+╚══════╝
diff --git a/raw/ansi-shadow/number/0.txt b/raw/ansi-shadow/number/0.txt
@@ -0,0 +1,7 @@
+0
+ ██████╗ 
+██╔═████╗
+██║██╔██║
+████╔╝██║
+╚██████╔╝
+ ╚═════╝ 
diff --git a/raw/ansi-shadow/number/1.txt b/raw/ansi-shadow/number/1.txt
@@ -0,0 +1,7 @@
+1
+ ██╗
+███║
+╚██║
+ ██║
+ ██║
+ ╚═╝