hrszpuk / odin-flag Goto Github PK

Problem

Currently flags can only be in two different permutations: --flag=value or --flag.
This may cause issues the user was to mistype, and overall just isn't an ideal way to handle flags.

The parser should be able to handle any white space between the end of the flag name, the equals, and the value:

--flag=value
--flag= value
--flag =value
--flag value
--flag = value
...etc

The ability to exclude the equals (=) all together would also be a great addition.

Todo list:

• issue templates
• pull request templates
• Improved README.md (description, links, shields)
• Improved bio (tags, better description)
• Add DOCS.md (basic documentation)
• Add release

Problem

Currently, if there are any issues during parsing, the library will ignore all issues and return as if nothing has happened.
For example, if your create an int flag, but the user gives a string, nothing will the parsed.

I think instead of ignoring parser issues, there should be a way for the library to store and return errors. This gives programs that are using the library the opportunity to react to invalid inputs.

Potential Error Types

• BadArgumentType: when a user supplies an argument with the wrong type
• BadArgumentParsing: when a handler runs into issues with parsing (general)

Potential Error Reactions

• ContinueOnError: ignore the error and continue parsing flags
• ExitOnError: exit the program when encountering an issue
• PanicOnError: panic when encountering an issue
• CustomOnError: run a procedure when encountering an issue

Problem

Many programs use command and subcommands. The most relevant example being the odin compiler itself:

odin is a tool for managing Odin source code
Usage:
	odin command [arguments]
Commands:
	build             compile directory of .odin files, as an executable.
	                  one must contain the program's entry point, all must be in the same package.
	run               same as 'build', but also then runs the newly compiled executable.
	check             parse, and type check a directory of .odin files
	strip-semicolon   parse, type check, and remove unneeded semicolons from the entire program
	test              build and runs procedures with the attribute @(test) in the initial package
	doc               generate documentation on a directory of .odin files
	version           print version
	report            print information useful to reporting a bug

For further details on a command, invoke command help:
	e.g. `odin build -help` or `odin help build`

Each command can have its own set of flags, but also share a set of flags (like with odin build and oding run).