howlongtoread 1.0.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Dobroslav Radosavljevic
+
+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,136 @@
+# 📦 npm-ts-start
+
+A minimal starter template for creating npm packages in pure TypeScript.
+
+## ✨ Features
+
+- 🔷 **TypeScript** - Write type-safe code with full TypeScript support
+- ⚡ **tsdown** - Fast bundling powered by Rolldown
+- 🧪 **Bun Test** - Fast built-in test runner
+- 🎨 **Ultracite** - Zero-config linting and formatting with Oxlint + Oxfmt
+- 📦 **ESM** - Ships as ES modules with TypeScript declarations
+- 🚀 **GitHub Actions** - CI/CD pipeline with automated testing and npm publishing
+- 🐶 **Husky** - Pre-commit hooks for code quality enforcement
+- 📝 **Commitlint** - Conventional commit message validation
+
+## 🚀 Getting Started
+
+1. Clone or use this template:
+
+```bash
+git clone https://github.com/dobroslavradosavljevic/npm-ts-start.git my-package
+cd my-package
+```
+
+2. Update `package.json` with your package name, description, and author info.
+
+3. Install dependencies:
+
+```bash
+bun install
+```
+
+4. Start developing in `src/index.ts`.
+
+## 📜 Scripts
+
+| Command             | Description                         |
+| ------------------- | ----------------------------------- |
+| `bun run build`     | Build the package                   |
+| `bun run dev`       | Build in watch mode                 |
+| `bun run test`      | Run tests                           |
+| `bun run lint`      | Check for linting issues            |
+| `bun run format`    | Fix linting and formatting issues   |
+| `bun run typecheck` | Run TypeScript type checking        |
+| `bun run bump`      | Bump version and generate changelog |
+| `bun run release`   | Publish the package to npm          |
+
+## 📁 Project Structure
+
+```txt
+├── src/
+│   └── index.ts          # Package entry point
+├── tests/
+│   └── index.test.ts     # Test files
+├── dist/                 # Build output (generated)
+├── .github/
+│   └── workflows/
+│       ├── ci.yml        # CI pipeline (lint, test, build)
+│       └── release.yml   # Automated npm publishing
+├── .husky/
+│   ├── pre-commit        # Runs lint-staged before commits
+│   └── commit-msg        # Validates commit messages
+├── tsdown.config.ts      # Build configuration
+├── tsconfig.json         # TypeScript configuration
+├── commitlint.config.ts  # Commit message rules
+└── package.json
+```
+
+## 🐶 Git Hooks
+
+This template uses Husky for Git hooks:
+
+- **pre-commit**: Runs `lint-staged` to lint and format staged files
+- **commit-msg**: Validates commit messages follow [Conventional Commits](https://www.conventionalcommits.org/)
+
+### Commit Message Format
+
+```
+type(scope): description
+
+# Examples:
+feat: add new feature
+fix: resolve bug in parser
+docs: update README
+chore: update dependencies
+```
+
+## 🔄 CI/CD
+
+### Continuous Integration
+
+On every push to `main` and pull request, the CI workflow runs:
+
+- ✅ Lint check
+- ✅ Type check
+- ✅ Tests
+- ✅ Build
+
+### Automated Releases
+
+When you push a version tag (`v*`), the release workflow:
+
+1. Runs all CI checks
+2. Publishes to npm with provenance
+3. Creates a GitHub release with auto-generated notes
+
+### Setup for Publishing
+
+Add `NPM_TOKEN` to your repository secrets:
+
+1. Go to **Settings** > **Secrets and variables** > **Actions**
+2. Add `NPM_TOKEN` with your npm automation token
+
+## 🚢 Publishing
+
+1. Bump the version (creates a tag):
+
+```bash
+bun run bump
+```
+
+2. Push the tag to trigger the release workflow:
+
+```bash
+git push --tags
+```
+
+Or publish manually:
+
+```bash
+bun publish
+```
+
+## 📄 License
+
+MIT

package/dist/index.d.mts

@@ -0,0 +1,4 @@
+//#region src/index.d.ts
+declare const fn: () => string;
+//#endregion
+export { fn };

package/dist/index.mjs

@@ -0,0 +1,5 @@
+//#region src/index.ts
+const fn = () => "Hello, tsdown!";
+
+//#endregion
+export { fn };

package/package.json

@@ -0,0 +1,67 @@
+{
+  "name": "howlongtoread",
+  "version": "1.0.0",
+  "description": "Estimate how long it takes to read text content.",
+  "keywords": [
+    "reading-time",
+    "read-time",
+    "estimate",
+    "text",
+    "words",
+    "typescript"
+  ],
+  "homepage": "https://github.com/dobroslavradosavljevic/howlongtoread#readme",
+  "bugs": {
+    "url": "https://github.com/dobroslavradosavljevic/howlongtoread/issues"
+  },
+  "license": "MIT",
+  "author": "Dobroslav Radosavljevic <dobroslav.radosavljevic@gmail.com>",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dobroslavradosavljevic/howlongtoread.git"
+  },
+  "files": [
+    "dist"
+  ],
+  "type": "module",
+  "main": "./dist/index.mjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.mts",
+  "exports": {
+    ".": "./dist/index.mjs",
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "test": "bun test",
+    "lint": "bun ultracite check",
+    "format": "bun ultracite fix",
+    "typecheck": "tsc --noEmit",
+    "prepare": "husky",
+    "prepublishOnly": "bun run build",
+    "bump": "bumpp --changelog",
+    "release": "bun publish"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^20.3.1",
+    "@commitlint/config-conventional": "^20.3.1",
+    "@types/bun": "latest",
+    "bumpp": "^10.3.2",
+    "husky": "^9.1.7",
+    "lint-staged": "^16.2.7",
+    "oxfmt": "^0.26.0",
+    "oxlint": "^1.41.0",
+    "tsdown": "^0.18.1",
+    "typescript": "^5.9.3",
+    "ultracite": "7.0.12"
+  },
+  "lint-staged": {
+    "*.{ts,tsx,js,jsx,mjs,cjs}": [
+      "bun ultracite fix"
+    ],
+    "*.{json,md,yml,yaml}": [
+      "bun ultracite fix"
+    ]
+  }
+}