lombok-typescript 0.1.0 → 0.3.0

package/README.md

@@ -1,51 +1,39 @@
 # lombok-typescript
 
-[![CI](https://github.com/A-Dev-Kit/lombok-typescript/actions/workflows/ci.yml/badge.svg)](https://github.com/A-Dev-Kit/lombok-typescript/actions/workflows/ci.yml)
-[![Docs](https://github.com/A-Dev-Kit/lombok-typescript/actions/workflows/docs.yml/badge.svg)](https://a-dev-kit.github.io/lombok-typescript/)
-[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](./LICENSE)
-[![npm version](https://img.shields.io/npm/v/lombok-typescript.svg?label=npm)](https://www.npmjs.com/package/lombok-typescript)
-[![coverage](https://img.shields.io/codecov/c/github/A-Dev-Kit/lombok-typescript/main?label=coverage)](https://codecov.io/gh/A-Dev-Kit/lombok-typescript)
-[![Node](https://img.shields.io/badge/node-%E2%89%A522-brightgreen)](https://nodejs.org/)
-[![TypeScript](https://img.shields.io/badge/TypeScript-%E2%89%A55.0-blue?logo=typescript)](https://www.typescriptlang.org/)
-
-A TypeScript port of Java's [Project Lombok](https://projectlombok.org/) with Gang-of-Four design patterns as decorators. Legacy `experimentalDecorators` and Stage 3 ECMAScript decorators are supported side-by-side.
-
-## Status
-
-**Version `0.1.0` — code-complete, not on npm yet.** Batch publish is deferred until the full release queue is ready. See [CHANGELOG.md](./CHANGELOG.md).
-
-Phase 1 decorators are implemented: `@NonNull`, `@ToString`, `@Builder`, `@Data`, `@Singleton`, `@Prototype`, `@Factory`, `@Memoize`.
-
-Documentation site: [a-dev-kit.github.io/lombok-typescript](https://a-dev-kit.github.io/lombok-typescript/) (after GitHub Pages deploy).
+TypeScript decorators inspired by Project Lombok and common design patterns.
 
 ## Install
 
-```bash
-# Not on npm yet — clone and link locally:
-git clone https://github.com/A-Dev-Kit/lombok-typescript.git
-cd lombok-typescript && pnpm install && pnpm build && pnpm link --global
+To install the current stable release:
 
-# When published (preview tag):
-npm install lombok-typescript@preview
+```bash
+npm install lombok-typescript
 ```
 
-## Pick a decorator standard
-
-### Legacy (`lombok-typescript/legacy`)
+To try the next preview release (one version ahead during backfill):
 
-For NestJS, TypeORM, and most existing decorator-based projects.
-
-```jsonc
-{ "compilerOptions": { "experimentalDecorators": true, "emitDecoratorMetadata": true } }
+```bash
+npm install lombok-typescript@preview
 ```
 
-### Stage 3 (`lombok-typescript/stage3`)
-
-For TS 5.0+ projects without `experimentalDecorators`.
-
-```jsonc
-{ "compilerOptions": { "experimentalDecorators": false } }
-```
+## Decorators in this release
+
+- @NonNull
+- @ToString
+- @Builder
+- @Data
+- @Singleton
+- @Prototype
+- @Factory
+- @Memoize
+- @Value
+- @With
+- @Equals
+- @Getter
+- @Setter
+- @Log
+- @Accessors
+- @UtilityClass
 
 ## Quick start
 
@@ -55,44 +43,25 @@ npx lombok-ts generate
 ```
 
 ```ts
-import { Data, Builder, NonNull, Memoize, Singleton } from 'lombok-typescript/legacy';
+import { Data, Builder, NonNull } from 'lombok-typescript/legacy';
 
 @Data
 @Builder
 class User {
   @NonNull name!: string;
-  age!: number;
-}
-
-@Singleton
-class Cache {
-  @Memoize()
-  get(key: string) {
-    return key;
-  }
 }
 ```
 
-After codegen, import and call `applyAllGenerated` from the `.lombok/` companion file. See [docs-site/guide/getting-started.md](./docs-site/guide/getting-started.md).
+Full setup, codegen, and framework guides: [https://a-dev-kit.github.io/lombok-typescript/](https://a-dev-kit.github.io/lombok-typescript/)
 
 ## CLI
 
-| Command              | Description                                   |
-| -------------------- | --------------------------------------------- |
-| `lombok-ts generate` | Emit `.lombok.ts` + `.lombok.d.ts` companions |
-| `lombok-ts init`     | Create `lombok.config.ts`                     |
-| `lombok-ts clean`    | Remove `.lombok/`, `dist/`, `coverage/`       |
-| `lombok-ts watch`    | Phase 2 stub                                  |
-
-## Examples
-
-- [examples/plain-ts](./examples/plain-ts/) — legacy backend + codegen
-- [examples/nestjs](./examples/nestjs/) — `@Injectable()` with `@Singleton`, `@Factory`, `@Memoize`
-
-## Contributing
-
-See [CONTRIBUTING.md](./CONTRIBUTING.md). Tests require **95%+** coverage on changed code.
+| Command              | Description                                               |
+| -------------------- | --------------------------------------------------------- |
+| `lombok-ts generate` | Generate companion TypeScript files for decorated classes |
+| `lombok-ts init`     | Add lombok configuration to your project                  |
+| `lombok-ts clean`    | Remove generated lombok output from your project          |
 
 ## License
 
-[MIT](./LICENSE)
+MIT