Skip to content

Apply prettier to pre-commit for automatic linting of .md .yaml files #263

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Dec 21, 2024

Conversation

bobleesj
Copy link
Contributor

@sbillinge

Do we want to automate linting for .md and .yaml files with the following addition to .pre-commit-config.yaml?

  # prettier - multi formatter for json, yaml, md
  - repo: https://github.com/pre-commit/mirrors-prettier
    rev: f12edd9c7be1c20cfa42420fd0e6df71e42b51ea # frozen: v4.0.0-alpha.8
    hooks:
      - id: prettier
        additional_dependencies:
          - "prettier@^3.2.4"

No manual edits have been made.

@bobleesj bobleesj changed the title Apply prettier pre-commit to automatic linting of .md .yaml files Apply prettier to pre-commit for automatic linting of .md .yaml files Dec 21, 2024
Copy link

codecov bot commented Dec 21, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 100.00%. Comparing base (9bd388d) to head (f79e88e).
Report is 11 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff            @@
##              main      #263   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            8         8           
  Lines          391       391           
=========================================
  Hits           391       391           

@@ -42,5 +42,5 @@ Please let @sbillinge know that all checks are done and the package is ready for

<!-- Before closing this issue, please complete the following: -->

- [ ] Run tutorial examples and conduct functional testing using the installation guide in the README. Attach screenshots/results as comments.
- [ ] Documentation (README, tutorials, API references, and websites) is deployed without broken links or missing figures.
- [ ] Run tutorial examples and conduct functional testing using the installation guide in the README. Attach screenshots/results as comments.
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

extra space detected

@sbillinge
Copy link
Contributor

@sbillinge

Do we want to automate linting for .md and .yaml files with the following addition to .pre-commit-config.yaml?

  # prettier - multi formatter for json, yaml, md
  - repo: https://github.com/pre-commit/mirrors-prettier
    rev: f12edd9c7be1c20cfa42420fd0e6df71e42b51ea # frozen: v4.0.0-alpha.8
    hooks:
      - id: prettier
        additional_dependencies:
          - "prettier@^3.2.4"

No manual edits have been made.

sure, why not? prettier is better!

@sbillinge sbillinge merged commit ce6c9cc into diffpy:main Dec 21, 2024
5 checks passed
@bobleesj
Copy link
Contributor Author

Okay! Will add to our cookiecutter standard

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants