@dcheglakov/uk-translit 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 dcheglakov
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,49 @@
+# uk-translit
+
+Official Ukrainian transliteration and slug generation for TypeScript, built according to the current rules of the Cabinet of Ministers of Ukraine Resolution No. 55. Designed for headless CMS workflows, with context-aware transliteration, clean slug output, strong test coverage, and no runtime dependencies.
+
+The implementation follows the current text of the Resolution of the Cabinet of Ministers of Ukraine dated January 27, 2010, No. 55, current revision effective from January 12, 2016:
+https://zakon.rada.gov.ua/go/55-2010-%D0%BF
+
+## Installation
+
+```bash
+bun add uk-translit
+```
+
+## Usage
+
+```typescript
+import { slugify, transliterate } from 'uk-translit';
+
+transliterate('Київ'); // Kyiv
+transliterate('Згурівка'); // Zghurivka
+slugify('Паляниця для всіх!'); // palianytsia-dlia-vsikh
+```
+
+## API
+
+### `transliterate(input: string): string`
+
+Transliterates Ukrainian text to Latin script according to KMU Resolution No. 55, including:
+
+- word-start rules for `Є`, `Ї`, `Й`, `Ю`, `Я`
+- `zgh` handling for `зг`
+- omission of soft sign and apostrophes
+
+### `slugify(input: string, options?): string`
+
+Builds an ASCII slug from transliterated text.
+
+Options:
+
+- `separator?: string` default `-`
+- `lowercase?: boolean` default `true`
+
+## Contributing
+
+Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for contribution guidelines.
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+declare function greet(name: string): string;
+export { greet };

package/dist/index.js

@@ -0,0 +1,7 @@
+// src/index.ts
+function greet(name) {
+  return `Hello, ${name}!`;
+}
+export {
+  greet
+};

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@dcheglakov/uk-translit",
+  "version": "1.0.0",
+  "description": "Official Ukrainian transliteration and slug generation for TypeScript, built according to the current rules of the Cabinet of Ministers of Ukraine Resolution No. 55. Designed for headless CMS workflows, with context-aware transliteration, clean slug output, strong test coverage, and a modern release pipeline.",
+  "homepage": "https://github.com/dcheglakov/uk-translit#readme",
+  "bugs": {
+    "url": "https://github.com/dcheglakov/uk-translit/issues"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dcheglakov/uk-translit.git"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      }
+    },
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "build": "bunup",
+    "changeset": "changeset",
+    "dev": "bunup --watch",
+    "format": "oxfmt",
+    "lint": "oxlint",
+    "prepare": "bun simple-git-hooks",
+    "publish:ci": "bun run build && bun pm pack && npm publish ./*.tgz --access public",
+    "release": "changeset publish",
+    "test": "bun test",
+    "test:coverage": "bun test --coverage",
+    "test:watch": "bun test --watch",
+    "type-check": "tsc --noEmit",
+    "version-packages": "changeset version"
+  },
+  "devDependencies": {
+    "@changesets/cli": "^2.30.0",
+    "@types/bun": "^1.3.12",
+    "bumpp": "^11.0.1",
+    "bunup": "^0.16.31",
+    "oxfmt": "^0.45.0",
+    "oxlint": "^1.60.0",
+    "simple-git-hooks": "^2.13.1",
+    "typescript": "^6.0.2"
+  },
+  "peerDependencies": {
+    "typescript": ">=4.5.0"
+  },
+  "peerDependenciesMeta": {
+    "typescript": {
+      "optional": true
+    }
+  },
+  "simple-git-hooks": {
+    "pre-commit": "bun run lint && bun run type-check"
+  }
+}