From c9620d0fde240e17fb5be58d8eb19b5aeba01046 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Micha=C5=82=20K=C4=99drzy=C5=84ski?= <kedrzu@gmail.com>
Date: Mon, 30 Sep 2024 15:09:08 +0200
Subject: [PATCH] feat: add typography package

---
 packages/typography/.eslintrc.cjs     |  7 +++++++
 packages/typography/package.json      | 20 ++++++++++++++++++++
 packages/typography/src/fixOrphans.ts | 25 +++++++++++++++++++++++++
 packages/typography/src/index.ts      |  1 +
 packages/typography/tsconfig.json     | 17 +++++++++++++++++
 5 files changed, 70 insertions(+)
 create mode 100644 packages/typography/.eslintrc.cjs
 create mode 100644 packages/typography/package.json
 create mode 100644 packages/typography/src/fixOrphans.ts
 create mode 100644 packages/typography/src/index.ts
 create mode 100644 packages/typography/tsconfig.json

diff --git a/packages/typography/.eslintrc.cjs b/packages/typography/.eslintrc.cjs
new file mode 100644
index 0000000..8ca3407
--- /dev/null
+++ b/packages/typography/.eslintrc.cjs
@@ -0,0 +1,7 @@
+module.exports = {
+    root: true,
+    extends: [require.resolve('@nzyme/eslint/typescript')],
+    parserOptions: {
+        project: `${__dirname}/tsconfig.json`,
+    },
+};
diff --git a/packages/typography/package.json b/packages/typography/package.json
new file mode 100644
index 0000000..7df6709
--- /dev/null
+++ b/packages/typography/package.json
@@ -0,0 +1,20 @@
+{
+    "name": "@nzyme/typography",
+    "version": "1.0.0",
+    "type": "module",
+    "main": "./dist/index.js",
+    "module": "./dist/index.js",
+    "types": "./dist/index.d.ts",
+    "sideEffects": false,
+    "repository": "https://github.com/nzymejs/nzyme.git",
+    "author": "Michał Kędrzyński <m.kedrzynski@gmail.com>",
+    "private": true,
+    "scripts": {
+        "eslint": "eslint . --fix --cache",
+        "build": "tsc --build"
+    },
+    "dependencies": {
+        "@nzyme/types": "*",
+        "@nzyme/utils": "*"
+    }
+}
diff --git a/packages/typography/src/fixOrphans.ts b/packages/typography/src/fixOrphans.ts
new file mode 100644
index 0000000..09036d8
--- /dev/null
+++ b/packages/typography/src/fixOrphans.ts
@@ -0,0 +1,25 @@
+const spaceAfterShortWordRegex = /([\s(]|^)(\w{1,2})\s/gmu;
+const longWordRegex = /\s([^\s]{12,})/gmu;
+
+/**
+ * Search for any word, that is 3 or less characters long
+ * Such short words should not end up on the end of the line.
+ * We add non-breakable space at the end of the word.
+ * Source: https://boanastudio.com/blog/text-in-responsive-web-design
+ * @param text Text to fix
+ */
+export function fixOrphans(text: string) {
+    // use [^\s] to match anything but whitespace characters
+    return (
+        text
+            .replace(spaceAfterShortWordRegex, (search, whitespace: string, word: string) => {
+                // replace spaces between short words with a non-breakable space
+                // do not swap it with any other character!
+                return whitespace + word + '\xa0';
+            })
+            // roll back the operation if following word has 12 or more letters
+            .replace(longWordRegex, (search, group: string) => {
+                return ' ' + group;
+            })
+    );
+}
diff --git a/packages/typography/src/index.ts b/packages/typography/src/index.ts
new file mode 100644
index 0000000..c8b94ff
--- /dev/null
+++ b/packages/typography/src/index.ts
@@ -0,0 +1 @@
+export * from './fixOrphans.js';
diff --git a/packages/typography/tsconfig.json b/packages/typography/tsconfig.json
new file mode 100644
index 0000000..d73550a
--- /dev/null
+++ b/packages/typography/tsconfig.json
@@ -0,0 +1,17 @@
+{
+    "extends": "../../tsconfig.base.json",
+    "compilerOptions": {
+        "outDir": "./dist",
+        "tsBuildInfoFile": "./dist/.tsbuildinfo",
+        "rootDir": "./src"
+    },
+    "include": ["src/**/*.ts", "src/**/*.json"],
+    "references": [
+        {
+            "path": "../types/tsconfig.json"
+        },
+        {
+            "path": "../utils/tsconfig.json"
+        }
+    ]
+}