From 3b18f4dd696efed2a1861d1a54d34f908c427bbd Mon Sep 17 00:00:00 2001 From: Steffen Exler Date: Sat, 25 Feb 2023 18:16:10 +0100 Subject: [PATCH 1/8] first draft Signed-off-by: Steffen Exler --- v2/gotemplate/modules.go | 58 + v2/gotemplate/template.go | 37 + v2/modules/base/modul.go | 38 + v2/modules/base/template/README.md | 38 + v2/modules/base/template/tools.go | 16 + v2/modules/licenses/template/CODEOWNERS | 1 + v2/modules/licenses/template/LICENSE | 2142 +++++++++++++++++++++++ 7 files changed, 2330 insertions(+) create mode 100644 v2/gotemplate/modules.go create mode 100644 v2/gotemplate/template.go create mode 100644 v2/modules/base/modul.go create mode 100644 v2/modules/base/template/README.md create mode 100644 v2/modules/base/template/tools.go create mode 100644 v2/modules/licenses/template/CODEOWNERS create mode 100644 v2/modules/licenses/template/LICENSE diff --git a/v2/gotemplate/modules.go b/v2/gotemplate/modules.go new file mode 100644 index 00000000..01d16eba --- /dev/null +++ b/v2/gotemplate/modules.go @@ -0,0 +1,58 @@ +package gotemplate + +// Module represents a module that can be included in a template. +type Module interface { + // GetNextQuestion returns the next question in the module. + // If there are no more questions, it returns nil. + GetNextQuestion() *TemplateQuestion + // ReceiveResponse receives the user's response to a question. + ReceiveResponse(response TemplateOptionResponse) + // GetModuleData returns the complete module data when all questions have been answered. + GetModuleData() *ModuleData +} + +// ModuleName represents the name of a module that can be included in a template. +type ModuleName string + +// ModuleData represents a module that can be included in a template. +type ModuleData struct { + // Name is the name of the module. + Name ModuleName + // TemplatePath is the path to the template files for this module. + TemplatePath string + // TemplateFiles is a list of file paths relative to TemplatePath. + // These files will be generated when the template is generated. + TemplateFiles []string + // TemplateData is the data that will be used to generate the template for this module. + // The data can be of any type, depending on the needs of the module. + TemplateData interface{} +} + +// ModuleBase implements the Module interface. +type ModuleBase struct { + ModuleData + questions []TemplateQuestion +} + +// GetNextQuestion returns the next question in the module. +// If there are no more questions, it returns nil. +func (m *ModuleBase) GetNextQuestion() *TemplateQuestion { + if len(m.questions) == 0 { + return nil + } + question := m.questions[0] + m.questions = m.questions[1:] + return &question +} + +// ReceiveResponse receives the user's response to a question. +func (m *ModuleBase) ReceiveResponse(response TemplateOptionResponse) { +} + +// GetModule returns the complete module data when all questions have been answered. +func (m *ModuleBase) GetModule() *ModuleData { + if len(m.questions) == 0 { + return &m.ModuleData + } + return nil +} diff --git a/v2/gotemplate/template.go b/v2/gotemplate/template.go new file mode 100644 index 00000000..34884995 --- /dev/null +++ b/v2/gotemplate/template.go @@ -0,0 +1,37 @@ +package gotemplate + +// TemplateOptionName represents the name of a template option. +type TemplateOptionName string + +// TemplateOptionResponse represents the user's response to a template option. +type TemplateOptionResponse struct { + // Name is the name of the option. + Name TemplateOptionName + // Value is the user's selected value for the option. + Value interface{} +} + +// TemplateQuestion represents a single question in a module. +type TemplateQuestion struct { + // Name is the name of the question. + Name TemplateOptionName + // Description is a short description of the question. + Description string + // DefaultValue is the default value for the question. This is optional. + DefaultValue interface{} + // IsValid is a function that validates the input value for the question. This is optional. + // If the input is valid, the function should return (true, ""). + // If the input is invalid, the function should return (false, "reason why input is invalid") or (false, "") if no reason is provided. + IsValid func(value interface{}) (isValid bool, reason string) + // PredefinedValues is a list of predefined values for the question. This is optional. + // If this is set, the user will be presented with a list of predefined values to choose from instead of an input field. + PredefinedValues []interface{} +} + +// Template represents a template that can be generated. +type Template struct { + // Modules is a map of modules that can be included in the template. + // The keys in the map are the names of the modules. + // The values are the module data, including the template files and template data. + Modules map[ModuleName]Module +} diff --git a/v2/modules/base/modul.go b/v2/modules/base/modul.go new file mode 100644 index 00000000..1558960f --- /dev/null +++ b/v2/modules/base/modul.go @@ -0,0 +1,38 @@ +package base + +import "github.com/schwarzit/go-template/v2/gotemplate" + +type Module struct { + gotemplate.ModuleData + questions map[string]gotemplate.TemplateQuestion +} + +func New() Module { + return Module{ + ModuleData: gotemplate.ModuleData{ + Name: "base", + TemplatePath: "base", + TemplateFiles: []string{ + "README.md", + "LICENSE", + "Makefile", + }, + }, + questions: map[string]gotemplate.TemplateQuestion{ + "project-name": { + Name: "project-name", + Description: "Project name", + IsValid: func(value interface{}) (bool, string) { + return true, "" + }, + }, + "project-description": { + Name: "project-description", + Description: "Project description", + IsValid: func(value interface{}) (bool, string) { + return true, "" + }, + }, + }, + } +} diff --git a/v2/modules/base/template/README.md b/v2/modules/base/template/README.md new file mode 100644 index 00000000..b866442e --- /dev/null +++ b/v2/modules/base/template/README.md @@ -0,0 +1,38 @@ +# {{.Base.projectName}} + +[![GoTemplate](https://img.shields.io/badge/go/template-black?logo=go)](https://github.com/SchwarzIT/go-template) + +{{.Base.projectDescription}} + +The project uses `make` to make your life easier. If you're not familiar with Makefiles you can take a look at [this quickstart guide](https://makefiletutorial.com). + +Whenever you need help regarding the available actions, just use the following command. + +```bash +make help +``` + +## Setup + +To get your setup up and running the only thing you have to do is + +```bash +make all +``` + +This will initialize a git repo, download the dependencies in the latest versions and install all needed tools. +If needed code generation will be triggered in this target as well. + +## Test & lint + +Run linting + +```bash +make lint +``` + +Run tests + +```bash +make test +``` diff --git a/v2/modules/base/template/tools.go b/v2/modules/base/template/tools.go new file mode 100644 index 00000000..9a6bb1ae --- /dev/null +++ b/v2/modules/base/template/tools.go @@ -0,0 +1,16 @@ +// +build tools + +package main + +import ( + _ "github.com/bufbuild/buf/cmd/buf" + _ "github.com/bufbuild/buf/cmd/protoc-gen-buf-breaking" + _ "github.com/bufbuild/buf/cmd/protoc-gen-buf-lint" + _ "github.com/envoyproxy/protoc-gen-validate" + _ "google.golang.org/grpc/cmd/protoc-gen-go-grpc" + _ "google.golang.org/protobuf/cmd/protoc-gen-go" + {{- if .Extensions.grpc.grpcGateway }} + _ "github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway" + _ "github.com/google/gnostic/cmd/protoc-gen-openapi" + {{- end }} +) diff --git a/v2/modules/licenses/template/CODEOWNERS b/v2/modules/licenses/template/CODEOWNERS new file mode 100644 index 00000000..a0f353ce --- /dev/null +++ b/v2/modules/licenses/template/CODEOWNERS @@ -0,0 +1 @@ +* {{ .Extensions.openSource.codeowner }} diff --git a/v2/modules/licenses/template/LICENSE b/v2/modules/licenses/template/LICENSE new file mode 100644 index 00000000..d662bdb5 --- /dev/null +++ b/v2/modules/licenses/template/LICENSE @@ -0,0 +1,2142 @@ +{{ if eq .Extensions.openSource.license 1 }}MIT License + +Copyright (c) {{now | date "2006"}} {{ .Extensions.openSource.author }} + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. +{{ else if eq .Extensions.openSource.license 2 }} Apache License + Version 2.0, January 2004 + http://www.apache.org/licenses/ + + TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION + + 1. Definitions. + + "License" shall mean the terms and conditions for use, reproduction, + and distribution as defined by Sections 1 through 9 of this document. + + "Licensor" shall mean the copyright owner or entity authorized by + the copyright owner that is granting the License. + + "Legal Entity" shall mean the union of the acting entity and all + other entities that control, are controlled by, or are under common + control with that entity. For the purposes of this definition, + "control" means (i) the power, direct or indirect, to cause the + direction or management of such entity, whether by contract or + otherwise, or (ii) ownership of fifty percent (50%) or more of the + outstanding shares, or (iii) beneficial ownership of such entity. + + "You" (or "Your") shall mean an individual or Legal Entity + exercising permissions granted by this License. + + "Source" form shall mean the preferred form for making modifications, + including but not limited to software source code, documentation + source, and configuration files. + + "Object" form shall mean any form resulting from mechanical + transformation or translation of a Source form, including but + not limited to compiled object code, generated documentation, + and conversions to other media types. + + "Work" shall mean the work of authorship, whether in Source or + Object form, made available under the License, as indicated by a + copyright notice that is included in or attached to the work + (an example is provided in the Appendix below). + + "Derivative Works" shall mean any work, whether in Source or Object + form, that is based on (or derived from) the Work and for which the + editorial revisions, annotations, elaborations, or other modifications + represent, as a whole, an original work of authorship. For the purposes + of this License, Derivative Works shall not include works that remain + separable from, or merely link (or bind by name) to the interfaces of, + the Work and Derivative Works thereof. + + "Contribution" shall mean any work of authorship, including + the original version of the Work and any modifications or additions + to that Work or Derivative Works thereof, that is intentionally + submitted to Licensor for inclusion in the Work by the copyright owner + or by an individual or Legal Entity authorized to submit on behalf of + the copyright owner. For the purposes of this definition, "submitted" + means any form of electronic, verbal, or written communication sent + to the Licensor or its representatives, including but not limited to + communication on electronic mailing lists, source code control systems, + and issue tracking systems that are managed by, or on behalf of, the + Licensor for the purpose of discussing and improving the Work, but + excluding communication that is conspicuously marked or otherwise + designated in writing by the copyright owner as "Not a Contribution." + + "Contributor" shall mean Licensor and any individual or Legal Entity + on behalf of whom a Contribution has been received by Licensor and + subsequently incorporated within the Work. + + 2. Grant of Copyright License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + copyright license to reproduce, prepare Derivative Works of, + publicly display, publicly perform, sublicense, and distribute the + Work and such Derivative Works in Source or Object form. + + 3. Grant of Patent License. Subject to the terms and conditions of + this License, each Contributor hereby grants to You a perpetual, + worldwide, non-exclusive, no-charge, royalty-free, irrevocable + (except as stated in this section) patent license to make, have made, + use, offer to sell, sell, import, and otherwise transfer the Work, + where such license applies only to those patent claims licensable + by such Contributor that are necessarily infringed by their + Contribution(s) alone or by combination of their Contribution(s) + with the Work to which such Contribution(s) was submitted. If You + institute patent litigation against any entity (including a + cross-claim or counterclaim in a lawsuit) alleging that the Work + or a Contribution incorporated within the Work constitutes direct + or contributory patent infringement, then any patent licenses + granted to You under this License for that Work shall terminate + as of the date such litigation is filed. + + 4. Redistribution. You may reproduce and distribute copies of the + Work or Derivative Works thereof in any medium, with or without + modifications, and in Source or Object form, provided that You + meet the following conditions: + + (a) You must give any other recipients of the Work or + Derivative Works a copy of this License; and + + (b) You must cause any modified files to carry prominent notices + stating that You changed the files; and + + (c) You must retain, in the Source form of any Derivative Works + that You distribute, all copyright, patent, trademark, and + attribution notices from the Source form of the Work, + excluding those notices that do not pertain to any part of + the Derivative Works; and + + (d) If the Work includes a "NOTICE" text file as part of its + distribution, then any Derivative Works that You distribute must + include a readable copy of the attribution notices contained + within such NOTICE file, excluding those notices that do not + pertain to any part of the Derivative Works, in at least one + of the following places: within a NOTICE text file distributed + as part of the Derivative Works; within the Source form or + documentation, if provided along with the Derivative Works; or, + within a display generated by the Derivative Works, if and + wherever such third-party notices normally appear. The contents + of the NOTICE file are for informational purposes only and + do not modify the License. You may add Your own attribution + notices within Derivative Works that You distribute, alongside + or as an addendum to the NOTICE text from the Work, provided + that such additional attribution notices cannot be construed + as modifying the License. + + You may add Your own copyright statement to Your modifications and + may provide additional or different license terms and conditions + for use, reproduction, or distribution of Your modifications, or + for any such Derivative Works as a whole, provided Your use, + reproduction, and distribution of the Work otherwise complies with + the conditions stated in this License. + + 5. Submission of Contributions. Unless You explicitly state otherwise, + any Contribution intentionally submitted for inclusion in the Work + by You to the Licensor shall be under the terms and conditions of + this License, without any additional terms or conditions. + Notwithstanding the above, nothing herein shall supersede or modify + the terms of any separate license agreement you may have executed + with Licensor regarding such Contributions. + + 6. Trademarks. This License does not grant permission to use the trade + names, trademarks, service marks, or product names of the Licensor, + except as required for reasonable and customary use in describing the + origin of the Work and reproducing the content of the NOTICE file. + + 7. Disclaimer of Warranty. Unless required by applicable law or + agreed to in writing, Licensor provides the Work (and each + Contributor provides its Contributions) on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or + implied, including, without limitation, any warranties or conditions + of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A + PARTICULAR PURPOSE. You are solely responsible for determining the + appropriateness of using or redistributing the Work and assume any + risks associated with Your exercise of permissions under this License. + + 8. Limitation of Liability. In no event and under no legal theory, + whether in tort (including negligence), contract, or otherwise, + unless required by applicable law (such as deliberate and grossly + negligent acts) or agreed to in writing, shall any Contributor be + liable to You for damages, including any direct, indirect, special, + incidental, or consequential damages of any character arising as a + result of this License or out of the use or inability to use the + Work (including but not limited to damages for loss of goodwill, + work stoppage, computer failure or malfunction, or any and all + other commercial damages or losses), even if such Contributor + has been advised of the possibility of such damages. + + 9. Accepting Warranty or Additional Liability. While redistributing + the Work or Derivative Works thereof, You may choose to offer, + and charge a fee for, acceptance of support, warranty, indemnity, + or other liability obligations and/or rights consistent with this + License. However, in accepting such obligations, You may act only + on Your own behalf and on Your sole responsibility, not on behalf + of any other Contributor, and only if You agree to indemnify, + defend, and hold each Contributor harmless for any liability + incurred by, or claims asserted against, such Contributor by reason + of your accepting any such warranty or additional liability. + + END OF TERMS AND CONDITIONS + + APPENDIX: How to apply the Apache License to your work. + + To apply the Apache License to your work, attach the following + boilerplate notice, with the fields enclosed by brackets "[]" + replaced with your own identifying information. (Don't include + the brackets!) The text should be enclosed in the appropriate + comment syntax for the file format. We also recommend that a + file or class name and description of purpose be included on the + same "printed page" as the copyright notice for easier + identification within third-party archives. + + Copyright [yyyy] [name of copyright owner] + + Licensed under the Apache License, Version 2.0 (the "License"); + you may not use this file except in compliance with the License. + You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, software + distributed under the License is distributed on an "AS IS" BASIS, + WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + See the License for the specific language governing permissions and + limitations under the License. +{{ else if eq .Extensions.openSource.license 3 }} GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + 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. + + + Copyright (C) + + 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 . + +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 +. +{{ else if eq .Extensions.openSource.license 4 }} GNU GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU General Public License is a free, copyleft license for +software and other kinds of works. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +the GNU General Public License is 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. We, the Free Software Foundation, use the +GNU General Public License for most of our software; it applies also to +any other work released this way by its authors. You can apply it to +your programs, too. + + 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. + + To protect your rights, we need to prevent others from denying you +these rights or asking you to surrender the rights. Therefore, you have +certain responsibilities if you distribute copies of the software, or if +you modify it: responsibilities to respect the freedom of others. + + For example, if you distribute copies of such a program, whether +gratis or for a fee, you must pass on to the recipients the same +freedoms that you received. You must make sure that they, too, receive +or can get the source code. And you must show them these terms so they +know their rights. + + Developers that use the GNU GPL protect your rights with two steps: +(1) assert copyright on the software, and (2) offer you this License +giving you legal permission to copy, distribute and/or modify it. + + For the developers' and authors' protection, the GPL clearly explains +that there is no warranty for this free software. For both users' and +authors' sake, the GPL requires that modified versions be marked as +changed, so that their problems will not be attributed erroneously to +authors of previous versions. + + Some devices are designed to deny users access to install or run +modified versions of the software inside them, although the manufacturer +can do so. This is fundamentally incompatible with the aim of +protecting users' freedom to change the software. The systematic +pattern of such abuse occurs in the area of products for individuals to +use, which is precisely where it is most unacceptable. Therefore, we +have designed this version of the GPL to prohibit the practice for those +products. If such problems arise substantially in other domains, we +stand ready to extend this provision to those domains in future versions +of the GPL, as needed to protect the freedom of users. + + Finally, every program is threatened constantly by software patents. +States should not allow patents to restrict development and use of +software on general-purpose computers, but in those that do, we wish to +avoid the special danger that patents applied to a free program could +make it effectively proprietary. To prevent this, the GPL assures that +patents cannot be used to render the program non-free. + + 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 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. Use with the GNU Affero General Public License. + + 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 Affero 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 special requirements of the GNU Affero General Public License, +section 13, concerning interaction through a network will apply to the +combination as such. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU 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 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 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 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. + + + Copyright (C) + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU 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 General Public License for more details. + + You should have received a copy of the GNU General Public License + along with this program. If not, see . + +Also add information on how to contact you by electronic and paper mail. + + If the program does terminal interaction, make it output a short +notice like this when it starts in an interactive mode: + + Copyright (C) + This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. + This is free software, and you are welcome to redistribute it + under certain conditions; type `show c' for details. + +The hypothetical commands `show w' and `show c' should show the appropriate +parts of the General Public License. Of course, your program's commands +might be different; for a GUI interface, you would use an "about box". + + 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 GPL, see +. + + The GNU General Public License does not permit incorporating your program +into proprietary programs. If your program is a subroutine library, you +may consider it more useful to permit linking proprietary applications with +the library. If this is what you want to do, use the GNU Lesser General +Public License instead of this License. But first, please read +. +{{ else if eq .Extensions.openSource.license 5 }} GNU LESSER GENERAL PUBLIC LICENSE + Version 3, 29 June 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + + This version of the GNU Lesser General Public License incorporates +the terms and conditions of version 3 of the GNU General Public +License, supplemented by the additional permissions listed below. + + 0. Additional Definitions. + + As used herein, "this License" refers to version 3 of the GNU Lesser +General Public License, and the "GNU GPL" refers to version 3 of the GNU +General Public License. + + "The Library" refers to a covered work governed by this License, +other than an Application or a Combined Work as defined below. + + An "Application" is any work that makes use of an interface provided +by the Library, but which is not otherwise based on the Library. +Defining a subclass of a class defined by the Library is deemed a mode +of using an interface provided by the Library. + + A "Combined Work" is a work produced by combining or linking an +Application with the Library. The particular version of the Library +with which the Combined Work was made is also called the "Linked +Version". + + The "Minimal Corresponding Source" for a Combined Work means the +Corresponding Source for the Combined Work, excluding any source code +for portions of the Combined Work that, considered in isolation, are +based on the Application, and not on the Linked Version. + + The "Corresponding Application Code" for a Combined Work means the +object code and/or source code for the Application, including any data +and utility programs needed for reproducing the Combined Work from the +Application, but excluding the System Libraries of the Combined Work. + + 1. Exception to Section 3 of the GNU GPL. + + You may convey a covered work under sections 3 and 4 of this License +without being bound by section 3 of the GNU GPL. + + 2. Conveying Modified Versions. + + If you modify a copy of the Library, and, in your modifications, a +facility refers to a function or data to be supplied by an Application +that uses the facility (other than as an argument passed when the +facility is invoked), then you may convey a copy of the modified +version: + + a) under this License, provided that you make a good faith effort to + ensure that, in the event an Application does not supply the + function or data, the facility still operates, and performs + whatever part of its purpose remains meaningful, or + + b) under the GNU GPL, with none of the additional permissions of + this License applicable to that copy. + + 3. Object Code Incorporating Material from Library Header Files. + + The object code form of an Application may incorporate material from +a header file that is part of the Library. You may convey such object +code under terms of your choice, provided that, if the incorporated +material is not limited to numerical parameters, data structure +layouts and accessors, or small macros, inline functions and templates +(ten or fewer lines in length), you do both of the following: + + a) Give prominent notice with each copy of the object code that the + Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the object code with a copy of the GNU GPL and this license + document. + + 4. Combined Works. + + You may convey a Combined Work under terms of your choice that, +taken together, effectively do not restrict modification of the +portions of the Library contained in the Combined Work and reverse +engineering for debugging such modifications, if you also do each of +the following: + + a) Give prominent notice with each copy of the Combined Work that + the Library is used in it and that the Library and its use are + covered by this License. + + b) Accompany the Combined Work with a copy of the GNU GPL and this license + document. + + c) For a Combined Work that displays copyright notices during + execution, include the copyright notice for the Library among + these notices, as well as a reference directing the user to the + copies of the GNU GPL and this license document. + + d) Do one of the following: + + 0) Convey the Minimal Corresponding Source under the terms of this + License, and the Corresponding Application Code in a form + suitable for, and under terms that permit, the user to + recombine or relink the Application with a modified version of + the Linked Version to produce a modified Combined Work, in the + manner specified by section 6 of the GNU GPL for conveying + Corresponding Source. + + 1) Use a suitable shared library mechanism for linking with the + Library. A suitable mechanism is one that (a) uses at run time + a copy of the Library already present on the user's computer + system, and (b) will operate properly with a modified version + of the Library that is interface-compatible with the Linked + Version. + + e) Provide Installation Information, but only if you would otherwise + be required to provide such information under section 6 of the + GNU GPL, and only to the extent that such information is + necessary to install and execute a modified version of the + Combined Work produced by recombining or relinking the + Application with a modified version of the Linked Version. (If + you use option 4d0, the Installation Information must accompany + the Minimal Corresponding Source and Corresponding Application + Code. If you use option 4d1, you must provide the Installation + Information in the manner specified by section 6 of the GNU GPL + for conveying Corresponding Source.) + + 5. Combined Libraries. + + You may place library facilities that are a work based on the +Library side by side in a single library together with other library +facilities that are not Applications and are not covered by this +License, and convey such a combined library under terms of your +choice, if you do both of the following: + + a) Accompany the combined library with a copy of the same work based + on the Library, uncombined with any other library facilities, + conveyed under the terms of this License. + + b) Give prominent notice with the combined library that part of it + is a work based on the Library, and explaining where to find the + accompanying uncombined form of the same work. + + 6. Revised Versions of the GNU Lesser General Public License. + + The Free Software Foundation may publish revised and/or new versions +of the GNU Lesser 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 +Library as you received it specifies that a certain numbered version +of the GNU Lesser General Public License "or any later version" +applies to it, you have the option of following the terms and +conditions either of that published version or of any later version +published by the Free Software Foundation. If the Library as you +received it does not specify a version number of the GNU Lesser +General Public License, you may choose any version of the GNU Lesser +General Public License ever published by the Free Software Foundation. + + If the Library as you received it specifies that a proxy can decide +whether future versions of the GNU Lesser General Public License shall +apply, that proxy's public statement of acceptance of any version is +permanent authorization for you to choose that version for the +Library. +{{ else if eq .Extensions.openSource.license 6 }}Mozilla Public License Version 2.0 +================================== + +1. Definitions +-------------- + +1.1. "Contributor" + means each individual or legal entity that creates, contributes to + the creation of, or owns Covered Software. + +1.2. "Contributor Version" + means the combination of the Contributions of others (if any) used + by a Contributor and that particular Contributor's Contribution. + +1.3. "Contribution" + means Covered Software of a particular Contributor. + +1.4. "Covered Software" + means Source Code Form to which the initial Contributor has attached + the notice in Exhibit A, the Executable Form of such Source Code + Form, and Modifications of such Source Code Form, in each case + including portions thereof. + +1.5. "Incompatible With Secondary Licenses" + means + + (a) that the initial Contributor has attached the notice described + in Exhibit B to the Covered Software; or + + (b) that the Covered Software was made available under the terms of + version 1.1 or earlier of the License, but not also under the + terms of a Secondary License. + +1.6. "Executable Form" + means any form of the work other than Source Code Form. + +1.7. "Larger Work" + means a work that combines Covered Software with other material, in + a separate file or files, that is not Covered Software. + +1.8. "License" + means this document. + +1.9. "Licensable" + means having the right to grant, to the maximum extent possible, + whether at the time of the initial grant or subsequently, any and + all of the rights conveyed by this License. + +1.10. "Modifications" + means any of the following: + + (a) any file in Source Code Form that results from an addition to, + deletion from, or modification of the contents of Covered + Software; or + + (b) any new file in Source Code Form that contains any Covered + Software. + +1.11. "Patent Claims" of a Contributor + means any patent claim(s), including without limitation, method, + process, and apparatus claims, in any patent Licensable by such + Contributor that would be infringed, but for the grant of the + License, by the making, using, selling, offering for sale, having + made, import, or transfer of either its Contributions or its + Contributor Version. + +1.12. "Secondary License" + means either the GNU General Public License, Version 2.0, the GNU + Lesser General Public License, Version 2.1, the GNU Affero General + Public License, Version 3.0, or any later versions of those + licenses. + +1.13. "Source Code Form" + means the form of the work preferred for making modifications. + +1.14. "You" (or "Your") + means an individual or a legal entity exercising rights under this + License. For legal entities, "You" includes any entity that + controls, is controlled by, or is under common control with You. For + purposes of this definition, "control" means (a) the power, direct + or indirect, to cause the direction or management of such entity, + whether by contract or otherwise, or (b) ownership of more than + fifty percent (50%) of the outstanding shares or beneficial + ownership of such entity. + +2. License Grants and Conditions +-------------------------------- + +2.1. Grants + +Each Contributor hereby grants You a world-wide, royalty-free, +non-exclusive license: + +(a) under intellectual property rights (other than patent or trademark) + Licensable by such Contributor to use, reproduce, make available, + modify, display, perform, distribute, and otherwise exploit its + Contributions, either on an unmodified basis, with Modifications, or + as part of a Larger Work; and + +(b) under Patent Claims of such Contributor to make, use, sell, offer + for sale, have made, import, and otherwise transfer either its + Contributions or its Contributor Version. + +2.2. Effective Date + +The licenses granted in Section 2.1 with respect to any Contribution +become effective for each Contribution on the date the Contributor first +distributes such Contribution. + +2.3. Limitations on Grant Scope + +The licenses granted in this Section 2 are the only rights granted under +this License. No additional rights or licenses will be implied from the +distribution or licensing of Covered Software under this License. +Notwithstanding Section 2.1(b) above, no patent license is granted by a +Contributor: + +(a) for any code that a Contributor has removed from Covered Software; + or + +(b) for infringements caused by: (i) Your and any other third party's + modifications of Covered Software, or (ii) the combination of its + Contributions with other software (except as part of its Contributor + Version); or + +(c) under Patent Claims infringed by Covered Software in the absence of + its Contributions. + +This License does not grant any rights in the trademarks, service marks, +or logos of any Contributor (except as may be necessary to comply with +the notice requirements in Section 3.4). + +2.4. Subsequent Licenses + +No Contributor makes additional grants as a result of Your choice to +distribute the Covered Software under a subsequent version of this +License (see Section 10.2) or under the terms of a Secondary License (if +permitted under the terms of Section 3.3). + +2.5. Representation + +Each Contributor represents that the Contributor believes its +Contributions are its original creation(s) or it has sufficient rights +to grant the rights to its Contributions conveyed by this License. + +2.6. Fair Use + +This License is not intended to limit any rights You have under +applicable copyright doctrines of fair use, fair dealing, or other +equivalents. + +2.7. Conditions + +Sections 3.1, 3.2, 3.3, and 3.4 are conditions of the licenses granted +in Section 2.1. + +3. Responsibilities +------------------- + +3.1. Distribution of Source Form + +All distribution of Covered Software in Source Code Form, including any +Modifications that You create or to which You contribute, must be under +the terms of this License. You must inform recipients that the Source +Code Form of the Covered Software is governed by the terms of this +License, and how they can obtain a copy of this License. You may not +attempt to alter or restrict the recipients' rights in the Source Code +Form. + +3.2. Distribution of Executable Form + +If You distribute Covered Software in Executable Form then: + +(a) such Covered Software must also be made available in Source Code + Form, as described in Section 3.1, and You must inform recipients of + the Executable Form how they can obtain a copy of such Source Code + Form by reasonable means in a timely manner, at a charge no more + than the cost of distribution to the recipient; and + +(b) You may distribute such Executable Form under the terms of this + License, or sublicense it under different terms, provided that the + license for the Executable Form does not attempt to limit or alter + the recipients' rights in the Source Code Form under this License. + +3.3. Distribution of a Larger Work + +You may create and distribute a Larger Work under terms of Your choice, +provided that You also comply with the requirements of this License for +the Covered Software. If the Larger Work is a combination of Covered +Software with a work governed by one or more Secondary Licenses, and the +Covered Software is not Incompatible With Secondary Licenses, this +License permits You to additionally distribute such Covered Software +under the terms of such Secondary License(s), so that the recipient of +the Larger Work may, at their option, further distribute the Covered +Software under the terms of either this License or such Secondary +License(s). + +3.4. Notices + +You may not remove or alter the substance of any license notices +(including copyright notices, patent notices, disclaimers of warranty, +or limitations of liability) contained within the Source Code Form of +the Covered Software, except that You may alter any license notices to +the extent required to remedy known factual inaccuracies. + +3.5. Application of Additional Terms + +You may choose to offer, and to charge a fee for, warranty, support, +indemnity or liability obligations to one or more recipients of Covered +Software. However, You may do so only on Your own behalf, and not on +behalf of any Contributor. You must make it absolutely clear that any +such warranty, support, indemnity, or liability obligation is offered by +You alone, and You hereby agree to indemnify every Contributor for any +liability incurred by such Contributor as a result of warranty, support, +indemnity or liability terms You offer. You may include additional +disclaimers of warranty and limitations of liability specific to any +jurisdiction. + +4. Inability to Comply Due to Statute or Regulation +--------------------------------------------------- + +If it is impossible for You to comply with any of the terms of this +License with respect to some or all of the Covered Software due to +statute, judicial order, or regulation then You must: (a) comply with +the terms of this License to the maximum extent possible; and (b) +describe the limitations and the code they affect. Such description must +be placed in a text file included with all distributions of the Covered +Software under this License. Except to the extent prohibited by statute +or regulation, such description must be sufficiently detailed for a +recipient of ordinary skill to be able to understand it. + +5. Termination +-------------- + +5.1. The rights granted under this License will terminate automatically +if You fail to comply with any of its terms. However, if You become +compliant, then the rights granted under this License from a particular +Contributor are reinstated (a) provisionally, unless and until such +Contributor explicitly and finally terminates Your grants, and (b) on an +ongoing basis, if such Contributor fails to notify You of the +non-compliance by some reasonable means prior to 60 days after You have +come back into compliance. Moreover, Your grants from a particular +Contributor are reinstated on an ongoing basis if such Contributor +notifies You of the non-compliance by some reasonable means, this is the +first time You have received notice of non-compliance with this License +from such Contributor, and You become compliant prior to 30 days after +Your receipt of the notice. + +5.2. If You initiate litigation against any entity by asserting a patent +infringement claim (excluding declaratory judgment actions, +counter-claims, and cross-claims) alleging that a Contributor Version +directly or indirectly infringes any patent, then the rights granted to +You by any and all Contributors for the Covered Software under Section +2.1 of this License shall terminate. + +5.3. In the event of termination under Sections 5.1 or 5.2 above, all +end user license agreements (excluding distributors and resellers) which +have been validly granted by You or Your distributors under this License +prior to termination shall survive termination. + +************************************************************************ +* * +* 6. Disclaimer of Warranty * +* ------------------------- * +* * +* Covered Software is provided under this License on an "as is" * +* basis, without warranty of any kind, either expressed, implied, or * +* statutory, including, without limitation, warranties that the * +* Covered Software is free of defects, merchantable, fit for a * +* particular purpose or non-infringing. The entire risk as to the * +* quality and performance of the Covered Software is with You. * +* Should any Covered Software prove defective in any respect, You * +* (not any Contributor) assume the cost of any necessary servicing, * +* repair, or correction. This disclaimer of warranty constitutes an * +* essential part of this License. No use of any Covered Software is * +* authorized under this License except under this disclaimer. * +* * +************************************************************************ + +************************************************************************ +* * +* 7. Limitation of Liability * +* -------------------------- * +* * +* Under no circumstances and under no legal theory, whether tort * +* (including negligence), contract, or otherwise, shall any * +* Contributor, or anyone who distributes Covered Software as * +* permitted above, be liable to You for any direct, indirect, * +* special, incidental, or consequential damages of any character * +* including, without limitation, damages for lost profits, loss of * +* goodwill, work stoppage, computer failure or malfunction, or any * +* and all other commercial damages or losses, even if such party * +* shall have been informed of the possibility of such damages. This * +* limitation of liability shall not apply to liability for death or * +* personal injury resulting from such party's negligence to the * +* extent applicable law prohibits such limitation. Some * +* jurisdictions do not allow the exclusion or limitation of * +* incidental or consequential damages, so this exclusion and * +* limitation may not apply to You. * +* * +************************************************************************ + +8. Litigation +------------- + +Any litigation relating to this License may be brought only in the +courts of a jurisdiction where the defendant maintains its principal +place of business and such litigation shall be governed by laws of that +jurisdiction, without reference to its conflict-of-law provisions. +Nothing in this Section shall prevent a party's ability to bring +cross-claims or counter-claims. + +9. Miscellaneous +---------------- + +This License represents the complete agreement concerning the subject +matter hereof. If any provision of this License is held to be +unenforceable, such provision shall be reformed only to the extent +necessary to make it enforceable. Any law or regulation which provides +that the language of a contract shall be construed against the drafter +shall not be used to construe this License against a Contributor. + +10. Versions of the License +--------------------------- + +10.1. New Versions + +Mozilla Foundation is the license steward. Except as provided in Section +10.3, no one other than the license steward has the right to modify or +publish new versions of this License. Each version will be given a +distinguishing version number. + +10.2. Effect of New Versions + +You may distribute the Covered Software under the terms of the version +of the License under which You originally received the Covered Software, +or under the terms of any subsequent version published by the license +steward. + +10.3. Modified Versions + +If you create software not governed by this License, and you want to +create a new license for such software, you may create and use a +modified version of this License if you rename the license and remove +any references to the name of the license steward (except to note that +such modified license differs from this License). + +10.4. Distributing Source Code Form that is Incompatible With Secondary +Licenses + +If You choose to distribute Source Code Form that is Incompatible With +Secondary Licenses under the terms of this version of the License, the +notice described in Exhibit B of this License must be attached. + +Exhibit A - Source Code Form License Notice +------------------------------------------- + + This Source Code Form is subject to the terms of the Mozilla Public + License, v. 2.0. If a copy of the MPL was not distributed with this + file, You can obtain one at http://mozilla.org/MPL/2.0/. + +If it is not possible or desirable to put the notice in a particular +file, then You may include the notice in a location (such as a LICENSE +file in a relevant directory) where a recipient would be likely to look +for such a notice. + +You may add additional accurate notices of copyright ownership. + +Exhibit B - "Incompatible With Secondary Licenses" Notice +--------------------------------------------------------- + + This Source Code Form is "Incompatible With Secondary Licenses", as + defined by the Mozilla Public License, v. 2.0. +{{ else if eq .Extensions.openSource.license 7 }}Boost Software License - Version 1.0 - August 17th, 2003 + +Permission is hereby granted, free of charge, to any person or organization +obtaining a copy of the software and accompanying documentation covered by +this license (the "Software") to use, reproduce, display, distribute, +execute, and transmit the Software, and to prepare derivative works of the +Software, and to permit third-parties to whom the Software is furnished to +do so, all subject to the following: + +The copyright notices in the Software and this entire statement, including +the above license grant, this restriction and the following disclaimer, +must be included in all copies of the Software, in whole or in part, and +all derivative works of the Software, unless such copies or derivative +works are solely in the form of machine-executable object code generated by +a source language processor. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE, TITLE AND NON-INFRINGEMENT. IN NO EVENT +SHALL THE COPYRIGHT HOLDERS OR ANYONE DISTRIBUTING THE SOFTWARE BE LIABLE +FOR ANY DAMAGES OR OTHER LIABILITY, WHETHER IN CONTRACT, TORT OR OTHERWISE, +ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER +DEALINGS IN THE SOFTWARE. +{{ else if eq .Extensions.openSource.license 8 }}This is free and unencumbered software released into the public domain. + +Anyone is free to copy, modify, publish, use, compile, sell, or +distribute this software, either in source code form or as a compiled +binary, for any purpose, commercial or non-commercial, and by any +means. + +In jurisdictions that recognize copyright laws, the author or authors +of this software dedicate any and all copyright interest in the +software to the public domain. We make this dedication for the benefit +of the public at large and to the detriment of our heirs and +successors. We intend this dedication to be an overt act of +relinquishment in perpetuity of all present and future rights to this +software under copyright law. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, +EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF +MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. +IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR +OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, +ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR +OTHER DEALINGS IN THE SOFTWARE. + +For more information, please refer to {{ end -}} From 0bd7804b596ec2477fe7dabb76375447547e6327 Mon Sep 17 00:00:00 2001 From: Steffen Exler Date: Sat, 25 Feb 2023 19:11:05 +0100 Subject: [PATCH 2/8] Add tests Signed-off-by: Steffen Exler --- v2/cmd/gt/main.go | 18 +++++ v2/gotemplate/files.go | 30 +++++++ v2/gotemplate/files_test.go | 46 +++++++++++ v2/gotemplate/modules.go | 6 -- v2/gotemplate/modules_test.go | 103 +++++++++++++++++++++++++ v2/gotemplate/template.go | 10 +-- v2/gotemplate/test_files/10/20/file_21 | 0 v2/gotemplate/test_files/file_01 | 0 v2/gotemplate/test_files/file_02 | 0 v2/modules/base/modul.go | 25 +++--- 10 files changed, 213 insertions(+), 25 deletions(-) create mode 100644 v2/cmd/gt/main.go create mode 100644 v2/gotemplate/files.go create mode 100644 v2/gotemplate/files_test.go create mode 100644 v2/gotemplate/modules_test.go create mode 100644 v2/gotemplate/test_files/10/20/file_21 create mode 100644 v2/gotemplate/test_files/file_01 create mode 100644 v2/gotemplate/test_files/file_02 diff --git a/v2/cmd/gt/main.go b/v2/cmd/gt/main.go new file mode 100644 index 00000000..b834b4b5 --- /dev/null +++ b/v2/cmd/gt/main.go @@ -0,0 +1,18 @@ +package main + +import ( + "fmt" + + "github.com/schwarzit/go-template/v2/modules/base" +) + +func main() { + fmt.Println("Hello, World!") + + m, err := base.New() + if err != nil { + panic(err) + } + + fmt.Println(m.TemplateFiles) +} diff --git a/v2/gotemplate/files.go b/v2/gotemplate/files.go new file mode 100644 index 00000000..a488ca00 --- /dev/null +++ b/v2/gotemplate/files.go @@ -0,0 +1,30 @@ +package gotemplate + +import ( + "os" + "path/filepath" +) + +// FindFiles returns a slice of strings representing the file paths of all files in the +// directory tree rooted at the specified path. Directories are skipped. +// If any error occurs while traversing the directory tree, it is returned. +func FindFiles(path string) ([]string, error) { + var files []string + + err := filepath.Walk(path, func(filePath string, info os.FileInfo, err error) error { + if err != nil { + return err + } + if info.IsDir() { + return nil + } + files = append(files, filePath) + return nil + }) + + if err != nil { + return nil, err + } + + return files, nil +} diff --git a/v2/gotemplate/files_test.go b/v2/gotemplate/files_test.go new file mode 100644 index 00000000..0c7edf3f --- /dev/null +++ b/v2/gotemplate/files_test.go @@ -0,0 +1,46 @@ +package gotemplate + +import ( + "reflect" + "testing" +) + +func TestFindFiles(t *testing.T) { + type args struct { + path string + } + tests := []struct { + name string + args args + want []string + wantErr bool + }{ + { + name: "FindFiles", + args: args{path: "test_files"}, + want: []string{ + "test_files/10/20/file_21", + "test_files/file_01", + "test_files/file_02", + }, + wantErr: false, + }, + { + name: "Invalid Folder", + args: args{path: "invlaid/folder"}, + wantErr: true, + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + got, err := FindFiles(tt.args.path) + if (err != nil) != tt.wantErr { + t.Errorf("FindFiles() error = %v, wantErr %v", err, tt.wantErr) + return + } + if !reflect.DeepEqual(got, tt.want) { + t.Errorf("FindFiles() = %v, want %v", got, tt.want) + } + }) + } +} diff --git a/v2/gotemplate/modules.go b/v2/gotemplate/modules.go index 01d16eba..68f6a243 100644 --- a/v2/gotemplate/modules.go +++ b/v2/gotemplate/modules.go @@ -5,8 +5,6 @@ type Module interface { // GetNextQuestion returns the next question in the module. // If there are no more questions, it returns nil. GetNextQuestion() *TemplateQuestion - // ReceiveResponse receives the user's response to a question. - ReceiveResponse(response TemplateOptionResponse) // GetModuleData returns the complete module data when all questions have been answered. GetModuleData() *ModuleData } @@ -45,10 +43,6 @@ func (m *ModuleBase) GetNextQuestion() *TemplateQuestion { return &question } -// ReceiveResponse receives the user's response to a question. -func (m *ModuleBase) ReceiveResponse(response TemplateOptionResponse) { -} - // GetModule returns the complete module data when all questions have been answered. func (m *ModuleBase) GetModule() *ModuleData { if len(m.questions) == 0 { diff --git a/v2/gotemplate/modules_test.go b/v2/gotemplate/modules_test.go new file mode 100644 index 00000000..8bf0fa01 --- /dev/null +++ b/v2/gotemplate/modules_test.go @@ -0,0 +1,103 @@ +package gotemplate + +import ( + "reflect" + "testing" +) + +func TestModuleBase_GetNextQuestion(t *testing.T) { + type fields struct { + ModuleData ModuleData + questions []TemplateQuestion + } + tests := []struct { + name string + fields fields + want *TemplateQuestion + }{ + { + name: "get first question", + fields: fields{ + questions: []TemplateQuestion{ + { + Name: "project-1", + }, + { + Name: "project-2", + }, + }, + }, + want: &TemplateQuestion{ + Name: "project-1", + }, + }, + { + name: "no question left", + fields: fields{ + questions: []TemplateQuestion{}, + }, + want: nil, + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + m := &ModuleBase{ + ModuleData: tt.fields.ModuleData, + questions: tt.fields.questions, + } + if got := m.GetNextQuestion(); !reflect.DeepEqual(got, tt.want) { + t.Errorf("ModuleBase.GetNextQuestion() = %v, want %v", got, tt.want) + } + }) + } +} + +func TestModuleBase_GetModule(t *testing.T) { + type fields struct { + ModuleData ModuleData + questions []TemplateQuestion + } + tests := []struct { + name string + fields fields + want *ModuleData + }{ + { + name: "no question left", + fields: fields{ + ModuleData: ModuleData{ + Name: "project-1", + }, + questions: []TemplateQuestion{}, + }, + want: &ModuleData{ + Name: "project-1", + }, + }, + { + name: "still questions left", + fields: fields{ + ModuleData: ModuleData{ + Name: "project-1", + }, + questions: []TemplateQuestion{ + { + Name: "project-1", + }, + }, + }, + want: nil, + }, + } + for _, tt := range tests { + t.Run(tt.name, func(t *testing.T) { + m := &ModuleBase{ + ModuleData: tt.fields.ModuleData, + questions: tt.fields.questions, + } + if got := m.GetModule(); !reflect.DeepEqual(got, tt.want) { + t.Errorf("ModuleBase.GetModule() = %v, want %v", got, tt.want) + } + }) + } +} diff --git a/v2/gotemplate/template.go b/v2/gotemplate/template.go index 34884995..95b16f86 100644 --- a/v2/gotemplate/template.go +++ b/v2/gotemplate/template.go @@ -3,14 +3,6 @@ package gotemplate // TemplateOptionName represents the name of a template option. type TemplateOptionName string -// TemplateOptionResponse represents the user's response to a template option. -type TemplateOptionResponse struct { - // Name is the name of the option. - Name TemplateOptionName - // Value is the user's selected value for the option. - Value interface{} -} - // TemplateQuestion represents a single question in a module. type TemplateQuestion struct { // Name is the name of the question. @@ -26,6 +18,8 @@ type TemplateQuestion struct { // PredefinedValues is a list of predefined values for the question. This is optional. // If this is set, the user will be presented with a list of predefined values to choose from instead of an input field. PredefinedValues []interface{} + // ResponseValue is the value that the user provided in response to the question. This is optional. + ResponseValue *string } // Template represents a template that can be generated. diff --git a/v2/gotemplate/test_files/10/20/file_21 b/v2/gotemplate/test_files/10/20/file_21 new file mode 100644 index 00000000..e69de29b diff --git a/v2/gotemplate/test_files/file_01 b/v2/gotemplate/test_files/file_01 new file mode 100644 index 00000000..e69de29b diff --git a/v2/gotemplate/test_files/file_02 b/v2/gotemplate/test_files/file_02 new file mode 100644 index 00000000..e69de29b diff --git a/v2/modules/base/modul.go b/v2/modules/base/modul.go index 1558960f..837b1e7b 100644 --- a/v2/modules/base/modul.go +++ b/v2/modules/base/modul.go @@ -1,22 +1,25 @@ package base -import "github.com/schwarzit/go-template/v2/gotemplate" +import ( + "github.com/schwarzit/go-template/v2/gotemplate" +) type Module struct { gotemplate.ModuleData questions map[string]gotemplate.TemplateQuestion } -func New() Module { - return Module{ +func New() (*Module, error) { + files, err := gotemplate.FindFiles("v2/modules/base/template") + if err != nil { + return nil, err + } + + return &Module{ ModuleData: gotemplate.ModuleData{ - Name: "base", - TemplatePath: "base", - TemplateFiles: []string{ - "README.md", - "LICENSE", - "Makefile", - }, + Name: "base", + TemplatePath: "v2/modules/base/template", + TemplateFiles: files, }, questions: map[string]gotemplate.TemplateQuestion{ "project-name": { @@ -34,5 +37,5 @@ func New() Module { }, }, }, - } + }, nil } From 461919964125a613dab0d39dbaea888d8b70d7c6 Mon Sep 17 00:00:00 2001 From: Steffen Exler Date: Sun, 26 Feb 2023 12:48:55 +0100 Subject: [PATCH 3/8] Create working setup Signed-off-by: Steffen Exler --- .vscode/launch.json | 16 +++ go.mod | 21 +++- go.sum | 54 ++++++++- nix/gomod2nix.toml | 51 +++++++-- v2/cmd/gt/main.go | 18 ++- v2/gotemplate/modules.go | 30 +++-- v2/gotemplate/modules_test.go | 202 +++++++++++++++++----------------- v2/gotemplate/template.go | 122 ++++++++++++++++++-- v2/gotemplate/view.go | 13 +++ v2/gotemplate/view_bubble.go | 57 ++++++++++ v2/modules/base/modul.go | 29 ++--- 11 files changed, 459 insertions(+), 154 deletions(-) create mode 100644 .vscode/launch.json create mode 100644 v2/gotemplate/view.go create mode 100644 v2/gotemplate/view_bubble.go diff --git a/.vscode/launch.json b/.vscode/launch.json new file mode 100644 index 00000000..7b31d3c0 --- /dev/null +++ b/.vscode/launch.json @@ -0,0 +1,16 @@ +{ + // Use IntelliSense to learn about possible attributes. + // Hover to view descriptions of existing attributes. + // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387 + "version": "0.2.0", + "configurations": [ + { + "name": "V2 gt", + "type": "go", + "request": "launch", + "mode": "auto", + "program": "${workspaceFolder}/v2/cmd/gt/main.go", + "cwd": "${workspaceFolder}", + } + ] +} diff --git a/go.mod b/go.mod index 0acf01fb..10c739c1 100644 --- a/go.mod +++ b/go.mod @@ -5,8 +5,10 @@ go 1.19 require ( github.com/Masterminds/semver/v3 v3.2.0 github.com/Masterminds/sprig/v3 v3.2.3 + github.com/charmbracelet/bubbles v0.15.0 + github.com/charmbracelet/bubbletea v0.23.2 github.com/google/go-github/v50 v50.0.0 - github.com/muesli/termenv v0.13.0 + github.com/muesli/termenv v0.14.0 github.com/pkg/errors v0.9.1 github.com/spf13/cobra v1.6.1 github.com/stretchr/testify v1.8.1 @@ -15,7 +17,9 @@ require ( require ( github.com/Masterminds/goutils v1.1.1 // indirect - github.com/aymanbagabas/go-osc52 v1.0.3 // indirect + github.com/aymanbagabas/go-osc52 v1.2.2 // indirect + github.com/charmbracelet/lipgloss v0.6.0 // indirect + github.com/containerd/console v1.0.3 // indirect github.com/davecgh/go-spew v1.1.1 // indirect github.com/golang/protobuf v1.3.2 // indirect github.com/google/go-querystring v1.1.0 // indirect @@ -24,18 +28,25 @@ require ( github.com/imdario/mergo v0.3.12 // indirect github.com/inconshreveable/mousetrap v1.0.1 // indirect github.com/lucasb-eyer/go-colorful v1.2.0 // indirect - github.com/mattn/go-isatty v0.0.16 // indirect + github.com/mattn/go-isatty v0.0.17 // indirect + github.com/mattn/go-localereader v0.0.1 // indirect github.com/mattn/go-runewidth v0.0.14 // indirect github.com/mitchellh/copystructure v1.2.0 // indirect github.com/mitchellh/reflectwalk v1.0.2 // indirect + github.com/muesli/ansi v0.0.0-20221106050444-61f0cd9a192a // indirect + github.com/muesli/cancelreader v0.2.2 // indirect + github.com/muesli/reflow v0.3.0 // indirect github.com/pmezard/go-difflib v1.0.0 // indirect - github.com/rivo/uniseg v0.2.0 // indirect + github.com/rivo/uniseg v0.4.4 // indirect github.com/shopspring/decimal v1.2.0 // indirect github.com/spf13/cast v1.4.1 // indirect github.com/spf13/pflag v1.0.5 // indirect golang.org/x/crypto v0.3.0 // indirect golang.org/x/net v0.2.0 // indirect golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be // indirect - golang.org/x/sys v0.2.0 // indirect + golang.org/x/sync v0.1.0 // indirect + golang.org/x/sys v0.5.0 // indirect + golang.org/x/term v0.5.0 // indirect + golang.org/x/text v0.7.0 // indirect google.golang.org/appengine v1.6.7 // indirect ) diff --git a/go.sum b/go.sum index b92749ac..d4c7772b 100644 --- a/go.sum +++ b/go.sum @@ -4,8 +4,21 @@ github.com/Masterminds/semver/v3 v3.2.0 h1:3MEsd0SM6jqZojhjLWWeBY+Kcjy9i6MQAeY7Y github.com/Masterminds/semver/v3 v3.2.0/go.mod h1:qvl/7zhW3nngYb5+80sSMF+FG2BjYrf8m9wsX0PNOMQ= github.com/Masterminds/sprig/v3 v3.2.3 h1:eL2fZNezLomi0uOLqjQoN6BfsDD+fyLtgbJMAj9n6YA= github.com/Masterminds/sprig/v3 v3.2.3/go.mod h1:rXcFaZ2zZbLRJv/xSysmlgIM1u11eBaRMhvYXJNkGuM= -github.com/aymanbagabas/go-osc52 v1.0.3 h1:DTwqENW7X9arYimJrPeGZcV0ln14sGMt3pHZspWD+Mg= +github.com/atotto/clipboard v0.1.4/go.mod h1:ZY9tmq7sm5xIbd9bOK4onWV4S6X0u6GY7Vn0Yu86PYI= github.com/aymanbagabas/go-osc52 v1.0.3/go.mod h1:zT8H+Rk4VSabYN90pWyugflM3ZhpTZNC7cASDfUCdT4= +github.com/aymanbagabas/go-osc52 v1.2.1/go.mod h1:zT8H+Rk4VSabYN90pWyugflM3ZhpTZNC7cASDfUCdT4= +github.com/aymanbagabas/go-osc52 v1.2.2 h1:NT7wkhEhPTcKnBCdPi9djmyy9L3JOL4+3SsfJyqptCo= +github.com/aymanbagabas/go-osc52 v1.2.2/go.mod h1:zT8H+Rk4VSabYN90pWyugflM3ZhpTZNC7cASDfUCdT4= +github.com/charmbracelet/bubbles v0.15.0 h1:c5vZ3woHV5W2b8YZI1q7v4ZNQaPetfHuoHzx+56Z6TI= +github.com/charmbracelet/bubbles v0.15.0/go.mod h1:Y7gSFbBzlMpUDR/XM9MhZI374Q+1p1kluf1uLl8iK74= +github.com/charmbracelet/bubbletea v0.23.1/go.mod h1:JAfGK/3/pPKHTnAS8JIE2u9f61BjWTQY57RbT25aMXU= +github.com/charmbracelet/bubbletea v0.23.2 h1:vuUJ9HJ7b/COy4I30e8xDVQ+VRDUEFykIjryPfgsdps= +github.com/charmbracelet/bubbletea v0.23.2/go.mod h1:FaP3WUivcTM0xOKNmhciz60M6I+weYLF76mr1JyI7sM= +github.com/charmbracelet/harmonica v0.2.0/go.mod h1:KSri/1RMQOZLbw7AHqgcBycp8pgJnQMYYT8QZRqZ1Ao= +github.com/charmbracelet/lipgloss v0.6.0 h1:1StyZB9vBSOyuZxQUcUwGr17JmojPNm87inij9N3wJY= +github.com/charmbracelet/lipgloss v0.6.0/go.mod h1:tHh2wr34xcHjC2HCXIlGSG1jaDF0S0atAUvBMP6Ppuk= +github.com/containerd/console v1.0.3 h1:lIr7SlA5PxZyMV30bDW0MGbiOPXwc63yRuCP0ARubLw= +github.com/containerd/console v1.0.3/go.mod h1:7LqA/THxQ86k76b8c/EMSiaJ3h1eZkMkXar0TQ1gf3U= github.com/cpuguy83/go-md2man/v2 v2.0.2/go.mod h1:tgQtvFlXSQOSOSIRvRPT7W67SCa46tRHOmNcaadrF8o= 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= @@ -29,10 +42,18 @@ github.com/imdario/mergo v0.3.12 h1:b6R2BslTbIEToALKP7LxUvijTsNI9TAe80pLWN2g/HU= github.com/imdario/mergo v0.3.12/go.mod h1:jmQim1M+e3UYxmgPu/WyfjB3N3VflVyUjjjwH0dnCYA= github.com/inconshreveable/mousetrap v1.0.1 h1:U3uMjPSQEBMNp1lFxmllqCPM6P5u/Xq7Pgzkat/bFNc= github.com/inconshreveable/mousetrap v1.0.1/go.mod h1:vpF70FUmC8bwa3OWnCshd2FqLfsEA9PFc4w1p2J65bw= +github.com/kylelemons/godebug v1.1.0/go.mod h1:9/0rRGxNHcop5bhtWyNeEfOS8JIWk580+fNqagV/RAw= github.com/lucasb-eyer/go-colorful v1.2.0 h1:1nnpGOrhyZZuNyfu1QjKiUICQ74+3FNCN69Aj6K7nkY= github.com/lucasb-eyer/go-colorful v1.2.0/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0= -github.com/mattn/go-isatty v0.0.16 h1:bq3VjFmv/sOjHtdEhmkEV4x1AJtvUvOJ2PFAZ5+peKQ= +github.com/mattn/go-isatty v0.0.14/go.mod h1:7GGIvUiUoEMVVmxf/4nioHXj79iQHKdU27kJ6hsGG94= github.com/mattn/go-isatty v0.0.16/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM= +github.com/mattn/go-isatty v0.0.17 h1:BTarxUcIeDqL27Mc+vyvdWYSL28zpIhv3RoTdsLMPng= +github.com/mattn/go-isatty v0.0.17/go.mod h1:kYGgaQfpe5nmfYZH+SKPsOc2e4SrIfOl2e/yFXSvRLM= +github.com/mattn/go-localereader v0.0.1 h1:ygSAOl7ZXTx4RdPYinUpg6W99U8jWvWi9Ye2JC/oIi4= +github.com/mattn/go-localereader v0.0.1/go.mod h1:8fBrzywKY7BI3czFoHkuzRoWE9C+EiG4R1k4Cjx5p88= +github.com/mattn/go-runewidth v0.0.10/go.mod h1:RAqKPSqVFrSLVXbA8x7dzmKdmGzieGRCM46jaSJTDAk= +github.com/mattn/go-runewidth v0.0.12/go.mod h1:RAqKPSqVFrSLVXbA8x7dzmKdmGzieGRCM46jaSJTDAk= +github.com/mattn/go-runewidth v0.0.13/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w= github.com/mattn/go-runewidth v0.0.14 h1:+xnbZSEeDbOIg5/mE6JF0w6n9duR1l3/WmbinWVwUuU= github.com/mattn/go-runewidth v0.0.14/go.mod h1:Jdepj2loyihRzMpdS35Xk/zdY8IAYHsh153qUoGf23w= github.com/mitchellh/copystructure v1.0.0/go.mod h1:SNtv71yrdKgLRyLFxmLdkAbkKEFWgYaq1OVrnRcwhnw= @@ -41,15 +62,28 @@ github.com/mitchellh/copystructure v1.2.0/go.mod h1:qLl+cE2AmVv+CoeAwDPye/v+N2HK github.com/mitchellh/reflectwalk v1.0.0/go.mod h1:mSTlrgnPZtwu0c4WaC2kGObEpuNDbx0jmZXqmk4esnw= github.com/mitchellh/reflectwalk v1.0.2 h1:G2LzWKi524PWgd3mLHV8Y5k7s6XUvT0Gef6zxSIeXaQ= github.com/mitchellh/reflectwalk v1.0.2/go.mod h1:mSTlrgnPZtwu0c4WaC2kGObEpuNDbx0jmZXqmk4esnw= -github.com/muesli/termenv v0.13.0 h1:wK20DRpJdDX8b7Ek2QfhvqhRQFZ237RGRO0RQ/Iqdy0= +github.com/muesli/ansi v0.0.0-20211018074035-2e021307bc4b/go.mod h1:fQuZ0gauxyBcmsdE3ZT4NasjaRdxmbCS0jRHsrWu3Ho= +github.com/muesli/ansi v0.0.0-20221106050444-61f0cd9a192a h1:jlDOeO5TU0pYlbc/y6PFguab5IjANI0Knrpg3u/ton4= +github.com/muesli/ansi v0.0.0-20221106050444-61f0cd9a192a/go.mod h1:CJlz5H+gyd6CUWT45Oy4q24RdLyn7Md9Vj2/ldJBSIo= +github.com/muesli/cancelreader v0.2.2 h1:3I4Kt4BQjOR54NavqnDogx/MIoWBFa0StPA8ELUXHmA= +github.com/muesli/cancelreader v0.2.2/go.mod h1:3XuTXfFS2VjM+HTLZY9Ak0l6eUKfijIfMUZ4EgX0QYo= +github.com/muesli/reflow v0.2.1-0.20210115123740-9e1d0d53df68/go.mod h1:Xk+z4oIWdQqJzsxyjgl3P22oYZnHdZ8FFTHAQQt5BMQ= +github.com/muesli/reflow v0.3.0 h1:IFsN6K9NfGtjeggFP+68I4chLZV2yIKsXJFNZ+eWh6s= +github.com/muesli/reflow v0.3.0/go.mod h1:pbwTDkVPibjO2kyvBQRBxTWEEGDGq0FlB1BIKtnHY/8= +github.com/muesli/termenv v0.11.1-0.20220204035834-5ac8409525e0/go.mod h1:Bd5NYQ7pd+SrtBSrSNoBBmXlcY8+Xj4BMJgh8qcZrvs= github.com/muesli/termenv v0.13.0/go.mod h1:sP1+uffeLaEYpyOTb8pLCUctGcGLnoFjSn4YJK5e2bc= +github.com/muesli/termenv v0.14.0 h1:8x9NFfOe8lmIWK4pgy3IfVEy47f+ppe3tUqdPZG2Uy0= +github.com/muesli/termenv v0.14.0/go.mod h1:kG/pF1E7fh949Xhe156crRUrHNyK221IuGO7Ez60Uc8= github.com/pkg/errors v0.9.1 h1:FEBLx1zS214owpjy7qsBeixbURkuhQAwrK5UwLGTwt4= github.com/pkg/errors v0.9.1/go.mod h1:bwawxfHBFNV+L2hUp1rHADufV3IMtnDRdf1r5NINEl0= 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/rivo/uniseg v0.2.0 h1:S1pD9weZBuJdFmowNwbpi7BJ8TNftyUImj/0WQi72jY= +github.com/rivo/uniseg v0.1.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc= github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc= +github.com/rivo/uniseg v0.4.4 h1:8TfxU8dW6PdqD27gjM8MVNuicgxIjxpm4K7x4jp8sis= +github.com/rivo/uniseg v0.4.4/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88= github.com/russross/blackfriday/v2 v2.1.0/go.mod h1:+Rmxgy9KzJVeS9/2gXHxylqXiyQDYRxCVz55jmeOWTM= +github.com/sahilm/fuzzy v0.1.0/go.mod h1:VFvziUEIMCrT6A6tw2RFIXPXXmzXbOsSHF0DOI8ZK9Y= github.com/shopspring/decimal v1.2.0 h1:abSATXmQEYyShuxI4/vyW3tV1MrKAJzCZ/0zLUXYbsQ= github.com/shopspring/decimal v1.2.0/go.mod h1:DKyhrW/HYNuLGql+MJL6WCR6knT2jwCFRcu2hWCYk4o= github.com/spf13/cast v1.3.1/go.mod h1:Qx5cxh0v+4UWYiBimWS+eyWzqEqokIECu5etghLkUJE= @@ -84,22 +118,32 @@ golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be h1:vEDujvNQGv4jgYKudGeI/+ golang.org/x/oauth2 v0.0.0-20180821212333-d2e6202438be/go.mod h1:N/0e6XlmueqKjAGxoOufVs8QHGRruUQn6yWY3a++T0U= golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= +golang.org/x/sync v0.1.0 h1:wsuoTGHzEhffawBOhz5CYhcrV4IdKZbEyZjBMuTp12o= +golang.org/x/sync v0.1.0/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= +golang.org/x/sys v0.0.0-20210124154548-22da62e12c0c/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= golang.org/x/sys v0.0.0-20210615035016-665e8c7367d1/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20210630005230-0f9fa26af87c/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.0.0-20220204135822-1c1b9b1eba6a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220520151302-bc2c85ada10a/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220722155257-8c9f86f7a55f/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/sys v0.0.0-20220811171246-fbc7d0a398ab/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/sys v0.2.0 h1:ljd4t30dBnAvMZaQCevtY0xLLD0A+bRZXbgLMLU1F/A= golang.org/x/sys v0.2.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= +golang.org/x/sys v0.5.0 h1:MUK/U/4lj1t1oPg0HfuXDN/Z1wv31ZJ/YcPiGccS4DU= +golang.org/x/sys v0.5.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= golang.org/x/term v0.0.0-20210927222741-03fcf44c2211/go.mod h1:jbD1KX2456YbFQfuXm/mYQcufACuNUgVhRMnK/tPxf8= golang.org/x/term v0.2.0/go.mod h1:TVmDHMZPmdnySmBfhjOoOdhjzdE1h4u1VwSiw2l1Nuc= +golang.org/x/term v0.5.0 h1:n2a8QNdAb0sZNpU9R1ALUXBbY+w51fCQDN+7EdxNBsY= +golang.org/x/term v0.5.0/go.mod h1:jMB1sMXY+tzblOD4FWmEbocvup2/aLOaQEp7JmGp78k= golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= golang.org/x/text v0.3.2/go.mod h1:bEr9sfX3Q8Zfm5fL9x+3itogRgK3+ptLWKqgva+5dAk= golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= golang.org/x/text v0.4.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= +golang.org/x/text v0.7.0 h1:4BRB4x83lYWy72KwLD/qYDuTu7q9PjSagHvijDw7cLo= +golang.org/x/text v0.7.0/go.mod h1:mrYo+phRRbMaCq/xk9113O4dZlRixOauAjOtrjsXDZ8= golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= golang.org/x/tools v0.1.12/go.mod h1:hNGJHUnrk76NpqgfD5Aqm5Crs+Hm0VOH/i9J2+nxYbc= diff --git a/nix/gomod2nix.toml b/nix/gomod2nix.toml index 03872049..5101f4dc 100644 --- a/nix/gomod2nix.toml +++ b/nix/gomod2nix.toml @@ -11,8 +11,20 @@ schema = 3 version = "v3.2.3" hash = "sha256-1GLZic3WQIBZGyjvyHbfcZ/7EV7oNzNhkwEiiTpVfL4=" [mod."github.com/aymanbagabas/go-osc52"] + version = "v1.2.2" + hash = "sha256-zuw3/3Q/ikIEC6yng1fLztEoAj/WzITAXU3wsSmHLnk=" + [mod."github.com/charmbracelet/bubbles"] + version = "v0.15.0" + hash = "sha256-DyphnjmsV0+sXdhXcjP/4t5pKqDFokKyqEcMCnK1mTw=" + [mod."github.com/charmbracelet/bubbletea"] + version = "v0.23.2" + hash = "sha256-ZIjkMtD5izq+8h5F6Po3FER28hS5Rh1hJsKozoinMX8=" + [mod."github.com/charmbracelet/lipgloss"] + version = "v0.6.0" + hash = "sha256-etQYdwy833o3Tp5zIatq0C6UFpInD2Fwk/WH8AtHRaY=" + [mod."github.com/containerd/console"] version = "v1.0.3" - hash = "sha256-+PPvxpq4eEcolG77a9g3r5Tw67Zs7hDOXS3nOYnizBQ=" + hash = "sha256-4p4u/rS7G4KKbIcZaVMqE1OtSoNlOpmcYFwO0ZEH/V0=" [mod."github.com/davecgh/go-spew"] version = "v1.1.1" hash = "sha256-nhzSUrE1fCkN0+RL04N4h8jWmRFPPPWbCuDc7Ss0akI=" @@ -41,8 +53,11 @@ schema = 3 version = "v1.2.0" hash = "sha256-Gg9dDJFCTaHrKHRR1SrJgZ8fWieJkybljybkI9x0gyE=" [mod."github.com/mattn/go-isatty"] - version = "v0.0.16" - hash = "sha256-YMaPZvShDfA98vqw1+zWWl7M1IT4nHPGBrAt7kHo8Iw=" + version = "v0.0.17" + hash = "sha256-c1u9eiMF9wLXgGvPTB5DH6S8uuCPqWZJTa6tCGuB3Ek=" + [mod."github.com/mattn/go-localereader"] + version = "v0.0.1" + hash = "sha256-JlWckeGaWG+bXK8l8WEdZqmSiTwCA8b1qbmBKa/Fj3E=" [mod."github.com/mattn/go-runewidth"] version = "v0.0.14" hash = "sha256-O3QdxqAcJgQ+HL1v8oBA4iKBwJ2AlDN+F464027hWMU=" @@ -52,9 +67,18 @@ schema = 3 [mod."github.com/mitchellh/reflectwalk"] version = "v1.0.2" hash = "sha256-VX9DPqChm7jPnyrA3RAYgxAFrAhj7TRKIWD/qR9Zr9s=" + [mod."github.com/muesli/ansi"] + version = "v0.0.0-20221106050444-61f0cd9a192a" + hash = "sha256-OLR5j8vW+7kd8Bh4OCrBMXnu1v/F68wqNXz/Udn7eXg=" + [mod."github.com/muesli/cancelreader"] + version = "v0.2.2" + hash = "sha256-uEPpzwRJBJsQWBw6M71FDfgJuR7n55d/7IV8MO+rpwQ=" + [mod."github.com/muesli/reflow"] + version = "v0.3.0" + hash = "sha256-Pou2ybE9SFSZG6YfZLVV1Eyfm+X4FuVpDPLxhpn47Cc=" [mod."github.com/muesli/termenv"] - version = "v0.13.0" - hash = "sha256-0KO2SSfj4J6Q3rXMohV+hnncUHiY7nAWU8hUbDQkLHA=" + version = "v0.14.0" + hash = "sha256-EOrn9W60qGFWLdIfKcnhtiPGRpptcQpjglg5qCyWLOo=" [mod."github.com/pkg/errors"] version = "v0.9.1" hash = "sha256-mNfQtcrQmu3sNg/7IwiieKWOgFQOVVe2yXgKBpe/wZw=" @@ -62,8 +86,8 @@ schema = 3 version = "v1.0.0" hash = "sha256-/FtmHnaGjdvEIKAJtrUfEhV7EVo5A/eYrtdnUkuxLDA=" [mod."github.com/rivo/uniseg"] - version = "v0.2.0" - hash = "sha256-GLj0jiGrT03Ept4V6FXCN1yeZ/b6PpS3MEXK6rYQ8Eg=" + version = "v0.4.4" + hash = "sha256-B8tbL9K6ICLdm0lEhs9+h4cpjAfvFtNiFMGvQZmw0bM=" [mod."github.com/shopspring/decimal"] version = "v1.2.0" hash = "sha256-f4Sk7p3S4ClpJN9sfm5MOJhWftcXrGgpX2ArRLt8TBg=" @@ -88,9 +112,18 @@ schema = 3 [mod."golang.org/x/oauth2"] version = "v0.0.0-20180821212333-d2e6202438be" hash = "sha256-x0Lvhts17qZLPpt43EuNzUXcKJ6krpGWLYiA0Fw5dnE=" + [mod."golang.org/x/sync"] + version = "v0.1.0" + hash = "sha256-Hygjq9euZ0qz6TvHYQwOZEjNiTbTh1nSLRAWZ6KFGR8=" [mod."golang.org/x/sys"] - version = "v0.2.0" - hash = "sha256-N6yfQH7R2gfcvyWTQZbxWuSNyVy6hAxiab2WFzgAykI=" + version = "v0.5.0" + hash = "sha256-0LTr3KeJ1OMQAwYUQo1513dXJtQAJn5Dq8sFkc8ps1U=" + [mod."golang.org/x/term"] + version = "v0.5.0" + hash = "sha256-f3DiX7NkDsEZpPS+PbmnOH9F5WHFZ1sQrfFg/T2UPno=" + [mod."golang.org/x/text"] + version = "v0.7.0" + hash = "sha256-ydgUqX+t5Qke16C6d3FP/06U/N1n+rUKpLRFj4KXjwk=" [mod."google.golang.org/appengine"] version = "v1.6.7" hash = "sha256-zIxGRHiq4QBvRqkrhMGMGCaVL4iM4TtlYpAi/hrivS4=" diff --git a/v2/cmd/gt/main.go b/v2/cmd/gt/main.go index b834b4b5..985075e6 100644 --- a/v2/cmd/gt/main.go +++ b/v2/cmd/gt/main.go @@ -1,18 +1,26 @@ package main import ( - "fmt" - + "github.com/schwarzit/go-template/v2/gotemplate" "github.com/schwarzit/go-template/v2/modules/base" ) func main() { - fmt.Println("Hello, World!") - m, err := base.New() if err != nil { panic(err) } - fmt.Println(m.TemplateFiles) + t := gotemplate.NewTemplate( + gotemplate.NewBubbleTeaView(), + ) + + t.AddModules([]gotemplate.Module{ + m, + }) + + err = t.ExecuteWizard() + if err != nil { + panic(err) + } } diff --git a/v2/gotemplate/modules.go b/v2/gotemplate/modules.go index 68f6a243..24857ff7 100644 --- a/v2/gotemplate/modules.go +++ b/v2/gotemplate/modules.go @@ -2,9 +2,14 @@ package gotemplate // Module represents a module that can be included in a template. type Module interface { + // GetModuleName returns the name of the module. + GetModuleName() ModuleName + // GetNextQuestion returns the next question in the module. + // The `moduleData` argument is a map of the module data that has been collected so far. // If there are no more questions, it returns nil. - GetNextQuestion() *TemplateQuestion + GetNextQuestion(moduleData map[ModuleName]ModuleData) *TemplateQuestion + // GetModuleData returns the complete module data when all questions have been answered. GetModuleData() *ModuleData } @@ -23,30 +28,35 @@ type ModuleData struct { TemplateFiles []string // TemplateData is the data that will be used to generate the template for this module. // The data can be of any type, depending on the needs of the module. - TemplateData interface{} + TemplateData map[TemplateOptionName]interface{} } // ModuleBase implements the Module interface. type ModuleBase struct { ModuleData - questions []TemplateQuestion + Questions []TemplateQuestion } // GetNextQuestion returns the next question in the module. // If there are no more questions, it returns nil. -func (m *ModuleBase) GetNextQuestion() *TemplateQuestion { - if len(m.questions) == 0 { +func (m *ModuleBase) GetNextQuestion(moduleData map[ModuleName]ModuleData) *TemplateQuestion { + if len(m.Questions) == 0 { return nil } - question := m.questions[0] - m.questions = m.questions[1:] + question := m.Questions[0] + m.Questions = m.Questions[1:] return &question } -// GetModule returns the complete module data when all questions have been answered. -func (m *ModuleBase) GetModule() *ModuleData { - if len(m.questions) == 0 { +// GetModuleData returns the complete module data when all questions have been answered. +func (m *ModuleBase) GetModuleData() *ModuleData { + if len(m.Questions) == 0 { return &m.ModuleData } return nil } + +// GetModuleName returns the name of the module. +func (m *ModuleBase) GetModuleName() ModuleName { + return m.ModuleData.Name +} diff --git a/v2/gotemplate/modules_test.go b/v2/gotemplate/modules_test.go index 8bf0fa01..bc4af185 100644 --- a/v2/gotemplate/modules_test.go +++ b/v2/gotemplate/modules_test.go @@ -1,103 +1,107 @@ package gotemplate -import ( - "reflect" - "testing" -) +// import ( +// "reflect" +// "testing" +// ) -func TestModuleBase_GetNextQuestion(t *testing.T) { - type fields struct { - ModuleData ModuleData - questions []TemplateQuestion - } - tests := []struct { - name string - fields fields - want *TemplateQuestion - }{ - { - name: "get first question", - fields: fields{ - questions: []TemplateQuestion{ - { - Name: "project-1", - }, - { - Name: "project-2", - }, - }, - }, - want: &TemplateQuestion{ - Name: "project-1", - }, - }, - { - name: "no question left", - fields: fields{ - questions: []TemplateQuestion{}, - }, - want: nil, - }, - } - for _, tt := range tests { - t.Run(tt.name, func(t *testing.T) { - m := &ModuleBase{ - ModuleData: tt.fields.ModuleData, - questions: tt.fields.questions, - } - if got := m.GetNextQuestion(); !reflect.DeepEqual(got, tt.want) { - t.Errorf("ModuleBase.GetNextQuestion() = %v, want %v", got, tt.want) - } - }) - } -} +// func TestModuleBase_GetNextQuestion(t *testing.T) { +// type fields struct { +// ModuleData ModuleData +// questions []TemplateQuestion +// } +// type args struct { +// moduleData map[ModuleName]ModuleData +// } +// tests := []struct { +// name string +// fields fields +// args args +// want *TemplateQuestion +// }{ +// { +// name: "get first question", +// fields: fields{ +// questions: []TemplateQuestion{ +// { +// Name: "project-1", +// }, +// { +// Name: "project-2", +// }, +// }, +// }, +// want: &TemplateQuestion{ +// Name: "project-1", +// }, +// }, +// { +// name: "no question left", +// fields: fields{ +// questions: []TemplateQuestion{}, +// }, +// want: nil, +// }, +// } +// for _, tt := range tests { +// t.Run(tt.name, func(t *testing.T) { +// m := &ModuleBase{ +// ModuleData: tt.fields.ModuleData, +// questions: tt.fields.questions, +// } +// if got := m.GetNextQuestion(tt.args.moduleData); !reflect.DeepEqual(got, tt.want) { +// t.Errorf("ModuleBase.GetNextQuestion() = %v, want %v", got, tt.want) +// } +// }) +// } +// } -func TestModuleBase_GetModule(t *testing.T) { - type fields struct { - ModuleData ModuleData - questions []TemplateQuestion - } - tests := []struct { - name string - fields fields - want *ModuleData - }{ - { - name: "no question left", - fields: fields{ - ModuleData: ModuleData{ - Name: "project-1", - }, - questions: []TemplateQuestion{}, - }, - want: &ModuleData{ - Name: "project-1", - }, - }, - { - name: "still questions left", - fields: fields{ - ModuleData: ModuleData{ - Name: "project-1", - }, - questions: []TemplateQuestion{ - { - Name: "project-1", - }, - }, - }, - want: nil, - }, - } - for _, tt := range tests { - t.Run(tt.name, func(t *testing.T) { - m := &ModuleBase{ - ModuleData: tt.fields.ModuleData, - questions: tt.fields.questions, - } - if got := m.GetModule(); !reflect.DeepEqual(got, tt.want) { - t.Errorf("ModuleBase.GetModule() = %v, want %v", got, tt.want) - } - }) - } -} +// func TestModuleBase_GetModule(t *testing.T) { +// type fields struct { +// ModuleData ModuleData +// questions []TemplateQuestion +// } +// tests := []struct { +// name string +// fields fields +// want *ModuleData +// }{ +// { +// name: "no question left", +// fields: fields{ +// ModuleData: ModuleData{ +// Name: "project-1", +// }, +// questions: []TemplateQuestion{}, +// }, +// want: &ModuleData{ +// Name: "project-1", +// }, +// }, +// { +// name: "still questions left", +// fields: fields{ +// ModuleData: ModuleData{ +// Name: "project-1", +// }, +// questions: []TemplateQuestion{ +// { +// Name: "project-1", +// }, +// }, +// }, +// want: nil, +// }, +// } +// for _, tt := range tests { +// t.Run(tt.name, func(t *testing.T) { +// m := &ModuleBase{ +// ModuleData: tt.fields.ModuleData, +// questions: tt.fields.questions, +// } +// if got := m.GetModule(); !reflect.DeepEqual(got, tt.want) { +// t.Errorf("ModuleBase.GetModule() = %v, want %v", got, tt.want) +// } +// }) +// } +// } diff --git a/v2/gotemplate/template.go b/v2/gotemplate/template.go index 95b16f86..e4a4a11e 100644 --- a/v2/gotemplate/template.go +++ b/v2/gotemplate/template.go @@ -1,5 +1,28 @@ package gotemplate +// QuestionType is an enum that defines the types of questions that can be presented to the user. +type QuestionType int + +const ( + // Choices is a question with pre-defined choices. + Choices QuestionType = iota + // SingleChoice is a question with a single choice. + SingleChoice + // String is a question with a string input. + String + // MultiLineText is a question with a multi-line text input. + MultiLineText +) + +// ResponseValue is the interface that describes the possible values that can be set as a response to a TemplateQuestion. +type ResponseValue interface{} + +// StringValue is a type that represents a single string value. +type StringValue string + +// StringListValue is a type that represents a list of string values. +type StringListValue []string + // TemplateOptionName represents the name of a template option. type TemplateOptionName string @@ -10,22 +33,105 @@ type TemplateQuestion struct { // Description is a short description of the question. Description string // DefaultValue is the default value for the question. This is optional. - DefaultValue interface{} + DefaultValue string + // Choices is a list of pre-defined choices for the question. This is optional. + Choices []string // IsValid is a function that validates the input value for the question. This is optional. // If the input is valid, the function should return (true, ""). // If the input is invalid, the function should return (false, "reason why input is invalid") or (false, "") if no reason is provided. IsValid func(value interface{}) (isValid bool, reason string) - // PredefinedValues is a list of predefined values for the question. This is optional. - // If this is set, the user will be presented with a list of predefined values to choose from instead of an input field. - PredefinedValues []interface{} - // ResponseValue is the value that the user provided in response to the question. This is optional. - ResponseValue *string + // ResponseValue is the value that the user provided in response to the question. + // This is optional and will be set after the question has been answered. + ResponseValue ResponseValue + // Type is the type of question. + Type QuestionType } // Template represents a template that can be generated. type Template struct { - // Modules is a map of modules that can be included in the template. + // InModules is a map of modules that can be included in the template. // The keys in the map are the names of the modules. // The values are the module data, including the template files and template data. - Modules map[ModuleName]Module + InModules map[ModuleName]Module + + // OutModuleData is a map of module data that is output by the template generation process. + // The keys in the map are the names of the modules. + // The values are the module data that was generated during the template generation process. + OutModuleData map[ModuleName]ModuleData + + // View is the user interface that will be used to present questions to the user. + View View +} + +// NewTemplate creates a new Template with the given View. +func NewTemplate(view View) *Template { + return &Template{ + InModules: make(map[ModuleName]Module), + OutModuleData: make(map[ModuleName]ModuleData), + View: view, + } +} + +// AddModules adds modules to the template. +func (t *Template) AddModules(modules []Module) { + for _, module := range modules { + t.InModules[module.GetModuleName()] = module + } +} + +// ProcessModules processes all modules in the template and generates the module data. +func (t *Template) ProcessModules() error { + // Initialize the module data for this module. + t.OutModuleData = map[ModuleName]ModuleData{} + + // Iterate over each module and process the questions. + for moduleName, module := range t.InModules { + t.OutModuleData[moduleName] = ModuleData{ + Name: moduleName, + TemplateData: map[TemplateOptionName]interface{}{}, + } + + // Get the questions for this module and iterate over them. + question := module.GetNextQuestion(t.OutModuleData) + for question != nil { + // Present the question to the user and get the response. + response, err := t.View.PresentQuestion(*question) + if err != nil { + return err + } + + t.OutModuleData[moduleName].TemplateData[question.Name] = response.ResponseValue + + // Get the next question. + question = module.GetNextQuestion(t.OutModuleData) + } + + // Store the module data in the template. + t.OutModuleData[moduleName] = *module.GetModuleData() + } + + return nil +} + +// ExecuteWizard executes the template wizard using the current View. +func (t *Template) ExecuteWizard() error { + // // Display a welcome message. + // err := t.View.ShowMessage("Welcome to the template wizard!") + // if err != nil { + // return err + // } + + // Process modules in the template and generate the module data. + err := t.ProcessModules() + if err != nil { + return err + } + + // // Display a message indicating the end of the wizard. + // err = t.View.ShowMessage("The template wizard is complete!") + // if err != nil { + // return err + // } + + return nil } diff --git a/v2/gotemplate/view.go b/v2/gotemplate/view.go new file mode 100644 index 00000000..10569983 --- /dev/null +++ b/v2/gotemplate/view.go @@ -0,0 +1,13 @@ +package gotemplate + +// View is an interface that defines the methods needed for a user interface. +type View interface { + // PresentQuestion presents a question to the user and returns the user's response. + PresentQuestion(question TemplateQuestion) (*TemplateQuestion, error) + + // // ShowMessage displays a message to the user. + // ShowMessage(message string) error + + // // ShowError displays an error message to the user. + // ShowError(message string) error +} diff --git a/v2/gotemplate/view_bubble.go b/v2/gotemplate/view_bubble.go new file mode 100644 index 00000000..4d56d4c3 --- /dev/null +++ b/v2/gotemplate/view_bubble.go @@ -0,0 +1,57 @@ +package gotemplate + +import ( + "errors" + "fmt" + + tea "github.com/charmbracelet/bubbletea" +) + +var ( + ErrInterrupt = errors.New("interrupted") +) + +// Model represents the state of the view at any given time. +type Model struct { + // Question is the current question being presented to the user. + Question TemplateQuestion + // Input is the user's response to the current question. + Input string + // Error is any error that occurred while processing the user's response to the current question. + Error error + // Choices is the list of pre-defined choices for the current question, if applicable. + Choices []string + // SelectedIdx is the index of the selected choice, if the current question is a multiple choice question. + SelectedIdx int +} + +// BubbleTeaView is a struct that implements the View interface using the Bubble Tea framework. +type BubbleTeaView struct { + model Model + program *tea.Program + done chan struct{} + response chan string +} + +// NewBubbleTeaView creates a new BubbleTeaView. +func NewBubbleTeaView() BubbleTeaView { + return BubbleTeaView{ + model: Model{}, + program: nil, + done: make(chan struct{}), + response: make(chan string), + } +} + +func (b BubbleTeaView) PresentQuestion(question TemplateQuestion) (*TemplateQuestion, error) { + fmt.Println("PresentQuestion") + fmt.Println(question) + question.ResponseValue = nil + return &question, nil +} + +// ShowMessage displays a message to the user. +func (b *BubbleTeaView) ShowMessage(message string) error { + fmt.Println(message) + return nil +} diff --git a/v2/modules/base/modul.go b/v2/modules/base/modul.go index 837b1e7b..a4255443 100644 --- a/v2/modules/base/modul.go +++ b/v2/modules/base/modul.go @@ -6,7 +6,8 @@ import ( type Module struct { gotemplate.ModuleData - questions map[string]gotemplate.TemplateQuestion + gotemplate.ModuleBase + // questions map[string]gotemplate.TemplateQuestion } func New() (*Module, error) { @@ -21,19 +22,21 @@ func New() (*Module, error) { TemplatePath: "v2/modules/base/template", TemplateFiles: files, }, - questions: map[string]gotemplate.TemplateQuestion{ - "project-name": { - Name: "project-name", - Description: "Project name", - IsValid: func(value interface{}) (bool, string) { - return true, "" + ModuleBase: gotemplate.ModuleBase{ + Questions: []gotemplate.TemplateQuestion{ + { + Name: "project-name", + Description: "Project name", + IsValid: func(value interface{}) (bool, string) { + return true, "" + }, }, - }, - "project-description": { - Name: "project-description", - Description: "Project description", - IsValid: func(value interface{}) (bool, string) { - return true, "" + { + Name: "project-description", + Description: "Project description", + IsValid: func(value interface{}) (bool, string) { + return true, "" + }, }, }, }, From 567bd919cb213b8b8f136c70cc93abc2cc49f8f1 Mon Sep 17 00:00:00 2001 From: Steffen Exler Date: Sun, 26 Feb 2023 14:30:56 +0100 Subject: [PATCH 4/8] Add example bubble view Signed-off-by: Steffen Exler --- go.mod | 1 + go.sum | 1 + nix/gomod2nix.toml | 3 + v2/cmd/gt/main.go | 3 +- v2/gotemplate/ptr.go | 6 ++ v2/gotemplate/template.go | 2 +- v2/modules/base/modul.go | 1 + .../view_bubble.go => view/bubble/bubble.go} | 13 +++- v2/view/bubble/textinput.go | 59 +++++++++++++++++++ 9 files changed, 84 insertions(+), 5 deletions(-) create mode 100644 v2/gotemplate/ptr.go rename v2/{gotemplate/view_bubble.go => view/bubble/bubble.go} (80%) create mode 100644 v2/view/bubble/textinput.go diff --git a/go.mod b/go.mod index 10c739c1..cf51516b 100644 --- a/go.mod +++ b/go.mod @@ -17,6 +17,7 @@ require ( require ( github.com/Masterminds/goutils v1.1.1 // indirect + github.com/atotto/clipboard v0.1.4 // indirect github.com/aymanbagabas/go-osc52 v1.2.2 // indirect github.com/charmbracelet/lipgloss v0.6.0 // indirect github.com/containerd/console v1.0.3 // indirect diff --git a/go.sum b/go.sum index d4c7772b..f7786f8c 100644 --- a/go.sum +++ b/go.sum @@ -4,6 +4,7 @@ github.com/Masterminds/semver/v3 v3.2.0 h1:3MEsd0SM6jqZojhjLWWeBY+Kcjy9i6MQAeY7Y github.com/Masterminds/semver/v3 v3.2.0/go.mod h1:qvl/7zhW3nngYb5+80sSMF+FG2BjYrf8m9wsX0PNOMQ= github.com/Masterminds/sprig/v3 v3.2.3 h1:eL2fZNezLomi0uOLqjQoN6BfsDD+fyLtgbJMAj9n6YA= github.com/Masterminds/sprig/v3 v3.2.3/go.mod h1:rXcFaZ2zZbLRJv/xSysmlgIM1u11eBaRMhvYXJNkGuM= +github.com/atotto/clipboard v0.1.4 h1:EH0zSVneZPSuFR11BlR9YppQTVDbh5+16AmcJi4g1z4= github.com/atotto/clipboard v0.1.4/go.mod h1:ZY9tmq7sm5xIbd9bOK4onWV4S6X0u6GY7Vn0Yu86PYI= github.com/aymanbagabas/go-osc52 v1.0.3/go.mod h1:zT8H+Rk4VSabYN90pWyugflM3ZhpTZNC7cASDfUCdT4= github.com/aymanbagabas/go-osc52 v1.2.1/go.mod h1:zT8H+Rk4VSabYN90pWyugflM3ZhpTZNC7cASDfUCdT4= diff --git a/nix/gomod2nix.toml b/nix/gomod2nix.toml index 5101f4dc..858ee8c9 100644 --- a/nix/gomod2nix.toml +++ b/nix/gomod2nix.toml @@ -10,6 +10,9 @@ schema = 3 [mod."github.com/Masterminds/sprig/v3"] version = "v3.2.3" hash = "sha256-1GLZic3WQIBZGyjvyHbfcZ/7EV7oNzNhkwEiiTpVfL4=" + [mod."github.com/atotto/clipboard"] + version = "v0.1.4" + hash = "sha256-ZZ7U5X0gWOu8zcjZcWbcpzGOGdycwq0TjTFh/eZHjXk=" [mod."github.com/aymanbagabas/go-osc52"] version = "v1.2.2" hash = "sha256-zuw3/3Q/ikIEC6yng1fLztEoAj/WzITAXU3wsSmHLnk=" diff --git a/v2/cmd/gt/main.go b/v2/cmd/gt/main.go index 985075e6..825e0a78 100644 --- a/v2/cmd/gt/main.go +++ b/v2/cmd/gt/main.go @@ -3,6 +3,7 @@ package main import ( "github.com/schwarzit/go-template/v2/gotemplate" "github.com/schwarzit/go-template/v2/modules/base" + "github.com/schwarzit/go-template/v2/view/bubble" ) func main() { @@ -12,7 +13,7 @@ func main() { } t := gotemplate.NewTemplate( - gotemplate.NewBubbleTeaView(), + bubble.NewBubbleTeaView(), ) t.AddModules([]gotemplate.Module{ diff --git a/v2/gotemplate/ptr.go b/v2/gotemplate/ptr.go new file mode 100644 index 00000000..2a11e0c3 --- /dev/null +++ b/v2/gotemplate/ptr.go @@ -0,0 +1,6 @@ +package gotemplate + +// StringPtr converts a string to a pointer to that string. +func StringPtr(s string) *string { + return &s +} diff --git a/v2/gotemplate/template.go b/v2/gotemplate/template.go index e4a4a11e..297ae8f1 100644 --- a/v2/gotemplate/template.go +++ b/v2/gotemplate/template.go @@ -33,7 +33,7 @@ type TemplateQuestion struct { // Description is a short description of the question. Description string // DefaultValue is the default value for the question. This is optional. - DefaultValue string + DefaultValue *string // Choices is a list of pre-defined choices for the question. This is optional. Choices []string // IsValid is a function that validates the input value for the question. This is optional. diff --git a/v2/modules/base/modul.go b/v2/modules/base/modul.go index a4255443..d21d8ad7 100644 --- a/v2/modules/base/modul.go +++ b/v2/modules/base/modul.go @@ -30,6 +30,7 @@ func New() (*Module, error) { IsValid: func(value interface{}) (bool, string) { return true, "" }, + DefaultValue: gotemplate.StringPtr("my-project"), }, { Name: "project-description", diff --git a/v2/gotemplate/view_bubble.go b/v2/view/bubble/bubble.go similarity index 80% rename from v2/gotemplate/view_bubble.go rename to v2/view/bubble/bubble.go index 4d56d4c3..a3d4a195 100644 --- a/v2/gotemplate/view_bubble.go +++ b/v2/view/bubble/bubble.go @@ -1,10 +1,11 @@ -package gotemplate +package bubble import ( "errors" "fmt" tea "github.com/charmbracelet/bubbletea" + "github.com/schwarzit/go-template/v2/gotemplate" ) var ( @@ -14,7 +15,7 @@ var ( // Model represents the state of the view at any given time. type Model struct { // Question is the current question being presented to the user. - Question TemplateQuestion + Question gotemplate.TemplateQuestion // Input is the user's response to the current question. Input string // Error is any error that occurred while processing the user's response to the current question. @@ -43,10 +44,16 @@ func NewBubbleTeaView() BubbleTeaView { } } -func (b BubbleTeaView) PresentQuestion(question TemplateQuestion) (*TemplateQuestion, error) { +func (b BubbleTeaView) PresentQuestion(question gotemplate.TemplateQuestion) (*gotemplate.TemplateQuestion, error) { fmt.Println("PresentQuestion") fmt.Println(question) question.ResponseValue = nil + + p := tea.NewProgram(initialModel(question)) + if _, err := p.Run(); err != nil { + return nil, err + } + return &question, nil } diff --git a/v2/view/bubble/textinput.go b/v2/view/bubble/textinput.go new file mode 100644 index 00000000..1d253314 --- /dev/null +++ b/v2/view/bubble/textinput.go @@ -0,0 +1,59 @@ +package bubble + +import ( + "github.com/charmbracelet/bubbles/textinput" + tea "github.com/charmbracelet/bubbletea" + "github.com/schwarzit/go-template/v2/gotemplate" +) + +type ( + errMsg error +) + +type textInputModel struct { + textInput textinput.Model + err error +} + +func initialModel(question gotemplate.TemplateQuestion) textInputModel { + ti := textinput.New() + if question.DefaultValue != nil { + ti.Placeholder = *question.DefaultValue + } + ti.Focus() + // ti.CharLimit = 156 + // ti.Width = 20 + + return textInputModel{ + textInput: ti, + err: nil, + } +} + +func (m textInputModel) Init() tea.Cmd { + return textinput.Blink +} + +func (m textInputModel) Update(msg tea.Msg) (tea.Model, tea.Cmd) { + var cmd tea.Cmd + + switch msg := msg.(type) { + case tea.KeyMsg: + switch msg.Type { + case tea.KeyEnter, tea.KeyCtrlC, tea.KeyEsc: + return m, tea.Quit + } + + // We handle errors just like any other message + case errMsg: + m.err = msg + return m, nil + } + + m.textInput, cmd = m.textInput.Update(msg) + return m, cmd +} + +func (m textInputModel) View() string { + return m.textInput.View() +} From aec8fa658eb32da1ab009acd66be2e60ddfb2e50 Mon Sep 17 00:00:00 2001 From: Steffen Exler Date: Sun, 26 Feb 2023 22:17:51 +0100 Subject: [PATCH 5/8] refactor BubbleTeaView to TeaView Signed-off-by: Steffen Exler --- v2/cmd/gt/main.go | 2 +- v2/view/bubble/bubble.go | 14 +++++++------- v2/view/bubble/textinput.go | 2 -- 3 files changed, 8 insertions(+), 10 deletions(-) diff --git a/v2/cmd/gt/main.go b/v2/cmd/gt/main.go index 825e0a78..827841de 100644 --- a/v2/cmd/gt/main.go +++ b/v2/cmd/gt/main.go @@ -13,7 +13,7 @@ func main() { } t := gotemplate.NewTemplate( - bubble.NewBubbleTeaView(), + bubble.NewTeaView(), ) t.AddModules([]gotemplate.Module{ diff --git a/v2/view/bubble/bubble.go b/v2/view/bubble/bubble.go index a3d4a195..201f7121 100644 --- a/v2/view/bubble/bubble.go +++ b/v2/view/bubble/bubble.go @@ -26,17 +26,17 @@ type Model struct { SelectedIdx int } -// BubbleTeaView is a struct that implements the View interface using the Bubble Tea framework. -type BubbleTeaView struct { +// TeaView is a struct that implements the View interface using the Bubble Tea framework. +type TeaView struct { model Model program *tea.Program done chan struct{} response chan string } -// NewBubbleTeaView creates a new BubbleTeaView. -func NewBubbleTeaView() BubbleTeaView { - return BubbleTeaView{ +// NewTeaView creates a new TeaView. +func NewTeaView() TeaView { + return TeaView{ model: Model{}, program: nil, done: make(chan struct{}), @@ -44,7 +44,7 @@ func NewBubbleTeaView() BubbleTeaView { } } -func (b BubbleTeaView) PresentQuestion(question gotemplate.TemplateQuestion) (*gotemplate.TemplateQuestion, error) { +func (b TeaView) PresentQuestion(question gotemplate.TemplateQuestion) (*gotemplate.TemplateQuestion, error) { fmt.Println("PresentQuestion") fmt.Println(question) question.ResponseValue = nil @@ -58,7 +58,7 @@ func (b BubbleTeaView) PresentQuestion(question gotemplate.TemplateQuestion) (*g } // ShowMessage displays a message to the user. -func (b *BubbleTeaView) ShowMessage(message string) error { +func (b *TeaView) ShowMessage(message string) error { fmt.Println(message) return nil } diff --git a/v2/view/bubble/textinput.go b/v2/view/bubble/textinput.go index 1d253314..d53d5bb3 100644 --- a/v2/view/bubble/textinput.go +++ b/v2/view/bubble/textinput.go @@ -21,8 +21,6 @@ func initialModel(question gotemplate.TemplateQuestion) textInputModel { ti.Placeholder = *question.DefaultValue } ti.Focus() - // ti.CharLimit = 156 - // ti.Width = 20 return textInputModel{ textInput: ti, From 11fd4b0a0088cd0ac3a08ccb73ac2d1be3977ded Mon Sep 17 00:00:00 2001 From: Steffen Exler Date: Thu, 30 Mar 2023 19:27:43 +0200 Subject: [PATCH 6/8] Add v3 test Signed-off-by: Steffen Exler --- v2/gotemplate/modules.go | 18 ++----- v2/gotemplate/template.go | 55 +++++++++++---------- v2/modules/base/modul.go | 30 +++++------ v2/question/question.go | 61 +++++++++++++++++++++++ v2/view/bubble/bubble.go | 2 +- v2/view/bubble/textinput.go | 2 +- v3/cmd/cli/main.go | 42 ++++++++++++++++ v3/gotemplate/engine/engine.go | 52 +++++++++++++++++++ v3/gotemplate/module/base.go | 49 ++++++++++++++++++ v3/gotemplate/module/module.go | 24 +++++++++ v3/gotemplate/option/base.go | 72 +++++++++++++++++++++++++++ v3/gotemplate/option/option.go | 27 ++++++++++ v3/gotemplate/view/cli.go | 69 ++++++++++++++++++++++++++ v3/gotemplate/view/view.go | 25 ++++++++++ v3/modules/golang/module.go | 74 ++++++++++++++++++++++++++++ v3/modules/golang/template/README.md | 38 ++++++++++++++ v3/modules/golang/template/tools.go | 16 ++++++ 17 files changed, 600 insertions(+), 56 deletions(-) create mode 100644 v2/question/question.go create mode 100644 v3/cmd/cli/main.go create mode 100644 v3/gotemplate/engine/engine.go create mode 100644 v3/gotemplate/module/base.go create mode 100644 v3/gotemplate/module/module.go create mode 100644 v3/gotemplate/option/base.go create mode 100644 v3/gotemplate/option/option.go create mode 100644 v3/gotemplate/view/cli.go create mode 100644 v3/gotemplate/view/view.go create mode 100644 v3/modules/golang/module.go create mode 100644 v3/modules/golang/template/README.md create mode 100644 v3/modules/golang/template/tools.go diff --git a/v2/gotemplate/modules.go b/v2/gotemplate/modules.go index 24857ff7..9b95ec54 100644 --- a/v2/gotemplate/modules.go +++ b/v2/gotemplate/modules.go @@ -5,10 +5,8 @@ type Module interface { // GetModuleName returns the name of the module. GetModuleName() ModuleName - // GetNextQuestion returns the next question in the module. - // The `moduleData` argument is a map of the module data that has been collected so far. - // If there are no more questions, it returns nil. - GetNextQuestion(moduleData map[ModuleName]ModuleData) *TemplateQuestion + // GetQuestions returns all the questions for the module. + GetQuestions() ([]TemplateQuestion, error) // GetModuleData returns the complete module data when all questions have been answered. GetModuleData() *ModuleData @@ -37,15 +35,9 @@ type ModuleBase struct { Questions []TemplateQuestion } -// GetNextQuestion returns the next question in the module. -// If there are no more questions, it returns nil. -func (m *ModuleBase) GetNextQuestion(moduleData map[ModuleName]ModuleData) *TemplateQuestion { - if len(m.Questions) == 0 { - return nil - } - question := m.Questions[0] - m.Questions = m.Questions[1:] - return &question +// GetQuestions returns all the questions in the module. +func (m *ModuleBase) GetQuestions() ([]TemplateQuestion, error) { + return m.Questions, nil } // GetModuleData returns the complete module data when all questions have been answered. diff --git a/v2/gotemplate/template.go b/v2/gotemplate/template.go index 297ae8f1..5401556c 100644 --- a/v2/gotemplate/template.go +++ b/v2/gotemplate/template.go @@ -17,34 +17,37 @@ const ( // ResponseValue is the interface that describes the possible values that can be set as a response to a TemplateQuestion. type ResponseValue interface{} -// StringValue is a type that represents a single string value. -type StringValue string - -// StringListValue is a type that represents a list of string values. -type StringListValue []string - // TemplateOptionName represents the name of a template option. type TemplateOptionName string // TemplateQuestion represents a single question in a module. -type TemplateQuestion struct { +type TemplateQuestion interface { // Name is the name of the question. - Name TemplateOptionName + Name() TemplateOptionName + // Description is a short description of the question. - Description string + Description() string + // DefaultValue is the default value for the question. This is optional. - DefaultValue *string + DefaultValue() *string + // Choices is a list of pre-defined choices for the question. This is optional. - Choices []string + Choices() []string + // IsValid is a function that validates the input value for the question. This is optional. // If the input is valid, the function should return (true, ""). // If the input is invalid, the function should return (false, "reason why input is invalid") or (false, "") if no reason is provided. - IsValid func(value interface{}) (isValid bool, reason string) + IsValid(answer []string) (isValid bool, reason *string, err error) + + // IsEnabled returns whether or not the question should be enabled based on the current module data. + IsEnabled(moduleData map[ModuleName]ModuleData) (bool, error) + // ResponseValue is the value that the user provided in response to the question. // This is optional and will be set after the question has been answered. - ResponseValue ResponseValue + ResponseValue(answer []string) (interface{}, error) + // Type is the type of question. - Type QuestionType + Type() QuestionType } // Template represents a template that can be generated. @@ -91,20 +94,20 @@ func (t *Template) ProcessModules() error { TemplateData: map[TemplateOptionName]interface{}{}, } - // Get the questions for this module and iterate over them. - question := module.GetNextQuestion(t.OutModuleData) - for question != nil { - // Present the question to the user and get the response. - response, err := t.View.PresentQuestion(*question) - if err != nil { - return err - } + // // Get the questions for this module and iterate over them. + // question := module.GetNextQuestion(t.OutModuleData) + // for question != nil { + // // Present the question to the user and get the response. + // response, err := t.View.PresentQuestion(*question) + // if err != nil { + // return err + // } - t.OutModuleData[moduleName].TemplateData[question.Name] = response.ResponseValue + // t.OutModuleData[moduleName].TemplateData[question.Name] = response.ResponseValue - // Get the next question. - question = module.GetNextQuestion(t.OutModuleData) - } + // // Get the next question. + // question = module.GetNextQuestion(t.OutModuleData) + // } // Store the module data in the template. t.OutModuleData[moduleName] = *module.GetModuleData() diff --git a/v2/modules/base/modul.go b/v2/modules/base/modul.go index d21d8ad7..1d5e9626 100644 --- a/v2/modules/base/modul.go +++ b/v2/modules/base/modul.go @@ -24,21 +24,21 @@ func New() (*Module, error) { }, ModuleBase: gotemplate.ModuleBase{ Questions: []gotemplate.TemplateQuestion{ - { - Name: "project-name", - Description: "Project name", - IsValid: func(value interface{}) (bool, string) { - return true, "" - }, - DefaultValue: gotemplate.StringPtr("my-project"), - }, - { - Name: "project-description", - Description: "Project description", - IsValid: func(value interface{}) (bool, string) { - return true, "" - }, - }, + // { + // Name: "project-name", + // Description: "Project name", + // IsValid: func(value interface{}) (bool, string) { + // return true, "" + // }, + // DefaultValue: gotemplate.StringPtr("my-project"), + // }, + // { + // Name: "project-description", + // Description: "Project description", + // IsValid: func(value interface{}) (bool, string) { + // return true, "" + // }, + // }, }, }, }, nil diff --git a/v2/question/question.go b/v2/question/question.go new file mode 100644 index 00000000..d7f8e569 --- /dev/null +++ b/v2/question/question.go @@ -0,0 +1,61 @@ +package question + +import "github.com/schwarzit/go-template/v2/gotemplate" + +type Question struct { + // Name is the name of the question. + name gotemplate.TemplateOptionName + + // Description is a short description of the question. + description string + + // DefaultValue is the default value for the question. This is optional. + defaultValue *string + + // Choices is a list of pre-defined choices for the question. This is optional. + choices []string + + // Type is the type of question. + questionType gotemplate.QuestionType +} + +func (q *Question) Name() gotemplate.TemplateOptionName { + return q.name +} + +func (q *Question) Description() string { + return q.description +} + +func (q *Question) DefaultValue() *string { + return q.defaultValue +} + +func (q *Question) Choices() []string { + return q.choices +} + +func (q *Question) IsValid(answer []string) (isValid bool, reason *string, err error) { + if q.IsValid != nil { + return q.IsValid(answer) + } + return true, nil, nil +} + +func (q *Question) IsEnabled(moduleData map[gotemplate.ModuleName]gotemplate.ModuleData) (bool, error) { + if q.IsEnabled != nil { + return q.IsEnabled(moduleData) + } + return true, nil +} + +func (q *Question) ResponseValue(answer []string) (interface{}, error) { + if q.ResponseValue != nil { + return q.ResponseValue(answer) + } + return answer[0], nil +} + +func (q *Question) Type() gotemplate.QuestionType { + return q.questionType +} diff --git a/v2/view/bubble/bubble.go b/v2/view/bubble/bubble.go index 201f7121..0f164dce 100644 --- a/v2/view/bubble/bubble.go +++ b/v2/view/bubble/bubble.go @@ -47,7 +47,7 @@ func NewTeaView() TeaView { func (b TeaView) PresentQuestion(question gotemplate.TemplateQuestion) (*gotemplate.TemplateQuestion, error) { fmt.Println("PresentQuestion") fmt.Println(question) - question.ResponseValue = nil + // question.ResponseValue = nil p := tea.NewProgram(initialModel(question)) if _, err := p.Run(); err != nil { diff --git a/v2/view/bubble/textinput.go b/v2/view/bubble/textinput.go index d53d5bb3..a443260d 100644 --- a/v2/view/bubble/textinput.go +++ b/v2/view/bubble/textinput.go @@ -18,7 +18,7 @@ type textInputModel struct { func initialModel(question gotemplate.TemplateQuestion) textInputModel { ti := textinput.New() if question.DefaultValue != nil { - ti.Placeholder = *question.DefaultValue + // ti.Placeholder = *question.DefaultValue } ti.Focus() diff --git a/v3/cmd/cli/main.go b/v3/cmd/cli/main.go new file mode 100644 index 00000000..3e2f9883 --- /dev/null +++ b/v3/cmd/cli/main.go @@ -0,0 +1,42 @@ +package main + +import ( + "github.com/schwarzit/go-template/v3/gotemplate/engine" + "github.com/schwarzit/go-template/v3/gotemplate/module" + "github.com/schwarzit/go-template/v3/gotemplate/option" + "github.com/schwarzit/go-template/v3/gotemplate/view" +) + +func main() { + // Create a new module with two options: project name and description. + m := module.NewBaseModule( + "Readme", + []option.Option{ + option.NewBaseOption( + "Project Name", + "The name of the new project.", + "My Project", + nil, + nil, + ), + option.NewBaseOption( + "Project Description", + "A brief description of the new project.", + "This is a new project.", + nil, + nil, + ), + }, + ) + + // Create a new CLI view. + cli := view.NewCLI() + + // Create a new engine with the module and the CLI view. + engine := engine.NewEngine([]module.Module{m}) + + // Start the engine. + if err := engine.Start(cli); err != nil { + panic(err) + } +} diff --git a/v3/gotemplate/engine/engine.go b/v3/gotemplate/engine/engine.go new file mode 100644 index 00000000..c085ec1f --- /dev/null +++ b/v3/gotemplate/engine/engine.go @@ -0,0 +1,52 @@ +package engine + +import ( + "github.com/schwarzit/go-template/v3/gotemplate/module" + "github.com/schwarzit/go-template/v3/gotemplate/view" +) + +type Engine struct { + modules []module.Module +} + +func NewEngine(modules []module.Module) *Engine { + return &Engine{ + modules: modules, + } +} + +func (e *Engine) Start(v view.View) error { + // Create a channel for communication with the view. + events := make(chan view.Event) + + // Listen for events from the view and generate the project when necessary. + go func() { + for event := range events { + if event.Type == view.GenerateEvent { + if err := e.generateProject(); err != nil { + v.ShowError(err) + } else { + v.ShowMessage("Project generated successfully.") + } + } + } + }() + + // Initialize the view. + if err := v.Start(e.modules, events); err != nil { + return err + } + + return nil +} + +func (e *Engine) generateProject() error { + // Generate the output for each module using the current option values. + for _, m := range e.modules { + if err := m.Generate(); err != nil { + return err + } + } + + return nil +} diff --git a/v3/gotemplate/module/base.go b/v3/gotemplate/module/base.go new file mode 100644 index 00000000..252360ba --- /dev/null +++ b/v3/gotemplate/module/base.go @@ -0,0 +1,49 @@ +package module + +import ( + "fmt" + + "github.com/schwarzit/go-template/v3/gotemplate/option" +) + +type BaseModule struct { + name string + options []option.Option +} + +func NewBaseModule(name string, options []option.Option) *BaseModule { + return &BaseModule{ + name: name, + options: options, + } +} + +func (m *BaseModule) GetName() string { + return m.name +} + +func (m *BaseModule) GetOptions() []option.Option { + return m.options +} + +func (m *BaseModule) GetOptionValue(title string) (string, error) { + for _, opt := range m.options { + if opt.GetTitle() == title { + return opt.GetValue(), nil + } + } + return "", fmt.Errorf("option not found: %s", title) +} + +func (m *BaseModule) Generate() error { + // Implementation for generating the module's content goes here. + return nil +} + +func (m *BaseModule) GetState() State { + state := make(State) + for _, opt := range m.options { + state[opt.GetTitle()] = opt.GetValue() + } + return state +} diff --git a/v3/gotemplate/module/module.go b/v3/gotemplate/module/module.go new file mode 100644 index 00000000..7f6c6328 --- /dev/null +++ b/v3/gotemplate/module/module.go @@ -0,0 +1,24 @@ +package module + +import "github.com/schwarzit/go-template/v3/gotemplate/option" + +// State represents the state of a module, as a map of string keys to string values. +type State map[string]string + +// TemplateModule represents a module in a template engine. +type Module interface { + // GetName returns the name of the module. + GetName() string + + // GetOptions returns a slice of options for the module. + GetOptions() []option.Option + + // GetOptionValue returns the value of an option by title. + GetOptionValue(title string) (string, error) + + // Generate generates the module's content. + Generate() error + + // GetState returns the state of the module. + GetState() State +} diff --git a/v3/gotemplate/option/base.go b/v3/gotemplate/option/base.go new file mode 100644 index 00000000..5caf4d7c --- /dev/null +++ b/v3/gotemplate/option/base.go @@ -0,0 +1,72 @@ +package option + +import "fmt" + +type BaseOption struct { + title string + description string + defaultValue string + availableAnswers []string + value string + validationFunc func(string) error +} + +func NewBaseOption(title, description, defaultValue string, availableAnswers []string, validationFunc func(string) error) *BaseOption { + return &BaseOption{ + title: title, + description: description, + defaultValue: defaultValue, + availableAnswers: availableAnswers, + value: defaultValue, + validationFunc: validationFunc, + } +} + +func (o *BaseOption) GetTitle() string { + return o.title +} + +func (o *BaseOption) GetDescription() string { + return o.description +} + +func (o *BaseOption) GetDefaultValue() string { + return o.defaultValue +} + +func (o *BaseOption) GetAvailableAnswers() []string { + return o.availableAnswers +} + +func (o *BaseOption) GetValue() string { + return o.value +} + +func (o *BaseOption) SetValue(value string) error { + if err := o.Validate(value); err != nil { + return err + } + o.value = value + return nil +} + +func (o *BaseOption) Validate(value string) error { + if o.availableAnswers != nil { + found := false + for _, answer := range o.availableAnswers { + if answer == value { + found = true + break + } + } + if !found { + return fmt.Errorf("invalid answer: %s", value) + } + } + if o.validationFunc != nil { + if err := o.validationFunc(value); err != nil { + return err + } + } + return nil +} diff --git a/v3/gotemplate/option/option.go b/v3/gotemplate/option/option.go new file mode 100644 index 00000000..942dae90 --- /dev/null +++ b/v3/gotemplate/option/option.go @@ -0,0 +1,27 @@ +package option + +// Option represents a configuration option that can be set by the user. +type Option interface { + // GetTitle returns the title of the option. + GetTitle() string + + // GetDescription returns the description of the option. + GetDescription() string + + // GetDefaultValue returns the default value of the option. + GetDefaultValue() string + + // GetAvailableAnswers returns a list of available answers for the option. + GetAvailableAnswers() []string + + // GetValue returns the current value of the option. + GetValue() string + + // SetValue sets the value of the option to the given value. + // Returns an error if the value is invalid. + SetValue(value string) error + + // Validate validates the given value for the option. + // Returns an error if the value is invalid. + Validate(value string) error +} diff --git a/v3/gotemplate/view/cli.go b/v3/gotemplate/view/cli.go new file mode 100644 index 00000000..c491414c --- /dev/null +++ b/v3/gotemplate/view/cli.go @@ -0,0 +1,69 @@ +package view + +import ( + "bufio" + "fmt" + "os" + "strings" + + "github.com/schwarzit/go-template/v3/gotemplate/module" +) + +type CLI struct{} + +func NewCLI() *CLI { + return &CLI{} +} + +func (c *CLI) Start(modules []module.Module, events chan<- Event) error { + // Print the welcome message. + fmt.Println("Welcome to the Go Template Engine!") + + // Iterate over the modules and prompt the user for input. + for _, m := range modules { + fmt.Printf("\n=== %s ===\n", m.GetName()) + + for _, o := range m.GetOptions() { + // Print the option title and description. + fmt.Println(o.GetTitle()) + fmt.Println(o.GetDescription()) + + // Print the available answers (if any). + answers := o.GetAvailableAnswers() + if len(answers) > 0 { + fmt.Printf("Available answers: %s\n", strings.Join(answers, ", ")) + } + + // Prompt the user for input. + scanner := bufio.NewScanner(os.Stdin) + fmt.Print("> ") + scanner.Scan() + input := scanner.Text() + + // Validate the input and set the option value. + if err := o.Validate(input); err != nil { + fmt.Printf("Invalid input: %v\n", err) + return err + } + if err := o.SetValue(input); err != nil { + fmt.Printf("Failed to set option value: %v\n", err) + return err + } + } + } + + // Notify the engine that the user has confirmed the project generation. + events <- Event{ + Type: GenerateEvent, + } + + return nil +} + +func (c *CLI) ShowMessage(message string) { + fmt.Println(message) +} + +func (c *CLI) ShowError(err error) { + fmt.Printf("Error: %v\n", err) +} diff --git a/v3/gotemplate/view/view.go b/v3/gotemplate/view/view.go new file mode 100644 index 00000000..57cc261b --- /dev/null +++ b/v3/gotemplate/view/view.go @@ -0,0 +1,25 @@ +package view + +import "github.com/schwarzit/go-template/v3/gotemplate/module" + +type EventType int + +const ( + GenerateEvent EventType = iota +) + +type Event struct { + Type EventType + Value interface{} +} + +type View interface { + // Initialize the view with the available modules and a channel for communication with the engine. + Start(modules []module.Module, events chan<- Event) error + + // Show a message to the user. + ShowMessage(message string) + + // Show an error message to the user. + ShowError(err error) +} diff --git a/v3/modules/golang/module.go b/v3/modules/golang/module.go new file mode 100644 index 00000000..9548d2a6 --- /dev/null +++ b/v3/modules/golang/module.go @@ -0,0 +1,74 @@ +package golang + +import ( + "fmt" + // "io/ioutil" + // "os" + // "path/filepath" + + "github.com/schwarzit/go-template/v3/gotemplate/module" + "github.com/schwarzit/go-template/v3/gotemplate/option" +) + +type ReadmeModule struct { + *module.BaseModule +} + +func NewReadmeModule() *ReadmeModule { + nameOption := option.NewBaseOption( + "Project Name", + "The name of the project", + "", + nil, + func(value string) error { + if value == "" { + return fmt.Errorf("project name cannot be empty") + } + return nil + }, + ) + + descOption := option.NewBaseOption( + "Project Description", + "A short description of the project", + "", + nil, + func(value string) error { + if value == "" { + return fmt.Errorf("project description cannot be empty") + } + return nil + }, + ) + + return &ReadmeModule{ + module.NewBaseModule("README", []option.Option{nameOption, descOption}), + } +} + +func (m *ReadmeModule) Generate() error { + // name, err := m.GetOptionValue("Project Name") + // if err != nil { + // return err + // } + + // desc, err := m.GetOptionValue("Project Description") + // if err != nil { + // return err + // } + + // content := fmt.Sprintf("# %s\n\n%s\n", name, desc) + + // dir, err := os.Getwd() + // if err != nil { + // return err + // } + + // filename := filepath.Join(dir, "README.md") + + // if err := ioutil.WriteFile(filename, []byte(content), 0644); err != nil { + // return err + // } + + return nil +} diff --git a/v3/modules/golang/template/README.md b/v3/modules/golang/template/README.md new file mode 100644 index 00000000..b866442e --- /dev/null +++ b/v3/modules/golang/template/README.md @@ -0,0 +1,38 @@ +# {{.Base.projectName}} + +[![GoTemplate](https://img.shields.io/badge/go/template-black?logo=go)](https://github.com/SchwarzIT/go-template) + +{{.Base.projectDescription}} + +The project uses `make` to make your life easier. If you're not familiar with Makefiles you can take a look at [this quickstart guide](https://makefiletutorial.com). + +Whenever you need help regarding the available actions, just use the following command. + +```bash +make help +``` + +## Setup + +To get your setup up and running the only thing you have to do is + +```bash +make all +``` + +This will initialize a git repo, download the dependencies in the latest versions and install all needed tools. +If needed code generation will be triggered in this target as well. + +## Test & lint + +Run linting + +```bash +make lint +``` + +Run tests + +```bash +make test +``` diff --git a/v3/modules/golang/template/tools.go b/v3/modules/golang/template/tools.go new file mode 100644 index 00000000..9a6bb1ae --- /dev/null +++ b/v3/modules/golang/template/tools.go @@ -0,0 +1,16 @@ +// +build tools + +package main + +import ( + _ "github.com/bufbuild/buf/cmd/buf" + _ "github.com/bufbuild/buf/cmd/protoc-gen-buf-breaking" + _ "github.com/bufbuild/buf/cmd/protoc-gen-buf-lint" + _ "github.com/envoyproxy/protoc-gen-validate" + _ "google.golang.org/grpc/cmd/protoc-gen-go-grpc" + _ "google.golang.org/protobuf/cmd/protoc-gen-go" + {{- if .Extensions.grpc.grpcGateway }} + _ "github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-grpc-gateway" + _ "github.com/google/gnostic/cmd/protoc-gen-openapi" + {{- end }} +) From ce4f8d62149b6cd0153ea2e76de602f5f02a85a1 Mon Sep 17 00:00:00 2001 From: Steffen Exler Date: Sat, 29 Apr 2023 11:27:20 +0200 Subject: [PATCH 7/8] Add base setup for v3 Signed-off-by: Steffen Exler --- .vscode/launch.json | 10 +- v3/cmd/cli/main.go | 42 +++---- v3/gotemplate/engine/engine.go | 28 ++++- v3/gotemplate/module/base.go | 93 +++++++++++--- v3/gotemplate/module/module.go | 31 +++-- v3/gotemplate/option/base.go | 114 +++++++++++------- v3/gotemplate/option/option.go | 35 +++--- v3/gotemplate/view/cli.go | 78 ++++++++++-- v3/gotemplate/view/view.go | 4 +- v3/modules/base/module.go | 65 ++++++++++ v3/modules/base/option_slug.go | 36 ++++++ .../{golang => base}/template/README.md | 0 v3/modules/{golang => base}/template/tools.go | 0 v3/modules/golang/module.go | 74 ------------ 14 files changed, 411 insertions(+), 199 deletions(-) create mode 100644 v3/modules/base/module.go create mode 100644 v3/modules/base/option_slug.go rename v3/modules/{golang => base}/template/README.md (100%) rename v3/modules/{golang => base}/template/tools.go (100%) delete mode 100644 v3/modules/golang/module.go diff --git a/.vscode/launch.json b/.vscode/launch.json index 7b31d3c0..f1ea57c7 100644 --- a/.vscode/launch.json +++ b/.vscode/launch.json @@ -11,6 +11,14 @@ "mode": "auto", "program": "${workspaceFolder}/v2/cmd/gt/main.go", "cwd": "${workspaceFolder}", + }, + { + "name": "V3 gt", + "type": "go", + "request": "launch", + "mode": "auto", + "program": "${workspaceFolder}/v3/cmd/cli/main.go", + "cwd": "${workspaceFolder}", } ] -} +} \ No newline at end of file diff --git a/v3/cmd/cli/main.go b/v3/cmd/cli/main.go index 3e2f9883..91b8eaa6 100644 --- a/v3/cmd/cli/main.go +++ b/v3/cmd/cli/main.go @@ -1,33 +1,28 @@ package main import ( + "fmt" + "os" + "github.com/schwarzit/go-template/v3/gotemplate/engine" "github.com/schwarzit/go-template/v3/gotemplate/module" - "github.com/schwarzit/go-template/v3/gotemplate/option" "github.com/schwarzit/go-template/v3/gotemplate/view" + "github.com/schwarzit/go-template/v3/modules/base" ) func main() { + if err := run(); err != nil { + fmt.Fprintf(os.Stderr, "an error occurred: %s\n", err) + os.Exit(1) + } +} + +func run() error { // Create a new module with two options: project name and description. - m := module.NewBaseModule( - "Readme", - []option.Option{ - option.NewBaseOption( - "Project Name", - "The name of the new project.", - "My Project", - nil, - nil, - ), - option.NewBaseOption( - "Project Description", - "A brief description of the new project.", - "This is a new project.", - nil, - nil, - ), - }, - ) + m, err := base.NewReadmeModule() + if err != nil { + return err + } // Create a new CLI view. cli := view.NewCLI() @@ -36,7 +31,10 @@ func main() { engine := engine.NewEngine([]module.Module{m}) // Start the engine. - if err := engine.Start(cli); err != nil { - panic(err) + err = engine.Start(cli) + if err != nil { + return err } + + return nil } diff --git a/v3/gotemplate/engine/engine.go b/v3/gotemplate/engine/engine.go index c085ec1f..facba70e 100644 --- a/v3/gotemplate/engine/engine.go +++ b/v3/gotemplate/engine/engine.go @@ -1,7 +1,10 @@ package engine import ( + "sync" + "github.com/schwarzit/go-template/v3/gotemplate/module" + "github.com/schwarzit/go-template/v3/gotemplate/option" "github.com/schwarzit/go-template/v3/gotemplate/view" ) @@ -19,8 +22,12 @@ func (e *Engine) Start(v view.View) error { // Create a channel for communication with the view. events := make(chan view.Event) + var wg sync.WaitGroup + wg.Add(1) + // Listen for events from the view and generate the project when necessary. go func() { + defer wg.Done() for event := range events { if event.Type == view.GenerateEvent { if err := e.generateProject(); err != nil { @@ -28,6 +35,7 @@ func (e *Engine) Start(v view.View) error { } else { v.ShowMessage("Project generated successfully.") } + return } } }() @@ -37,13 +45,31 @@ func (e *Engine) Start(v view.View) error { return err } + // Wait for the event listener goroutine to finish. + wg.Wait() + return nil } func (e *Engine) generateProject() error { + // Collect all options from the modules. + var allOptions []option.Option + for _, m := range e.modules { + options, err := m.GetOptions() + if err != nil { + return err + } + allOptions = append(allOptions, options...) + } + // Generate the output for each module using the current option values. for _, m := range e.modules { - if err := m.Generate(); err != nil { + templateFiles, err := m.GetTemplateFiles() + if err != nil { + return err + } + + if err := m.Generate(templateFiles, allOptions); err != nil { return err } } diff --git a/v3/gotemplate/module/base.go b/v3/gotemplate/module/base.go index 252360ba..b2838836 100644 --- a/v3/gotemplate/module/base.go +++ b/v3/gotemplate/module/base.go @@ -1,49 +1,102 @@ package module import ( + "errors" "fmt" "github.com/schwarzit/go-template/v3/gotemplate/option" ) +var ( + ErrMissingName = errors.New("missing module name") + ErrMissingOptions = errors.New("missing module options") + ErrUnimplementedMethod = errors.New("method is not implemented") +) + +// TemplateFile represents a file that will be generated from a template. +type BaseTemplateFile struct { + // SourcePath is the path to the template file. + SourcePath string + + // TargetPath is the path where the generated file will be created. + TargetPath string +} + +// Source returns the path to the template file. +func (f *BaseTemplateFile) Source() string { + return f.SourcePath +} + +// Target returns the path where the generated file will be created. +func (f *BaseTemplateFile) Target() string { + return f.TargetPath +} + +// BaseModule is a struct that implements the Module interface. type BaseModule struct { name string options []option.Option } -func NewBaseModule(name string, options []option.Option) *BaseModule { +// NewBaseModule returns a new instance of the BaseModule struct. +func NewBaseModule(name string, options []option.Option) (*BaseModule, error) { + if name == "" { + return nil, ErrMissingName + } + + if options == nil || len(options) == 0 { + return nil, ErrMissingOptions + } + return &BaseModule{ name: name, options: options, - } + }, nil } -func (m *BaseModule) GetName() string { - return m.name +// GetName returns the name of the module. +func (m *BaseModule) GetName() (option.ModuleName, error) { + if m.name == "" { + return "", ErrMissingName + } + + return option.ModuleName(m.name), nil } -func (m *BaseModule) GetOptions() []option.Option { - return m.options +// GetOptions returns the options that can be configured for the module. +func (m *BaseModule) GetOptions() ([]option.Option, error) { + if m.options == nil || len(m.options) == 0 { + return nil, ErrMissingOptions + } + + return m.options, nil } -func (m *BaseModule) GetOptionValue(title string) (string, error) { - for _, opt := range m.options { - if opt.GetTitle() == title { - return opt.GetValue(), nil +// Generate generates the project files for the module using the current +// option values and the provided templatePath. +func (m *BaseModule) Generate(files []TemplateFile, options []option.Option) error { + for _, file := range files { + fmt.Println(fmt.Sprintf("Generating file %s to %s", file.Source(), file.Target())) + } + + // print the options + for _, opt := range options { + name, err := opt.GetTitle() + if err != nil { + return err + } + value, err := opt.GetCurrentValue() + if err != nil { + return err } + fmt.Println("Option Name:", name) + fmt.Println("Option Value:", value) } - return "", fmt.Errorf("option not found: %s", title) -} -func (m *BaseModule) Generate() error { - // Implementation for generating the module's content goes here. return nil } -func (m *BaseModule) GetState() State { - state := make(State) - for _, opt := range m.options { - state[opt.GetTitle()] = opt.GetValue() - } - return state +// GetTemplateFiles returns the template files for the module. +func (m *BaseModule) GetTemplateFiles() ([]TemplateFile, error) { + return nil, ErrUnimplementedMethod } diff --git a/v3/gotemplate/module/module.go b/v3/gotemplate/module/module.go index 7f6c6328..ed805e96 100644 --- a/v3/gotemplate/module/module.go +++ b/v3/gotemplate/module/module.go @@ -2,23 +2,28 @@ package module import "github.com/schwarzit/go-template/v3/gotemplate/option" -// State represents the state of a module, as a map of string keys to string values. -type State map[string]string +// TemplateFile represents a file to be generated by a module. +type TemplateFile interface { + // Source path sets the source path of the template file. + Source() string -// TemplateModule represents a module in a template engine. + // Target path sets the target path of the generated file. + Target() string +} + +// Module is an interface that describes a module that can be used to generate +// project files. type Module interface { // GetName returns the name of the module. - GetName() string - - // GetOptions returns a slice of options for the module. - GetOptions() []option.Option + GetName() (option.ModuleName, error) - // GetOptionValue returns the value of an option by title. - GetOptionValue(title string) (string, error) + // GetOptions returns the options that can be configured for the module. + GetOptions() ([]option.Option, error) - // Generate generates the module's content. - Generate() error + // Generate generates the project files for the module using the current + // option values. + Generate([]TemplateFile, []option.Option) error - // GetState returns the state of the module. - GetState() State + // GetTemplateFiles returns the template files for the module. + GetTemplateFiles() ([]TemplateFile, error) } diff --git a/v3/gotemplate/option/base.go b/v3/gotemplate/option/base.go index 5caf4d7c..33eb8150 100644 --- a/v3/gotemplate/option/base.go +++ b/v3/gotemplate/option/base.go @@ -1,72 +1,102 @@ package option -import "fmt" +import ( + "errors" + "fmt" +) + +var ( + ErrInvalidAnswer = errors.New("invalid answer") + ErrInvalidValue = errors.New("invalid value") + ErrMissingTitle = errors.New("missing title") + ErrMissingDesc = errors.New("missing description") +) type BaseOption struct { - title string - description string - defaultValue string - availableAnswers []string - value string - validationFunc func(string) error + Title string + Description string + DefaultValue []string + AvailableAnswers []string + CurrentValue []string + ValidationFunc func([]string) error + ShouldDisplayFunc func(map[ModuleName]State) (bool, error) +} + +type NewBaseOptionArgs struct { + Title string + Description string + DefaultValue []string + AvailableAnswers []string + ValidationFunc func([]string) error + ShouldDisplayFunc func(map[ModuleName]State) (bool, error) } -func NewBaseOption(title, description, defaultValue string, availableAnswers []string, validationFunc func(string) error) *BaseOption { +func NewBaseOption(args NewBaseOptionArgs) *BaseOption { return &BaseOption{ - title: title, - description: description, - defaultValue: defaultValue, - availableAnswers: availableAnswers, - value: defaultValue, - validationFunc: validationFunc, + Title: args.Title, + Description: args.Description, + DefaultValue: args.DefaultValue, + AvailableAnswers: args.AvailableAnswers, + CurrentValue: args.DefaultValue, + ValidationFunc: args.ValidationFunc, + ShouldDisplayFunc: args.ShouldDisplayFunc, } } -func (o *BaseOption) GetTitle() string { - return o.title +func (o *BaseOption) GetTitle() (string, error) { + if o.Title == "" { + return "", ErrMissingTitle + } + return o.Title, nil } -func (o *BaseOption) GetDescription() string { - return o.description +func (o *BaseOption) GetDescription() (string, error) { + if o.Description == "" { + return "", ErrMissingDesc + } + return o.Description, nil } -func (o *BaseOption) GetDefaultValue() string { - return o.defaultValue +func (o *BaseOption) GetDefaultValue(state map[ModuleName]State) ([]string, error) { + return o.DefaultValue, nil } -func (o *BaseOption) GetAvailableAnswers() []string { - return o.availableAnswers +func (o *BaseOption) GetAvailableAnswers() ([]string, error) { + if o.AvailableAnswers == nil { + return nil, nil + } + return o.AvailableAnswers, nil } -func (o *BaseOption) GetValue() string { - return o.value +func (o *BaseOption) GetCurrentValue() ([]string, error) { + if o.CurrentValue == nil { + return nil, ErrInvalidValue + } + return o.CurrentValue, nil } -func (o *BaseOption) SetValue(value string) error { +func (o *BaseOption) SetCurrentValue(value []string) error { if err := o.Validate(value); err != nil { return err } - o.value = value + o.CurrentValue = value return nil } -func (o *BaseOption) Validate(value string) error { - if o.availableAnswers != nil { - found := false - for _, answer := range o.availableAnswers { - if answer == value { - found = true - break - } - } - if !found { - return fmt.Errorf("invalid answer: %s", value) - } +func (o *BaseOption) Validate(value []string) error { + if o.ValidationFunc == nil { + return nil } - if o.validationFunc != nil { - if err := o.validationFunc(value); err != nil { - return err - } + + if err := o.ValidationFunc(value); err != nil { + return fmt.Errorf("invalid value: %w", err) } return nil } + +func (o *BaseOption) ShouldDisplay(state map[ModuleName]State) (bool, error) { + if o.ShouldDisplayFunc == nil { + return true, nil + } + return o.ShouldDisplayFunc(state) +} diff --git a/v3/gotemplate/option/option.go b/v3/gotemplate/option/option.go index 942dae90..c3db3ef2 100644 --- a/v3/gotemplate/option/option.go +++ b/v3/gotemplate/option/option.go @@ -1,27 +1,34 @@ package option -// Option represents a configuration option that can be set by the user. +// State represents the state of a module, as a map of string keys to string values. +type State map[string][]string + +type ModuleName string type Option interface { // GetTitle returns the title of the option. - GetTitle() string + GetTitle() (string, error) // GetDescription returns the description of the option. - GetDescription() string + GetDescription() (string, error) - // GetDefaultValue returns the default value of the option. - GetDefaultValue() string + // GetDefaultValue returns the default value of the option, taking into account the + // current state of the module. + GetDefaultValue(state map[ModuleName]State) ([]string, error) - // GetAvailableAnswers returns a list of available answers for the option. - GetAvailableAnswers() []string + // GetAvailableAnswers returns the available answers for the option. If the + // option does not have a limited set of answers, it returns nil. + GetAvailableAnswers() ([]string, error) - // GetValue returns the current value of the option. - GetValue() string + // GetCurrentValue returns the current value of the option. + GetCurrentValue() ([]string, error) - // SetValue sets the value of the option to the given value. - // Returns an error if the value is invalid. - SetValue(value string) error + // SetCurrentValue sets the value of the option. + SetCurrentValue(value []string) error // Validate validates the given value for the option. - // Returns an error if the value is invalid. - Validate(value string) error + Validate(value []string) error + + // ShouldDisplay determines if the option should be displayed given the + // current state of the module. + ShouldDisplay(state map[ModuleName]State) (bool, error) } diff --git a/v3/gotemplate/view/cli.go b/v3/gotemplate/view/cli.go index c491414c..37c05cb2 100644 --- a/v3/gotemplate/view/cli.go +++ b/v3/gotemplate/view/cli.go @@ -7,9 +7,12 @@ import ( "strings" "github.com/schwarzit/go-template/v3/gotemplate/module" + "github.com/schwarzit/go-template/v3/gotemplate/option" ) -type CLI struct{} +type CLI struct { + State map[option.ModuleName]option.State +} func NewCLI() *CLI { return &CLI{} @@ -21,15 +24,52 @@ func (c *CLI) Start(modules []module.Module, events chan<- Event) error { // Iterate over the modules and prompt the user for input. for _, m := range modules { - fmt.Printf("\n=== %s ===\n", m.GetName()) + name, err := m.GetName() + if err != nil { + return err + } + fmt.Printf("\n=== %s ===\n", name) + + options, err := m.GetOptions() + if err != nil { + return err + } + + for _, o := range options { + shouldDisplay, err := o.ShouldDisplay(nil) + if err != nil { + return err + } + if !shouldDisplay { + continue + } - for _, o := range m.GetOptions() { // Print the option title and description. - fmt.Println(o.GetTitle()) - fmt.Println(o.GetDescription()) + title, err := o.GetTitle() + if err != nil { + return err + } + fmt.Println(title) + + desc, err := o.GetDescription() + if err != nil { + return err + } + fmt.Println(desc) + + defaultValue, err := o.GetDefaultValue(c.State) + if err != nil { + return err + } + if len(defaultValue) > 0 { + fmt.Printf("Default value: %s\n", strings.Join(defaultValue, ", ")) + } // Print the available answers (if any). - answers := o.GetAvailableAnswers() + answers, err := o.GetAvailableAnswers() + if err != nil { + return err + } if len(answers) > 0 { fmt.Printf("Available answers: %s\n", strings.Join(answers, ", ")) } @@ -41,14 +81,30 @@ func (c *CLI) Start(modules []module.Module, events chan<- Event) error { input := scanner.Text() // Validate the input and set the option value. - if err := o.Validate(input); err != nil { + if err := o.Validate([]string{input}); err != nil { fmt.Printf("Invalid input: %v\n", err) return err } - if err := o.SetValue(input); err != nil { + if err := o.SetCurrentValue([]string{input}); err != nil { fmt.Printf("Failed to set option value: %v\n", err) return err } + + // Merge the state. + moduleName, err := m.GetName() + if err != nil { + return err + } + if c.State == nil { + c.State = make(map[option.ModuleName]option.State) + } + if c.State[moduleName] == nil { + c.State[moduleName] = make(option.State) + } + c.State[moduleName][title], err = o.GetCurrentValue() + if err != nil { + return err + } } } @@ -60,10 +116,12 @@ func (c *CLI) Start(modules []module.Module, events chan<- Event) error { return nil } -func (c *CLI) ShowMessage(message string) { +func (c *CLI) ShowMessage(message string) error { fmt.Println(message) + return nil } -func (c *CLI) ShowError(err error) { +func (c *CLI) ShowError(err error) error { fmt.Printf("Error: %v\n", err) + return err } diff --git a/v3/gotemplate/view/view.go b/v3/gotemplate/view/view.go index 57cc261b..8636aaec 100644 --- a/v3/gotemplate/view/view.go +++ b/v3/gotemplate/view/view.go @@ -18,8 +18,8 @@ type View interface { Start(modules []module.Module, events chan<- Event) error // Show a message to the user. - ShowMessage(message string) + ShowMessage(message string) error // Show an error message to the user. - ShowError(err error) + ShowError(err error) error } diff --git a/v3/modules/base/module.go b/v3/modules/base/module.go new file mode 100644 index 00000000..dec4f220 --- /dev/null +++ b/v3/modules/base/module.go @@ -0,0 +1,65 @@ +package base + +import ( + "errors" + "fmt" + "path/filepath" + "runtime" + + "github.com/schwarzit/go-template/v3/gotemplate/module" + "github.com/schwarzit/go-template/v3/gotemplate/option" +) + +var ( + ErrUnableFindCurrentPath = errors.New("unable to get current file path") +) + +const ( + ModuleName = "README" + OptionProjectName = "Project Name" +) + +type ReadmeModule struct { + *module.BaseModule +} + +func NewReadmeModule() (*ReadmeModule, error) { + nameOption := option.NewBaseOption(option.NewBaseOptionArgs{ + Title: OptionProjectName, + Description: "The name of the project", + }) + + slugOption := SlugOption{ + BaseOption: option.NewBaseOption(option.NewBaseOptionArgs{ + Title: "Project Slug", + Description: "The name of the project slug", + }), + } + + baseModule, err := module.NewBaseModule( + ModuleName, + []option.Option{nameOption, slugOption}, + ) + if err != nil { + return nil, err + } + + return &ReadmeModule{baseModule}, nil +} + +func (m *ReadmeModule) GetTemplateFiles() ([]module.TemplateFile, error) { + _, currentFilePath, _, ok := runtime.Caller(0) + if !ok { + return nil, ErrUnableFindCurrentPath + } + currentPackagePath := filepath.Dir(currentFilePath) + + fmt.Println("Current package path:", currentPackagePath) + + return []module.TemplateFile{ + &module.BaseTemplateFile{ + SourcePath: filepath.Join(currentPackagePath, "templates", "README.md"), + TargetPath: "README.md", + }, + }, nil +} diff --git a/v3/modules/base/option_slug.go b/v3/modules/base/option_slug.go new file mode 100644 index 00000000..8c14edde --- /dev/null +++ b/v3/modules/base/option_slug.go @@ -0,0 +1,36 @@ +package base + +import ( + "regexp" + "strings" + + "github.com/schwarzit/go-template/v3/gotemplate/option" +) + +type SlugOption struct { + *option.BaseOption +} + +func (o SlugOption) GetDefaultValue(state map[option.ModuleName]option.State) ([]string, error) { + // Get the value of "Project Name" from the "README" module + projectName := state[ModuleName][OptionProjectName] + if len(projectName) == 1 { + return []string{slugify(projectName[0])}, nil + } + + return []string{}, nil +} + +func slugify(input string) string { + // Remove any non-alphanumeric or non-hyphen characters and replace with hyphens + reg, err := regexp.Compile("[^a-zA-Z0-9-]+") + if err != nil { + panic(err) + } + + // Replace any multiple consecutive hyphens with a single hyphen + input = reg.ReplaceAllString(strings.TrimSpace(input), "-") + + // Convert the string to lowercase + return strings.ToLower(input) +} diff --git a/v3/modules/golang/template/README.md b/v3/modules/base/template/README.md similarity index 100% rename from v3/modules/golang/template/README.md rename to v3/modules/base/template/README.md diff --git a/v3/modules/golang/template/tools.go b/v3/modules/base/template/tools.go similarity index 100% rename from v3/modules/golang/template/tools.go rename to v3/modules/base/template/tools.go diff --git a/v3/modules/golang/module.go b/v3/modules/golang/module.go deleted file mode 100644 index 9548d2a6..00000000 --- a/v3/modules/golang/module.go +++ /dev/null @@ -1,74 +0,0 @@ -package golang - -import ( - "fmt" - // "io/ioutil" - // "os" - // "path/filepath" - - "github.com/schwarzit/go-template/v3/gotemplate/module" - "github.com/schwarzit/go-template/v3/gotemplate/option" -) - -type ReadmeModule struct { - *module.BaseModule -} - -func NewReadmeModule() *ReadmeModule { - nameOption := option.NewBaseOption( - "Project Name", - "The name of the project", - "", - nil, - func(value string) error { - if value == "" { - return fmt.Errorf("project name cannot be empty") - } - return nil - }, - ) - - descOption := option.NewBaseOption( - "Project Description", - "A short description of the project", - "", - nil, - func(value string) error { - if value == "" { - return fmt.Errorf("project description cannot be empty") - } - return nil - }, - ) - - return &ReadmeModule{ - module.NewBaseModule("README", []option.Option{nameOption, descOption}), - } -} - -func (m *ReadmeModule) Generate() error { - // name, err := m.GetOptionValue("Project Name") - // if err != nil { - // return err - // } - - // desc, err := m.GetOptionValue("Project Description") - // if err != nil { - // return err - // } - - // content := fmt.Sprintf("# %s\n\n%s\n", name, desc) - - // dir, err := os.Getwd() - // if err != nil { - // return err - // } - - // filename := filepath.Join(dir, "README.md") - - // if err := ioutil.WriteFile(filename, []byte(content), 0644); err != nil { - // return err - // } - - return nil -} From 345745c5a35aed0733915badccc9ec01b0d39ed7 Mon Sep 17 00:00:00 2001 From: Steffen Exler Date: Sat, 29 Apr 2023 12:28:02 +0200 Subject: [PATCH 8/8] Add template generation Signed-off-by: Steffen Exler --- v3/gotemplate/engine/engine.go | 2 +- v3/gotemplate/module/base.go | 82 ++++++++++++++++++++++++++---- v3/gotemplate/module/module.go | 5 +- v3/gotemplate/option/base.go | 16 +++++- v3/gotemplate/option/option.go | 3 ++ v3/gotemplate/slugify/slugify.go | 21 ++++++++ v3/gotemplate/view/cli.go | 6 ++- v3/modules/base/module.go | 11 ++-- v3/modules/base/option_slug.go | 23 ++------- v3/modules/base/template/README.md | 39 +------------- 10 files changed, 134 insertions(+), 74 deletions(-) create mode 100644 v3/gotemplate/slugify/slugify.go diff --git a/v3/gotemplate/engine/engine.go b/v3/gotemplate/engine/engine.go index facba70e..971f2317 100644 --- a/v3/gotemplate/engine/engine.go +++ b/v3/gotemplate/engine/engine.go @@ -69,7 +69,7 @@ func (e *Engine) generateProject() error { return err } - if err := m.Generate(templateFiles, allOptions); err != nil { + if err := m.Generate(templateFiles, allOptions, "./testing-project/"); err != nil { // TODO: fix out path return err } } diff --git a/v3/gotemplate/module/base.go b/v3/gotemplate/module/base.go index b2838836..7800dda0 100644 --- a/v3/gotemplate/module/base.go +++ b/v3/gotemplate/module/base.go @@ -2,11 +2,20 @@ package module import ( "errors" - "fmt" + "html/template" + "io/fs" + "io/ioutil" + "os" + "path/filepath" "github.com/schwarzit/go-template/v3/gotemplate/option" ) +const ( + // DefaultFilePermissionRWX is the default file permission for a generated + FilePermissionRWX = 0755 +) + var ( ErrMissingName = errors.New("missing module name") ErrMissingOptions = errors.New("missing module options") @@ -20,6 +29,9 @@ type BaseTemplateFile struct { // TargetPath is the path where the generated file will be created. TargetPath string + + // File Permission is the file permission for the generated file. + Permission uint } // Source returns the path to the template file. @@ -32,6 +44,15 @@ func (f *BaseTemplateFile) Target() string { return f.TargetPath } +// FilePermission returns the file permission for the generated file. +func (f *BaseTemplateFile) FilePermission() uint { + if f.Permission == 0 { + return FilePermissionRWX + } + + return f.Permission +} + // BaseModule is a struct that implements the Module interface. type BaseModule struct { name string @@ -74,23 +95,46 @@ func (m *BaseModule) GetOptions() ([]option.Option, error) { // Generate generates the project files for the module using the current // option values and the provided templatePath. -func (m *BaseModule) Generate(files []TemplateFile, options []option.Option) error { +func (m *BaseModule) Generate(files []TemplateFile, options []option.Option, outPath string) error { + tmpl := template.New("ModuleTemplates") + for _, file := range files { - fmt.Println(fmt.Sprintf("Generating file %s to %s", file.Source(), file.Target())) - } + content, err := ioutil.ReadFile(file.Source()) + if err != nil { + return err + } - // print the options - for _, opt := range options { - name, err := opt.GetTitle() + tmpl, err = tmpl.New(file.Source()).Parse(string(content)) if err != nil { return err } - value, err := opt.GetCurrentValue() + } + + optionMap := make(map[string]interface{}) + err := updateOptionMap(optionMap, options) + if err != nil { + return err + } + + for _, file := range files { + targetPath := filepath.Join(outPath, file.Target()) + if err := os.MkdirAll(filepath.Dir(targetPath), fs.FileMode(file.FilePermission())); err != nil { + return err + } + + outFile, err := os.Create(targetPath) if err != nil { return err } - fmt.Println("Option Name:", name) - fmt.Println("Option Value:", value) + + if err := tmpl.ExecuteTemplate(outFile, file.Source(), optionMap); err != nil { + outFile.Close() + return err + } + + if err := outFile.Close(); err != nil { + return err + } } return nil @@ -100,3 +144,21 @@ func (m *BaseModule) Generate(files []TemplateFile, options []option.Option) err func (m *BaseModule) GetTemplateFiles() ([]TemplateFile, error) { return nil, ErrUnimplementedMethod } + +func updateOptionMap(optionMap map[string]interface{}, options []option.Option) error { + for _, opt := range options { + templateKey, err := opt.GetTemplateKey() + if err != nil { + return err + } + + value, err := opt.GetCurrentValue() + if err != nil { + return err + } + + optionMap[templateKey] = value + } + + return nil +} diff --git a/v3/gotemplate/module/module.go b/v3/gotemplate/module/module.go index ed805e96..7ce8ae63 100644 --- a/v3/gotemplate/module/module.go +++ b/v3/gotemplate/module/module.go @@ -9,6 +9,9 @@ type TemplateFile interface { // Target path sets the target path of the generated file. Target() string + + // FilePermission returns the file permissions for the generated file. + FilePermission() uint } // Module is an interface that describes a module that can be used to generate @@ -22,7 +25,7 @@ type Module interface { // Generate generates the project files for the module using the current // option values. - Generate([]TemplateFile, []option.Option) error + Generate(files []TemplateFile, options []option.Option, outPath string) error // GetTemplateFiles returns the template files for the module. GetTemplateFiles() ([]TemplateFile, error) diff --git a/v3/gotemplate/option/base.go b/v3/gotemplate/option/base.go index 33eb8150..9e4d347d 100644 --- a/v3/gotemplate/option/base.go +++ b/v3/gotemplate/option/base.go @@ -3,6 +3,8 @@ package option import ( "errors" "fmt" + + "github.com/schwarzit/go-template/v3/gotemplate/slugify" ) var ( @@ -13,7 +15,10 @@ var ( ) type BaseOption struct { - Title string + Title string + // TemplateTag is the tag used in the template to render the option. + // if not provided, the title is used in a slugify form. + TemplateTag string Description string DefaultValue []string AvailableAnswers []string @@ -24,6 +29,7 @@ type BaseOption struct { type NewBaseOptionArgs struct { Title string + TemplateTag string Description string DefaultValue []string AvailableAnswers []string @@ -34,6 +40,7 @@ type NewBaseOptionArgs struct { func NewBaseOption(args NewBaseOptionArgs) *BaseOption { return &BaseOption{ Title: args.Title, + TemplateTag: args.TemplateTag, Description: args.Description, DefaultValue: args.DefaultValue, AvailableAnswers: args.AvailableAnswers, @@ -50,6 +57,13 @@ func (o *BaseOption) GetTitle() (string, error) { return o.Title, nil } +func (o *BaseOption) GetTemplateKey() (string, error) { + if o.TemplateTag == "" { + return slugify.Slugify(o.Title), nil + } + return o.TemplateTag, nil +} + func (o *BaseOption) GetDescription() (string, error) { if o.Description == "" { return "", ErrMissingDesc diff --git a/v3/gotemplate/option/option.go b/v3/gotemplate/option/option.go index c3db3ef2..045fd5f4 100644 --- a/v3/gotemplate/option/option.go +++ b/v3/gotemplate/option/option.go @@ -8,6 +8,9 @@ type Option interface { // GetTitle returns the title of the option. GetTitle() (string, error) + // GetTemplateKey returns the template key of the option. + GetTemplateKey() (string, error) + // GetDescription returns the description of the option. GetDescription() (string, error) diff --git a/v3/gotemplate/slugify/slugify.go b/v3/gotemplate/slugify/slugify.go new file mode 100644 index 00000000..87a36b6e --- /dev/null +++ b/v3/gotemplate/slugify/slugify.go @@ -0,0 +1,21 @@ +package slugify + +import ( + "regexp" + "strings" +) + +// slugify converts a string to a slug. +func Slugify(input string) string { + // Remove any non-alphanumeric or non-hyphen characters and replace with hyphens + reg, err := regexp.Compile("[^a-zA-Z0-9-]+") + if err != nil { + panic(err) + } + + // Replace any multiple consecutive hyphens with a single hyphen + input = reg.ReplaceAllString(strings.TrimSpace(input), "-") + + // Convert the string to lowercase + return strings.ToLower(input) +} diff --git a/v3/gotemplate/view/cli.go b/v3/gotemplate/view/cli.go index 37c05cb2..ddac8de3 100644 --- a/v3/gotemplate/view/cli.go +++ b/v3/gotemplate/view/cli.go @@ -101,7 +101,11 @@ func (c *CLI) Start(modules []module.Module, events chan<- Event) error { if c.State[moduleName] == nil { c.State[moduleName] = make(option.State) } - c.State[moduleName][title], err = o.GetCurrentValue() + templateKey, err := o.GetTemplateKey() + if err != nil { + return err + } + c.State[moduleName][templateKey], err = o.GetCurrentValue() if err != nil { return err } diff --git a/v3/modules/base/module.go b/v3/modules/base/module.go index dec4f220..906e0f77 100644 --- a/v3/modules/base/module.go +++ b/v3/modules/base/module.go @@ -15,8 +15,9 @@ var ( ) const ( - ModuleName = "README" - OptionProjectName = "Project Name" + ModuleName = "README" + TemplateTagProjectName = "NAME" + TemplateTagProjectSlug = "SLUG" ) type ReadmeModule struct { @@ -25,13 +26,15 @@ type ReadmeModule struct { func NewReadmeModule() (*ReadmeModule, error) { nameOption := option.NewBaseOption(option.NewBaseOptionArgs{ - Title: OptionProjectName, + Title: "Project Name", + TemplateTag: TemplateTagProjectName, Description: "The name of the project", }) slugOption := SlugOption{ BaseOption: option.NewBaseOption(option.NewBaseOptionArgs{ Title: "Project Slug", + TemplateTag: TemplateTagProjectSlug, Description: "The name of the project slug", }), } @@ -58,7 +61,7 @@ func (m *ReadmeModule) GetTemplateFiles() ([]module.TemplateFile, error) { return []module.TemplateFile{ &module.BaseTemplateFile{ - SourcePath: filepath.Join(currentPackagePath, "templates", "README.md"), + SourcePath: filepath.Join(currentPackagePath, "template", "README.md"), TargetPath: "README.md", }, }, nil diff --git a/v3/modules/base/option_slug.go b/v3/modules/base/option_slug.go index 8c14edde..6de21b6d 100644 --- a/v3/modules/base/option_slug.go +++ b/v3/modules/base/option_slug.go @@ -1,10 +1,10 @@ package base import ( - "regexp" - "strings" + "fmt" "github.com/schwarzit/go-template/v3/gotemplate/option" + "github.com/schwarzit/go-template/v3/gotemplate/slugify" ) type SlugOption struct { @@ -13,24 +13,11 @@ type SlugOption struct { func (o SlugOption) GetDefaultValue(state map[option.ModuleName]option.State) ([]string, error) { // Get the value of "Project Name" from the "README" module - projectName := state[ModuleName][OptionProjectName] + fmt.Println(state[ModuleName]) + projectName := state[ModuleName][TemplateTagProjectName] if len(projectName) == 1 { - return []string{slugify(projectName[0])}, nil + return []string{slugify.Slugify(projectName[0])}, nil } return []string{}, nil } - -func slugify(input string) string { - // Remove any non-alphanumeric or non-hyphen characters and replace with hyphens - reg, err := regexp.Compile("[^a-zA-Z0-9-]+") - if err != nil { - panic(err) - } - - // Replace any multiple consecutive hyphens with a single hyphen - input = reg.ReplaceAllString(strings.TrimSpace(input), "-") - - // Convert the string to lowercase - return strings.ToLower(input) -} diff --git a/v3/modules/base/template/README.md b/v3/modules/base/template/README.md index b866442e..81ec09c4 100644 --- a/v3/modules/base/template/README.md +++ b/v3/modules/base/template/README.md @@ -1,38 +1 @@ -# {{.Base.projectName}} - -[![GoTemplate](https://img.shields.io/badge/go/template-black?logo=go)](https://github.com/SchwarzIT/go-template) - -{{.Base.projectDescription}} - -The project uses `make` to make your life easier. If you're not familiar with Makefiles you can take a look at [this quickstart guide](https://makefiletutorial.com). - -Whenever you need help regarding the available actions, just use the following command. - -```bash -make help -``` - -## Setup - -To get your setup up and running the only thing you have to do is - -```bash -make all -``` - -This will initialize a git repo, download the dependencies in the latest versions and install all needed tools. -If needed code generation will be triggered in this target as well. - -## Test & lint - -Run linting - -```bash -make lint -``` - -Run tests - -```bash -make test -``` +{{.NAME}}