Skip to content

fix: support piped content in note updates #112

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Yukaii merged 1 commit into from
Sep 16, 2026
+119 −20
Merged

fix: support piped content in note updates #112

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -546,6 +546,8 @@ EXAMPLES
$ hackmd-cli notes update --noteId=WNkLM6gkS0Cg2cQ8rv7bYA --readPermission=owner --writePermission=owner

$ hackmd-cli notes update --noteId=WNkLM6gkS0Cg2cQ8rv7bYA --tags=tag1,tag2

cat README.md | hackmd-cli notes update --noteId=WNkLM6gkS0Cg2cQ8rv7bYA
```

## `hackmd-cli team-folders`
Expand Down Expand Up @@ -826,6 +828,8 @@ EXAMPLES
$ hackmd-cli team-notes update --teamPath=CLI-test --noteId=WNkLM6gkS0Cg2cQ8rv7bYA --readPermission=owner --writePermission=owner

$ hackmd-cli team-notes update --teamPath=CLI-test --noteId=WNkLM6gkS0Cg2cQ8rv7bYA --tags=tag1,tag2

cat README.md | hackmd-cli team-notes update --teamPath=CLI-test --noteId=WNkLM6gkS0Cg2cQ8rv7bYA
```

## `hackmd-cli teams`
Expand Down
27 changes: 17 additions & 10 deletions src/commands/notes/update.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
import type {NotePermissionRole, UpdateNoteOptions} from '@hackmd/api'
import type {UpdateNoteOptions} from '@hackmd/api'

import {Flags} from '@oclif/core'

import HackMDCommand from '../../command'
import {
noteContent, noteId, notePermission, noteTags, parentFolderId, permalink,
} from '../../flags'
import {buildNoteUpdatePayload} from '../../note-update'
import {safeStdinRead} from '../../utils'

