Merge pull request #13 from razroo/ZETA-8704-update-readme-html-adf

Zeta 8704 update readme to include jira markdown to html + markdown logic

Author: CharlieGreenman

README.md

@@ -1,13 +1,14 @@
 # Html To ADF
-Used to convert Atlassian Document Format from ADF to html and also from 
-html to adf
+Used to convert from Atlassian Document Format(ADF) and also from 
+html to ADF. In addition, allows to convert from Jira Markdown to 
+regular markdown. 
 
 # How to install
 ```
 npm install @razroo/html-to-adf --save
 ```
 
-## Two main functions
+## HTML to ADF + ADF to HTML
 
 ### convertHtmlToADF
 
@@ -82,4 +83,48 @@ it('should convert a simple paragraph with bold', () => {
   const expected = `<p>test <b>this</b></p>`;
   expect(result).toEqual(expected);
 });
+```
+
+## Convert Jira Markdown to Markdown or HTML
+
+### Convert Jira Markdown to Markdown
+```ts
+it('should convert jira markdown to regular markdown', () => {
+    const jiraMarkdown = "*Feature*: Convert Jira ticket ADF description to HTML\n\nScenario: User converts Jira ticket ADF to HTML\nGiven that I have a Jira ticket ADF description\nWhen I initiate the conversion process\n  And use the importJiraTicket function\nThen the ADF description is successfully converted to HTML\n\nNotes: \n\n# Will use the function here: [https://github.com/razroo/html-to-adf?tab=readme-ov-file#convertadftohtml|https://github.com/razroo/html-to-adf?tab=readme-ov-file#convertadftohtml|smart-link] \n# Will be within the importJiraTickets function";
+    const result = convertJiraMarkdownToRegularMarkdown(jiraMarkdown);
+    const expected = `**Feature**: Convert Jira ticket ADF description to HTML
+
+Scenario: User converts Jira ticket ADF to HTML
+Given that I have a Jira ticket ADF description
+When I initiate the conversion process
+  And use the importJiraTicket function
+Then the ADF description is successfully converted to HTML
+
+Notes: 
+
+1. Will use the function here: [https://github.com/razroo/html-to-adf?tab=readme-ov-file#convertadftohtml](https://github.com/razroo/html-to-adf?tab=readme-ov-file#convertadftohtml) 
+1. Will be within the importJiraTickets function`;
+expect(result).toEqual(expected);
+});
+```
+
+### Convert Jira Markdown to HTML
+```ts
+it('should convert jira markdown to html', async() => {
+    const jiraMarkdown = "*Feature*: Convert Jira ticket ADF description to HTML\n\nScenario: User converts Jira ticket ADF to HTML\nGiven that I have a Jira ticket ADF description\nWhen I initiate the conversion process\n  And use the importJiraTicket function\nThen the ADF description is successfully converted to HTML\n\nNotes: \n\n# Will use the function here: [https://github.com/razroo/html-to-adf?tab=readme-ov-file#convertadftohtml|https://github.com/razroo/html-to-adf?tab=readme-ov-file#convertadftohtml|smart-link] \n# Will be within the importJiraTickets function";
+    const result = await convertJiraMarkdownToHtml(jiraMarkdown);
+    const expected = `<p><strong>Feature</strong>: Convert Jira ticket ADF description to HTML</p>
+<p>Scenario: User converts Jira ticket ADF to HTML
+Given that I have a Jira ticket ADF description
+When I initiate the conversion process
+  And use the importJiraTicket function
+Then the ADF description is successfully converted to HTML</p>
+<p>Notes: </p>
+<ol>
+<li>Will use the function here: <a href="https://github.com/razroo/html-to-adf?tab=readme-ov-file#convertadftohtml">https://github.com/razroo/html-to-adf?tab=readme-ov-file#convertadftohtml</a> </li>
+<li>Will be within the importJiraTickets function</li>
+</ol>
+`;
+    expect(result).toEqual(expected);
+  });
 ```

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@razroo/html-to-adf",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "HtmlToAdf",
   "main": "./lib/cjs/index.js",
   "types": "./lib/cjs/types/index.d.ts",

src/index.ts

@@ -1,2 +1,3 @@
 export {convertHtmlToADF} from './html-to-adf';
-export {convertADFToHtml} from './adf-to-html';
+export {convertADFToHtml} from './adf-to-html';
+export {convertJiraMarkdownToRegularMarkdown, convertJiraMarkdownToHtml} from './jm-to-markdown';