Feat run prettier on markdown #3093

nathan-castlehow · 2019-06-23T06:26:16Z

Description

Adds support for Prettier in editor to "Prettify" Markdown.
Hotkey option available in config. Prettier Config json also available in config.
Runs prettier over current markdown with configured prettier options.

Issue fixed

#3039

Type of changes

⚪ Bug fix (Change that fixed an issue)
⚪ Breaking change (Change that can cause existing functionality to change)
⚪ Improvement (Change that improves the code. Maybe performance or development improvement)
🔘 Feature (Change that adds new functionality)
⚪ Documentation change (Change that modifies documentation. Maybe typo fixes)

Checklist:

🔘 My code follows the project code style
⚪ I have written test for my code and it has been tested
🔘 All existing tests have been passed
🔘 I have attached a screenshot/video to visualize my change if possible

IssueHunt Summary

Referenced issues

This pull request has been submitted to:

#3039: [Feature Request] Format markdown notes with Prettier.

IssueHunt has been backed by the following sponsors. Become a sponsor

…hyperlink

… and created config file

…ell as added hot key option. Partial Implementation of Prettier config in configuration screen. TODO Fix defaulting of prettier configuration

…alue

…r instance

ZeroX-DG · 2019-07-02T23:06:10Z

browser/components/CodeEditor.js

@@ -28,6 +28,7 @@ import {generateInEditor, tocExistsInEditor} from 'browser/lib/markdown-toc-gene
 import markdownlint from 'markdownlint'
 import Jsonlint from 'jsonlint-mod'
 import { DEFAULT_CONFIG } from '../main/lib/ConfigManager'
+const prettier = require('prettier')


Can you replace this with import statement?

Addressed in #bde357f

ZeroX-DG · 2019-07-02T23:33:31Z

browser/main/lib/ConfigManager.js

+      "tabWidth": 4,
+      "semi": false,
+      "singleQuote": true,
+      "parser":"markdown"


Can you append this parser option at the end? Because this will never change so we should make it default.

@ZeroX-DG do you mean as in don't have it in the options that show up in the config and then append the parser property before use?

Assuming i understood the comment correctly this should be addressed in #1d59d89

Yep that's exactly what I wanted, thank you!

…er set to markdown when used.

ZeroX-DG · 2019-07-07T02:10:16Z

One more small request, can you trigger the format table too? Currently it doesn't format the table.

nathan-castlehow · 2019-07-07T10:59:43Z

One more small request, can you trigger the format table too? Currently it doesn't format the table.

@ZeroX-DG Do you have sample markdown and expected results? I assume we are meaning its not correctly formatting a markdown table?

ZeroX-DG · 2019-07-07T12:03:40Z

I never used prettier to format markdown before so I didn't realized that they have support for table. However, in this case the table is not formatted with the default config. Here's my input:

|asd| asdasd|
|---|--------|
|asd|asdasdasd|
|dasd|ASdasdasd|

it should produce this:

| asd  | asdasd    |
| ---- | --------- |
| asd  | asdasdasd |
| dasd | ASdasdasd |

nathan-castlehow · 2019-07-08T10:06:44Z

@ZeroX-DG i just tried the table you had and it works ok for me?
My default config is
{
"trailingComma": "es5",
"tabWidth": 4,
"semi": false,
"singleQuote": true
}

What do you have as your default?

nathan-castlehow · 2019-07-17T03:30:18Z

@ZeroX-DG have you had a chance to look at this?

ZeroX-DG · 2019-07-17T09:09:54Z

@nathan-castlehow sorry for the late review. I found out about the reason behind this. If you have a line directly above the table then it will not format the table (or maybe format it wrongly).

asdasd
| asd  | asdasd|
| ---- | --------- |
| asd  | asdasdasd |
| dasd | ASdasdasd |

The code above will make the table to format wrongly. Is this a prettier bug or intended behavior?

nathan-castlehow · 2019-07-20T04:03:24Z

