lombok-typescript 0.2.0 → 0.3.0

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.
Files changed (2) hide show
  1. package/README.md +26 -18
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,27 +1,39 @@
1
1
  # lombok-typescript
2
2
 
3
- Lombok-like decorators and code generation for TypeScript, with Gang-of-Four design patterns.
4
-
5
- **Version:** `0.2.0`
3
+ TypeScript decorators inspired by Project Lombok and common design patterns.
6
4
 
7
5
  ## Install
8
6
 
7
+ To install the current stable release:
8
+
9
9
  ```bash
10
- npm install lombok-typescript@preview
11
- # pin this tree: npm install lombok-typescript@0.2.0
10
+ npm install lombok-typescript
12
11
  ```
13
12
 
14
- ## Decorators
13
+ To try the next preview release (one version ahead during backfill):
15
14
 
16
- Includes all decorators from `0.1.0` and earlier.
15
+ ```bash
16
+ npm install lombok-typescript@preview
17
+ ```
17
18
 
18
- **New in 0.2.0:**
19
+ ## Decorators in this release
19
20
 
21
+ - @NonNull
22
+ - @ToString
23
+ - @Builder
24
+ - @Data
25
+ - @Singleton
26
+ - @Prototype
27
+ - @Factory
28
+ - @Memoize
20
29
  - @Value
21
30
  - @With
22
31
  - @Equals
23
32
  - @Getter
24
33
  - @Setter
34
+ - @Log
35
+ - @Accessors
36
+ - @UtilityClass
25
37
 
26
38
  ## Quick start
27
39
 
@@ -40,19 +52,15 @@ class User {
40
52
  }
41
53
  ```
42
54
 
43
- After codegen, call `applyAllGenerated` from the `.lombok/` companion file.
55
+ Full setup, codegen, and framework guides: [https://a-dev-kit.github.io/lombok-typescript/](https://a-dev-kit.github.io/lombok-typescript/)
44
56
 
45
57
  ## CLI
46
58
 
47
- | Command | Description |
48
- | -------------------- | --------------------------------------- |
49
- | `lombok-ts generate` | Emit `.lombok.ts` companion files |
50
- | `lombok-ts init` | Create `lombok.config.ts` |
51
- | `lombok-ts clean` | Remove `.lombok/`, `dist/`, `coverage/` |
52
-
53
- ## Documentation
54
-
55
- https://a-dev-kit.github.io/lombok-typescript/
59
+ | Command | Description |
60
+ | -------------------- | --------------------------------------------------------- |
61
+ | `lombok-ts generate` | Generate companion TypeScript files for decorated classes |
62
+ | `lombok-ts init` | Add lombok configuration to your project |
63
+ | `lombok-ts clean` | Remove generated lombok output from your project |
56
64
 
57
65
  ## License
58
66
 
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "lombok-typescript",
3
- "version": "0.2.0",
4
- "description": "TypeScript Lombok-style decorators immutable @Value, @With, @Equals, accessors.",
3
+ "version": "0.3.0",
4
+ "description": "Lombok-style TypeScript decorators with logging and accessor utilities.",
5
5
  "type": "module",
6
6
  "main": "./dist/index.cjs",
7
7
  "module": "./dist/index.js",