Skip to content

Commit 9122d5f

Browse files
committed
Merge branch 'master' into develop
2 parents 5d5e911 + 4d6adc4 commit 9122d5f

File tree

3 files changed

+128
-20
lines changed

3 files changed

+128
-20
lines changed

CHANGELOG.md

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,111 @@
22

33
All notable changes to HackMD-CLI will be documented in this file.
44

5+
## 2.4.0
6+
7+
### Added
8+
9+
- Smoke tests for built CLI binary verification
10+
- Integration tests for login, notes, and whoami commands
11+
- GitHub Actions workflow for automated unit and smoke test execution
12+
- GitHub Actions workflow for automated package publishing to npm
13+
- pnpm as the package manager
14+
15+
### Changed
16+
17+
- Migrated from Yarn to pnpm for dependency management
18+
- Upgraded Node.js requirement from >=12.0.0 to >=24.0.0
19+
- Modernized ESLint configuration (migrated from `.eslintrc` to `eslint.config.mjs`)
20+
- Upgraded ESLint dependencies and fixed linting issues
21+
- Updated test infrastructure and configuration
22+
- Improved CI/CD workflows
23+
24+
### Fixed
25+
26+
- Various linting issues across the codebase
27+
- Build process to run before smoke tests
28+
- Config test workflow configuration
29+
30+
## 2.3.2
31+
32+
### Changed
33+
34+
- Replaced oclif-completion with custom fork for autocomplete functionality
35+
36+
## 2.3.1
37+
38+
### Added
39+
40+
- Added autocomplete plugin support
41+
42+
## 2.3.0
43+
44+
### Changed
45+
46+
- Updated README documentation
47+
- Added `/lib` to package files
48+
49+
## 2.2.0
50+
51+
### Added
52+
53+
- Support `--editor` option for team note creation
54+
55+
### Changed
56+
57+
- Migrated from npm to Yarn as package manager
58+
- Upgraded oclif dependencies
59+
- Upgraded various dependencies
60+
61+
### Fixed
62+
63+
- Removed dev-cli references
64+
- Fixed lint errors and typing issues
65+
- Added test helper improvements
66+
67+
## 2.1.0
68+
69+
### Added
70+
71+
- Support `$EDITOR` environment variable for creating notes with content
72+
73+
### Changed
74+
75+
- Upgraded Node.js requirement from >=10.0.0 to >=12.0.0
76+
- Upgraded oclif to version 18
77+
- Updated CI workflow to use Node.js 18
78+
79+
### Fixed
80+
81+
- Fixed config file creation to ensure it's present with proper initialization
82+
- Fixed tslint issues
83+
84+
## 2.0.2
85+
86+
### Fixed
87+
88+
- Fixed stdin unavailable read when accessing stdin.fd
89+
90+
## 2.0.1
91+
92+
### Added
93+
94+
- Added `export` command to export note content
95+
96+
### Changed
97+
98+
- Upgraded Node.js requirement to >=17.0.0
99+
- Replaced lodash with lodash.defaults package for smaller bundle size
100+
101+
### Fixed
102+
103+
- Fixed stdin stream not being consumed and being paused
104+
- Removed teamPath from notes create command documentation
105+
106+
### Removed
107+
108+
- Removed unused inquirer dependency
109+
5110
## 2.0.0
6111

7112
### Added

README.md

