Markdown parser

The console app designed to parse markdown tags into html tags or ansi escape codes. There are possibilities to output resulted text to the console or to the specific file. By default markdown tags are transformed and printed to the console. Default format for saving parsed markdown to a file is html. Supported tags are ** for **bold**, _ for _italic_, ` for monospaced, ``` for preformatted.

Installation

  1. Clone the repository using this command:
git clone https://github.com/andriihalai/markdown-parser.git
  1. Change into directory:
cd markdown-parser
  1. Install dependencies
npm install

How to use

  • To parse markdown into asni escape code and output it to console run:
node index.js /path/to/markdown/file

Write output to a file:

  • You can specify the output file by using the --out option:
node index.js /path/to/markdown/file --out path/to/output/file

Choose a format:

  • Use --format=html for html:
node index.js /path/to/markdown/file --format=html
  • Use --format=ansi for ansi:
node index.js /path/to/markdown/file --format=ansi --out path/to/output/file

How to run tests

  • To run tests use the command:
npm test
  • To run tests in the development mode use:
npm run test:dev

Посилання на коміт на якому тести впали

Failure build

Revert commit

Revert commit

Висновки

Виконуючи дану лабораторну роботу, за допомогою юніт тестів я зміг знайти досить багато недоліків свого додатку, що навіть привезвело до зміни частини логіки програми. З недоліків тестів помітив те, що змінюючи логіку роботи деяких функцій, потім також потрібно змінювати тести, а це все займає досить багато часу. Загалом варто відзначити, що написання тестів має сенс, оскільки дозволяє відловити багато багів ще на стадії розробки додатку.