https://github.com/fokaaas/improved-markdown-parser
This console application allows you to parse markdown into html & escape codes
https://github.com/fokaaas/improved-markdown-parser
console escape html markdown parser
Last synced: 3 months ago
JSON representation
This console application allows you to parse markdown into html & escape codes
- Host: GitHub
- URL: https://github.com/fokaaas/improved-markdown-parser
- Owner: fokaaas
- Created: 2024-03-16T13:18:17.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-03-17T12:50:58.000Z (about 1 year ago)
- Last Synced: 2025-01-22T00:32:11.816Z (4 months ago)
- Topics: console, escape, html, markdown, parser
- Language: TypeScript
- Homepage:
- Size: 92.8 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Markdown Parser
This console application allows you to parse markdown into html & escape codes.
The result can be displayed in the console or saved to a file.
**Tech Stack**:
- Node.js
- TypeScript
- Commander
## How to set up it locally?
Firstly, clone this repo:
```bash
git clone https://github.com/fokaaas/improved-markdown-parser.git
```
Then install **pnpm** globally:
```bash
npm install -g pnpm
```
Install dependencies in project directory:
```bash
pnpm install
```
Run application:
```bash
pnpm parse --out --format
```
Explore all commands:
```bash
pnpm parse --help
```
```bash
Usage: Markdown Parser [options]
Converts a markdown file to HTML
Arguments:
path path to markdown file
Options:
-v, --version output the current version
-o, --out path to html file
-f, --format output format (choices: "html", "escape")
-h, --help display help for command
```
## Examples
Lets parse churka-example.md file and save result to churka-example.html:
### churka-example.md
```markdown
Їде `чурка` по дорозі. Зупиняється і **ба_чить**: _крисак на дорозі лежить_. Великий такий, правда дохлий.
Ну і вирішив він його забрати із собою. Взяв на руки, _відкрив багажник_. І положив туди крисака зі словами "Прігодіться!".
На наступний **день** їде чурка _тією самою_ дорогою. <Зупиняється>
Зупиняється>
\```
Відкриває `багажник, дістає звідти крисака`, кладе його на те
ж саме місце. І `говорить`: "Нє прігоділся!"
\```
```
Parse it:
```bash
pnpm parse churka-example.md --out churka-example.html
```
churka-example.html:
```html
Їде чурка по дорозі. Зупиняється і ба_чить: крисак на дорозі лежить. Великий такий, правда дохлий.
Ну і вирішив він його забрати із собою. Взяв на руки, відкрив багажник. І положив туди крисака зі словами "Прігодіться!".
На наступний день їде чурка тією самою дорогою. Зупиняється.
Відкриває `багажник, дістає звідти крисака`, кладе його на те
ж саме місце. І `говорить`: "Нє прігоділся!"
```
Then, lets parse churka-example.md file into escape codes:
```bash
pnpm parse churka-example.md --out churka-example.txt --format escape
```
churka-example.txt:
```
Їде [7mчурка[27m по дорозі. Зупиняється і [1mба_чить[22m: [3mкрисак на дорозі лежить[23m. Великий такий, правда дохлий.
Ну і вирішив він його забрати із собою. Взяв на руки, [3mвідкрив багажник[23m. І положив туди крисака зі словами "Прігодіться!".
На наступний [1mдень[22m їде чурка [3mтією самою[23m дорогою. Зупиняється.
[7m
Відкриває `багажник, дістає звідти крисака`, кладе його на те
ж саме місце. І `говорить`: "Нє прігоділся!"
[27m
```
## Unit Tests
32 unit tests are available for this application.
Run them:
```bash
pnpm test
```
And you will see some message like this:
```bash
Test Suites: 4 passed, 4 total
Tests: 32 passed, 32 total
Snapshots: 0 total
Time: 3.692 s, estimated 4 s
Ran all test suites.
```
## Revert Commit
[Commit](https://github.com/fokaaas/improved-markdown-parser/commit/de63ed97fa3a5908788de5147e221631e32de893)
## Commit with failed actions
There are 3 actions available for this project: Build, Lint, Test.
[Commit](https://github.com/fokaaas/improved-markdown-parser/commit/7c5abec2952658e46ac1e84623e73c754bee058c)
## Conclusion
I have experience with writing unit tests on various projects, in particular at my work
and on the [FICE Advisor](https://github.com/fictadvisor/fictadvisor) project. They helped me personally when refactoring the code.
They guarantee that after refactoring, the functionality will remain the same
and nothing will break. Also, tests encourage adherence to architectural rules when writing code.
And it is also very convenient to study the functionality you do not know, precisely
from the written unit tests.