urdu-text-utils 0.2.1 → 0.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/CHANGELOG.md CHANGED
@@ -1,5 +1,11 @@
1
1
  # Changelog
2
2
 
3
+ ## 0.2.2
4
+
5
+ - Smoke-test the release tarball before and after publish
6
+ - Add one-command release script
7
+
8
+
3
9
  ## 0.2.1
4
10
 
5
11
  - Add Urdu name transliteration with part extraction (`transliterateNameToEnglish`, `transliterateNameToUrdu`, `extractNameParts`), covering honorifics, family names, and prefixes.
package/README.md CHANGED
@@ -303,14 +303,15 @@ CI builds the docs on every push. VitePress fails on dead links, so a renamed pa
303
303
 
304
304
  ## Releasing
305
305
 
306
- Publishing is automated and tag-driven. CI runs tests on Node 18/20/22 for every push and PR; nothing reaches npm until a version tag exists.
306
+ Publishing is automated and tag-driven. CI runs tests on Node 18/20/22 for every push and PR; nothing reaches npm until a version tag exists. Commit the feature work first, then release with a single command:
307
307
 
308
308
  ```bash
309
- npm version patch # or minor / major commits and tags
310
- git push --follow-tags
309
+ npm run release -- patch # or minor, major, or an explicit 0.3.0
311
310
  ```
312
311
 
313
- The `Release` workflow then verifies the tag matches `package.json`, re-runs typecheck/tests/build, publishes with `--provenance`, and opens a GitHub Release with generated notes.
312
+ The script bumps `package.json` and the lockfile, writes a CHANGELOG section from the commits since the last tag, commits `chore: release vX.Y.Z`, and pushes the annotated `vX.Y.Z` tag. Useful options: `--yes` skips the confirmation prompt, `--no-push` bumps/commits/tags locally only, `--dry-run` previews the whole plan without changing anything, and `--notes "line one\nline two"` overrides the auto-generated changelog section.
313
+
314
+ The `Release` workflow then verifies the tag matches `package.json`, packs and smoke-tests the tarball, publishes with `--provenance`, re-installs the published version from the registry to verify it, and opens a GitHub Release with the changelog notes. The manual equivalent of the script is `npm version patch` plus editing `CHANGELOG.md` and pushing `--follow-tags` by hand.
314
315
 
315
316
  Authentication is npm [Trusted Publishing](https://docs.npmjs.com/trusted-publishers) over OIDC — no npm token exists in this repository and none needs to be rotated. npm trusts `Zaid-maker/urdu-text-utils` publishing from `release.yml` specifically, so renaming that workflow file breaks releases until the trusted publisher is updated on npm.
316
317
 
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "urdu-text-utils",
3
- "version": "0.2.1",
3
+ "version": "0.2.2",
4
4
  "description": "Comprehensive Urdu NLP & text processing toolkit: normalization, Roman Urdu transliteration, stop words, script detection, digits, diacritics (aerab), sorting, search, and statistics. Zero dependencies, ESM + CJS.",
5
5
  "keywords": [
6
6
  "urdu",
@@ -79,6 +79,7 @@
79
79
  "test": "vitest run",
80
80
  "test:watch": "vitest",
81
81
  "typecheck": "tsc --noEmit",
82
+ "release": "node release.mjs",
82
83
  "prepublishOnly": "npm run typecheck && npm test && npm run build",
83
84
  "docs:dev": "vitepress dev docs",
84
85
  "docs:build": "vitepress build docs",