export default class Update extends HackMDCommand {
static description = 'Update note'
Expand All @@ -14,6 +16,7 @@ export default class Update extends HackMDCommand {
"$ hackmd-cli notes update --noteId=WNkLM6gkS0Cg2cQ8rv7bYA --parentFolderId=fc7a3d48-4a07-4cbf-bf4f-e65dd896e01c --content='# A new title'",
'$ hackmd-cli notes update --noteId=WNkLM6gkS0Cg2cQ8rv7bYA --readPermission=owner --writePermission=owner',
'$ hackmd-cli notes update --noteId=WNkLM6gkS0Cg2cQ8rv7bYA --tags=tag1,tag2',
'$ cat README.md | hackmd-cli notes update --noteId=WNkLM6gkS0Cg2cQ8rv7bYA',
]
static flags = {
content: noteContent,
Expand All @@ -34,18 +37,22 @@ export default class Update extends HackMDCommand {
this.error('Flag noteId could not be empty')
}

const payload: UpdateNoteOptions & {tags?: string[]} = {}

if (content !== undefined) payload.content = content
if (parentFolderId !== undefined) payload.parentFolderId = parentFolderId
if (readPermission !== undefined) payload.readPermission = readPermission as NotePermissionRole
if (writePermission !== undefined) payload.writePermission = writePermission as NotePermissionRole
if (permalink !== undefined) payload.permalink = permalink
if (tags !== undefined) payload.tags = tags.split(',').map((t: string) => t.trim()).filter(Boolean)
const stdinContent = process.stdin.isTTY ? undefined : safeStdinRead()
let payload: UpdateNoteOptions
try {
payload = buildNoteUpdatePayload(
{
content, parentFolderId, permalink, readPermission, tags, writePermission,
},
stdinContent,
)
} catch (error) {
this.error(error as Error)
}

try {
const APIClient = await this.getAPIClient()
await APIClient.updateNote(noteId, payload as UpdateNoteOptions)
await APIClient.updateNote(noteId, payload)
} catch (error) {
this.log('Update note failed')
this.error(error as Error)
Expand Down
27 changes: 17 additions & 10 deletions src/commands/team-notes/update.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
import type {NotePermissionRole, UpdateNoteOptions} from '@hackmd/api'
import type {UpdateNoteOptions} from '@hackmd/api'

import {Flags} from '@oclif/core'

import HackMDCommand from '../../command'
import {
noteContent, noteId, notePermission, noteTags, parentFolderId, permalink, teamPath,
} from '../../flags'
import {buildNoteUpdatePayload} from '../../note-update'
import {safeStdinRead} from '../../utils'

export default class Update extends HackMDCommand {
static description = 'Update team note'
Expand All @@ -14,6 +16,7 @@ export default class Update extends HackMDCommand {
"$ hackmd-cli team-notes update --teamPath=CLI-test --noteId=WNkLM6gkS0Cg2cQ8rv7bYA --parentFolderId=fc7a3d48-4a07-4cbf-bf4f-e65dd896e01c --content='# A new title'",
'$ hackmd-cli team-notes update --teamPath=CLI-test --noteId=WNkLM6gkS0Cg2cQ8rv7bYA --readPermission=owner --writePermission=owner',
'$ hackmd-cli team-notes update --teamPath=CLI-test --noteId=WNkLM6gkS0Cg2cQ8rv7bYA --tags=tag1,tag2',
'$ cat README.md | hackmd-cli team-notes update --teamPath=CLI-test --noteId=WNkLM6gkS0Cg2cQ8rv7bYA',
]
static flags = {
content: noteContent,
Expand All @@ -39,18 +42,22 @@ export default class Update extends HackMDCommand {
this.error('Flag noteId could not be empty')
}

const payload: UpdateNoteOptions & {tags?: string[]} = {}

if (content !== undefined) payload.content = content
if (parentFolderId !== undefined) payload.parentFolderId = parentFolderId
if (readPermission !== undefined) payload.readPermission = readPermission as NotePermissionRole
if (writePermission !== undefined) payload.writePermission = writePermission as NotePermissionRole
if (permalink !== undefined) payload.permalink = permalink
if (tags !== undefined) payload.tags = tags.split(',').map((t: string) => t.trim()).filter(Boolean)
const stdinContent = process.stdin.isTTY ? undefined : safeStdinRead()
let payload: UpdateNoteOptions
try {
payload = buildNoteUpdatePayload(
{
content, parentFolderId, permalink, readPermission, tags, writePermission,
},
stdinContent,
)
} catch (error) {
this.error(error as Error)
}

try {
const APIClient = await this.getAPIClient()
await APIClient.updateTeamNote(teamPath, noteId, payload as UpdateNoteOptions)
await APIClient.updateTeamNote(teamPath, noteId, payload)
} catch (error) {
this.log('Update team note failed')
this.error(error as Error)
Expand Down
35 changes: 35 additions & 0 deletions src/note-update.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
import type {NotePermissionRole, UpdateNoteOptions} from '@hackmd/api'

export type NoteUpdateFlags = {
content?: string
parentFolderId?: string
permalink?: string
readPermission?: string
tags?: string
writePermission?: string
}

export function buildNoteUpdatePayload(
{content, parentFolderId, permalink, readPermission, tags, writePermission}: NoteUpdateFlags,
stdinContent?: string,
): UpdateNoteOptions {
if (stdinContent && content !== undefined) {
throw new Error('Content cannot be provided from both stdin and --content')
}

const payload: UpdateNoteOptions = {}
Comment thread
EastSun5566 marked this conversation as resolved.
const resolvedContent = stdinContent || content

if (resolvedContent !== undefined) payload.content = resolvedContent
if (parentFolderId !== undefined) payload.parentFolderId = parentFolderId
if (readPermission !== undefined) payload.readPermission = readPermission as NotePermissionRole
if (writePermission !== undefined) payload.writePermission = writePermission as NotePermissionRole
if (permalink !== undefined) payload.permalink = permalink
if (tags !== undefined) payload.tags = tags.split(',').map(tag => tag.trim()).filter(Boolean)

if (Object.keys(payload).length === 0) {
throw new Error('Nothing to update')
}

return payload
}
46 changes: 46 additions & 0 deletions test/note-update.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
import {expect} from 'chai'

import {buildNoteUpdatePayload} from '../src/note-update'

describe('Note update payload', () => {
it('uses piped stdin content without changing it', () => {
const content = '# Piped content\n\nBody with trailing newline.\n'

expect(buildNoteUpdatePayload({}, content)).to.deep.equal({content})
})

it('uses --content when stdin is empty', () => {
expect(buildNoteUpdatePayload({content: '# Flag content'}, '')).to.deep.equal({
content: '# Flag content',
})
})

it('rejects content from both stdin and --content', () => {
expect(() => buildNoteUpdatePayload({content: '# Flag content'}, '# Piped content'))
.to.throw('Content cannot be provided from both stdin and --content')
})

it('rejects an empty update', () => {
expect(() => buildNoteUpdatePayload({}, '')).to.throw('Nothing to update')
})

it('allows metadata-only updates', () => {
expect(buildNoteUpdatePayload({
parentFolderId: 'folder-id',
permalink: 'new-permalink',
readPermission: 'guest',
tags: ' tag1, tag2, ,',
writePermission: 'owner',
})).to.deep.equal({
parentFolderId: 'folder-id',
permalink: 'new-permalink',
readPermission: 'guest',
tags: ['tag1', 'tag2'],
writePermission: 'owner',
})
})

it('allows an explicit empty --content value', () => {
expect(buildNoteUpdatePayload({content: ''}, '')).to.deep.equal({content: ''})
})
})
Loading