turkish-text-utils 1.0.0

package/README.md

@@ -0,0 +1,79 @@
+# turkish-text-utils
+
+A lightweight, zero-dependency utility library for handling Turkish string operations. It provides reliable methods for Turkish text normalization, URL-friendly slug generation, and locale-aware case-insensitive substring searching.
+
+## Installation
+
+Install using npm:
+
+```bash
+npm install turkish-text-utils
+```
+
+Or using yarn:
+
+```bash
+yarn add turkish-text-utils
+```
+
+Or using pnpm:
+
+```bash
+pnpm add turkish-text-utils
+```
+
+## Usage
+
+You can import the required utility functions directly from the package:
+
+```javascript
+import { normalizeTr, toSlug, includesInsensitive } from 'turkish-text-utils';
+```
+
+If you are using CommonJS:
+
+```javascript
+const { normalizeTr, toSlug, includesInsensitive } = require('turkish-text-utils');
+```
+
+## API
+
+### `normalizeTr(text: string): string`
+
+Converts all Turkish-specific characters in a given string to their English/ASCII lowercase equivalents.
+
+```javascript
+// Example
+const text = "Şeker Fıstıkçı Şahap ÖĞÜTÜCÜ";
+console.log(normalizeTr(text)); 
+// Output: "seker fistikci sahap ogutucu"
+```
+
+### `toSlug(text: string): string`
+
+Generates a URL-friendly slug from a given Turkish string. It automatically normalizes Turkish characters, removes irregular symbols, and replaces spaces with hyphens `-`.
+
+```javascript
+// Example
+const title = "Türkiye'nin En Güzel Dağları ve Gölleri 2024!";
+console.log(toSlug(title)); 
+// Output: "turkiyenin-en-guzel-daglari-ve-golleri-2024"
+```
+
+### `includesInsensitive(text: string, search: string): boolean`
+
+Performs a locale-aware, case-insensitive check to determine if the `search` string is found within `text`. This correctly handles the `I`/`ı` and `İ`/`i` problems inherent in the Turkish alphabet.
+
+```javascript
+// Example
+const content = "İstanbul BÜYÜKŞEHİR Belediyesi";
+
+console.log(includesInsensitive(content, "istanbul")); // true
+console.log(includesInsensitive(content, "BÜYÜK")); // true
+console.log(includesInsensitive(content, "sehir")); // true
+console.log(includesInsensitive(content, "Ankara")); // false
+```
+
+## License
+
+[MIT](LICENSE)

package/dist/index.d.mts

@@ -0,0 +1,7 @@
+declare function normalizeTr(text: string): string;
+
+declare function toSlug(text: string): string;
+
+declare function includesInsensitive(text: string, search: string): boolean;
+
+export { includesInsensitive, normalizeTr, toSlug };

package/dist/index.d.ts

@@ -0,0 +1,7 @@
+declare function normalizeTr(text: string): string;
+
+declare function toSlug(text: string): string;
+
+declare function includesInsensitive(text: string, search: string): boolean;
+
+export { includesInsensitive, normalizeTr, toSlug };

package/dist/index.js

@@ -0,0 +1,66 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  includesInsensitive: () => includesInsensitive,
+  normalizeTr: () => normalizeTr,
+  toSlug: () => toSlug
+});
+module.exports = __toCommonJS(index_exports);
+
+// src/normalizeTr.ts
+var TR_MAP = {
+  \u00E7: "c",
+  \u00C7: "c",
+  \u011F: "g",
+  \u011E: "g",
+  \u0131: "i",
+  I: "i",
+  \u0130: "i",
+  \u00F6: "o",
+  \u00D6: "o",
+  \u015F: "s",
+  \u015E: "s",
+  \u00FC: "u",
+  \u00DC: "u"
+};
+function normalizeTr(text) {
+  return text.split("").map((char) => {
+    var _a;
+    return (_a = TR_MAP[char]) != null ? _a : char;
+  }).join("").toLowerCase();
+}
+
+// src/toSlug.ts
+function toSlug(text) {
+  return normalizeTr(text).replace(/[^a-z0-9\s-]/g, "").trim().replace(/\s+/g, "-").replace(/-+/g, "-");
+}
+
+// src/includesInsensitive.ts
+function includesInsensitive(text, search) {
+  return normalizeTr(text).includes(normalizeTr(search));
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  includesInsensitive,
+  normalizeTr,
+  toSlug
+});

package/dist/index.mjs

@@ -0,0 +1,37 @@
+// src/normalizeTr.ts
+var TR_MAP = {
+  \u00E7: "c",
+  \u00C7: "c",
+  \u011F: "g",
+  \u011E: "g",
+  \u0131: "i",
+  I: "i",
+  \u0130: "i",
+  \u00F6: "o",
+  \u00D6: "o",
+  \u015F: "s",
+  \u015E: "s",
+  \u00FC: "u",
+  \u00DC: "u"
+};
+function normalizeTr(text) {
+  return text.split("").map((char) => {
+    var _a;
+    return (_a = TR_MAP[char]) != null ? _a : char;
+  }).join("").toLowerCase();
+}
+
+// src/toSlug.ts
+function toSlug(text) {
+  return normalizeTr(text).replace(/[^a-z0-9\s-]/g, "").trim().replace(/\s+/g, "-").replace(/-+/g, "-");
+}
+
+// src/includesInsensitive.ts
+function includesInsensitive(text, search) {
+  return normalizeTr(text).includes(normalizeTr(search));
+}
+export {
+  includesInsensitive,
+  normalizeTr,
+  toSlug
+};

package/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "turkish-text-utils",
+  "version": "1.0.0",
+  "description": "Utility functions for Turkish text normalization, slug generation, and insensitive text search.",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsup src/index.ts --format cjs,esm --dts --clean",
+    "test": "vitest run",
+    "format": "prettier --write 'src/**/*.ts' 'tests/**/*.ts'",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "turkish",
+    "text",
+    "slug",
+    "string",
+    "utils"
+  ],
+  "license": "MIT",
+  "devDependencies": {
+    "prettier": "^3.8.1",
+    "tsup": "^8.5.1",
+    "typescript": "^6.0.2",
+    "vitest": "^4.1.2"
+  },
+  "author": "Sergen",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/sergen/turkish-text-utils.git"
+  },
+  "homepage": "https://github.com/sergen/turkish-text-utils#readme",
+  "bugs": {
+    "url": "https://github.com/sergen/turkish-text-utils/issues"
+  },
+  "module": "./dist/index.mjs",
+  "exports": {
+    "types": "./dist/index.d.ts",
+    "require": "./dist/index.js",
+    "import": "./dist/index.mjs"
+  }
+}