search

prettier / plugin-pug

Prettier Pug Plugin
https://prettier.github.io/plugin-pug
MIT License
196 stars 44 forks source link

Enhance Documentation #467

Closed Permanently closed 4 months ago

Permanently commented 12 months ago

Just to avoid #463 occurring again, here's a change to README.md to reflect the latest version's usage changes.

OiYouYeahYou commented 12 months ago

My preference would be to recommend adding the plugin config to the .prettierrc, rather than adding it to every command

Permanently commented 12 months ago

My preference would be to recommend adding the plugin config to the .prettierrc, rather than adding it to every command

This was more for just the README.md for people's reference, but if it's applicable then might as well - do you mind referencing where? (can't seem to find anywhere I can add it to, and I'm at work)

OiYouYeahYou commented 12 months ago

Same place that documents the CLI option: https://prettier.io/docs/en/plugins#using-plugins

{
  "plugins": ["@prettier/plugin-pug"]
}
Permanently commented 12 months ago

You did make me remember another file for editing, so caught that whilst it was in my head. Thanks for unintentionally reminding me.

Some people can just add it to the file, but for a CLI lover (like myself) I'd rather stick to having it in-line. You're right though, the other methods should also be covered. This PR was originally gonna cover just the method that's documented, but I'll have a look later and add that in if time's on my side. (if @Shinigami92 or anyone else doesn't do it before me)

Shinigami92 commented 12 months ago

You did make me remember another file for editing, so caught that whilst it was in my head. Thanks for unintentionally reminding me.

So is this ready to merge? Or do you need to do something else and right now you cant because e.g. you are out of home, touching grass?

Permanently commented 12 months ago

do you need to do something else and right now you cant because e.g. you are out of home, touching grass?

You won't believe this fella. Grass is real. I thought it was a myth.

Yep, still a draft - lost the button to change the PR state back to draft. If you give me a few hours, I'll make the necessary commits to address the various other methods.

Shinigami92 commented 12 months ago

do you need to do something else and right now you cant because e.g. you are out of home, touching grass?

You won't believe this fella. Grass is real. I thought it was a myth.

:exploding_head: :green_heart:

Yep, still a draft - lost the button to change the PR state back to draft. If you give me a few hours, I'll make the necessary commits to address the various other methods.

Shinigami92 commented 12 months ago

You can also please run prettier before doing a commit, that does some stuff for you

Permanently commented 12 months ago

You can also please run prettier before doing a commit, that does some stuff for you

Apologies, didn't cross my mind - my environment's changed so I'm still reinstalling packages 😓

Does this content section do not have content anymore?

Re: header, amended that on the latest commit, looks like I won't be doing anything that requires thought after work in the future as I'm clearly pooped hahaha