Add new file mode, add usage and library docs #3
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Collaborator
kanaka
commented
May 2, 2024
kanaka
commented
- Add support for file deps data from files (JSON).
- Refactor library functions to make them more externally usable
- Add guide/examples to README with 9 CLI example
- Document library functions with Clojure usage examples
- Add comma separation for paths (in addition to colon).
- Add map format for alternate/or deps
For order/weak dependencies, the dependency node format is:
`{:after SEQUENCE}`. Add a similar format for alternative/logical or
dependencies (in addition to the existing sequence format):
`{:or SEQUENCE}`.
This only applies to `resolve-dep-order`. The other dependency functions
are not aware of weak/order only dependencies.
If the component of the path specifier refers to a file rather than
a directory, then treat it as a JSON file containing a dependency
specification. The JSON file uses the full dependency map/graph format
rather than the user dep string format of deps file within dep
directories. For example, the following JSON file specifies that "a"
depends on both "b" and "c", that "c" depends on either "d" of "e", and
that "f" must come after "c" if it required:
```
{
"a": ["b", "c"],
"c": [{"or": ["d", "e"]}],
"f": [{:after "c"}]
}
```
If a path component is "-", then dependencies will be read as a JSON
string from stdin.
Also add equivalent JSON files for each dependency directory under
`./tests/`.
- Rename `tests/resolve-deps.sh` to `tests/runtest.sh`. - Add second optional argument that specifies the mode: - dir: default and prior behavior that uses dep dirs - json: use JSON dep files - Track passing count. Report final pass, fail, and total tests. - Update GHA push workflow to run both dir and json modes for each implementation.
jonsmock
reviewed
May 2, 2024
jonsmock
approved these changes
May 2, 2024
|
Awesome work! Examples are excellent. |
- Add a guide/examples section to the README that covers 9 different use cases. - Add 6 example JSON files that are used for the first 5 examples in the README. - Add README section on running the tests.
Extract the full-to-alt-graph and alt-to-kahn-graph functions so that they can be called by users of the library functions since they are needed to fully utilitize the functions. Change the order of arguments to the python alt_set_covers function so that the pending argument is first. This allows direct calling of alt_set_covers with two position arguments (instead of requiring the pending argument to be passed by name).
Update the middle version since there are some changes to API and CLI. But not a full major bump since they are backwards compatible.
|
@jonsmock Thanks! I've added another commit to bump to 0.1.0 and merged. When you get a chance (no hurry) can you npm publish this new version? |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.