@nathan-castlehow sorry for the late review. I found out about the reason behind this. If you have a line directly above the table then it will not format the table (or maybe format it wrongly).
asdasd
| asd  | asdasd|
| ---- | --------- |
| asd  | asdasdasd |
| dasd | ASdasdasd |
The code above will make the table to format wrongly. Is this a prettier bug or intended behavior?

Hi @ZeroX-DG, no worries.
Hmm great question.
When there is an empty line above the table (as below) it formats fine? Its either prettier intended behaviour or prettier bug i would say. Prettier uses remark-parse for dealing with the markdown.

asdasd

| asd  | asdasd|
 | ---- | --------- |
 | asd  | asdasdasd |
 | dasd | ASdasdasd |

ZeroX-DG · 2019-07-26T23:44:38Z

Hmm...let's just say it's upstream issue for now. Can you fix the conflict so I can aprove it? @nathan-castlehow

… and created config file

…ell as added hot key option. Partial Implementation of Prettier config in configuration screen. TODO Fix defaulting of prettier configuration

…alue

…r instance

…er set to markdown when used.

…than-castlehow/Boostnote into feat-run-prettier-on-markdown

nathan-castlehow · 2019-08-01T12:20:11Z

Hmm...let's just say it's upstream issue for now. Can you fix the conflict so I can aprove it? @nathan-castlehow

@ZeroX-DG Should be all sorted now. Still understanding the ropes of git (use tfs at work) so apologies in advance if there are any issues. Let me know if you need me to fix anything.

ZeroX-DG

LGTM 🎉

nathan-castlehow added 8 commits June 9, 2019 13:28

feat: Added Context Menu for markdown preview mode and copy url when …

090b5c3

…hyperlink

feat(prettierOnMarkdown): Added Reference To Prettier

ef18093

feat(prettierOnMarkdown): Added Reference to prettier in Code Editor…

25bdaf9

… and created config file

feat(prettierOnMarkdown): Added support for prettyifing markdown as w…

f0380ef

…ell as added hot key option. Partial Implementation of Prettier config in configuration screen. TODO Fix defaulting of prettier configuration

feat(prettierOnMarkdown):Added prettier config default to config manager

ae0837e

feat(prettierOnMarkdown):Tweaked spacing on default Prettier Config V…

020bc11

…alue

feat(prettierOnMarkdown):Fixed incorrect options passed to code mirro…

fbb9afe

…r instance

feat(prettierOnMarkdown): Changed default hotkey value

ed4a670

ZeroX-DG added the awaiting review ❇️ Pull request is awaiting a review. label Jun 24, 2019

ZeroX-DG requested changes Jul 2, 2019

View reviewed changes

ZeroX-DG added awaiting changes 🖊️ Pull request has been reviewed, but contributor needs to make changes. and removed awaiting review ❇️ Pull request is awaiting a review. labels Jul 2, 2019

nathan-castlehow added 2 commits July 3, 2019 09:03

feat(prettierOnMarkdown): Changed Prettier require to use import

bde357f

feat(prettierOnMarkdown): Forced prettier options to always have pars…

1d59d89

…er set to markdown when used.

nathan-castlehow added 8 commits August 1, 2019 18:36

feat(prettierOnMarkdown): Added Reference To Prettier

a39e9c2

feat(prettierOnMarkdown): Added Reference to prettier in Code Editor…

7e3c662

… and created config file

feat(prettierOnMarkdown): Added support for prettyifing markdown as w…

33161e4

…ell as added hot key option. Partial Implementation of Prettier config in configuration screen. TODO Fix defaulting of prettier configuration

feat(prettierOnMarkdown):Added prettier config default to config manager

de0af15

feat(prettierOnMarkdown):Tweaked spacing on default Prettier Config V…

70892ca

…alue

feat(prettierOnMarkdown):Fixed incorrect options passed to code mirro…

89ae2a9

…r instance

feat(prettierOnMarkdown): Changed default hotkey value

