Skip to content
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

Jump to bottom

Add a delayed notification for reading Markdown from the stdin stream #644

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Add a delayed notification for reading Markdown from the stdin stream #644

wants to merge 6 commits into from

Conversation

yhatt
Copy link
Member

@yhatt yhatt commented Feb 3, 2025

This PR adds a delayed notification for when Marp CLI is reading Markdown from the stdin stream.

[  INFO ] Currently waiting data from stdin stream. Conversion will start after
          finished reading. (Pass --no-stdin option if it was not intended)

Marp CLI supports stdin and stdout, similar to other UNIX tools. When stdin is open, Marp CLI waits for data to be fully received until the stream is closed.

However, users have frequently reported issues where the CLI appears to freeze due to an unclosed stdin stream. These problems are often caused by spawning the CLI process from the other language.

To make it easier to recognize when the CLI is reading from stdin, I have updated it to display a notification message via stderr.

This notification is delayed, so in simple use cases like the following, users may not notice the message:

$ echo slide.md | marp > slide.html
[  INFO ] Converting 1 markdown...
[  INFO ] <stdin> => <stdout>

If the stream is taking a while to read the stream (e.g. using curl to fetch the source through the network request), the notification message will appear after 3 seconds, like this:

$ curl -s --limit-rate 1k https://gist.githubusercontent.com/yhatt/a7d33a306a87ff634df7bb96aab058b5/raw/fbfaebfa469035306c38f87c108f73f6f837d6f5/marp.md | marp > slide.html
[  INFO ] Currently waiting data from stdin stream. Conversion will start after
          finished reading. (Pass --no-stdin option if it was not intended)
[  INFO ] Converting 1 markdown...
[  INFO ] <stdin> => <stdout>

@yhatt yhatt linked an issue Feb 3, 2025 that may be closed by this pull request
marp.exe rendering and watch mode do not work in msys on Windows 10 (i.e. git-bash) #573
Open
@codecov Codecov
Copy link

codecov bot commented Feb 18, 2025 •
edited
Loading

❌ 95 Tests Failed:

Tests completed Failed Passed Skipped
1192 95 1097 5
View the top 3 failed test(s) by shortest run time 
Marp CLI with passing a file with --parallel option converts files in parallel with specified concurrency
Stack Traces | 5s run time 
Error: thrown: "Exceeded timeout of 5000 ms for a test.
Add a timeout value to this test to increase the timeout, if this is a long-running test. See https://jestjs.io/docs/api#testname-fn-timeout."
    at .../marp-cli/test/marp-cli.ts:1172:9
    at _dispatchDescribe (.../jest-circus/build/index.js:91:26)
    at describe (.../jest-circus/build/index.js:55:5)
    at .../marp-cli/test/marp-cli.ts:1171:7
    at _dispatchDescribe (.../jest-circus/build/index.js:91:26)
    at describe (.../jest-circus/build/index.js:55:5)
    at .../marp-cli/test/marp-cli.ts:613:3
    at _dispatchDescribe (.../jest-circus/build/index.js:91:26)
    at describe (.../jest-circus/build/index.js:55:5)
    at Object.<anonymous> (.../marp-cli/test/marp-cli.ts:66:1)
    at Runtime._execModule (.../jest-runtime/build/index.js:1439:24)
    at Runtime._loadModule (.../jest-runtime/build/index.js:1022:12)
    at Runtime.requireModule (.../jest-runtime/build/index.js:882:12)
    at jestAdapter (.../build/legacy-code-todo-rewrite/jestAdapter.js:77:13)
    at processTicksAndRejections (node:internal/process/task_queues:105:5)
    at runTestInternal (.../jest-runner/build/runTest.js:367:16)
    at runTest (.../jest-runner/build/runTest.js:444:34)
    at Object.worker (.../jest-runner/build/testWorker.js:106:12)
Marp CLI with passing a file with --pptx-editable options prefers PPTX than HTML if not specified conversion type
Stack Traces | 5s run time 
Error: thrown: "Exceeded timeout of 5000 ms for a test.
Add a timeout value to this test to increase the timeout, if this is a long-running test. See https://jestjs.io/docs/api#testname-fn-timeout."
    at .../marp-cli/test/marp-cli.ts:1569:7
    at _dispatchDescribe (.../jest-circus/build/index.js:91:26)
    at describe (.../jest-circus/build/index.js:55:5)
    at .../marp-cli/test/marp-cli.ts:1568:5
    at _dispatchDescribe (.../jest-circus/build/index.js:91:26)
    at describe (.../jest-circus/build/index.js:55:5)
    at .../marp-cli/test/marp-cli.ts:613:3
    at _dispatchDescribe (.../jest-circus/build/index.js:91:26)
    at describe (.../jest-circus/build/index.js:55:5)
    at Object.<anonymous> (.../marp-cli/test/marp-cli.ts:66:1)
    at Runtime._execModule (.../jest-runtime/build/index.js:1439:24)
    at Runtime._loadModule (.../jest-runtime/build/index.js:1022:12)
    at Runtime.requireModule (.../jest-runtime/build/index.js:882:12)
    at jestAdapter (.../build/legacy-code-todo-rewrite/jestAdapter.js:77:13)
    at processTicksAndRejections (node:internal/process/task_queues:105:5)
    at runTestInternal (.../jest-runner/build/runTest.js:367:16)
    at runTest (.../jest-runner/build/runTest.js:444:34)
    at Object.worker (.../jest-runner/build/testWorker.js:106:12)
Marp CLI with passing a file with browser options with --browser option uses no browser finders when --no-browser has specified
Stack Traces | 5s run time 
Error: thrown: "Exceeded timeout of 5000 ms for a test.
Add a timeout value to this test to increase the timeout, if this is a long-running test. See https://jestjs.io/docs/api#testname-fn-timeout."
    at .../marp-cli/test/marp-cli.ts:811:9
    at _dispatchDescribe (.../jest-circus/build/index.js:91:26)
    at describe (.../jest-circus/build/index.js:55:5)
    at .../marp-cli/test/marp-cli.ts:656:7
    at _dispatchDescribe (.../jest-circus/build/index.js:91:26)
    at describe (.../jest-circus/build/index.js:55:5)
    at .../marp-cli/test/marp-cli.ts:655:5
    at _dispatchDescribe (.../jest-circus/build/index.js:91:26)
    at describe (.../jest-circus/build/index.js:55:5)
    at .../marp-cli/test/marp-cli.ts:613:3
    at _dispatchDescribe (.../jest-circus/build/index.js:91:26)
    at describe (.../jest-circus/build/index.js:55:5)
    at Object.<anonymous> (.../marp-cli/test/marp-cli.ts:66:1)
    at Runtime._execModule (.../jest-runtime/build/index.js:1439:24)
    at Runtime._loadModule (.../jest-runtime/build/index.js:1022:12)
    at Runtime.requireModule (.../jest-runtime/build/index.js:882:12)
    at jestAdapter (.../build/legacy-code-todo-rewrite/jestAdapter.js:77:13)
    at processTicksAndRejections (node:internal/process/task_queues:105:5)
    at runTestInternal (.../jest-runner/build/runTest.js:367:16)
    at runTest (.../jest-runner/build/runTest.js:444:34)
    at Object.worker (.../jest-runner/build/testWorker.js:106:12)

To view more test analytics, go to the Test Analytics Dashboard
📋 Got 3 mins? Take this short survey to help us improve Test Analytics.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

marp.exe rendering and watch mode do not work in msys on Windows 10 (i.e. git-bash)
1 participant
@yhatt