@tmjeee/w-lib 0.0.1

package/CHANGELOG.md

@@ -0,0 +1,22 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.0.1] - 2026-05-27
+
+### Added
+- Initial library skeleton for npm publishing
+- `helloWorld()` sample function exported as the public API
+- Full ESM + CJS dual package support via tsdown
+- TypeScript strict configuration
+- Vitest test suite with coverage
+- `examples/basic.ts` runnable usage example
+- Complete publish-ready `package.json` (exports map, files, sideEffects, publishConfig)
+- MIT license and minimal conventional changelog
+
+### Notes
+- This is the bootstrap release of the w-lib skeleton.
+- Ready for `npm publish --access public`.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 tmjeee
+
+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,181 @@
+# w-lib
+
+[![npm version](https://img.shields.io/npm/v/@tmjeee/w-lib.svg)](https://www.npmjs.com/package/@tmjeee/w-lib)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+A minimal, modern TypeScript library skeleton ready for publishing to npmjs.com.
+
+This package demonstrates current (2026) best practices for shipping small, tree-shakeable, dual-format (ESM + CJS) libraries with excellent TypeScript support.
+
+## Installation
+
+```bash
+npm install @tmjeee/w-lib
+```
+
+## Usage
+
+This package is **ESM-only**.
+
+```ts
+import { helloWorld } from '@tmjeee/w-lib';
+
+console.log(helloWorld()); // "Hello, world!"
+```
+
+> **Note**: CommonJS (`require()`) is not supported.  
+> If you are in a CommonJS environment, use dynamic import instead:
+> ```js
+> const { helloWorld } = await import('@tmjeee/w-lib');
+> ```
+
+For more information, see the [Node.js documentation on publishing ESM packages](https://nodejs.org/en/learn/modules/publishing-a-package).
+
+## API
+
+### `helloWorld(): string`
+
+Returns the classic greeting.
+
+```ts
+helloWorld(); // "Hello, world!"
+```
+
+## Development
+
+```bash
+# Install dependencies
+npm install
+
+# Type check
+npm run typecheck
+
+# Run tests (once, exits after completion)
+npm test
+
+# Run tests in watch mode (for development)
+npm run test:watch
+
+# Run tests with coverage
+npm run test:coverage
+
+# Build (outputs to dist/)
+npm run build
+
+# Watch mode during development
+npm run dev
+```
+
+### Project Structure
+
+```
+src/index.ts          # Source (helloWorld)
+test/index.test.ts    # Vitest tests
+examples/basic.ts     # Runnable usage demo
+dist/                 # Build output (generated)
+```
+
+## Publishing
+
+This package is configured for immediate publishing.
+
+### Recommended: One-command publish
+
+```bash
+# Bump version first (patch / minor / major)
+npm version patch
+
+# Dry-run first (highly recommended)
+npm run publish:npm:dry
+
+# Then publish for real
+npm run publish:npm
+```
+
+### Manual / step-by-step (with safety checks)
+
+```bash
+# 1. Make sure everything is clean
+npm run typecheck && npm test && npm run build
+# (npm test now runs once and exits automatically)
+
+# 2. Dry-run the publish (strongly recommended)
+npm publish --dry-run --access public
+
+# 3. Bump version
+npm version patch
+
+# 4. Publish
+npm publish --access public
+```
+
+The `prepublishOnly` hook (and both `publish:npm*` scripts) ensure that `build` + `test` run before anything is published.
+
+### What gets published?
+
+Only the contents of the `dist/` folder plus `package.json`, `README.md`, `LICENSE`, and `CHANGELOG.md` (controlled via the `"files"` field).
+
+### Automated publishing with GitHub Actions
+
+This repository includes two GitHub Actions workflows:
+
+- **`.github/workflows/ci.yml`** — Runs type checking and tests on every push and pull request. Can also be triggered manually from the Actions tab.
+- **`.github/workflows/publish.yml`** — Publishes to npmjs.com when you create a new GitHub Release. Can also be triggered manually from the Actions tab (use with caution).
+
+#### Setup steps (one time)
+
+1. Create an npm access token:
+   - Go to https://www.npmjs.com/settings/~tokens
+   - Generate a new **Automation** token (or **Granular** with publish permission for `@tmjeee/w-lib`)
+2. Add the token as a repository secret:
+   - In your GitHub repo → **Settings → Secrets and variables → Actions**
+   - Create a new secret named `NPM_TOKEN` with the value from step 1
+3. (Optional but recommended) Enable npm **Trusted Publishing** (OIDC) for passwordless publishing:
+   - See the comments in `publish.yml` and https://docs.npmjs.com/trusted-publishers
+
+#### How to release
+
+```bash
+# 1. Update CHANGELOG.md
+# 2. Commit everything
+git add .
+git commit -m "chore: prepare v0.0.2"
+
+# 3. Create a version tag + GitHub Release
+npm version patch
+git push && git push --tags
+
+# 4. Go to GitHub → Releases → "Draft a new release"
+#    - Choose the tag you just pushed
+#    - Publish the release
+
+# → The publish workflow will run automatically and publish to npm
+
+**Alternative**: You can also manually trigger the publish workflow from the GitHub repo → **Actions** tab → **"Publish to npmjs"** → **"Run workflow"**.
+```
+
+## Tooling
+
+- **Build**: [tsdown](https://tsdown.dev/) (Rolldown + Oxc)
+- **Testing**: [Vitest](https://vitest.dev/)
+- **TypeScript**: Strict mode, ES2022 target, bundler resolution
+
+### Optional: Add oxlint + oxfmt
+
+For consistency with other `@tmjeee` projects you can add:
+
+```bash
+npm install -D oxlint oxfmt
+```
+
+Then add scripts:
+
+```json
+"lint": "oxlint",
+"format": "oxfmt --check",
+"format:fix": "oxfmt --write"
+```
+
+## License
+
+MIT © 2026 tmjeee

package/dist/index.d.ts

@@ -0,0 +1,17 @@
+//#region src/index.d.ts
+/**
+ * Classic hello world sample for the w-lib skeleton.
+ *
+ * @returns The canonical greeting string
+ *
+ * @example
+ * ```ts
+ * import { helloWorld } from '@tmjeee/w-lib';
+ *
+ * console.log(helloWorld()); // "Hello, world!"
+ * ```
+ */
+declare function helloWorld(): string;
+//#endregion
+export { helloWorld };
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","names":[],"sources":["../src/index.ts"],"mappings":";;AAYA;;;;;;;;;;;iBAAgB,UAAA,CAAA"}

package/dist/index.js

@@ -0,0 +1,20 @@
+//#region src/index.ts
+/**
+* Classic hello world sample for the w-lib skeleton.
+*
+* @returns The canonical greeting string
+*
+* @example
+* ```ts
+* import { helloWorld } from '@tmjeee/w-lib';
+*
+* console.log(helloWorld()); // "Hello, world!"
+* ```
+*/
+function helloWorld() {
+	return "Hello, world!";
+}
+
+//#endregion
+export { helloWorld };
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","names":[],"sources":["../src/index.ts"],"sourcesContent":["/**\n * Classic hello world sample for the w-lib skeleton.\n *\n * @returns The canonical greeting string\n *\n * @example\n * ```ts\n * import { helloWorld } from '@tmjeee/w-lib';\n *\n * console.log(helloWorld()); // \"Hello, world!\"\n * ```\n */\nexport function helloWorld(): string {\n  return 'Hello, world!';\n}\n"],"mappings":";;;;;;;;;;;;;AAYA,SAAgB,aAAqB;AACnC,QAAO"}

package/package.json

@@ -0,0 +1,61 @@
+{
+  "name": "@tmjeee/w-lib",
+  "version": "0.0.1",
+  "description": "A minimal, modern TypeScript library skeleton ready for publishing to npmjs.com. Includes helloWorld sample.",
+  "keywords": [
+    "typescript",
+    "library",
+    "npm",
+    "esm",
+    "hello-world",
+    "skeleton"
+  ],
+  "license": "MIT",
+  "author": "tmjeee <tmjeee@gmail.com>",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/tmjeee/w-lib.git"
+  },
+  "bugs": {
+    "url": "https://github.com/tmjeee/w-lib/issues"
+  },
+  "homepage": "https://github.com/tmjeee/w-lib#readme",
+  "type": "module",
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    }
+  },
+  "files": [
+    "dist",
+    "CHANGELOG.md"
+  ],
+  "sideEffects": false,
+  "engines": {
+    "node": ">=22.14.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "test": "vitest run",
+    "test:watch": "vitest",
+    "test:coverage": "vitest run --coverage",
+    "typecheck": "tsc --noEmit",
+    "prepublishOnly": "npm run build && npm run test",
+    "publish:npm": "npm run build && npm run test && npm publish --access public",
+    "publish:npm:dry": "npm run build && npm run test && npm publish --access public --dry-run"
+  },
+  "devDependencies": {
+    "@types/node": "^22.15.0",
+    "tsdown": "^0.20.3",
+    "typescript": "^5.9.3",
+    "vitest": "^4.0.8"
+  }
+}