0ad3da5

feat(prettierOnMarkdown): Changed Prettier require to use import

911fd9a

nathan-castlehow added 6 commits August 1, 2019 18:36

feat(prettierOnMarkdown): Forced prettier options to always have pars…

1173631

…er set to markdown when used.

Merge branch 'feat-run-prettier-on-markdown' of https://github.com/na…

86370ed

…than-castlehow/Boostnote into feat-run-prettier-on-markdown

Merge upstream into master

918a862

Merge upstream into master

eeca031

Merged Master into feature branch and fixed conflicts

b837653

Fixed eslint issue

2d3c69d

ZeroX-DG approved these changes Aug 2, 2019

View reviewed changes

ZeroX-DG added approved 👍 Pull request has been approved by sufficient reviewers. and removed awaiting changes 🖊️ Pull request has been reviewed, but contributor needs to make changes. labels Aug 2, 2019

Rokt33r added this to the v0.13.0 milestone Aug 24, 2019

Rokt33r merged commit b9dd651 into BoostIO:master Aug 24, 2019

robbawebba mentioned this pull request Sep 10, 2019

Default hotkey for "Prettify Markdown" conflicts with capital F character #3246

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Feat run prettier on markdown #3093

Feat run prettier on markdown #3093

nathan-castlehow commented Jun 23, 2019 •

edited by issuehunt-oss bot

Loading

ZeroX-DG Jul 2, 2019

nathan-castlehow Jul 3, 2019

ZeroX-DG Jul 3, 2019

ZeroX-DG Jul 2, 2019

nathan-castlehow Jul 2, 2019

nathan-castlehow Jul 3, 2019

ZeroX-DG Jul 3, 2019

ZeroX-DG commented Jul 7, 2019

nathan-castlehow commented Jul 7, 2019 •

edited

Loading

ZeroX-DG commented Jul 7, 2019

nathan-castlehow commented Jul 8, 2019 •

edited

Loading

nathan-castlehow commented Jul 17, 2019

ZeroX-DG commented Jul 17, 2019

nathan-castlehow commented Jul 20, 2019 •

edited

Loading

ZeroX-DG commented Jul 26, 2019

nathan-castlehow commented Aug 1, 2019

ZeroX-DG left a comment

Feat run prettier on markdown #3093

Feat run prettier on markdown #3093

Conversation

nathan-castlehow commented Jun 23, 2019 • edited by issuehunt-oss bot Loading

Description

Issue fixed

Type of changes

Checklist:

Referenced issues

ZeroX-DG Jul 2, 2019

Choose a reason for hiding this comment

nathan-castlehow Jul 3, 2019

Choose a reason for hiding this comment

ZeroX-DG Jul 3, 2019

Choose a reason for hiding this comment

ZeroX-DG Jul 2, 2019

Choose a reason for hiding this comment

nathan-castlehow Jul 2, 2019

Choose a reason for hiding this comment

nathan-castlehow Jul 3, 2019

Choose a reason for hiding this comment

ZeroX-DG Jul 3, 2019

Choose a reason for hiding this comment

ZeroX-DG commented Jul 7, 2019

nathan-castlehow commented Jul 7, 2019 • edited Loading

ZeroX-DG commented Jul 7, 2019

nathan-castlehow commented Jul 8, 2019 • edited Loading

nathan-castlehow commented Jul 17, 2019

ZeroX-DG commented Jul 17, 2019

nathan-castlehow commented Jul 20, 2019 • edited Loading

ZeroX-DG commented Jul 26, 2019

nathan-castlehow commented Aug 1, 2019

ZeroX-DG left a comment

Choose a reason for hiding this comment

nathan-castlehow commented Jun 23, 2019 •

edited by issuehunt-oss bot

Loading

nathan-castlehow commented Jul 7, 2019 •

edited

Loading

nathan-castlehow commented Jul 8, 2019 •

edited

Loading

nathan-castlehow commented Jul 20, 2019 •

edited

Loading