Lines changed: 22 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@
99
* [Commands](#commands)
1010
* [Configuration](#configuration)
1111
* [License](#license)
12+
* [Changelog](#changelog)
1213

1314
## v2 notice
1415

@@ -25,12 +26,10 @@
2526
<!-- usage -->
2627
```sh-session
2728
$ npm install -g @hackmd/hackmd-cli
28-
# or using pnpm
29-
$ pnpm add -g @hackmd/hackmd-cli
3029
$ hackmd-cli COMMAND
3130
running command...
3231
$ hackmd-cli (--version|-v)
33-
@hackmd/hackmd-cli/2.3.2 darwin-arm64 node-v18.14.2
32+
@hackmd/hackmd-cli/2.4.0 darwin-arm64 node-v24.13.0
3433
$ hackmd-cli --help [COMMAND]
3534
USAGE
3635
$ hackmd-cli COMMAND
@@ -168,7 +167,7 @@ EXAMPLES
168167
# A note to be exported
169168
```
170169

171-
_See code: [src/commands/export.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.2/src/commands/export.ts)_
170+
_See code: [src/commands/export.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.4.0/src/commands/export.ts)_
172171

173172
## `hackmd-cli help [COMMANDS]`
174173

@@ -222,7 +221,7 @@ EXAMPLES
222221
BnC6gN0_TfStV2KKmPPXeg Welcome to your team's workspace null CLI-test
223222
```
224223

225-
_See code: [src/commands/history.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.2/src/commands/history.ts)_
224+
_See code: [src/commands/history.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.4.0/src/commands/history.ts)_
226225

227226
## `hackmd-cli login`
228227

@@ -244,7 +243,7 @@ EXAMPLES
244243
Login successfully
245244
```
246245

247-
_See code: [src/commands/login.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.2/src/commands/login.ts)_
246+
_See code: [src/commands/login.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.4.0/src/commands/login.ts)_
248247

249248
## `hackmd-cli logout`
250249

@@ -265,7 +264,7 @@ EXAMPLES
265264
You've logged out successfully
266265
```
267266

268-
_See code: [src/commands/logout.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.2/src/commands/logout.ts)_
267+
_See code: [src/commands/logout.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.4.0/src/commands/logout.ts)_
269268

270269
## `hackmd-cli notes`
271270

@@ -299,17 +298,17 @@ EXAMPLES
299298
raUuSTetT5uQbqQfLnz9lA CLI test note gvfz2UB5THiKABQJQnLs6Q null
300299
```
301300

302-
_See code: [src/commands/notes/index.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.2/src/commands/notes/index.ts)_
301+
_See code: [src/commands/notes/index.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.4.0/src/commands/notes/index.ts)_
303302

304303
## `hackmd-cli notes create`
305304

306305
Create a note
307306

308307
```
309308
USAGE
310-
$ hackmd-cli notes create [-h] [--title <value>] [--content <value>] [--readPermission <value>]
311-
[--writePermission <value>] [--commentPermission <value>] [-e] [--columns <value> | -x] [--sort <value>] [--filter
312-
<value>] [--output csv|json|yaml | | [--csv | --no-truncate]] [--no-header | ]
309+
$ hackmd-cli notes create [--commentPermission <value>] [--content <value>] [-e] [-h] [--readPermission <value>]
310+
[--title <value>] [--writePermission <value>] [--columns <value> | -x] [--sort <value>] [--filter <value>] [--output
311+
csv|json|yaml | | [--csv | --no-truncate]] [--no-header | ]
313312
314313
FLAGS
315314
-e, --editor create note with $EDITOR
@@ -369,7 +368,7 @@ Update note content
369368

370369
```
371370
USAGE
372-
$ hackmd-cli notes update [-h] [--noteId <value>] [--content <value>]
371+
$ hackmd-cli notes update [--content <value>] [-h] [--noteId <value>]
373372
374373
FLAGS
375374
-h, --help Show CLI help.
@@ -416,16 +415,16 @@ EXAMPLES
416415
BnC6gN0_TfStV2KKmPPXeg Welcome to your team's workspace null CLI-test
417416
```
418417

419-
_See code: [src/commands/team-notes/index.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.2/src/commands/team-notes/index.ts)_
418+
_See code: [src/commands/team-notes/index.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.4.0/src/commands/team-notes/index.ts)_
420419

421420
## `hackmd-cli team-notes create`
422421

423422
Create a team note
424423

425424
```
426425
USAGE
427-
$ hackmd-cli team-notes create [-h] [--teamPath <value>] [--title <value>] [--content <value>] [--readPermission
428-
<value>] [--writePermission <value>] [--commentPermission <value>] [-e] [--columns <value> | -x] [--sort <value>]
426+
$ hackmd-cli team-notes create [--commentPermission <value>] [--content <value>] [-e] [-h] [--readPermission <value>]
427+
[--teamPath <value>] [--title <value>] [--writePermission <value>] [--columns <value> | -x] [--sort <value>]
429428
[--filter <value>] [--output csv|json|yaml | | [--csv | --no-truncate]] [--no-header | ]
430429
431430
FLAGS
@@ -467,7 +466,7 @@ Delete a team note
467466

468467
```
469468
USAGE
470-
$ hackmd-cli team-notes delete [-h] [--teamPath <value>] [--noteId <value>]
469+
$ hackmd-cli team-notes delete [-h] [--noteId <value>] [--teamPath <value>]
471470
472471
FLAGS
473472
-h, --help Show CLI help.
@@ -487,7 +486,7 @@ Update team note content
487486

488487
```
489488
USAGE
490-
$ hackmd-cli team-notes update [-h] [--teamPath <value>] [--noteId <value>] [--content <value>]
489+
$ hackmd-cli team-notes update [--content <value>] [-h] [--noteId <value>] [--teamPath <value>]
491490
492491
FLAGS
493492
-h, --help Show CLI help.
@@ -533,7 +532,7 @@ EXAMPLES
533532
f76308a6-d77a-41f6-86d0-8ada426a6fb4 CLI test team CLI-test 82f7f3d9-4079-4c78-8a00-14094272ece9
534533
```
535534

536-
_See code: [src/commands/teams.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.2/src/commands/teams.ts)_
535+
_See code: [src/commands/teams.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.4.0/src/commands/teams.ts)_
537536

538537
## `hackmd-cli version`
539538

@@ -586,9 +585,13 @@ EXAMPLES
586585
82f7f3d9-4079-4c78-8a00-14094272ece9 Ming-Hsiu Tsai null gvfz2UB5THiKABQJQnLs6Q
587586
```
588587

589-
_See code: [src/commands/whoami.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.3.2/src/commands/whoami.ts)_
588+
_See code: [src/commands/whoami.ts](https://github.com/hackmdio/hackmd-cli/blob/v2.4.0/src/commands/whoami.ts)_
590589
<!-- commandsstop -->
591590

592591
## License
593592

594593
MIT
594+
595+
## Changelog
596+
597+
See [CHANGELOG.md](CHANGELOG.md) for a list of changes and version history.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@hackmd/hackmd-cli",
3-
"version": "2.3.2",
3+
"version": "2.4.0",
44
"author": "HackMD Team",
55
"bin": {
66
"hackmd-cli": "./bin/run"

0 commit comments

Comments
 (0)