diff --git a/.chglog/CHANGELOG.tpl.md b/.chglog/CHANGELOG.tpl.md
new file mode 100755
index 0000000000000000000000000000000000000000..8e98c0bf98c7470201b177f755da8cd7bb424663
--- /dev/null
+++ b/.chglog/CHANGELOG.tpl.md
@@ -0,0 +1,27 @@
+{{ range .Versions }}
+<a name="{{ .Tag.Name }}"></a>
+## {{ if .Tag.Previous }}[{{ .Tag.Name }}]{{ else }}{{ .Tag.Name }}{{ end }} - {{ datetime "2006-01-02" .Tag.Date }}
+{{ range .CommitGroups -}}
+### {{ .Title }}
+{{ range .Commits -}}
+- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }}
+{{ end }}
+{{ end -}}
+
+{{- if .NoteGroups -}}
+{{ range .NoteGroups -}}
+### {{ .Title }}
+{{ range .Notes }}
+{{ .Body }}
+{{ end }}
+{{ end -}}
+{{ end -}}
+{{ end -}}
+
+{{- if .Versions }}
+{{ range .Versions -}}
+{{ if .Tag.Previous -}}
+[{{ .Tag.Name }}]: {{ $.Info.RepositoryURL }}/compare/{{ .Tag.Previous.Name }}...{{ .Tag.Name }}
+{{ end -}}
+{{ end -}}
+{{ end -}}
\ No newline at end of file
diff --git a/.chglog/config.yml b/.chglog/config.yml
new file mode 100755
index 0000000000000000000000000000000000000000..9b9b87e9d9017258dc12cc7fef74d50017c1c886
--- /dev/null
+++ b/.chglog/config.yml
@@ -0,0 +1,57 @@
+style: gitlab
+template: CHANGELOG.tpl.md
+info:
+ title: CHANGELOG
+ repository_url: https://gitlab.schukai.com/oss/libraries/go/application/configuration
+options:
+ commits:
+ filters:
+ Type:
+ - feat
+ - fix
+ - doc
+ - refactor
+ - perf
+ - test
+ - chore
+ ## deprecated types and typos
+ - docs
+ - documentation
+ - feat
+ - added
+ - add
+ - bugfix
+ - revert
+ - update
+ - updates
+ - change
+ - changed
+ commit_groups:
+ title_maps:
+ feat: Add Features
+ fix: Bug Fixes
+ doc: Documentation
+ refactor: Code Refactoring
+ perf: Performance Improvements
+ test: Tests
+ ## Chore is used for all other changes that don't fit in the other categories
+ chore: Changes
+ ## deprecated types and typos
+ docs: Documentation
+ documentation: Documentation
+ added: Add Features
+ add: Add Features
+ bugfix: Bug Fixes
+ revert: Reverts
+ update: Changes
+ updates: Changes
+ change: Changes
+ changed: Changes
+ header:
+ pattern: "^((\\w+)\\s.*)$"
+ pattern_maps:
+ - Subject
+ - Type
+ notes:
+ keywords:
+ - BREAKING CHANGE
diff --git a/LICENSE b/LICENSE
new file mode 100644
index 0000000000000000000000000000000000000000..29ebfa545f5580919a4e884d7014d7a3eb2df762
--- /dev/null
+++ b/LICENSE
@@ -0,0 +1,661 @@
+ GNU AFFERO GENERAL PUBLIC LICENSE
+ Version 3, 19 November 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+ Preamble
+
+ The GNU Affero General Public License is a free, copyleft license for
+software and other kinds of works, specifically designed to ensure
+cooperation with the community in the case of network server software.
+
+ The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works. By contrast,
+our General Public Licenses are intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.
+
+ When we speak of free software, we are referring to freedom, not
+price. Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+ Developers that use our General Public Licenses protect your rights
+with two steps: (1) assert copyright on the software, and (2) offer
+you this License which gives you legal permission to copy, distribute
+and/or modify the software.
+
+ A secondary benefit of defending all users' freedom is that
+improvements made in alternate versions of the program, if they
+receive widespread use, become available for other developers to
+incorporate. Many developers of free software are heartened and
+encouraged by the resulting cooperation. However, in the case of
+software used on network servers, this result may fail to come about.
+The GNU General Public License permits making a modified version and
+letting the public access it on a server without ever releasing its
+source code to the public.
+
+ The GNU Affero General Public License is designed specifically to
+ensure that, in such cases, the modified source code becomes available
+to the community. It requires the operator of a network server to
+provide the source code of the modified version running there to the
+users of that server. Therefore, public use of a modified version, on
+a publicly accessible server, gives the public access to the source
+code of the modified version.
+
+ An older license, called the Affero General Public License and
+published by Affero, was designed to accomplish similar goals. This is
+a different license, not a version of the Affero GPL, but Affero has
+released a new version of the Affero GPL which permits relicensing under
+this license.
+
+ The precise terms and conditions for copying, distribution and
+modification follow.
+
+ TERMS AND CONDITIONS
+
+ 0. Definitions.
+
+ "This License" refers to version 3 of the GNU Affero General Public License.
+
+ "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+ "The Program" refers to any copyrightable work licensed under this
+License. Each licensee is addressed as "you". "Licensees" and
+"recipients" may be individuals or organizations.
+
+ To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy. The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+ A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+ To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy. Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+ To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies. Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+ An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License. If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+ 1. Source Code.
+
+ The "source code" for a work means the preferred form of the work
+for making modifications to it. "Object code" means any non-source
+form of a work.
+
+ A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+ The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form. A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+ The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities. However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work. For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+ The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+ The Corresponding Source for a work in source code form is that
+same work.
+
+ 2. Basic Permissions.
+
+ All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met. This License explicitly affirms your unlimited
+permission to run the unmodified Program. The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work. This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+ You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force. You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright. Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+ Conveying under any other circumstances is permitted solely under
+the conditions stated below. Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+ 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+ No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+ When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+ 4. Conveying Verbatim Copies.
+
+ You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+ You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+ 5. Conveying Modified Source Versions.
+
+ You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+ a) The work must carry prominent notices stating that you modified
+ it, and giving a relevant date.
+
+ b) The work must carry prominent notices stating that it is
+ released under this License and any conditions added under section
+ 7. This requirement modifies the requirement in section 4 to
+ "keep intact all notices".
+
+ c) You must license the entire work, as a whole, under this
+ License to anyone who comes into possession of a copy. This
+ License will therefore apply, along with any applicable section 7
+ additional terms, to the whole of the work, and all its parts,
+ regardless of how they are packaged. This License gives no
+ permission to license the work in any other way, but it does not
+ invalidate such permission if you have separately received it.
+
+ d) If the work has interactive user interfaces, each must display
+ Appropriate Legal Notices; however, if the Program has interactive
+ interfaces that do not display Appropriate Legal Notices, your
+ work need not make them do so.
+
+ A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit. Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+ 6. Conveying Non-Source Forms.
+
+ You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+ a) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by the
+ Corresponding Source fixed on a durable physical medium
+ customarily used for software interchange.
+
+ b) Convey the object code in, or embodied in, a physical product
+ (including a physical distribution medium), accompanied by a
+ written offer, valid for at least three years and valid for as
+ long as you offer spare parts or customer support for that product
+ model, to give anyone who possesses the object code either (1) a
+ copy of the Corresponding Source for all the software in the
+ product that is covered by this License, on a durable physical
+ medium customarily used for software interchange, for a price no
+ more than your reasonable cost of physically performing this
+ conveying of source, or (2) access to copy the
+ Corresponding Source from a network server at no charge.
+
+ c) Convey individual copies of the object code with a copy of the
+ written offer to provide the Corresponding Source. This
+ alternative is allowed only occasionally and noncommercially, and
+ only if you received the object code with such an offer, in accord
+ with subsection 6b.
+
+ d) Convey the object code by offering access from a designated
+ place (gratis or for a charge), and offer equivalent access to the
+ Corresponding Source in the same way through the same place at no
+ further charge. You need not require recipients to copy the
+ Corresponding Source along with the object code. If the place to
+ copy the object code is a network server, the Corresponding Source
+ may be on a different server (operated by you or a third party)
+ that supports equivalent copying facilities, provided you maintain
+ clear directions next to the object code saying where to find the
+ Corresponding Source. Regardless of what server hosts the
+ Corresponding Source, you remain obligated to ensure that it is
+ available for as long as needed to satisfy these requirements.
+
+ e) Convey the object code using peer-to-peer transmission, provided
+ you inform other peers where the object code and Corresponding
+ Source of the work are being offered to the general public at no
+ charge under subsection 6d.
+
+ A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+ A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling. In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage. For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product. A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+ "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source. The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+ If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information. But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+ The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed. Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+ Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+ 7. Additional Terms.
+
+ "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law. If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+ When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it. (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.) You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+ Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+ a) Disclaiming warranty or limiting liability differently from the
+ terms of sections 15 and 16 of this License; or
+
+ b) Requiring preservation of specified reasonable legal notices or
+ author attributions in that material or in the Appropriate Legal
+ Notices displayed by works containing it; or
+
+ c) Prohibiting misrepresentation of the origin of that material, or
+ requiring that modified versions of such material be marked in
+ reasonable ways as different from the original version; or
+
+ d) Limiting the use for publicity purposes of names of licensors or
+ authors of the material; or
+
+ e) Declining to grant rights under trademark law for use of some
+ trade names, trademarks, or service marks; or
+
+ f) Requiring indemnification of licensors and authors of that
+ material by anyone who conveys the material (or modified versions of
+ it) with contractual assumptions of liability to the recipient, for
+ any liability that these contractual assumptions directly impose on
+ those licensors and authors.
+
+ All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10. If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term. If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+ If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+ Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+ 8. Termination.
+
+ You may not propagate or modify a covered work except as expressly
+provided under this License. Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+ However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+ Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+ Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License. If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+ 9. Acceptance Not Required for Having Copies.
+
+ You are not required to accept this License in order to receive or
+run a copy of the Program. Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance. However,
+nothing other than this License grants you permission to propagate or
+modify any covered work. These actions infringe copyright if you do
+not accept this License. Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+ 10. Automatic Licensing of Downstream Recipients.
+
+ Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License. You are not responsible
+for enforcing compliance by third parties with this License.
+
+ An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations. If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+ You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License. For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+ 11. Patents.
+
+ A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based. The
+work thus licensed is called the contributor's "contributor version".
+
+ A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version. For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+ Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+ In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement). To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+ If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients. "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+ If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+ A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License. You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+ Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+ 12. No Surrender of Others' Freedom.
+
+ If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License. If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all. For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+ 13. Remote Network Interaction; Use with the GNU General Public License.
+
+ Notwithstanding any other provision of this License, if you modify the
+Program, your modified version must prominently offer all users
+interacting with it remotely through a computer network (if your version
+supports such interaction) an opportunity to receive the Corresponding
+Source of your version by providing access to the Corresponding Source
+from a network server at no charge, through some standard or customary
+means of facilitating copying of software. This Corresponding Source
+shall include the Corresponding Source for any work covered by version 3
+of the GNU General Public License that is incorporated pursuant to the
+following paragraph.
+
+ Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU General Public License into a single
+combined work, and to convey the resulting work. The terms of this
+License will continue to apply to the part which is the covered work,
+but the work with which it is combined will remain governed by version
+3 of the GNU General Public License.
+
+ 14. Revised Versions of this License.
+
+ The Free Software Foundation may publish revised and/or new versions of
+the GNU Affero General Public License from time to time. Such new versions
+will be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+ Each version is given a distinguishing version number. If the
+Program specifies that a certain numbered version of the GNU Affero General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation. If the Program does not specify a version number of the
+GNU Affero General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+ If the Program specifies that a proxy can decide which future
+versions of the GNU Affero General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+ Later license versions may give you additional or different
+permissions. However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+ 15. Disclaimer of Warranty.
+
+ THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+ 16. Limitation of Liability.
+
+ IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+ 17. Interpretation of Sections 15 and 16.
+
+ If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+ END OF TERMS AND CONDITIONS
+
+ How to Apply These Terms to Your New Programs
+
+ If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+ To do so, attach the following notices to the program. It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+ <one line to give the program's name and a brief idea of what it does.>
+ Copyright (C) <year> <name of author>
+
+ This program is free software: you can redistribute it and/or modify
+ it under the terms of the GNU Affero General Public License as published
+ by the Free Software Foundation, either version 3 of the License, or
+ (at your option) any later version.
+
+ This program is distributed in the hope that it will be useful,
+ but WITHOUT ANY WARRANTY; without even the implied warranty of
+ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ GNU Affero General Public License for more details.
+
+ You should have received a copy of the GNU Affero General Public License
+ along with this program. If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+ If your software can interact with users remotely through a computer
+network, you should also make sure that it provides a way for users to
+get its source. For example, if your program is a web application, its
+interface could display a "Source" link that leads users to an archive
+of the code. There are many ways you could offer source, and different
+solutions will be better for different programs; see section 13 for the
+specific requirements.
+
+ You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU AGPL, see
+<https://www.gnu.org/licenses/>.
\ No newline at end of file
diff --git a/Makefile b/Makefile
index 0e828da2523b942450f24f214d8a2f485676886b..e4f9d619b9f97deb2be2e1448d584e96e6114ca4 100644
--- a/Makefile
+++ b/Makefile
@@ -61,8 +61,15 @@ ifndef VERSION_BIN
$(shell curl -o $(VERSION_BIN_PATH) http://download.schukai.com/tools/version/version-$(shell uname -s | tr [:upper:] [:lower:])-$(shell echo `uname -m | sed s/aarch64/arm64/ | sed s/x86_64/amd64/`))
$(shell chmod +x $(VERSION_BIN_PATH))
endif
+
+GIT_CHGLOG_BIN := $(shell command -v git-chglog 2> /dev/null)
+
+ifeq ($(GIT_CHGLOG_BIN),)
+ $(shell go install github.com/git-chglog/git-chglog/cmd/git-chglog@latest)
+endif
RELEASE_FILE ?= $(PROJECT_ROOT)release.json
+CHANGELOG_FILE ?= $(PROJECT_ROOT)CHANGELOG.md
ifeq ("$(wildcard $(RELEASE_FILE))","")
$(shell echo '{"version":"0.1.0"}' > $(RELEASE_FILE))
@@ -72,21 +79,18 @@ PROJECT_VERSION ?= $(shell cat $(RELEASE_FILE) | jq -r .version)
PROJECT_BUILD_DATE ?= $(shell $(VERSION_BIN) date)
.PHONY: next-patch-version
-## create next patch version
next-patch-version: check-clean-repo
echo "Creating next version"
$(VERSION_BIN) patch --path $(RELEASE_FILE) --selector "version"
git add $(RELEASE_FILE) && git commit -m "Bump version to $$(cat $(RELEASE_FILE) | jq -r .version)"
.PHONY: next-minor-version
-## create next minor version
next-minor-version: check-clean-repo
echo "Creating next minor version"
$(VERSION_BIN) minor --path $(RELEASE_FILE) --selector "version"
git add $(RELEASE_FILE) && git commit -m "Bump version to $$( cat $(RELEASE_FILE) | jq -r .version)"
.PHONY: next-major-version
-## create next major version
next-major-version: check-clean-repo
echo "Creating next minor version"
$(VERSION_BIN) major --path $(RELEASE_FILE) --selector "version"
@@ -100,18 +104,24 @@ check-clean-repo:
tag-patch-version: next-patch-version
echo "Tagging patch version"
$(eval PROJECT_VERSION := $(shell cat $(RELEASE_FILE) | jq -r .version))
+ git-chglog --next-tag v$(PROJECT_VERSION) -o $(CHANGELOG_FILE)
+ git add $(CHANGELOG_FILE) && git commit -m "Update changelog"
git tag -a v$(PROJECT_VERSION) -m "Version $(PROJECT_VERSION)"
## tag repository with next minor version
tag-minor-version: next-minor-version
echo "Tagging minor version"
$(eval PROJECT_VERSION := $(shell cat $(RELEASE_FILE) | jq -r .version))
+ git-chglog --next-tag v$(PROJECT_VERSION) -o $(CHANGELOG_FILE)
+ git add $(CHANGELOG_FILE) && git commit -m "Update changelog"
git tag -a v$(PROJECT_VERSION) -m "Version $(PROJECT_VERSION)"
## tag repository with next major version
tag-major-version: next-major-version
echo "Tagging major version"
$(eval PROJECT_VERSION := $(shell cat $(RELEASE_FILE) | jq -r .version))
+ git-chglog --next-tag v$(PROJECT_VERSION) -o $(CHANGELOG_FILE)
+ git add $(CHANGELOG_FILE) && git commit -m "Update changelog"
git tag -a v$(PROJECT_VERSION) -m "Version $(PROJECT_VERSION)"
GO_MOD_FILE := $(SOURCE_PATH)go.mod
diff --git a/README.md b/README.md
index bd547ff5f5acd184fe3d2c0dcc0d823002fed074..f5213b8f31cf0777f2b085311396b6d8e93758be 100644
--- a/README.md
+++ b/README.md
@@ -7,7 +7,11 @@ to be able to define and use a structure with flags.
It supports:
-* [x] Define flags in a structure
+* [X] Define flags in a structure
+* [X] Define callbacks for flags
+* [X] Define default values for flags
+* [X] Define aliases for flags
+* [X] Define required flags
## Installation
@@ -19,18 +23,156 @@ go get gitlab.schukai.com/oss/libraries/go/network/xflags
## Usage
-## Change Log
+### Initialize
-### 1.0.0
+A new flag set is created using the `xflags.New()` function. The passed
+structure is used type for the flags.
-* Initial release
+```go
+package main
+
+import (
+ "fmt"
+ "os"
+ "gitlab.schukai.com/oss/libraries/go/network/xflags"
+)
+
+```
+
+### Definition
+
+The flags are defined in the structure. The structure can be nested.
+The name of the field is used as the name of the flag. The type of the
+field is used as the type of the flag.
+
+```go
+type Definition struct {
+ Verbose bool `short:"v" long:"verbose" description:"Show verbose debug information"`
+ Serve struct {
+ Host string `short:"h" long:"host" description:"Host to bind to" default:"localhost"`
+ Port int `short:"p" long:"port" description:"Port to bind to" default:"8080"`
+ } `command:"serve" description:"Run the HTTP server" call:"DoServe"`
+}
+```
+
+The following tags are supported:
+
+| Tag | Context | Description |
+|---------------|---------|--------------------------------------------|
+| `short` | Value | Short name of the flag. |
+| `long` | Value | Long name of the flag. |
+| `description` | Value | Description of the flag. |
+| `required` | Value | Flag is required. |
+| `command` | Command | Flag is a command. |
+| `call` | Command | Function to call when the command is used. |
+| `ignore` | -/- | Property is ignored. |
+
+
+### Callbacks
+
+The functions are called up with a receiver. The receiver is the
+configuration. The function must have the following signature:
+`func (d *Definition) DoServe(s *setting[Definition])`
+
+Let's assume we have the above definition. The Property `Serve` contains
+the command `serve`. Furthermore, the command has the tag `call` with
+the value `DoServe`. The function `DoServe` is called when the command
+`serve` is used.
+
+The function is called with the receiver `*Definition`
+
+An example for the function `DoServe`:
+
+```go
+func (d *Definition) DoServe(_ *setting[Definition]) {
+ fmt.Printf("Serving on %s:%d", d.Serve.Host, d.Serve.Port)
+}
+```
+
+In this example, the function is called with the receiver `*Definition`.
+The function is called with the setting `*setting[Definition]`. The
+setting is used to get the values of the flags. But in this example, we
+don't need the setting. So we use the underscore `_` to ignore the
+setting.
+
+### New Setting
+
+The function `New` creates a new setting for the given
+definition. The function returns a pointer to the setting.
+The first argument is a name for the setting. The second argument is the
+definition.
+
+A good choice for the name is the argument `os.Args[0]`.
+
+```go
+setting := New(os.Args[0], Definition{})
+```
+
+### Parse
+
+The flags are parsed using the `Parse()` function. The function returns
+the command and the setting. The command is the name of the command
+which was used. The setting is the setting of the flags.
+
+```go
+setting.Parse(os.Args[1:])
+```
+
+For testing, you can use the following arguments:
+
+```go
+setting.Parse([]string{"--verbose", "serve", "--host", "localhost", "--port", "8080"})
+```
+
+### Get Values
+
+The values of the flags are available in the setting. The values are
+available in the structure. The structure is the same as the definition.
+
+```go
+fmt.Printf("Host: %s", setting.GetValues().Serve.Host)
+fmt.Printf("Port: %d", setting.GetValues().Serve.Port)
+```
+
+### Execute
+
+The function `Execute()` executes the command. See the section
+[Callbacks](#callbacks) for more information.
+
+```go
+setting.Execute()
+```
## Contributing
Merge requests are welcome. For major changes, please open an issue first to discuss what
-you would like to change.
+you would like to change. **Please make sure to update tests as appropriate.**
+
+Versioning is done with [SemVer](https://semver.org/).
+Changelog is generated with [git-chglog](https://github.com/git-chglog/git-chglog#git-chglog)
+
+Commit messages should follow the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
+Messages are started with a type, which is one of the following:
-Please make sure to update tests as appropriate.
+- **feat**: A new feature
+- **fix**: A bug fix
+- **doc**: Documentation only changes
+- **refactor**: A code change that neither fixes a bug nor adds a feature
+- **perf**: A code change that improves performance
+- **test**: Adding missing or correcting existing tests
+- **chore**: Other changes that don't modify src or test files
+
+The footer would be used for a reference to an issue or a breaking change.
+
+A commit that has a footer `BREAKING CHANGE:`, or appends a ! after the type/scope,
+introduces a breaking API change (correlating with MAJOR in semantic versioning).
+A BREAKING CHANGE can be part of commits of any type.
+
+the following is an example of a commit message:
+
+```text
+feat: add 'extras' field
+```
## License
diff --git a/api.go b/api.go
new file mode 100644
index 0000000000000000000000000000000000000000..0bc87fe48c1db25db21151332c6b3b914251fb5d
--- /dev/null
+++ b/api.go
@@ -0,0 +1,42 @@
+package xflags
+
+import (
+ "bytes"
+ "flag"
+ "io"
+ "reflect"
+)
+
+// New creates a new instance of the settings.
+// name should be the name of the command and comes from the first argument of the command line.
+// os.Args[0] is a good choice.
+func New[C any](name string, definitions C) *setting[C] {
+
+ s := &setting[C]{
+ config: config{
+ errorHandling: flag.ContinueOnError,
+ },
+ }
+
+ if reflect.TypeOf(definitions).Kind() != reflect.Struct {
+ s.errors = append(s.errors, newUnsupportedReflectKindError(reflect.TypeOf(definitions)))
+ return s
+ }
+
+ buf := bytes.NewBufferString("")
+ s.flagOutput = io.Writer(buf)
+ s.definitions = definitions
+ s.initCommands(name)
+
+ return s
+}
+
+// FlagOutput returns the writer where the flag package writes its output.
+func (s *setting[C]) FlagOutput() string {
+ return s.flagOutput.(*bytes.Buffer).String()
+}
+
+// Args Returns not parsed arguments.
+func (s *setting[C]) Args() []string {
+ return s.args
+}
diff --git a/api_test.go b/api_test.go
new file mode 100644
index 0000000000000000000000000000000000000000..2ec6c88084153bc9955ed4d314d277b9f78ae568
--- /dev/null
+++ b/api_test.go
@@ -0,0 +1,62 @@
+package xflags
+
+import (
+ "github.com/stretchr/testify/assert"
+ "testing"
+)
+
+func TestNewIntWithError(t *testing.T) {
+
+ // two is not a struct
+ commands := New("root", 2)
+ assert.True(t, commands.HasErrors())
+
+}
+
+func TestNew(t *testing.T) {
+
+ c := struct {
+ Verbose bool `short:"v" long:"verbose" description:"Show verbose debug information"`
+ }{
+ Verbose: false,
+ }
+
+ commands := New("root", c)
+ assert.False(t, commands.HasErrors())
+
+}
+
+type CmdTest1 struct {
+ A bool `short:"a"`
+ Sub1 struct {
+ B bool `short:"b"`
+ Sub2 struct {
+ C bool `short:"c"`
+ Sub3 struct {
+ D bool `short:"d"`
+ } `command:"sub3"`
+ } `command:"sub2"`
+ } `command:"sub1"`
+ aa int `short:"x"`
+}
+
+func TestCommand2(t *testing.T) {
+
+ commands := New("root", CmdTest1{})
+ args := []string{"root", "-a", "sub1", "-b", "sub2", "-c", "sub3", "-d"}
+
+ commands.Parse(args)
+
+ assert.False(t, commands.HasErrors())
+ if commands.HasErrors() {
+ t.Log(commands.Errors())
+ }
+
+ assert.True(t, CmdTest1(commands.GetValues()).A)
+ assert.True(t, CmdTest1(commands.GetValues()).Sub1.B)
+ assert.True(t, CmdTest1(commands.GetValues()).Sub1.Sub2.C)
+ assert.True(t, CmdTest1(commands.GetValues()).Sub1.Sub2.Sub3.D)
+
+ assert.False(t, commands.HasErrors())
+
+}
diff --git a/command.go b/command.go
new file mode 100644
index 0000000000000000000000000000000000000000..09f870511d823fc66ddf02f8b1ef81fd8f83fc17
--- /dev/null
+++ b/command.go
@@ -0,0 +1,180 @@
+package xflags
+
+import (
+ "flag"
+ "reflect"
+)
+
+const (
+ tagIgnore = "ignore"
+ tagCall = "call"
+ tagCommand = "command"
+ tagShort = "short"
+ tagLong = "long"
+ tagDescription = "description"
+)
+
+type cmd[C any] struct {
+ name string
+ flagSet *flag.FlagSet
+ mapping map[string]string
+ commands []*cmd[C]
+ settings *setting[C]
+ valuePath []string
+ functionName string
+}
+
+func (c *cmd[C]) parse(args []string) {
+
+ s := c.settings
+
+ for _, command := range c.commands {
+
+ if command.name == args[0] {
+
+ if command.flagSet == nil {
+ s.errors = append(s.errors, newMissingFlagSetError(command.name))
+ continue
+ }
+
+ err := command.flagSet.Parse(args[1:])
+ if err != nil {
+ s.errors = append(s.errors, err)
+ continue
+ }
+
+ s.assignValues(*command)
+
+ r := command.flagSet.Args()
+ if len(r) == 0 {
+ c.settings.args = []string{}
+ continue
+ }
+
+ c.settings.args = r
+ command.parse(r)
+
+ }
+ }
+
+}
+
+func buildCommandStruct[C any](s *setting[C], name, fkt string, errorHandling flag.ErrorHandling, path []string) *cmd[C] {
+ cc := &cmd[C]{
+ name: name,
+ flagSet: flag.NewFlagSet(name, errorHandling),
+ commands: []*cmd[C]{},
+ settings: s,
+ mapping: map[string]string{},
+ valuePath: path,
+ functionName: fkt,
+ }
+
+ cc.flagSet.SetOutput(s.flagOutput)
+
+ return cc
+}
+
+func (c *cmd[C]) initCommands(x reflect.Value, m map[string]string, path string) {
+
+ if x.Kind() != reflect.Struct {
+ c.settings.errors = append(c.settings.errors, newUnsupportedReflectKindError(x.Type()))
+ return
+ }
+
+ cc := buildCommandStruct[C](c.settings, m[tagCommand], m[tagCall], c.settings.config.errorHandling, append(c.valuePath, path))
+
+ cc.parseStruct(x.Interface())
+ c.commands = append(c.commands, cc)
+
+}
+
+func (c *cmd[C]) initFlags(x reflect.Value, m map[string]string) {
+
+ if x.Kind() == reflect.Struct {
+ c.settings.errors = append(c.settings.errors, newUnsupportedReflectKindError(x.Type()))
+ return
+ }
+
+ switch x.Kind() {
+ case reflect.Bool:
+ if m[tagShort] != "" {
+ c.flagSet.Bool(m[tagShort], x.Bool(), m[tagDescription])
+ }
+ if m[tagLong] != "" {
+ c.flagSet.Bool(m[tagLong], x.Bool(), m[tagDescription])
+ }
+ case reflect.Int, reflect.Int8, reflect.Int16, reflect.Int32, reflect.Int64:
+ if m[tagShort] != "" {
+ c.flagSet.Int(m[tagShort], int(x.Int()), m[tagDescription])
+ }
+ if m[tagLong] != "" {
+ c.flagSet.Int(m[tagLong], int(x.Int()), m[tagDescription])
+ }
+
+ case reflect.Float32, reflect.Float64:
+ if m[tagShort] != "" {
+ c.flagSet.Float64(m[tagShort], x.Float(), m[tagDescription])
+ }
+ if m[tagLong] != "" {
+ c.flagSet.Float64(m[tagLong], x.Float(), m[tagDescription])
+ }
+ case reflect.String:
+ if m[tagShort] != "" {
+ c.flagSet.String(m[tagShort], x.String(), m[tagDescription])
+ }
+ if m[tagLong] != "" {
+ c.flagSet.String(m[tagLong], x.String(), m[tagDescription])
+ }
+
+ default:
+ c.settings.errors = append(c.settings.errors, newUnsupportedFlagTypeError(x.Type()))
+ }
+
+}
+
+func (c *cmd[C]) parseStruct(dta any) {
+
+ t := reflect.TypeOf(dta)
+
+ if t.Kind() != reflect.Struct {
+ c.settings.errors = append(c.settings.errors, newUnsupportedReflectKindError(t))
+ return
+ }
+
+ v := reflect.ValueOf(dta)
+
+ for i := 0; i < v.NumField(); i++ {
+ x := v.Field(i)
+ m := getTagMap(v.Type().Field(i))
+
+ if m[tagShort] != "" || m[tagLong] != "" {
+ if m[tagCommand] != "" {
+ c.settings.errors = append(c.settings.errors, newAmbiguousTagError(v.Type().Field(i).Name, m))
+ continue
+ }
+
+ if m[tagShort] != "" {
+ c.mapping[m[tagShort]] = v.Type().Field(i).Name
+ }
+
+ if m[tagLong] != "" {
+ c.mapping[m[tagLong]] = v.Type().Field(i).Name
+ }
+
+ c.initFlags(x, m)
+ } else if m[tagCommand] != "" {
+
+ //c.valuePath = append(c.valuePath, )
+ c.mapping[m[tagCommand]] = v.Type().Field(i).Name
+
+ c.initCommands(x, m, v.Type().Field(i).Name)
+ } else if m[tagIgnore] != "" {
+ continue
+ } else {
+ c.settings.errors = append(c.settings.errors, newMissingTagError(v.Type().Field(i).Name))
+ }
+
+ }
+
+}
diff --git a/command_test.go b/command_test.go
new file mode 100644
index 0000000000000000000000000000000000000000..8ecdf9c2333f1824b9e5213c856bf6e0c5b61cfb
--- /dev/null
+++ b/command_test.go
@@ -0,0 +1,47 @@
+package xflags
+
+import (
+ "flag"
+ "github.com/stretchr/testify/assert"
+ "testing"
+)
+
+type testStructParseCommand1 struct {
+ V1 bool `short:"v1"`
+ Cmd1 struct {
+ V2 bool `short:"v2"`
+ V4 int `short:"v4"`
+ } `command:"cmd1"`
+ Cmd2 struct {
+ V3 bool `short:"v3"`
+ Cmd3 struct {
+ V3 bool `short:"v3"`
+ } `command:"cmd3"`
+ } `command:"cmd2"`
+}
+
+func TestParse(t *testing.T) {
+ tests := []struct {
+ commandline []string
+ }{
+ {[]string{"command1"}},
+ }
+ for _, test := range tests {
+ t.Run(test.commandline[0], func(t *testing.T) {
+
+ c := &cmd[testStructParseCommand1]{}
+ c.settings = &setting[testStructParseCommand1]{}
+
+ c.commands = []*cmd[testStructParseCommand1]{}
+
+ c.commands = append(c.commands, &cmd[testStructParseCommand1]{
+ name: "command1",
+ flagSet: &flag.FlagSet{},
+ })
+
+ c.parse(test.commandline)
+ assert.Equal(t, 0, len(c.settings.errors))
+
+ })
+ }
+}
diff --git a/doc.go b/doc.go
new file mode 100644
index 0000000000000000000000000000000000000000..3e7422784387fdb6bf6047c882136ecde828aee8
--- /dev/null
+++ b/doc.go
@@ -0,0 +1,8 @@
+// Copyright schukai GmbH. All rights reserved.
+// Use of this source code is governed by a GNU AGPLv3
+// license that can be found in the LICENSE file.
+
+// This package provides a simple way to create a CLI application
+// with subcommands.
+
+package xflags
diff --git a/error.go b/error.go
new file mode 100644
index 0000000000000000000000000000000000000000..9803ea70823d71d161b736a54745b8b2534b87ed
--- /dev/null
+++ b/error.go
@@ -0,0 +1,110 @@
+package xflags
+
+import (
+ "errors"
+ "reflect"
+)
+
+// ResetError is used to reset the error to nil
+// After calling this function, the call HasErrors() will return false
+func (s *setting[C]) ResetErrors() *setting[C] {
+ s.errors = []error{}
+ return s
+}
+
+// Check if the setting contains errors
+func (s *setting[C]) HasErrors() bool {
+ return len(s.errors) > 0
+}
+
+// Get all errors
+func (s *setting[C]) Errors() []error {
+ return s.errors
+}
+
+var WatchListNotInitializedError = errors.New("watch list not initialized")
+var MissingCommandError = errors.New("missing command")
+var NotParsedError = errors.New("flag set not parsed")
+
+// At the reflect level, some types are not supported
+type UnsupportedReflectKindError error
+
+func newUnsupportedReflectKindError(t reflect.Type) UnsupportedReflectKindError {
+ return UnsupportedReflectKindError(errors.New("type " + t.String() + " is not supported"))
+}
+
+// AmbiguousTagError is used when a tag is ambiguous
+type AmbiguousTagError error
+
+func newAmbiguousTagError(name string, m map[string]string) AmbiguousTagError {
+
+ msg := "ambiguous tag for field " + name + ": "
+ for k, v := range m {
+ msg += k + " = " + v + ", "
+ }
+
+ return AmbiguousTagError(errors.New(msg))
+}
+
+// UnsupportedFlagTypeError is used when a flag type is not supported
+type UnsupportedFlagTypeError error
+
+func newUnsupportedFlagTypeError(t reflect.Type) UnsupportedFlagTypeError {
+ return UnsupportedFlagTypeError(errors.New("type " + t.String() + " is not supported"))
+}
+
+// EmptyTagError is used when a tag is empty
+type EmptyTagError error
+
+func newEmptyTagError(tag, name string) EmptyTagError {
+ return EmptyTagError(errors.New("tag " + tag + " is empty for field " + name))
+}
+
+// MissingTagError is used when a tag is missing
+type MissingTagError error
+
+func newMissingTagError(tag string) MissingTagError {
+ return MissingTagError(errors.New("tag " + tag + " is empty"))
+}
+
+type InvalidPathError error
+
+func newInvalidPathError(path string) InvalidPathError {
+ return InvalidPathError(errors.New("invalid path " + path))
+}
+
+type UnsupportedTypeAtTopOfPathError error
+
+func newUnsupportedTypeAtTopOfPathError(path string, t reflect.Type) UnsupportedTypeAtTopOfPathError {
+ return UnsupportedTypeAtTopOfPathError(errors.New("unsupported type " + t.String() + " at top of path " + path))
+}
+
+type UnsupportedTypePathError error
+
+func newUnsupportedTypePathError(path string, t reflect.Type) UnsupportedTypeAtTopOfPathError {
+ return UnsupportedTypePathError(errors.New("unsupported type " + t.String() + " at path " + path))
+}
+
+type UnknownFlagError error
+
+func newUnknownFlagError(name string) UnknownFlagError {
+ return UnknownFlagError(errors.New("unknown flag " + name))
+}
+
+type CannotSetError error
+
+func newCannotSetError(name string) CannotSetError {
+ return CannotSetError(errors.New("cannot set " + name))
+}
+
+type MissingFlagSetError error
+
+func newMissingFlagSetError(name string) MissingFlagSetError {
+ return MissingFlagSetError(errors.New("missing flag set for command " + name))
+}
+
+type StdoutError error
+
+func newStdoutError(message string) StdoutError {
+ return StdoutError(errors.New(message))
+}
diff --git a/error_test.go b/error_test.go
new file mode 100644
index 0000000000000000000000000000000000000000..62663211c5f35cdd6b14f81972a732193eaaee3d
--- /dev/null
+++ b/error_test.go
@@ -0,0 +1,89 @@
+package xflags
+
+import (
+ "github.com/stretchr/testify/assert"
+ "reflect"
+ "testing"
+)
+
+func TestHasErrors(t *testing.T) {
+ c := New("root", 2)
+ assert.True(t, c.HasErrors())
+ c.ResetErrors()
+ assert.False(t, c.HasErrors())
+}
+
+func TestResetErrors(t *testing.T) {
+ c := New("root", 4)
+ c.errors = append(c.errors, newUnsupportedReflectKindError(reflect.TypeOf(1)))
+ assert.True(t, c.HasErrors())
+ c.ResetErrors()
+ assert.False(t, c.HasErrors())
+}
+
+func TestNewUnsupportedReflectKindError(t *testing.T) {
+ ref := reflect.TypeOf(1)
+ err := newUnsupportedReflectKindError(ref)
+ _, ok := err.(UnsupportedReflectKindError)
+ assert.True(t, ok)
+}
+
+func TestNewAmbiguousTagError(t *testing.T) {
+ err := newAmbiguousTagError("test", map[string]string{"short": "s", "long": "long"})
+ _, ok := err.(AmbiguousTagError)
+ assert.True(t, ok)
+}
+
+func TestNewUnsupportedFlagTypeError(t *testing.T) {
+ err := newUnsupportedFlagTypeError(reflect.TypeOf(make(map[string]string)))
+ _, ok := err.(UnsupportedFlagTypeError)
+ assert.True(t, ok)
+}
+
+func TestNewEmptyTagError(t *testing.T) {
+ err := newEmptyTagError("test", "test")
+ _, ok := err.(EmptyTagError)
+ assert.True(t, ok)
+}
+
+func TestMissingTagError(t *testing.T) {
+ err := newMissingTagError("test")
+ _, ok := err.(MissingTagError)
+ assert.True(t, ok)
+}
+
+func TestInvalidPathError(t *testing.T) {
+ err := newInvalidPathError("test")
+ _, ok := err.(InvalidPathError)
+ assert.True(t, ok)
+}
+
+func TestUnsupportedTypeAtTopOfPathError(t *testing.T) {
+ err := newUnsupportedTypeAtTopOfPathError("test", reflect.TypeOf(1))
+ _, ok := err.(UnsupportedTypeAtTopOfPathError)
+ assert.True(t, ok)
+}
+
+func TestUnsupportedTypePathError(t *testing.T) {
+ err := newUnsupportedTypeAtTopOfPathError("test", reflect.TypeOf(1))
+ _, ok := err.(UnsupportedTypeAtTopOfPathError)
+ assert.True(t, ok)
+}
+
+func TestUnknownFlagError(t *testing.T) {
+ err := newUnknownFlagError("test")
+ _, ok := err.(UnknownFlagError)
+ assert.True(t, ok)
+}
+
+func TestCannotSetError(t *testing.T) {
+ err := newCannotSetError("test")
+ _, ok := err.(CannotSetError)
+ assert.True(t, ok)
+}
+
+func TestStdoutError(t *testing.T) {
+ err := newStdoutError("test")
+ _, ok := err.(StdoutError)
+ assert.True(t, ok)
+}
diff --git a/execute.go b/execute.go
new file mode 100644
index 0000000000000000000000000000000000000000..1878761c7fa57104238567c5d061205766f75182
--- /dev/null
+++ b/execute.go
@@ -0,0 +1,41 @@
+package xflags
+
+import (
+ "reflect"
+)
+
+func (s *setting[C]) Execute() *setting[C] {
+ if len(s.errors) > 0 {
+ return s
+ }
+
+ if s.command == nil {
+ s.errors = append(s.errors, MissingCommandError)
+ return s
+ }
+
+ if !s.command.flagSet.Parsed() {
+ s.errors = append(s.errors, NotParsedError)
+ } else {
+ callCmdFunctions(s.command.commands)
+ }
+
+ return s
+}
+
+func callCmdFunctions[C any](commands []*cmd[C]) {
+ for _, command := range commands {
+ if command.flagSet.Parsed() {
+
+ f := reflect.ValueOf(&command.settings.definitions).MethodByName(command.functionName)
+ if f.IsValid() {
+ m := command.settings
+ in := []reflect.Value{reflect.ValueOf(m)}
+ f.Call(in)
+ }
+
+ callCmdFunctions(command.commands)
+ }
+ }
+
+}
diff --git a/execute_test.go b/execute_test.go
new file mode 100644
index 0000000000000000000000000000000000000000..398cb61f16c249ee09d89a5588cb005cc0cf7b64
--- /dev/null
+++ b/execute_test.go
@@ -0,0 +1,88 @@
+package xflags
+
+import (
+ "github.com/stretchr/testify/assert"
+ "strconv"
+ "testing"
+)
+
+type testExecutionStruct struct {
+ callbackCounter int `ignore:"true"`
+
+ Global1 bool `short:"a" long:"global1" description:"Global 1"`
+ Global2 bool `short:"b" long:"global2" description:"Global 2"`
+ Command1 struct {
+ Command1Flag1 bool `short:"c" long:"command1flag1" description:"Command 1 Flag 1"`
+ Command1Flag2 bool `short:"d" long:"command1flag2" description:"Command 1 Flag 2"`
+ Command2 struct {
+ Command2Flag1 bool `short:"e" long:"command2flag1" description:"Command 2 Flag 1"`
+ Command2Flag2 bool `short:"f" long:"command2flag2" description:"Command 2 Flag 2"`
+ } `command:"command2" description:"Command 2" call:"Command2Callback" `
+ } `command:"command1" description:"Command 1" call:"Command1Callback" `
+ Command3 struct {
+ Command3Flag1 bool `short:"g" long:"command3flag1" description:"Command 3 Flag 1"`
+ } `command:"command3" description:"Command 3" call:"Command3Callback" `
+}
+
+func (c *testExecutionStruct) Command1Callback(s *setting[testExecutionStruct]) {
+ s.definitions.callbackCounter++
+}
+
+func (c *testExecutionStruct) Command2Callback(s *setting[testExecutionStruct]) {
+ s.definitions.callbackCounter++
+}
+
+func (c *testExecutionStruct) Command3Callback(s *setting[testExecutionStruct]) {
+ s.definitions.callbackCounter++
+}
+
+type testExecutionTestCases[C any] struct {
+ name string
+ args []string
+ targetValue int
+}
+
+func TestExec(t *testing.T) {
+
+ tests := []testExecutionTestCases[testExecutionStruct]{
+ {
+ name: "test",
+ args: []string{"test", "command1", "-c"},
+ targetValue: 1,
+ },
+ {
+ name: "test",
+ args: []string{"test", "command1", "command2", "-e"},
+ targetValue: 2,
+ }, {
+ name: "test",
+ args: []string{"test", "-a", "command3"},
+ targetValue: 1,
+ },
+ }
+
+ for _, tt := range tests {
+ t.Run(tt.args[0], func(t *testing.T) {
+ settings := New(tt.name, testExecutionStruct{})
+ assert.NotNil(t, settings)
+
+ if settings.definitions.callbackCounter != 0 {
+ t.Error("Callback counter should be 0")
+ }
+
+ settings.Parse(tt.args)
+ settings.Execute()
+
+ if settings.HasErrors() {
+ t.Error("Should not have errors")
+ t.Log(settings.Errors())
+ }
+
+ if settings.definitions.callbackCounter != tt.targetValue {
+ t.Error("Callback counter should be " + strconv.Itoa(tt.targetValue) + " but is " + strconv.Itoa(settings.definitions.callbackCounter))
+ }
+
+ //tt.test(s)
+ })
+ }
+}
diff --git a/flag.go b/flag.go
new file mode 100644
index 0000000000000000000000000000000000000000..3a0a17e725d90d962c0205fe6e0756c610f1abdf
--- /dev/null
+++ b/flag.go
@@ -0,0 +1,62 @@
+package xflags
+
+import (
+ "flag"
+ "strings"
+)
+
+// Parse parses the command line arguments and assigns the values to the settings.
+func (s *setting[C]) Parse(args []string) *setting[C] {
+ if len(s.errors) > 0 {
+ return s
+ }
+
+ if s.command == nil {
+ s.errors = append(s.errors, MissingCommandError)
+ return s
+ }
+
+ err := s.command.flagSet.Parse(args[1:])
+ if err != nil {
+ s.errors = append(s.errors, err)
+ return s
+ }
+
+ s.assignValues(*s.command)
+
+ r := s.command.flagSet.Args()
+ if len(r) == 0 {
+ return s
+ }
+
+ s.command.parse(r)
+
+ return s
+}
+
+func (s *setting[C]) assignValues(c cmd[C]) {
+ flgs := c.flagSet
+ flgs.Visit(func(f *flag.Flag) {
+
+ name := f.Name
+ value := f.Value.String()
+
+ k, ok := c.mapping[name]
+ if !ok {
+ s.errors = append(s.errors, newUnknownFlagError(name))
+ return
+ }
+
+ pa := append(c.valuePath, k)
+ p := strings.Join(pa, ".")
+
+ err := setTheValueOverPath(&s.definitions, p, value)
+ if err != nil {
+ s.errors = append(s.errors, err)
+ }
+
+ return
+
+ })
+
+}
diff --git a/flag_test.go b/flag_test.go
new file mode 100644
index 0000000000000000000000000000000000000000..843e64b69110287d1644960e5f4fbc5d3de5132a
--- /dev/null
+++ b/flag_test.go
@@ -0,0 +1,34 @@
+package xflags
+
+import (
+ "fmt"
+ "github.com/stretchr/testify/assert"
+ "testing"
+)
+
+func TestWrongDefinitionType(t *testing.T) {
+ c := New("root", 2)
+ c.Parse([]string{"test"})
+ c.Execute()
+ assert.True(t, c.HasErrors())
+}
+
+type testExecuteCommandStruct struct {
+ Command1 struct {
+ } `command:"command1" description:"Command 1" callback:"command1Callback" `
+ Command2 struct {
+ Command3 struct {
+ } `command:"command3" description:"Command 3" callback:"command3Callback" `
+ } `command:"command2" description:"Command 2" callback:"command2Callback" `
+}
+
+func (c *testExecuteCommandStruct) command1Callback(args []string) {
+ fmt.Println("command1Callback", args)
+}
+
+func TestExecute1(t *testing.T) {
+ c := New("root", testExecuteCommandStruct{})
+ c.Parse([]string{"root", "command2", "command3", "commandX"})
+ c.Execute()
+ assert.False(t, c.HasErrors())
+}
diff --git a/go.mod b/go.mod
index 2d683b6aab1d321ca81dd5895523dfb53a18d1ef..d59d5608a928ba0cf7d15bd143685980e2bf880d 100644
--- a/go.mod
+++ b/go.mod
@@ -1,3 +1,11 @@
module gitlab.schukai.com/oss/libraries/go/application/xflags
go 1.19
+
+require github.com/stretchr/testify v1.8.0
+
+require (
+ github.com/davecgh/go-spew v1.1.1 // indirect
+ github.com/pmezard/go-difflib v1.0.0 // indirect
+ gopkg.in/yaml.v3 v3.0.1 // indirect
+)
diff --git a/go.sum b/go.sum
new file mode 100644
index 0000000000000000000000000000000000000000..51648299d59e0c4e587047b1f9eb3d34090c0910
--- /dev/null
+++ b/go.sum
@@ -0,0 +1,15 @@
+github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c=
+github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
+github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
+github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
+github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
+github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
+github.com/stretchr/testify v1.7.1/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg=
+github.com/stretchr/testify v1.8.0 h1:pSgiaMZlXftHpm5L7V1+rVB+AZJydKsMxsQBIJw4PKk=
+github.com/stretchr/testify v1.8.0/go.mod h1:yNjHg4UonilssWZ8iaSj1OCr/vHnekPRkoO+kdMU+MU=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
+gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
+gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
+gopkg.in/yaml.v3 v3.0.1 h1:fxVm/GzAzEWqLHuvctI91KS9hhNmmWOoWu0XTYJS7CA=
+gopkg.in/yaml.v3 v3.0.1/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM=
diff --git a/integration_test.go b/integration_test.go
new file mode 100644
index 0000000000000000000000000000000000000000..3021bb7177d2aa73204f3bf352d7f018de469ccd
--- /dev/null
+++ b/integration_test.go
@@ -0,0 +1,123 @@
+package xflags
+
+import (
+ "github.com/stretchr/testify/assert"
+ "testing"
+)
+
+type testInterfaceCallbacks func(s *setting[testIntegrationStruct])
+
+type testIntegrationStruct struct {
+ Help bool `short:"h" long:"help" description:"Show this help message"`
+ Verbose bool `short:"v" long:"verbose" description:"Enable verbose logging"`
+}
+
+type testIntegrationTestCases[C any] struct {
+ name string
+ args []string
+ test testInterfaceCallbacks
+ errors []string
+}
+
+func TestIntegrationError(t *testing.T) {
+
+ tests := []testIntegrationTestCases[testIntegrationStruct]{
+ {
+ name: "test",
+ args: []string{"test2", "-a"},
+ errors: []string{
+ "flag provided but not defined: -a",
+ },
+ },
+ }
+
+ for _, tt := range tests {
+ t.Run(tt.args[0], func(t *testing.T) {
+ settings := New(tt.name, testIntegrationStruct{})
+ assert.NotNil(t, settings)
+
+ s := settings.Parse(tt.args)
+ if !s.HasErrors() {
+ t.Error(s.Errors())
+ }
+
+ summarizedErrors := []string{}
+ for _, e := range s.Errors() {
+ summarizedErrors = append(summarizedErrors, e.Error())
+ }
+
+ for _, err := range tt.errors {
+ assert.Contains(t, summarizedErrors, err)
+ }
+
+ })
+ }
+
+}
+
+func TestIntegration(t *testing.T) {
+
+ tests := []testIntegrationTestCases[testIntegrationStruct]{
+ {
+ name: "test",
+ args: []string{"test"},
+ test: func(s *setting[testIntegrationStruct]) {
+ v := s.GetValues()
+ assert.NotNil(t, v)
+ assert.IsType(t, testIntegrationStruct{}, v)
+ assert.False(t, v.Verbose)
+ assert.False(t, s.GetValues().Verbose)
+ },
+ },
+ {
+ name: "test",
+ args: []string{"test", "-v"},
+ test: func(s *setting[testIntegrationStruct]) {
+ v := s.GetValues()
+ assert.NotNil(t, v)
+ assert.IsType(t, testIntegrationStruct{}, v)
+ assert.True(t, v.Verbose)
+ assert.True(t, s.GetValues().Verbose)
+ },
+ },
+ {
+ name: "test",
+ args: []string{"test", "--verbose"},
+ test: func(s *setting[testIntegrationStruct]) {
+ assert.True(t, s.GetValues().Verbose)
+ },
+ },
+ {
+ name: "test",
+ args: []string{"test", "-verbose"},
+ test: func(s *setting[testIntegrationStruct]) {
+ assert.True(t, s.GetValues().Verbose)
+ },
+ },
+ {
+ name: "test",
+ args: []string{"test", "sub1"},
+ test: func(s *setting[testIntegrationStruct]) {
+ assert.False(t, s.GetValues().Verbose)
+ },
+ },
+ }
+
+ for _, tt := range tests {
+ t.Run(tt.args[0], func(t *testing.T) {
+ settings := New(tt.name, testIntegrationStruct{})
+ assert.NotNil(t, settings)
+
+ s := settings.Parse(tt.args)
+
+ if s.HasErrors() {
+ t.Error(s.Errors())
+ }
+
+ assert.Equal(t, settings, s)
+
+ tt.test(settings)
+
+ })
+ }
+}
diff --git a/pathfind.go b/pathfind.go
new file mode 100644
index 0000000000000000000000000000000000000000..8c9bdcb4025017e5d68f848310b451c2007f1e98
--- /dev/null
+++ b/pathfind.go
@@ -0,0 +1,113 @@
+package xflags
+
+import (
+ "reflect"
+ "strconv"
+ "strings"
+)
+
+// This function returns the value of a field in a struct, given a path to the field.
+func getValueFrom[D any](obj D, keyWithDots string) (interface{}, error) {
+ keySlice := strings.Split(keyWithDots, ".")
+ v := reflect.ValueOf(obj)
+
+ for _, key := range keySlice[0 : len(keySlice)-1] {
+ for v.Kind() == reflect.Ptr {
+ v = v.Elem()
+ }
+
+ if v.Kind() != reflect.Struct {
+ return nil, newUnsupportedTypePathError(keyWithDots, v.Type())
+ }
+
+ v = v.FieldByName(key)
+ }
+
+ for v.Kind() == reflect.Ptr {
+ v = v.Elem()
+ }
+
+ // non-supporter type at the top of the path
+ if v.Kind() != reflect.Struct {
+ return nil, newUnsupportedTypeAtTopOfPathError(keyWithDots, v.Type())
+ }
+
+ v = v.FieldByName(keySlice[len(keySlice)-1])
+ if !v.IsValid() {
+ return nil, newInvalidPathError(keyWithDots)
+ }
+
+ return v.Interface(), nil
+
+}
+
+// This function sets the value of a field in a struct, given a path to the field.
+func setTheValueOverPath[D any](obj D, keyWithDots string, newValue string) error {
+
+ keySlice := strings.Split(keyWithDots, ".")
+ v := reflect.ValueOf(obj)
+
+ for _, key := range keySlice[0 : len(keySlice)-1] {
+ for v.Kind() != reflect.Ptr {
+ v = v.Addr()
+ }
+
+ if v.Kind() != reflect.Ptr {
+ return newUnsupportedTypePathError(keyWithDots, v.Type())
+ }
+
+ elem := v.Elem()
+ if elem.Kind() != reflect.Struct {
+ return newUnsupportedTypePathError(keyWithDots, v.Type())
+ }
+
+ v = elem.FieldByName(key)
+
+ }
+
+ for v.Kind() == reflect.Ptr {
+ v = v.Elem()
+ }
+
+ // non-supporter type at the top of the path
+ if v.Kind() != reflect.Struct {
+ return newUnsupportedTypeAtTopOfPathError(keyWithDots, v.Type())
+ }
+
+ v = v.FieldByName(keySlice[len(keySlice)-1])
+ if !v.IsValid() {
+ return newInvalidPathError(keyWithDots)
+ }
+
+ if !v.CanSet() {
+ return newCannotSetError(keyWithDots)
+ }
+
+ switch v.Kind() {
+ case reflect.String:
+ v.SetString(newValue)
+ case reflect.Int:
+
+ s, err := strconv.Atoi(newValue)
+ if err != nil {
+ return err
+ }
+
+ v.SetInt(int64(s))
+ case reflect.Bool:
+ v.SetBool(newValue == "true")
+ case reflect.Float64:
+
+ s, err := strconv.ParseFloat(newValue, 64)
+ if err != nil {
+ return err
+ }
+
+ v.SetFloat(s)
+ default:
+ return newUnsupportedTypeAtTopOfPathError(keyWithDots, v.Type())
+ }
+
+ return nil
+
+}
diff --git a/pathfind_test.go b/pathfind_test.go
new file mode 100644
index 0000000000000000000000000000000000000000..dab17a86004fd72a9be1e5f48881ecd017368c4b
--- /dev/null
+++ b/pathfind_test.go
@@ -0,0 +1,275 @@
+package xflags
+
+import "testing"
+
+type PathfindTestStruct1 struct {
+ A bool
+ Sub1 struct {
+ B bool
+ Bi int
+ Bs string
+ Bf float64
+ Sub2 struct {
+ C bool
+ Ci int
+ Cs string
+ Cf float64
+
+ Sub3 struct {
+ D bool
+ Di int
+ Ds string
+ Df float64
+ }
+ }
+ }
+}
+
+func TestPathFindError(t *testing.T) {
+
+ s := PathfindTestStruct1{}
+
+ _, err := getValueFrom[PathfindTestStruct1](s, "Sub1.Sub2.Sub3.XX")
+ if err == nil {
+ t.Error("err == nil")
+ }
+
+}
+
+func TestPathFindSetValueString(t *testing.T) {
+
+ testData := map[string]string{
+ "Sub1.B": "true",
+ "Sub1.Bi": "2",
+ "Sub1.Bs": "3",
+ "Sub1.Bf": "4.0",
+ "Sub1.Sub2.C": "true",
+ "Sub1.Sub2.Ci": "2",
+ "Sub1.Sub2.Cs": "3",
+ "Sub1.Sub2.Cf": "4.0",
+ "Sub1.Sub2.Sub3.D": "true",
+ "Sub1.Sub2.Sub3.Di": "2",
+ "Sub1.Sub2.Sub3.Ds": "3",
+ "Sub1.Sub2.Sub3.Df": "4.0",
+ }
+
+ for k, v := range testData {
+ s := &PathfindTestStruct1{}
+ err := setTheValueOverPath[*PathfindTestStruct1](s, k, v)
+ if err != nil {
+ t.Error(err)
+ }
+ }
+}
+
+func TestPathFindGetValueFrom(t *testing.T) {
+
+ s := PathfindTestStruct1{}
+
+ s.Sub1.B = true
+ s.Sub1.Bi = 2
+ s.Sub1.Bs = "3"
+ s.Sub1.Bf = 4.0
+
+ v, err := getValueFrom[PathfindTestStruct1](s, "Sub1.B")
+ if err != nil {
+ t.Error(err)
+ }
+
+ if v != true {
+ t.Error("v != true")
+ }
+
+ v, err = getValueFrom[PathfindTestStruct1](s, "Sub1.Bi")
+ if err != nil {
+ t.Error(err)
+ }
+
+ if v != 2 {
+ t.Error("v != 2")
+ }
+
+ v, err = getValueFrom[PathfindTestStruct1](s, "Sub1.Bs")
+ if err != nil {
+ t.Error(err)
+ }
+
+ if v != "3" {
+ t.Error("v != 3")
+ }
+
+ v, err = getValueFrom[PathfindTestStruct1](s, "Sub1.Bf")
+ if err != nil {
+ t.Error(err)
+ }
+
+ if v != 4.0 {
+ t.Error("v != 4.0")
+ }
+
+ s.Sub1.Sub2.C = true
+ s.Sub1.Sub2.Ci = 2
+ s.Sub1.Sub2.Cs = "3"
+ s.Sub1.Sub2.Cf = 4.0
+
+ v, err = getValueFrom[PathfindTestStruct1](s, "Sub1.Sub2.C")
+ if err != nil {
+ t.Error(err)
+ }
+
+ if v != true {
+ t.Error("v != true")
+ }
+
+ v, err = getValueFrom[PathfindTestStruct1](s, "Sub1.Sub2.Ci")
+ if err != nil {
+ t.Error(err)
+ }
+
+ if v != 2 {
+ t.Error("v != 2")
+ }
+
+ v, err = getValueFrom[PathfindTestStruct1](s, "Sub1.Sub2.Cs")
+ if err != nil {
+ t.Error(err)
+ }
+
+ if v != "3" {
+ t.Error("v != 3")
+ }
+
+ v, err = getValueFrom[PathfindTestStruct1](s, "Sub1.Sub2.Cf")
+ if err != nil {
+ t.Error(err)
+ }
+
+ if v != 4.0 {
+ t.Error("v != 4.0")
+ }
+
+ s.Sub1.Sub2.Sub3.D = true
+ s.Sub1.Sub2.Sub3.Di = 2
+ s.Sub1.Sub2.Sub3.Ds = "3"
+ s.Sub1.Sub2.Sub3.Df = 4.0
+
+ v, err = getValueFrom[PathfindTestStruct1](s, "Sub1.Sub2.Sub3.D")
+ if err != nil {
+ t.Error(err)
+
+ }
+
+ if v != true {
+ t.Error("v != true")
+ }
+
+ v, err = getValueFrom[PathfindTestStruct1](s, "Sub1.Sub2.Sub3.Di")
+ if err != nil {
+ t.Error(err)
+ }
+
+ if v != 2 {
+ t.Error("v != 2")
+ }
+
+ v, err = getValueFrom[PathfindTestStruct1](s, "Sub1.Sub2.Sub3.Ds")
+ if err != nil {
+ t.Error(err)
+ }
+
+ if v != "3" {
+ t.Error("v != 3")
+ }
+
+ v, err = getValueFrom[PathfindTestStruct1](s, "Sub1.Sub2.Sub3.Df")
+ if err != nil {
+ t.Error(err)
+ }
+
+ if v != 4.0 {
+ t.Error("v != 4.0")
+ }
+
+}
+
+func TestPathFindSetValueFrom(t *testing.T) {
+ s := &PathfindTestStruct1{}
+
+ setTheValueOverPath[*PathfindTestStruct1](s, "Sub1.B", "true")
+ setTheValueOverPath[*PathfindTestStruct1](s, "Sub1.Bi", "2")
+ setTheValueOverPath[*PathfindTestStruct1](s, "Sub1.Bs", "3")
+ setTheValueOverPath[*PathfindTestStruct1](s, "Sub1.Bf", "4.0")
+
+ if s.Sub1.B != true {
+ t.Error("s.Sub1.B != true")
+ }
+
+ if s.Sub1.Bi != 2 {
+ t.Error("s.Sub1.Bi != 2")
+
+ }
+
+ if s.Sub1.Bs != "3" {
+ t.Error("s.Sub1.Bs != 3")
+ }
+
+ if s.Sub1.Bf != 4.0 {
+ t.Error("s.Sub1.Bf != 4.0")
+ }
+
+ setTheValueOverPath[*PathfindTestStruct1](s, "Sub1.Sub2.C", "true")
+ setTheValueOverPath[*PathfindTestStruct1](s, "Sub1.Sub2.Ci", "2")
+ setTheValueOverPath[*PathfindTestStruct1](s, "Sub1.Sub2.Cs", "3")
+ setTheValueOverPath[*PathfindTestStruct1](s, "Sub1.Sub2.Cf", "4.0")
+
+ if s.Sub1.Sub2.C != true {
+ t.Error("s.Sub1.Sub2.C != true")
+
+ }
+
+ if s.Sub1.Sub2.Ci != 2 {
+ t.Error("s.Sub1.Sub2.Ci != 2")
+
+ }
+
+ if s.Sub1.Sub2.Cs != "3" {
+ t.Error("s.Sub1.Sub2.Cs != 3")
+
+ }
+
+ if s.Sub1.Sub2.Cf != 4.0 {
+ t.Error("s.Sub1.Sub2.Cf != 4.0")
+
+ }
+
+ if s.Sub1.Sub2.Sub3.D != false {
+ t.Error("s.Sub1.Sub2.Sub3.D != false")
+
+ }
+
+ setTheValueOverPath[*PathfindTestStruct1](s, "Sub1.Sub2.Sub3.D", "true")
+ setTheValueOverPath[*PathfindTestStruct1](s, "Sub1.Sub2.Sub3.Di", "2")
+ setTheValueOverPath[*PathfindTestStruct1](s, "Sub1.Sub2.Sub3.Ds", "3")
+ setTheValueOverPath[*PathfindTestStruct1](s, "Sub1.Sub2.Sub3.Df", "4.0")
+
+ if s.Sub1.Sub2.Sub3.D != true {
+ t.Error("s.Sub1.Sub2.Sub3.D != true")
+
+ }
+
+ if s.Sub1.Sub2.Sub3.Di != 2 {
+ t.Error("s.Sub1.Sub2.Sub3.Di != 2")
+
+ }
+
+ if s.Sub1.Sub2.Sub3.Ds != "3" {
+ t.Error("s.Sub1.Sub2.Sub3.Ds != 3")
+
+ }
+
+ if s.Sub1.Sub2.Sub3.Df != 4.0 {
+ t.Error("s.Sub1.Sub2.Sub3.Df != 4.0")
+
+ }
+
+}
diff --git a/readme_test.go b/readme_test.go
new file mode 100644
index 0000000000000000000000000000000000000000..c1554ba82185a058edbf4ca7ec7ff6360c34aba5
--- /dev/null
+++ b/readme_test.go
@@ -0,0 +1,33 @@
+package xflags
+
+import (
+ "github.com/stretchr/testify/assert"
+ "testing"
+)
+
+type Definition struct {
+ Verbose bool `short:"v" long:"verbose" description:"Show verbose debug information"`
+ Serve struct {
+ Host string `short:"h" long:"host" description:"Host to bind to" default:"localhost"`
+ Port int `short:"p" long:"port" description:"Port to bind to" default:"8080"`
+ } `command:"serve" description:"Run the HTTP server" call:"DoServe"`
+}
+
+func (d *Definition) DoServe(_ *setting[Definition]) {
+ // do something
+}
+
+func TestReadMeInit(t *testing.T) {
+ setting := New("test", Definition{})
+ setting.Parse([]string{"test", "-v", "serve", "-h", "localhost", "-p", "8080"})
+ setting.Execute()
+ assert.True(t, setting.definitions.Verbose)
+ assert.False(t, setting.HasErrors())
+}
+
+func TestReadMeInit2(t *testing.T) {
+ cmd := New("test", Definition{})
+ cmd.Parse([]string{"serve"})
+ assert.False(t, cmd.definitions.Verbose)
+ assert.False(t, cmd.HasErrors())
+}
diff --git a/setting.go b/setting.go
new file mode 100644
index 0000000000000000000000000000000000000000..f9c218d1dd1c534b50c4c78e468930d5a4f90234
--- /dev/null
+++ b/setting.go
@@ -0,0 +1,32 @@
+package xflags
+
+import (
+ "flag"
+ "io"
+)
+
+func (s *setting[C]) initCommands(name string) {
+ s.command = buildCommandStruct[C](s, name, "", s.config.errorHandling, []string{})
+ s.command.parseStruct(s.definitions)
+}
+
+type config struct {
+ errorHandling flag.ErrorHandling
+}
+
+type setting[C any] struct {
+ definitions C
+
+ command *cmd[C]
+
+ errors []error
+ flagOutput io.Writer
+
+ args []string
+
+ config config
+}
+
+func (s *setting[C]) GetValues() C {
+ return s.definitions
+}
diff --git a/setting_test.go b/setting_test.go
new file mode 100644
index 0000000000000000000000000000000000000000..6ca3021181d8c81db7388ee58b7790af09de8842
--- /dev/null
+++ b/setting_test.go
@@ -0,0 +1,25 @@
+package xflags
+
+import (
+ "github.com/stretchr/testify/assert"
+ "testing"
+)
+
+func TestGetValues(t *testing.T) {
+ s := &setting[CmdTest1]{
+ definitions: CmdTest1{},
+ }
+ assert.Equal(t, CmdTest1{}, s.GetValues())
+}
+
+func TestInitCommands(t *testing.T) {
+ s := &setting[CmdTest1]{
+ definitions: CmdTest1{},
+ }
+
+ s.initCommands("test")
+ assert.Equal(t, 0, len(s.errors))
+ assert.Equal(t, "test", s.command.name)
+ assert.Equal(t, 1, len(s.command.commands))
+ assert.Equal(t, 3, len(s.command.mapping))
+}
diff --git a/tags.go b/tags.go
new file mode 100644
index 0000000000000000000000000000000000000000..058019103370113aad94ea4385c414d31cbe58e7
--- /dev/null
+++ b/tags.go
@@ -0,0 +1,59 @@
+package xflags
+
+import (
+ "reflect"
+ "strconv"
+)
+
+func getTagMap(field reflect.StructField) (value map[string]string) {
+
+ tagValues := map[string]string{}
+ tag := field.Tag
+
+ // code from reflect.StructTag.Lookup
+ for tag != "" {
+ // Skip leading space.
+ i := 0
+ for i < len(tag) && tag[i] == ' ' {
+ i++
+ }
+ tag = tag[i:]
+ if tag == "" {
+ break
+ }
+
+ i = 0
+ for i < len(tag) && tag[i] > ' ' && tag[i] != ':' && tag[i] != '"' && tag[i] != 0x7f {
+ i++
+ }
+ if i == 0 || i+1 >= len(tag) || tag[i] != ':' || tag[i+1] != '"' {
+ break
+ }
+ name := string(tag[:i])
+ tag = tag[i+1:]
+
+ // Scan quoted string to find value.
+ i = 1
+ for i < len(tag) && tag[i] != '"' {
+ if tag[i] == '\\' {
+ i++
+ }
+ i++
+ }
+ if i >= len(tag) {
+ break
+ }
+ qvalue := string(tag[:i+1])
+ tag = tag[i+1:]
+
+ value, err := strconv.Unquote(qvalue)
+ if err != nil {
+ break
+ }
+
+ tagValues[name] = value
+
+ }
+
+ return tagValues
+}
diff --git a/tags_test.go b/tags_test.go
new file mode 100644
index 0000000000000000000000000000000000000000..eab10fb89d2ac54ba1999aa18de8fe4aae94e2c4
--- /dev/null
+++ b/tags_test.go
@@ -0,0 +1,31 @@
+package xflags
+
+import (
+ "github.com/stretchr/testify/assert"
+ "reflect"
+ "testing"
+)
+
+func TestGetTagMap(t *testing.T) {
+
+ type testStruct struct {
+ Verbose bool `short:"v" long:"verbose" description:"Show verbose debug information"`
+ }
+
+ m := getTagMap(reflect.TypeOf(testStruct{}).Field(0))
+ assert.Equal(t, "v", m["short"])
+ assert.Equal(t, "v", m["short"])
+ assert.Equal(t, "Show verbose debug information", m["description"])
+
+}
+
+func TestGetTagMapWithNoTags(t *testing.T) {
+
+ type testStruct struct {
+ Verbose bool
+ }
+
+ m := getTagMap(reflect.TypeOf(testStruct{}).Field(0))
+ assert.Empty(t, m)
+
+}
diff --git a/xflags.iml b/xflags.iml
index 8021953ed9f8cc6cd6d71c79462bad4cd2b5394c..49df094a939bad91c791b0986d7e479bcc496640 100644
--- a/xflags.iml
+++ b/xflags.iml
@@ -1,5 +1,6 @@
<?xml version="1.0" encoding="UTF-8"?>
<module type="WEB_MODULE" version="4">
+ <component name="Go" enabled="true" />
<component name="NewModuleRootManager" inherit-compiler-output="true">
<exclude-output />
<content url="file://$MODULE_DIR$" />