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

Add option to CLI to allow user to specify the manifest file #29

Open
pjohnmeyer opened this issue Apr 21, 2023 · 0 comments
Open

Add option to CLI to allow user to specify the manifest file #29

pjohnmeyer opened this issue Apr 21, 2023 · 0 comments
Labels
enhancement Request for new feature or usability improvement good first issue Good for newcomers

Comments

@pjohnmeyer
Copy link
Member

Currently, for ease of use, the CLI applies a set of heuristics to find a manifest file within the provided folder.

In the odd case that these heuristics incorrectly flag an error, or that a user has multiple packages in a single folder, it might be useful to allow some combination or arguments or options for specifying which file in the package is the manifest file, e.g.:

Approach 1: Positional argument can be directory or single file

ocf2ocx ./path/to/package would apply the existing heuristic as it does today
ocf2ocx ./path/to/package/manifest.json would skip the heuristic and load the specified file as the manifest

Approach 2: Additional option to specify which file is the manifest

ocf2ocx ./path/to/package would apply the existing heuristic as it does today
ocf2ocx ./path/to/package --manifest manifest.json would skip the heuristic and load the specified file, relative to the package, as the manifest

There are of course other options but I prefer Approach 1.

@pjohnmeyer pjohnmeyer added enhancement Request for new feature or usability improvement good first issue Good for newcomers labels Apr 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Request for new feature or usability improvement good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant