tutorial icon indicating copy to clipboard operation
tutorial copied to clipboard

Run Prettier linter

Open HonkingGoose opened this issue 3 years ago • 3 comments

Goal:

Speed up reviewing PRs by enforcing one code style for the project.

Todo:

  • [ ] Install Prettier linter as development dependency
  • [ ] Create basic Prettier config
  • [ ] Create two script entries in the package.json file:
    • [ ] prettier that runs Prettier with the --cache option
    • [ ] prettier-fix that runs prettier with the --cache option and fixes the files
  • [ ] Create basic GitHub Action run to check if the prettier command run passes

HonkingGoose avatar Jul 20 '22 14:07 HonkingGoose

adding extra dependencies to this project might change the outcome results of the tutorial right?

PhilipAbed avatar Jul 21 '22 07:07 PhilipAbed

I'm probably getting something mixed up here. 🙈😄

The goal for this project is: ^comment

I would like for us to have a specific "demo" repository with a hands-on getting started guide where users can fork it and follow the guide to experience Renovate. E.g. starting simply with onboarding but then showing:

  • making config changes during onboarding and seeing the change
  • making changes after, e.g. adding package rules and common features like labels, assignees, etc.

This should be part of our "official" documentation and maintained to stay accurate.

When we say "maintained to stay accurate" do we mean:

  • update the project dependencies ourselves/with Renovate?
  • update the documentation whenever Renovate bot configuration or other upstream like Kubernetes/AWS/Docker changes?
  • both of the above?

Do we want this repository to have "stale dependencies"? So that the examples in the doc match the behavior after people fork the renovatebot/tutorial repository?

Right now, I don't understand why adding Prettier may cause problems. 😉

HonkingGoose avatar Jul 21 '22 08:07 HonkingGoose

ill test it out, thing is, we have Screenshots of the dependencies, im hoping renovate config:base ignores devDependencies if it changes the Order of the PRs, i will give it a test

PhilipAbed avatar Jul 21 '22 10:07 PhilipAbed