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

Gather Requirements Command #15

Open
navarr opened this issue Jul 14, 2021 · 0 comments
Open

Gather Requirements Command #15

navarr opened this issue Jul 14, 2021 · 0 comments
Assignees
Labels
enhancement New feature or request help wanted Extra attention is needed
Milestone

Comments

@navarr
Copy link
Owner

navarr commented Jul 14, 2021

Acceptance Criteria

  • I can run depanno gather <dir>, where <dir> is a directory to search through
  • I can pass the flag -l or --include-legacy-annotations
  • I can pass the flag -f or --format with a value of text, csv, xml, or json
  • All Attributes (and annotations with flag l) are found
  • Attributes for the same package are simplified via exclusion (e.g. ^2 and ^2.1|3 becomes ^2.1)
  • If the format is specified to be JSON, I get an object containing a "require" object and a "suggest" object that should be usable with composer
  • If the format is specified to be CSV, the columns should be: "package", "requirement", "optional" where "optional" should be "Yes" or "No"
  • If the format is specified to be XML, I should receive a document like:
<?xml version="1.0" encoding="utf-8"?>
<dependencies>
    <!-- for each simplified requirement -->
    <requirement package="" constraint="" optional="true"><!-- optional default should be "false" and not included -->
        <!-- for each attribute/annotation -->
        <reason file="" line="" constraint="">reason text</reason>
    </requirement>
</dependencies>
@navarr navarr added the enhancement New feature or request label Jul 14, 2021
@navarr navarr changed the title Requirements Command Gather Requirements Command Jul 14, 2021
@navarr navarr self-assigned this Jul 14, 2021
@navarr navarr added the help wanted Extra attention is needed label Sep 2, 2022
@navarr navarr added this to the v2.1.0 milestone Sep 2, 2022
@navarr navarr added this to DepAnno Jun 28, 2024
@navarr navarr moved this to To do in DepAnno Jun 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request help wanted Extra attention is needed
Projects
Status: To do
Development

No branches or pull requests

1 participant