Skip to content
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

Introduce :overrides option #147

Closed
wants to merge 15 commits into from
Closed

Introduce :overrides option #147

wants to merge 15 commits into from

Conversation

vemv
Copy link
Contributor

@vemv vemv commented Mar 10, 2020

Brief

Implements #134 (comment)

Starting from this PR, :overrides becomes the primary API for customizing things: as a consumer, one should:

  • Use one of: git-status-formatter, branch-formatter, project-formatter
  • Pass :overrides to those if wanting to tweak something.

...and should not:

  • Use core/format! directly
  • Use the "factory" stuff introduced in this PR

TODO

  • At this point, git-status-formatter, branch-formatter, project-formatter all deserve some test coverage.
  • Explore how much can we DRY git-status-formatter, branch-formatter, project-formatter
    • A nice 'overrides' implementation would allow absolute DRY.
    • Might be less prioritary for now
  • Create impl sub-nses for git-status-formatter, branch-formatter, project-formatter
    • The intended API is format-and-lint! / lint!
    • Things like speced/defn default-formatters are certainly not public
  • Review doc (README)
  • Review examples (test-resources)

QA plan

  • git-status-formatter, branch-formatter, project-formatter all keep working
  • The examples work as advertised, customizing things as its code shows

Author checklist

  • I have QAed the functionality
  • The PR has a reasonably reviewable size and a meaningful commit history
  • I have run the branch formatter and observed no new/significative warnings
  • The build passes
  • I have self-reviewed the PR prior to assignment
  • Additionally, I have code-reviewed iteratively the PR considering the following aspects in isolation:
    • Correctness
    • Robustness (red paths, failure handling etc)
    • Modular design
    • Test coverage
    • Spec coverage
    • Documentation
    • Security
    • Performance
    • Breaking API changes
    • Cross-compatibility (Clojure/ClojureScript)

Reviewer checklist

  • I have checked out this branch and reviewed it locally, running it
  • I have QAed the functionality
  • I have reviewed the PR
  • Additionally, I have code-reviewed iteratively the PR considering the following aspects in isolation:
    • Correctness
    • Robustness (red paths, failure handling etc)
    • Modular design
    • Test coverage
    • Spec coverage
    • Documentation
    • Security
    • Performance
    • Breaking API changes
    • Cross-compatibility (Clojure/ClojureScript)

@vemv
Copy link
Contributor Author

vemv commented Apr 1, 2020

@thumbnail : Progressed quite a bit. Although the branch isn't pretty, the extended specs, examples, protocols, tests etc should make it quite clear the overall intended API.

You might want to take over the branch, as I see it it's 90% there.

reporter
in-background?]}]
(speced/defn format! [& {:keys [^vector? strategies
;; XXX rename `formatters` to `formatter-factories`
Copy link
Contributor Author

Choose a reason for hiding this comment

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

(Important to address this XXX)

@vemv vemv changed the title WIP Introduce :overrides option Apr 1, 2020
@vemv
Copy link
Contributor Author

vemv commented Apr 1, 2020

Closing so that I'll push a rebased version.

@vemv vemv closed this Apr 1, 2020
@thumbnail thumbnail deleted the deep-merge branch September 10, 2021 07:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants