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

Give an :id to every member of the stack #130

Merged
merged 6 commits into from
Feb 24, 2020
Merged

Give an :id to every member of the stack #130

merged 6 commits into from
Feb 24, 2020

Conversation

vemv
Copy link
Contributor

@vemv vemv commented Feb 22, 2020

Brief

Fixes #38

...It uses an alternative approach to that described in #38: Instead of a supdate-based map, we leverage the fact that all members of the stack are data (arrays of maps).

So we can just associate an :id, and let users customize formatting-stack by writing Clojure however they wish.

Notes

The :id requirement (w/ spec) is a breaking change, because a user that provided a map-based custom member would have to add an :id to have things working again.

Users passing a reify will see no :id requirement (there's a comment in the diff explaining that).

QA plan

Run the provided example, observing that the provided customizations are honored.

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
      • The examples could be moved to a examples/ folder, in a future, if they keep growing.
    • 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 vemv marked this pull request as ready for review February 23, 2020 04:40
@vemv vemv requested a review from thumbnail February 23, 2020 05:29
Copy link
Member

@thumbnail thumbnail left a comment

Choose a reason for hiding this comment

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

Seems trivial enough 👍

@thumbnail thumbnail merged commit d9f7999 into master Feb 24, 2020
@thumbnail thumbnail deleted the 38--config branch February 24, 2020 07:27
This was referenced Feb 24, 2020
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.

Config as data
2 participants