arsam 2.0.3 → 2.1.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.
- package/README.md +68 -7
- package/dist/index.js +131 -146
- package/dist/index.js.map +510 -0
- package/package.json +32 -19
package/README.md
CHANGED
|
@@ -2,24 +2,85 @@
|
|
|
2
2
|
|
|
3
3
|
## What is this?
|
|
4
4
|
|
|
5
|
-
This is a command line tool that
|
|
5
|
+
This is a modern, type-safe command line tool that displays my résumé in an interactive terminal interface. Built with TypeScript and following clean architecture principles.
|
|
6
6
|
|
|
7
|
-
##
|
|
7
|
+
## Features
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
- 🎨 Beautiful terminal UI with animations
|
|
10
|
+
- 📦 Modern ESM architecture
|
|
11
|
+
- 🔒 Strict type safety with TypeScript
|
|
12
|
+
- 🏗️ Clean, layered architecture
|
|
13
|
+
- ⚡ Fast builds with Bun
|
|
14
|
+
- 🧪 Highly testable and maintainable
|
|
15
|
+
- 🎯 Single responsibility principle throughout
|
|
16
|
+
|
|
17
|
+
## Usage
|
|
18
|
+
|
|
19
|
+
### Run with npx (recommended)
|
|
10
20
|
|
|
11
21
|
```shell
|
|
12
22
|
npx arsam
|
|
13
23
|
```
|
|
14
24
|
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
You can install it globally using `npm` or `yarn`.
|
|
25
|
+
### Install globally
|
|
18
26
|
|
|
19
27
|
```shell
|
|
20
28
|
npm install -g arsam
|
|
29
|
+
# or
|
|
30
|
+
bun install -g arsam
|
|
21
31
|
```
|
|
22
32
|
|
|
33
|
+
## Development
|
|
34
|
+
|
|
35
|
+
### Prerequisites
|
|
36
|
+
|
|
37
|
+
- [Bun](https://bun.sh) >= 1.0.0
|
|
38
|
+
|
|
39
|
+
### Setup
|
|
40
|
+
|
|
23
41
|
```shell
|
|
24
|
-
|
|
42
|
+
# Install dependencies
|
|
43
|
+
bun install
|
|
44
|
+
|
|
45
|
+
# Run in development mode
|
|
46
|
+
bun dev
|
|
47
|
+
|
|
48
|
+
# Build the project
|
|
49
|
+
bun run build
|
|
50
|
+
|
|
51
|
+
# Run the built version
|
|
52
|
+
bun start
|
|
25
53
|
```
|
|
54
|
+
|
|
55
|
+
### Scripts
|
|
56
|
+
|
|
57
|
+
- `bun dev` - Run the application in development mode
|
|
58
|
+
- `bun run build` - Build for production
|
|
59
|
+
- `bun start` - Run the production build
|
|
60
|
+
- `bun run typecheck` - Run TypeScript type checking
|
|
61
|
+
- `bun run lint` - Lint the codebase
|
|
62
|
+
- `bun run prettier` - Format code with Prettier
|
|
63
|
+
- `bun run tidy` - Run both linting and formatting
|
|
64
|
+
|
|
65
|
+
## Architecture
|
|
66
|
+
|
|
67
|
+
This project follows modern software architecture principles with clear separation of concerns:
|
|
68
|
+
|
|
69
|
+
- **Config Layer**: Centralized configuration and constants
|
|
70
|
+
- **Core Layer**: Business logic and domain services
|
|
71
|
+
- **UI Layer**: Presentation and user interaction
|
|
72
|
+
- **Data Layer**: Data models and content
|
|
73
|
+
|
|
74
|
+
## Technical Stack
|
|
75
|
+
|
|
76
|
+
- **TypeScript 5.3+**: Modern, strict type safety
|
|
77
|
+
- **Bun**: Fast runtime, package manager, and bundler
|
|
78
|
+
- **ESM**: Native ES modules
|
|
79
|
+
- **inquirer**: Interactive CLI prompts
|
|
80
|
+
- **chalk**: Terminal styling
|
|
81
|
+
- **boxen**: Terminal boxes
|
|
82
|
+
- **figlet**: ASCII art text
|
|
83
|
+
|
|
84
|
+
## License
|
|
85
|
+
|
|
86
|
+
MIT
|