himanshuchandola 1.0.0 → 1.0.1
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 +12 -146
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -2,170 +2,32 @@
|
|
|
2
2
|
|
|
3
3
|
Interactive CLI portfolio for Himanshu Chandola - A modern terminal experience built with TypeScript.
|
|
4
4
|
|
|
5
|
-
[](https://www.npmjs.com/package/himanshuchandola)
|
|
6
|
-
[](https://opensource.org/licenses/MIT)
|
|
7
|
-
[](https://www.typescriptlang.org/)
|
|
5
|
+
[](https://www.npmjs.com/package/himanshuchandola)
|
|
6
|
+
[](https://opensource.org/licenses/MIT)
|
|
7
|
+
[](https://www.typescriptlang.org/)
|
|
8
8
|
|
|
9
|
-
##
|
|
9
|
+
## 🚀 Quick Start
|
|
10
10
|
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
## Installation
|
|
14
|
-
|
|
15
|
-
### Run without installing
|
|
11
|
+
Run the CLI directly without installation:
|
|
16
12
|
|
|
17
13
|
```bash
|
|
18
14
|
npx himanshuchandola
|
|
19
15
|
```
|
|
20
16
|
|
|
21
|
-
|
|
17
|
+
Or install globally:
|
|
22
18
|
|
|
23
19
|
```bash
|
|
24
20
|
npm install -g himanshuchandola
|
|
25
|
-
```
|
|
26
|
-
|
|
27
|
-
Then run:
|
|
28
|
-
|
|
29
|
-
```bash
|
|
30
21
|
himanshuchandola
|
|
31
22
|
```
|
|
32
23
|
|
|
33
|
-
##
|
|
34
|
-
|
|
35
|
-
```bash
|
|
36
|
-
himanshuchandola [options]
|
|
37
|
-
```
|
|
38
|
-
|
|
39
|
-
### Options
|
|
40
|
-
|
|
41
|
-
- `--open=<destination>` - Open a destination directly (portfolio, github, linkedin, peerlist, twitter)
|
|
42
|
-
- `--no-anim` - Skip the animated banner
|
|
43
|
-
- `-h, --help` - Show help message
|
|
44
|
-
|
|
45
|
-
### Examples
|
|
46
|
-
|
|
47
|
-
```bash
|
|
48
|
-
# Open GitHub directly
|
|
49
|
-
himanshuchandola --open=github
|
|
50
|
-
|
|
51
|
-
# Skip animation
|
|
52
|
-
himanshuchandola --no-anim
|
|
53
|
-
|
|
54
|
-
# Show help
|
|
55
|
-
himanshuchandola --help
|
|
56
|
-
```
|
|
57
|
-
|
|
58
|
-
## Features
|
|
59
|
-
|
|
60
|
-
- Animated ASCII banner with color cycling
|
|
61
|
-
- Beautiful terminal card with personal information
|
|
62
|
-
- Interactive numbered menu for navigation
|
|
63
|
-
- CLI flags for direct navigation and animation control
|
|
64
|
-
- Graceful fallbacks for non-TTY environments
|
|
65
|
-
- TypeScript with strict mode
|
|
66
|
-
- Comprehensive test coverage
|
|
67
|
-
- Automated versioning and publishing with semantic-release
|
|
68
|
-
|
|
69
|
-
## Tech Stack
|
|
70
|
-
|
|
71
|
-
- **TypeScript** - Type-safe development with strict mode
|
|
72
|
-
- **tsup** - Fast TypeScript bundler
|
|
73
|
-
- **Biome** - Fast linter and formatter
|
|
74
|
-
- **Vitest** - Unit testing framework
|
|
75
|
-
- **Inquirer** - Interactive command-line prompts
|
|
76
|
-
- **Chalk** - Terminal string styling
|
|
77
|
-
- **Boxen** - Terminal boxes
|
|
78
|
-
- **Figlet** - ASCII art text
|
|
79
|
-
- **Ora** - Elegant terminal spinners
|
|
80
|
-
- **Semantic Release** - Automated versioning and npm publishing
|
|
81
|
-
|
|
82
|
-
## Development
|
|
83
|
-
|
|
84
|
-
### Prerequisites
|
|
85
|
-
|
|
86
|
-
- [Bun](https://bun.sh/) (recommended) or Node.js 18+
|
|
87
|
-
|
|
88
|
-
### Setup
|
|
89
|
-
|
|
90
|
-
```bash
|
|
91
|
-
# Clone the repository
|
|
92
|
-
git clone https://github.com/himanshuchandola/himanshuchandola-cli.git
|
|
93
|
-
cd himanshuchandola-cli
|
|
94
|
-
|
|
95
|
-
# Install dependencies
|
|
96
|
-
bun install
|
|
97
|
-
|
|
98
|
-
# Run in development mode
|
|
99
|
-
bun run dev
|
|
100
|
-
|
|
101
|
-
# Build
|
|
102
|
-
bun run build
|
|
103
|
-
|
|
104
|
-
# Test
|
|
105
|
-
bun test
|
|
106
|
-
|
|
107
|
-
# Lint
|
|
108
|
-
bun run lint
|
|
109
|
-
```
|
|
110
|
-
|
|
111
|
-
### Scripts
|
|
112
|
-
|
|
113
|
-
- `bun run dev` - Watch mode with auto-rebuild
|
|
114
|
-
- `bun run build` - Build for production
|
|
115
|
-
- `bun test` - Run tests
|
|
116
|
-
- `bun run type-check` - TypeScript type checking
|
|
117
|
-
- `bun run lint` - Lint code with Biome
|
|
118
|
-
- `bun run format` - Format code with Biome
|
|
119
|
-
|
|
120
|
-
## Project Structure
|
|
121
|
-
|
|
122
|
-
```
|
|
123
|
-
himanshuchandola-cli/
|
|
124
|
-
├── src/
|
|
125
|
-
│ ├── index.ts # CLI entry point
|
|
126
|
-
│ ├── config/
|
|
127
|
-
│ │ └── personal.ts # Personal data configuration
|
|
128
|
-
│ ├── modules/
|
|
129
|
-
│ │ ├── banner.ts # Animated ASCII banner
|
|
130
|
-
│ │ ├── menu.ts # Interactive menu system
|
|
131
|
-
│ │ └── card.ts # Terminal card display
|
|
132
|
-
│ ├── utils/
|
|
133
|
-
│ │ ├── flags.ts # CLI flag parsing
|
|
134
|
-
│ │ ├── loader.ts # Dynamic module loading
|
|
135
|
-
│ │ └── open.ts # Safe URL opening
|
|
136
|
-
│ └── types/
|
|
137
|
-
│ └── index.ts # TypeScript type definitions
|
|
138
|
-
├── tests/ # Test files
|
|
139
|
-
├── docs/ # Documentation
|
|
140
|
-
├── .github/workflows/ # CI/CD workflows
|
|
141
|
-
└── package.json
|
|
142
|
-
```
|
|
143
|
-
|
|
144
|
-
## Documentation
|
|
24
|
+
## 📖 Documentation
|
|
145
25
|
|
|
146
26
|
- [Development Guide](./docs/DEVELOPMENT.md)
|
|
147
27
|
- [Testing Guide](./docs/TESTING.md)
|
|
148
28
|
- [Contributing Guidelines](./docs/CONTRIBUTING.md)
|
|
149
29
|
|
|
150
|
-
##
|
|
151
|
-
|
|
152
|
-
This project uses semantic-release for automated versioning and npm publishing. Commits following the [Conventional Commits](https://www.conventionalcommits.org/) specification will trigger automated releases.
|
|
153
|
-
|
|
154
|
-
### Commit Message Format
|
|
155
|
-
|
|
156
|
-
- `feat(scope): message` - Minor version bump
|
|
157
|
-
- `fix(scope): message` - Patch version bump
|
|
158
|
-
- `feat(scope)!: message` - Major version bump (breaking change)
|
|
159
|
-
- `docs(scope): message` - No version bump
|
|
160
|
-
- `chore(scope): message` - No version bump
|
|
161
|
-
|
|
162
|
-
Valid scopes: cli, config, deps, ci, types, utils, banner, menu, card, release
|
|
163
|
-
|
|
164
|
-
## License
|
|
165
|
-
|
|
166
|
-
This project is [MIT](./LICENSE) licensed.
|
|
167
|
-
|
|
168
|
-
## Author
|
|
30
|
+
## 👨💻 Author
|
|
169
31
|
|
|
170
32
|
**Himanshu Chandola**
|
|
171
33
|
|
|
@@ -173,3 +35,7 @@ This project is [MIT](./LICENSE) licensed.
|
|
|
173
35
|
- GitHub: [@himanshuchandola](https://github.com/himanshuchandola)
|
|
174
36
|
- LinkedIn: [himanshuchandola](https://www.linkedin.com/in/himanshuchandola/)
|
|
175
37
|
- Twitter: [@himanshuistaken](https://x.com/himanshuistaken)
|
|
38
|
+
|
|
39
|
+
## 📄 License
|
|
40
|
+
|
|
41
|
+
This project is [MIT](./LICENSE) licensed.
|