diff --git a/.gitignore b/.gitignore index ea4f9c4ba88d5ebf96e2a7e90057bb6f09b68ab8..e511b1e051c1a3cb0904419967875aa0fd30cc82 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,11 @@ + +# Makefile comes from update +Makefile.example + +# Vendor +/development/vendor/ +/deployment/vendor/ + # Created by https://www.toptal.com/developers/gitignore/api/intellij+iml,phpunit,git,vim,visualstudiocode,phpstorm,go,intellij+all,netbeans,dbeaver,node,yarn # Edit at https://www.toptal.com/developers/gitignore?templates=intellij+iml,phpunit,git,vim,visualstudiocode,phpstorm,go,intellij+all,netbeans,dbeaver,node,yarn @@ -7,7 +15,7 @@ ### Git ### # Created by git for backups. To disable backups in Git: -# git config --global mergetool.keepBackup false +# $ git config --global mergetool.keepBackup false *.orig # Created by git when using merge tools for conflicts @@ -415,7 +423,8 @@ dist # Cache file creation bug # See https://youtrack.jetbrains.com/issue/JBR-2257 -.idea/ACHE_FILE +.idea/$CACHE_FILE$ + # CodeStream plugin # https://plugins.jetbrains.com/plugin/12206-codestream .idea/codestream.xml @@ -501,4 +510,3 @@ tags # and uncomment the following lines # .pnp.* - diff --git a/Makefile b/Makefile index 87f019a87919466cc655d249ff75f9e2f8e05bdd..932185900f69ebc5ab05ca826ede69d90d07fe3b 100644 --- a/Makefile +++ b/Makefile @@ -21,12 +21,14 @@ THIS_MAKEFILE_PATH:=$(word $(words $(MAKEFILE_LIST)),$(MAKEFILE_LIST)) PROJECT_ROOT:=$(shell cd $(dir $(THIS_MAKEFILE_PATH));pwd)/ THIS_MAKEFILE:=$(PROJECT_ROOT)$(THIS_MAKEFILE_PATH) - +# include project.mk only if it exists -include $(PROJECT_ROOT)project.mk -## Define the location of Makefiles +# Define the location of Makefiles MAKEFILE_IMPORT_PATH?=$(PROJECT_ROOT)makefiles/ + +# include project.mk only if it exists -include $(MAKEFILE_IMPORT_PATH)project.mk ############################################################################################# @@ -41,30 +43,43 @@ include $(MAKEFILE_IMPORT_PATH)directories-standard.mk include $(MAKEFILE_IMPORT_PATH)jsdoc.mk include $(MAKEFILE_IMPORT_PATH)output.mk include $(MAKEFILE_IMPORT_PATH)placeholder.mk +include $(MAKEFILE_IMPORT_PATH)conan.mk include $(MAKEFILE_IMPORT_PATH)s3.mk +#include $(MAKEFILE_IMPORT_PATH)readme-standard.mk +include $(MAKEFILE_IMPORT_PATH)readme-webcomponents.mk +include $(MAKEFILE_IMPORT_PATH)licenses.mk include $(MAKEFILE_IMPORT_PATH)license-agpl3.mk +#include $(MAKEFILE_IMPORT_PATH)license-unlicensed.mk +#include $(MAKEFILE_IMPORT_PATH)license-all-rights-reserved.mk include $(MAKEFILE_IMPORT_PATH)jsdoc-json.mk -#include $(MAKEFILE_IMPORT_PATH)go.mk +include $(MAKEFILE_IMPORT_PATH)go.mk +include $(MAKEFILE_IMPORT_PATH)changelog.mk +#include $(MAKEFILE_IMPORT_PATH)docman.mk +#include $(MAKEFILE_IMPORT_PATH)reqman.mk +include $(MAKEFILE_IMPORT_PATH)git.mk include $(MAKEFILE_IMPORT_PATH)gitignore.mk include $(MAKEFILE_IMPORT_PATH)color.mk include $(MAKEFILE_IMPORT_PATH)version.mk +#include $(MAKEFILE_IMPORT_PATH)docker.mk include $(MAKEFILE_IMPORT_PATH)node.mk include $(MAKEFILE_IMPORT_PATH)terminal.mk -#include $(MAKEFILE_IMPORT_PATH)target-go-fetch-licenses.mk -include $(MAKEFILE_IMPORT_PATH)target-deploy-tool.mk +include $(MAKEFILE_IMPORT_PATH)target-go-fetch-licenses.mk +include $(MAKEFILE_IMPORT_PATH)target-add-licenses.mk +#include $(MAKEFILE_IMPORT_PATH)target-deploy-tool.mk include $(MAKEFILE_IMPORT_PATH)target-jsdoc-build.mk -include $(MAKEFILE_IMPORT_PATH)target-jekyll.mk -include $(MAKEFILE_IMPORT_PATH)target-minerva.mk #include $(MAKEFILE_IMPORT_PATH)target-docman.mk -include $(MAKEFILE_IMPORT_PATH)target-node-build.mk #include $(MAKEFILE_IMPORT_PATH)target-caddy.mk +include $(MAKEFILE_IMPORT_PATH)target-conan.mk include $(MAKEFILE_IMPORT_PATH)target-update-makefiles.mk include $(MAKEFILE_IMPORT_PATH)target-help.mk #include $(MAKEFILE_IMPORT_PATH)target-go-build.mk +include $(MAKEFILE_IMPORT_PATH)target-node-build.mk include $(MAKEFILE_IMPORT_PATH)target-node-test.mk include $(MAKEFILE_IMPORT_PATH)target-npm-publish.mk include $(MAKEFILE_IMPORT_PATH)target-git.mk -include $(MAKEFILE_IMPORT_PATH)target-init-standard.mk +#include $(MAKEFILE_IMPORT_PATH)target-init-standard.mk +#include $(MAKEFILE_IMPORT_PATH)target-init-webcomponent.mk +include $(MAKEFILE_IMPORT_PATH)target-version.mk include $(MAKEFILE_IMPORT_PATH)target-variable.mk include $(MAKEFILE_IMPORT_PATH)terminal-check.mk diff --git a/application/package.json b/application/package.json index 808b0f9083ead4e8044a3ab65accf3901bf24fdb..bbb8cdcabe2bb8263ec304ddb31b6c690b5649f8 100644 --- a/application/package.json +++ b/application/package.json @@ -1,6 +1,6 @@ { "name": "@schukai/monster", - "version": "2.0.8", + "version": "2.0.14", "description": "Monster is a simple library for creating fast, robust and lightweight websites.", "keywords": [ "framework", diff --git a/application/source/types/version.mjs b/application/source/types/version.mjs index fbf0274aee735ca7c65204b226c3eb383d9c3c19..155a657b3f46f77ac7ac130edfebe000befb485d 100644 --- a/application/source/types/version.mjs +++ b/application/source/types/version.mjs @@ -137,7 +137,7 @@ function getMonsterVersion() { } /** don't touch, replaced by make with package.json version */ - monsterVersion = new Version('2.0.8') + monsterVersion = new Version('2.0.14') return monsterVersion; diff --git a/development/makefiles/changelog.mk b/development/makefiles/changelog.mk new file mode 100644 index 0000000000000000000000000000000000000000..8e1faf9039df98c04a2cd5ca4ba01a88af4c6ae0 --- /dev/null +++ b/development/makefiles/changelog.mk @@ -0,0 +1,138 @@ +############################################################################################# +############################################################################################# +## +## CHANGELOG +## +############################################################################################# +############################################################################################# + + +GIT_CHGLOG_BIN := $(shell command -v git-chglog 2> /dev/null) +GIT_CHGLOG_CONFIG_DIR := $(PROJECT_ROOT).chglog +REPOSURL := $(subst .git,,$(subst $(shell git config --get user.name)@,,$(shell git config --get remote.origin.url))) + +ifeq ($(GO),) + $(error $(ERRORMARKER) GO is not defined) +endif + +ifeq ($(GIT_CHGLOG_BIN),) + $(shell $(GO) install github.com/git-chglog/git-chglog/cmd/git-chglog@latest) +endif + +ifneq ($(shell test -d $(GIT_CHGLOG_CONFIG_DIR) && echo -n yes),yes) + $(shell mkdir -p $(GIT_CHGLOG_CONFIG_DIR)) +endif + +remove-config-files: + $(shell rm -Rf $(GIT_CHGLOG_CONFIG_DIR)/ && mkdir -p $(GIT_CHGLOG_CONFIG_DIR)) + +.PHONY: update-chglog-files +## update standard git-chglog configuration files +update-chglog-files: remove-config-files $(GIT_CHGLOG_CONFIG_DIR)/config.yml $(GIT_CHGLOG_CONFIG_DIR)/CHANGELOG.tpl.md + $(ECHOMARKER) "update standard git-chglog configuration files" + +define GIT_CHGLOG_CONFIG_FILE +style: gitlab +template: CHANGELOG.tpl.md +info: + title: CHANGELOG + repository_url: $(REPOSURL) +options: + commits: + filters: + Type: + - feat + - fix + - doc + - refactor + - perf + - test + - chore + ## deprecated types and typos + - docs + - documentation + - feat + - added + - add + - bugfix + - revert + - update + - updates + - change + - changed + commit_groups: + title_maps: + feat: Add Features + fix: Bug Fixes + doc: Documentation + refactor: Code Refactoring + perf: Performance Improvements + test: Tests + ## Chore is used for all other changes that don't fit in the other categories + chore: Changes + ## deprecated types and typos + docs: Documentation + documentation: Documentation + added: Add Features + add: Add Features + bugfix: Bug Fixes + revert: Reverts + update: Changes + updates: Changes + change: Changes + changed: Changes + header: + pattern: "^(\\w*)(?:\\(([\\w\\$$\\.\\-\\*\\s]*)\\))?\\:\\s(.*)$$" + pattern_maps: + - Type + - Scope + - Subject + notes: + keywords: + - BREAKING CHANGE +endef + +export GIT_CHGLOG_CONFIG_FILE + +$(GIT_CHGLOG_CONFIG_DIR)/config.yml: + $(QUITE) $(ECHO) "$$GIT_CHGLOG_CONFIG_FILE" >> $@ + +define GIT_CHGLOG_CONFIG_TEMPLATE +{{ range .Versions }} +<a name="{{ .Tag.Name }}"></a> +## {{ if .Tag.Previous }}[{{ .Tag.Name }}]{{ else }}{{ .Tag.Name }}{{ end }} - {{ datetime "2006-01-02" .Tag.Date }} +{{ range .CommitGroups -}} +### {{ .Title }} +{{ range .Commits -}} +- {{ if .Scope }}**{{ .Scope }}:** {{ end }}{{ .Subject }} +{{ end }} +{{ end -}} + +{{- if .NoteGroups -}} +{{ range .NoteGroups -}} +### {{ .Title }} +{{ range .Notes }} +{{ .Body }} +{{ end }} +{{ end -}} +{{ end -}} +{{ end -}} + +{{- if .Versions }} +{{ range .Versions -}} +{{ if .Tag.Previous -}} +[{{ .Tag.Name }}]: {{ $$.Info.RepositoryURL }}/compare/{{ .Tag.Previous.Name }}...{{ .Tag.Name }} +{{ end -}} +{{ end -}} +{{ end -}} +endef + +export GIT_CHGLOG_CONFIG_TEMPLATE + + +$(GIT_CHGLOG_CONFIG_DIR)/CHANGELOG.tpl.md: + $(QUITE) $(ECHO) "$$GIT_CHGLOG_CONFIG_TEMPLATE" >> $@ + +## location of CHANGELOG.md file +CHANGELOG_FILE ?= $(PROJECT_ROOT)CHANGELOG.md +EXECUTABLES = $(EXECUTABLES:-) $(GIT_CHGLOG_BIN) \ No newline at end of file diff --git a/development/makefiles/conan.mk b/development/makefiles/conan.mk new file mode 100644 index 0000000000000000000000000000000000000000..f7707dbc9501e743477ae1a55efa26fdcb119f8d --- /dev/null +++ b/development/makefiles/conan.mk @@ -0,0 +1,51 @@ +############################################################################################# +############################################################################################# +## +## DEFINE CONAN +## +############################################################################################# +############################################################################################# + + +CONAN_BIN ?= $(VENDOR_PATH)conan +CONAN_CONFIG ?= $(VENDOR_PATH)conan.conf + +define CONANEXAMPLECONF +Server: + + # The hostname or IP address of the server (CONAN_SERVER_HOST) + # Domain, IP or hostname of the server + #Host: localhost:8080 + + # The port of the server (CONAN_SERVER_ADDRESS) + # Address: localhost + + # The port of the server (CONAN_SERVER_PORT) + # Port: 8080 + + # + Path: + # The path to the server (CONAN_SERVER_WEB_PATH) + Web: web + + Watch: + - Path: src + Command: /bin/bash -c "npx esbuild --bundle --outfile={{ .WebPath }}/scripts/bundle.js --sourcemap {{ .Path }}" + Exclude: + - ~$ + - ^\. + - Path: web + Exclude: + - ~$ + - ^\. + + Flags: + FollowSymlinks: true + +endef + +export CONANEXAMPLECONF + +$(CONAN_CONFIG): + $(QUITE) $(ECHO) "$$CONANEXAMPLECONF" >> $@ + diff --git a/development/makefiles/directories-standard.mk b/development/makefiles/directories-standard.mk index aedb8969dff906b0907f0260d27a8ce7aed83d41..177cbf2c0fb73e383943a1aa3745d82ebaee3443 100644 --- a/development/makefiles/directories-standard.mk +++ b/development/makefiles/directories-standard.mk @@ -29,6 +29,7 @@ VENDOR_PATH ?= $(DEPLOYMENT_PATH)vendor/ TEST_PATH ?= $(DEVELOPMENT_PATH)test/ DEPLOYMENT_SCRIPTS_PATH ?= $(DEPLOYMENT_PATH)script/ +LICENSE_PATH ?= $(PROJECT_ROOT) PROJECT_DIRECTORIES := $(PROJECT_DIRECTORIES) \ $(APPLICATION_PATH) \ @@ -43,5 +44,6 @@ PROJECT_DIRECTORIES := $(PROJECT_DIRECTORIES) \ $(DOCUMENTATION_PATH) \ $(REQUIREMENT_PATH) \ $(CREDENTIALS_PATH) \ + $(LICENSE_PATH) \ $(BUILD_PATH) - \ No newline at end of file + diff --git a/development/makefiles/docker.mk b/development/makefiles/docker.mk new file mode 100644 index 0000000000000000000000000000000000000000..4bc7f6c984beb519d1fbc767d0480920bc72f49a --- /dev/null +++ b/development/makefiles/docker.mk @@ -0,0 +1,11 @@ +############################################################################################# +############################################################################################# +## +## DOCKER +## +############################################################################################# +############################################################################################# + +DOCKER ?= docker +EXECUTABLES = $(EXECUTABLES:-) $(DOCKER); + diff --git a/development/makefiles/docman.mk b/development/makefiles/docman.mk new file mode 100644 index 0000000000000000000000000000000000000000..cc61cff5ba99d12818613002164e4aaf3353b7ac --- /dev/null +++ b/development/makefiles/docman.mk @@ -0,0 +1,10 @@ +############################################################################################# +############################################################################################# +## +## DOCMAN +## +############################################################################################# +############################################################################################# + + +DOCMAN_BIN ?= $(VENDOR_PATH)docman diff --git a/development/makefiles/git.mk b/development/makefiles/git.mk new file mode 100644 index 0000000000000000000000000000000000000000..5521077229d9fa29ad53cb945b872db978996347 --- /dev/null +++ b/development/makefiles/git.mk @@ -0,0 +1,12 @@ +############################################################################################# +############################################################################################# +## +## GIT +## +############################################################################################# +############################################################################################# + +GIT ?= git +UUIDGEN ?= uuidgen + +EXECUTABLES = $(EXECUTABLES:-) $(UUIDGEN) $(GIT) \ No newline at end of file diff --git a/development/makefiles/gitignore.mk b/development/makefiles/gitignore.mk index 4131f64a25d954c6a461a624798e67c174d8c701..0dc290ddf7f72e198a3c5b630eb22e415431ece5 100644 --- a/development/makefiles/gitignore.mk +++ b/development/makefiles/gitignore.mk @@ -7,6 +7,14 @@ ############################################################################################# define GITIGNOREDS + +# Makefile comes from update +Makefile.example + +# Vendor +/development/vendor/ +/deployment/vendor/ + # Created by https://www.toptal.com/developers/gitignore/api/intellij+iml,phpunit,git,vim,visualstudiocode,phpstorm,go,intellij+all,netbeans,dbeaver,node,yarn # Edit at https://www.toptal.com/developers/gitignore?templates=intellij+iml,phpunit,git,vim,visualstudiocode,phpstorm,go,intellij+all,netbeans,dbeaver,node,yarn diff --git a/development/makefiles/go.mk b/development/makefiles/go.mk index 29955369f69ad15bb22c2cd1c77bdd127977aaf9..00ff9478e3e0d69e4370abb88dcaca5f88185437 100644 --- a/development/makefiles/go.mk +++ b/development/makefiles/go.mk @@ -10,3 +10,7 @@ GO := go EXECUTABLES = $(EXECUTABLES:-) $(GO); + +ifeq ($(shell command -v $(GO) 2> /dev/null),) + $(error "go is not installed. Please install go <https://go.dev/doc/install>") +endif diff --git a/development/makefiles/license-agpl3.mk b/development/makefiles/license-agpl3.mk index ebb06a7123fe3efbd7f1f8d5bc70608a76c84674..9b3a5a9fa2093cf57953e04be5dce0d2079f44c8 100644 --- a/development/makefiles/license-agpl3.mk +++ b/development/makefiles/license-agpl3.mk @@ -1,7 +1,7 @@ ############################################################################################# ############################################################################################# ## -## COLORS +## AGPL 3.0 LICENSE ## ############################################################################################# ############################################################################################# @@ -9,5 +9,692 @@ ## License used in the project LICENSE_TEXT ?= AGPL 3.0 +## The spdx license identifier +SPDX_LICENSE_ID ?= AGPL-3.0 + ## Copyright holder of the project -COPYRIGHT_TEXT ?= © schukai GmbH, Released under the $(LICENSE_TEXT) License. \ No newline at end of file +COPYRIGHT_TEXT ?= © schukai GmbH, Released under the $(LICENSE_TEXT) License. + +## Copyright URL +COPYRIGHT_URL ?= [AGPL](https://www.gnu.org/licenses/agpl-3.0.de.html) + +## The owner of the project +COPYRIGHT_OWNER ?= schukai GmbH + + +define LICENSE_FILE_CONTENT +LICENSE + +* All content residing under the "documentation/" directory of this repository is licensed under "Creative Commons: CC BY-SA 4.0 license". +* All content that resides under the "application/" directory of this repository, if that directory exists, is licensed under the license defined in "application/LICENSE". +* All third-party components that are integrated into our software are licensed under the original licence provided by the owner of the respective component. +* Content outside the above directories or restrictions is available under the "AGPL 3.0" licence as defined here: https://www.gnu.org/licenses/agpl-3.0.en.html + +endef + + +define LICENSE_AGPL_FILE_CONTENT + GNU AFFERO GENERAL PUBLIC LICENSE + Version 3, 19 November 2007 + + Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed. + + Preamble + + The GNU Affero General Public License is a free, copyleft license for +software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software. + + The licenses for most software and other practical works are designed +to take away your freedom to share and change the works. By contrast, +our General Public Licenses are intended to guarantee your freedom to +share and change all versions of a program--to make sure it remains free +software for all its users. + + When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things. + + Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software. + + A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public. + + The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version. + + An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license. + + The precise terms and conditions for copying, distribution and +modification follow. + + TERMS AND CONDITIONS + + 0. Definitions. + + "This License" refers to version 3 of the GNU Affero General Public License. + + "Copyright" also means copyright-like laws that apply to other kinds of +works, such as semiconductor masks. + + "The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations. + + To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work. + + A "covered work" means either the unmodified Program or a work based +on the Program. + + To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well. + + To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying. + + An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion. + + 1. Source Code. + + The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work. + + A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language. + + The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it. + + The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work. + + The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source. + + The Corresponding Source for a work in source code form is that +same work. + + 2. Basic Permissions. + + All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law. + + You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you. + + Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary. + + 3. Protecting Users' Legal Rights From Anti-Circumvention Law. + + No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures. + + When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures. + + 4. Conveying Verbatim Copies. + + You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program. + + You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee. + + 5. Conveying Modified Source Versions. + + You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions: + + a) The work must carry prominent notices stating that you modified + it, and giving a relevant date. + + b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices". + + c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it. + + d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so. + + A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate. + + 6. Conveying Non-Source Forms. + + You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways: + + a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange. + + b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge. + + c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b. + + d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements. + + e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d. + + A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work. + + A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product. + + "Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made. + + If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM). + + The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network. + + Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying. + + 7. Additional Terms. + + "Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions. + + When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission. + + Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms: + + a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or + + b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or + + c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or + + d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or + + e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or + + f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors. + + All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further +restriction, you may remove that term. If a license document contains +a further restriction but permits relicensing or conveying under this +License, you may add to a covered work material governed by the terms +of that license document, provided that the further restriction does +not survive such relicensing or conveying. + + If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms. + + Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way. + + 8. Termination. + + You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11). + + However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation. + + Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice. + + Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10. + + 9. Acceptance Not Required for Having Copies. + + You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so. + + 10. Automatic Licensing of Downstream Recipients. + + Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License. + + An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts. + + You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it. + + 11. Patents. + + A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version". + + A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License. + + Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version. + + In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party. + + If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid. + + If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it. + + A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007. + + Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law. + + 12. No Surrender of Others' Freedom. + + If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program. + + 13. Remote Network Interaction; Use with the GNU General Public License. + + Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph. + + Notwithstanding any other provision of this License, you have +permission to link or combine any covered work with a work licensed +under version 3 of the GNU General Public License into a single +combined work, and to convey the resulting work. The terms of this +License will continue to apply to the part which is the covered work, +but the work with which it is combined will remain governed by version +3 of the GNU General Public License. + + 14. Revised Versions of this License. + + The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new versions +will be similar in spirit to the present version, but may differ in detail to +address new problems or concerns. + + Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero General +Public License "or any later version" applies to it, you have the +option of following the terms and conditions either of that numbered +version or of any later version published by the Free Software +Foundation. If the Program does not specify a version number of the +GNU Affero General Public License, you may choose any version ever published +by the Free Software Foundation. + + If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that proxy's +public statement of acceptance of a version permanently authorizes you +to choose that version for the Program. + + Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version. + + 15. Disclaimer of Warranty. + + THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION. + + 16. Limitation of Liability. + + IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES. + + 17. Interpretation of Sections 15 and 16. + + If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee. + + END OF TERMS AND CONDITIONS + + How to Apply These Terms to Your New Programs + + If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms. + + To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found. + + <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as published by + the Free Software Foundation, either version 3 of the License, or + (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see <https://www.gnu.org/licenses/>. + +Also add information on how to contact you by electronic and paper mail. + + If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements. + + You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +<https://www.gnu.org/licenses/>. +endef + + diff --git a/development/makefiles/license-all-rights-reserved.mk b/development/makefiles/license-all-rights-reserved.mk new file mode 100644 index 0000000000000000000000000000000000000000..84642719ca80e1aaa2e5f7ae2f0fbc679870eee8 --- /dev/null +++ b/development/makefiles/license-all-rights-reserved.mk @@ -0,0 +1,72 @@ +############################################################################################# +############################################################################################# +## +## AGPL 3.0 LICENSE +## +############################################################################################# +############################################################################################# + +## License used in the project +LICENSE_TEXT ?= All rights reserved + +## The spdx license identifier +SPDX_LICENSE_ID ?= + +## Copyright holder of the project +COPYRIGHT_TEXT ?= © schukai GmbH, $(LICENSE_TEXT). + +## The owner of the project +COPYRIGHT_OWNER ?= schukai GmbH + +COPYRIGHT_URL ?= [LICENSE](https://www.schukai.com/) + +define LICENSE_FILE_CONTENT +# End User Licence Agreement (EULA) + +This End User Licence Agreement ("EULA") is a legal agreement between you and schukai GmbH. + +This EULA governs your purchase and use of our software ("Software") directly from schukai GmbH or indirectly through a reseller or distributor authorized by schukai GmbH (a "Reseller"). + +Please read this EULA carefully before completing the installation process and using the software. It contains a licence to use the software, as well as warranty information and disclaimers. + +If you register for a free trial version of the software, this EULA also applies to that trial version. By clicking "Accept" or installing and/or using the software, you acknowledge that you accept the Software and agree to be bound by the terms of this EULA. + +If you are entering into this EULA on behalf of a company or other legal entity, you represent that you have the authority to bind that company and its affiliates to these terms. If you do not have such authority or do not agree to the terms of this EULA, you may not install or use the Software and you are not required to accept this EULA. + +This EULA applies only to the Software supplied by schukai GmbH herewith, whether other software is referred to or described herein. The Terms also apply to all updates, supplements, internet-based services and support services provided by schukai GmbH for the Software, unless different terms and conditions are attached to those items at the time of delivery. Where this is the case, these Terms shall apply. + +## Grant of Licence + +schukai GmbH hereby grants you a personal, non-transferable, non-exclusive licence to use the software on your Devices in accordance with the terms of this EULA. + +You are authorized to download the software onto a device (e.g. PC, laptop, mobile phone or tablet) that is under your control. You are responsible for ensuring that your device meets the minimum requirements of the software. + +**In addition, you are not permitted to:** + +* Edit, alter, modify, adapt, translate or otherwise change the Software in whole or in part, nor allow the Software to be combined with or incorporated into other software in whole or in part, nor decompile, disassemble or reverse engineer the Software or attempt to do any such things reproduce, copy, distribute, resell or otherwise use the Software for commercial purposes +* Allow any third party to use the Software on behalf of or for any third party +* Use the Software in a manner that violates any applicable local, national or international law use the Software for any purpose that, in the opinion of schukai GmbH, constitutes a breach of this EULA. + +## Intellectual Property and Proprietary Rights + +schukai GmbH shall at all times retain ownership of the Software originally downloaded by you and of any subsequent downloads of the Software by you. + +The Software (and the copyright and other intellectual property rights of any kind in the Software, including any modifications made thereto) are and shall remain the property of schukai GmbH. + +schukai GmbH reserves the right to license the use of the Software to third parties. + +## Termination + +This EULA is effective from the date you first use the Software and shall remain in effect until terminated. You may terminate it at any time by giving written notice to schukai GmbH. + +It will also terminate immediately if you fail to comply with any of the terms of this EULA. Upon such termination, the licences granted by this EULA shall immediately terminate, and you agree to cease all access to and use of the Software. The provisions that by their nature continue and survive shall survive any termination of this EULA. + +## Governing Law + +This EULA and any dispute arising out of or in connection with this EULA shall be governed by and construed in accordance with the laws of Germany. + +endef + + + + diff --git a/development/makefiles/license-unlicensed.mk b/development/makefiles/license-unlicensed.mk new file mode 100644 index 0000000000000000000000000000000000000000..953b34bb8d7f667ee976c26a4de501d54ab48adf --- /dev/null +++ b/development/makefiles/license-unlicensed.mk @@ -0,0 +1,21 @@ +############################################################################################# +############################################################################################# +## +## UNLICENSED +## +############################################################################################# +############################################################################################# + +## License used in the project +LICENSE_TEXT ?= UNLICENSED + +## The spdx license identifier +SPDX_LICENSE_ID ?= + +## Copyright holder of the project +COPYRIGHT_TEXT ?= © schukai GmbH, $(LICENSE_TEXT). + +COPYRIGHT_URL ?= [LICENSE](https://www.schukai.com/) + +## The owner of the project +COPYRIGHT_OWNER ?= schukai GmbH diff --git a/development/makefiles/licenses.mk b/development/makefiles/licenses.mk new file mode 100644 index 0000000000000000000000000000000000000000..667c68aa9bbfac4fb5f0bb5501943f4ed52c511d --- /dev/null +++ b/development/makefiles/licenses.mk @@ -0,0 +1,21 @@ +############################################################################################# +############################################################################################# +## +## LICENSE +## +############################################################################################# +############################################################################################# + +ifneq "$(wildcard $(SOURCE_PATH) )" "" + ## Files wich should be checked for license headers + LICENSE_FILE_PATTERN ?= $(SOURCE_PATH).*{go,js,php} +endif + +# https://spdx.github.io/spdx-spec/v2.3/SPDX-license-list/ +ADDLICENSE_BIN ?= addlicense +ifeq ($(shell command -v $(ADDLICENSE_BIN) 2> /dev/null),) + $(shell $(GO) install github.com/google/addlicense@latest) + EXECUTABLES = $(EXECUTABLES:-) $(ADDLICENSE_BIN); +endif + +EXECUTABLES = $(EXECUTABLES:-) $(ADDLICENSE_BIN) diff --git a/development/makefiles/node.mk b/development/makefiles/node.mk index 346fe3bec228435cb40e41c83f6b95ac36bc75ce..4c1bf4e4330dbd5511e989adf86143ae8f1eadaf 100644 --- a/development/makefiles/node.mk +++ b/development/makefiles/node.mk @@ -11,11 +11,12 @@ NODEJS ?= node NODE ?= node NPM ?= pnpm -EXECUTABLES = $(EXECUTABLES:-) $(PNPM); +EXECUTABLES = $(EXECUTABLES:-) $(NPM); NODE_PACKAGES := $(shell find $(PROJECT_ROOT) -type f -name 'package.json' -not -path '*/node_modules/*') NODE_MODULES := $(shell find $(PROJECT_ROOT) -type d -name 'node_modules' -prune) -NODE_MODULES_MODIFIED := $(shell find $(PROJECT_ROOT) -type d -name 'node_modules' -prune -exec echo {}/.modified \; ) + +NODE_MODULES_MODIFIED := $(shell find $(PROJECT_ROOT) -type f -name 'package.json' -not -path '*/node_modules/*' -exec sh -c 'F=$$(dirname {}); echo $${F}/node_modules/.modified' \;) $(NODE_MODULES_MODIFIED): $(NODE_PACKAGES) $(ECHOMARKER) "Updating node modules..." @@ -23,8 +24,10 @@ $(NODE_MODULES_MODIFIED): $(NODE_PACKAGES) DIR=$$(dirname $$p); \ echo "Updating package: $${DIR}" ;\ $(NPM) install --prefix $${DIR} ;\ - done ; \ - touch $(NODE_MODULES_MODIFIED) + if [ -d $${DIR}/node_modules/ ]; then \ + touch $${DIR}/node_modules/.modified ;\ + fi ;\ + done ## Main Develpoment Node Repos NODE_ROOT_DIR ?= $(DEVELOPMENT_PATH) @@ -41,11 +44,12 @@ MOCHA ?= $(NODE_MODULES_BIN_DIR)mocha PACKAGE_JSON ?= $(NODE_ROOT_DIR)package.json -MJS_SOURCE_FILES := $(shell find $(SOURCE_PATH) -name '*.mjs') -MJS_RELATIVE_SOURCE_FILES := $(shell find $(SOURCE_PATH) -name '*.mjs' -exec realpath --relative-to $(PROJECT_ROOT) {} \; ) - -JS_SOURCE_FILES := $(shell find $(SOURCE_PATH) -name '*.js') -JS_RELATIVE_SOURCE_FILES := $(shell find $(SOURCE_PATH) -name '*.js' -exec realpath --relative-to $(PROJECT_ROOT) {} \; ) +ifneq "$(wildcard $(SOURCE_PATH) )" "" + MJS_SOURCE_FILES := $(shell find $(SOURCE_PATH) -name '*.mjs') + MJS_RELATIVE_SOURCE_FILES := $(shell find $(SOURCE_PATH) -name '*.mjs' -exec realpath --relative-to $(PROJECT_ROOT) {} \; ) + JS_SOURCE_FILES := $(shell find $(SOURCE_PATH) -name '*.js') + JS_RELATIVE_SOURCE_FILES := $(shell find $(SOURCE_PATH) -name '*.js' -exec realpath --relative-to $(PROJECT_ROOT) {} \; ) +endif diff --git a/development/makefiles/placeholder.mk b/development/makefiles/placeholder.mk index c99024c96bfb32c566687f0547c4f01f5d7c9aaa..7b79026ced6a04468d12c2407b5e4838509d69f0 100644 --- a/development/makefiles/placeholder.mk +++ b/development/makefiles/placeholder.mk @@ -6,4 +6,4 @@ ############################################################################################# ############################################################################################# -COMPONENT_SLUG := $(shell echo "$(COMPONENT_NAME)" | tr '[:upper:]' '[:lower:]') \ No newline at end of file +COMPONENT_SLUG := $(shell echo "$(COMPONENT_NAME)" | tr '[:upper:]' '[:lower:]') diff --git a/development/makefiles/readme-standard.mk b/development/makefiles/readme-standard.mk new file mode 100644 index 0000000000000000000000000000000000000000..d9fd70eaef9ef4f0ffaa1f786dd98771d3665ca1 --- /dev/null +++ b/development/makefiles/readme-standard.mk @@ -0,0 +1,45 @@ +############################################################################################# +############################################################################################# +## +## README +## +############################################################################################# +############################################################################################# + + +define README_FILE_CONTENT +# $(COMPONENT_NAME) + +$(COMPONENT_NAME) is ... + +## Documentation + +To check out docs and examples, visit .... + +## Installation + + +## Usage + + +## Questions + +For questions and commercial support, please contact [schukai GmbH](https://www.schukai.com/). +The issue list of this repo is exclusively for bug reports and feature requests. + +## Issues + +Please make sure to read the Issue Reporting Checklist before opening an +issue. Issues not conforming to the guidelines may be closed immediately. + +## License + +$(COPYRIGHT_TEXT) + +$(COPYRIGHT_URL) + +You can also purchase a commercial license. + + +endef + diff --git a/development/makefiles/readme-webcomponents.mk b/development/makefiles/readme-webcomponents.mk new file mode 100644 index 0000000000000000000000000000000000000000..b80cf440c59a7148b44003ce2bd62d09488dd27c --- /dev/null +++ b/development/makefiles/readme-webcomponents.mk @@ -0,0 +1,106 @@ +############################################################################################# +############################################################################################# +## +## README +## +############################################################################################# +############################################################################################# + + +define README_FILE_CONTENT +# $(COMPONENT_NAME) + +$(COMPONENT_NAME) is a lightweight, robust and easy-to-use form library with modest ambitions. +The component easily integrates with your existing websites without taking over everything. + +One design target is to reach the shiny sun with as little JavaScript as possible. + +Monster was built with ES6 modules and uses [import](https://developer.mozilla.org/en/docs/Web/JavaScript/Reference/Statements/import) +and [export](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Statements/export). + +For some functions, you need additional [polyfills](#polyfill). + +## Documentation + +To check out docs and examples, visit [monsterjs.org/en/doc/$(COMPONENT_SLUG)/](https://monsterjs.org/en/doc/$(COMPONENT_SLUG)/). + +## Installation + +`npm install @schukai/$(COMPONENT_SLUG)`, `yarn install @schukai/$(COMPONENT_SLUG)` or `pnpm install @schukai/$(COMPONENT_SLUG)` + +## Usage + +A simple example of the use of functionality from Monster. We create a small file `index.mjs`. +The `m` in `.mjs` stands for module. In the example we want to make substitutions in a string. + +```js +const button = document.createElement('monster-button'); +button.setOption('labels.button', 'click me'); +button.setOption('actions.click', (e) => { + document.getElementById('example-result').innerText = "clicked!"; + setTimeout(() => { + document.getElementById('example-result').innerText = ""; + }, 2000) +}) + +``` + +To integrate this function into a website it is recommended to use a bundler like [esbuild](https://esbuild.github.io/). + +```sh +esbuild index.mjs --outfile dist.js +``` + +We can now integrate that into our website. + +```html +<!DOCTYPE html> +<html lang="en"> +<head> + <meta charset="UTF-8"> + <title>Monster</title> + <script src="dist.js"></script> +</head> +<body> +``` + +Voila! + + +### Polyfill + +We do try to work around some browser bugs, but on the whole we don't use polyfills and feature detection. + +However, many functions can be mapped via [polyfill.io](https://polyfill.io/) and thus the compatibility can be increased. + +```js +<script id="polyfill" src="https://polyfill.io/v3/polyfill.min.js?..." + crossorigin="anonymous" + referrerpolicy="no-referrer"></script> +``` + +## Questions + +For questions and commercial support, please contact [schukai GmbH](https://www.schukai.com/). +The issue list of this repo is exclusively for bug reports and feature requests. + +## Issues + +Please make sure to read the Issue Reporting Checklist before opening an +issue. Issues not conforming to the guidelines may be closed immediately. + +## License + +$(COPYRIGHT_TEXT) + +$(COPYRIGHT_URL) + +You can also purchase a commercial license. + +## Changelog + +Detailed changes for each release are documented in +the [CHANGELOG](https://gitlab.schukai.com/oss/libraries/javascript/web-components/$(COMPONENT_SLUG)). + +endef + diff --git a/development/makefiles/reqman.mk b/development/makefiles/reqman.mk new file mode 100644 index 0000000000000000000000000000000000000000..64f4e1ab165dd831659cd207b5c8935f52d31f71 --- /dev/null +++ b/development/makefiles/reqman.mk @@ -0,0 +1,10 @@ +############################################################################################# +############################################################################################# +## +## REQMAN +## +############################################################################################# +############################################################################################# + + +REQMAN_BIN ?= $(VENDOR_PATH)reqman diff --git a/development/makefiles/target-add-licenses.mk b/development/makefiles/target-add-licenses.mk new file mode 100644 index 0000000000000000000000000000000000000000..4750f2180582c45de35b7301d20fb14cdcdf8a1d --- /dev/null +++ b/development/makefiles/target-add-licenses.mk @@ -0,0 +1,28 @@ +############################################################################################# +############################################################################################# +## +## ADD SPDX LICENSES +## +## For commercial projects, it is not necessary to add the SPDX license identifier. +## The license header in each file is only for open-source projects, for example under +## the AGPL 3.0 license. +## +############################################################################################# +############################################################################################# + +ifeq ($(ADDLICENSE_BIN),) + $(error "addlicense is not installed. Please check your makefile and include the licenses.mk") +endif + +.PHONY: add-licenses +## Add license headers to all go files +add-licenses: + $(ECHOMARKER) "Add license headers to all sourche files" +ifeq ($(LICENSE_FILE_PATTERN),) + $(error "LICENSE_FILE_PATTERN is not set. Please check your makefile and include the licenses.mk") +endif + +ifndef SPDX_LICENSE_ID + $(error "SPDX_LICENSE_ID is not defined. Please check your makefile and include the licenses.mk") +endif + $(QUIET) $(ADDLICENSE_BIN) -c "$(COPYRIGHT_OWNER)" -s -l "$(SPDX_LICENSE_ID)" $(LICENSE_FILE_PATTERN) \ No newline at end of file diff --git a/development/makefiles/target-conan.mk b/development/makefiles/target-conan.mk new file mode 100644 index 0000000000000000000000000000000000000000..4a9a06ff83dd2d43ef85c2955d90e98f67ca6953 --- /dev/null +++ b/development/makefiles/target-conan.mk @@ -0,0 +1,22 @@ +############################################################################################# +############################################################################################# +## +## SERVER CONAN +## +############################################################################################# +############################################################################################# + +ifeq ($(CONAN_BIN),) + $(error $(ERRORMARKER) Conan is not defined, check your Makefile if conan.mk is included) +endif + + +$(CONAN_BIN): + $(QUIET) $(MKDIR) -p $(VENDOR_PATH) + $(QUIET) $(WGET) -O $(CONAN_BIN) http://download.schukai.com/tools/conan/conan-$(shell uname -s | tr [:upper:] [:lower:])-$(shell echo `uname -m | sed s/aarch64/arm64/ | sed s/x86_64/amd64/`) + $(QUIET) $(CHMOD) u+x $(CONAN_BIN) + +.PHONY: run-conan +## run conan webserver +run-conan: $(CONAN_BIN) $(CONAN_CONFIG) + $(QUIET) $(CONAN_BIN) server serve --config $(CONAN_CONFIG) diff --git a/development/makefiles/target-deploy-tool.mk b/development/makefiles/target-deploy-tool.mk index bb18b0682aad2b2ae468a466724018137079abe3..4e69db87e41f75f0579b27f024ff3c42d73fd5f8 100644 --- a/development/makefiles/target-deploy-tool.mk +++ b/development/makefiles/target-deploy-tool.mk @@ -17,4 +17,6 @@ deploy: compile .PHONY: overview-to-s3 ## overview-to-s3 overview-to-s3: - $(QUIET) AWS_PROFILE=$(AWS_PROFILE) $(AWS) s3 cp $(WEB_PATH)/index.html $(UPLOAD_TOOL_URL) \ No newline at end of file + $(QUIET) AWS_PROFILE=$(AWS_PROFILE) $(AWS) s3 cp $(WEB_PATH)/index.html $(UPLOAD_TOOL_URL) + $(QUIET) AWS_PROFILE=$(AWS_PROFILE) $(AWS) s3 cp $(WEB_PATH)/index.css $(UPLOAD_TOOL_URL) + $(QUIET) AWS_PROFILE=$(AWS_PROFILE) $(AWS) s3 cp $(WEB_PATH)/index.js $(UPLOAD_TOOL_URL) \ No newline at end of file diff --git a/development/makefiles/target-docman.mk b/development/makefiles/target-docman.mk index e5c836ed8f11e2c3d627aa7761503781e772f746..050374042edb1b317f88df55b763df189bf0d25c 100644 --- a/development/makefiles/target-docman.mk +++ b/development/makefiles/target-docman.mk @@ -7,13 +7,20 @@ ############################################################################################# ############################################################################################# +ifeq ($(DOCMAN_BIN),) + $(error "$(DOCMAN_BIN) is not installed. Please check your makefile and include the docman.mk") +endif +$(DOCMAN_BIN): + $(QUIET) $(MKDIR) -p $(VENDOR_PATH) + $(QUIET) $(WGET) -O $(DOCMAN_BIN) http://download.schukai.com/tools/docman/docman-$(shell uname -s | tr [:upper:] [:lower:])-$(shell echo `uname -m | sed s/aarch64/arm64/ | sed s/x86_64/amd64/`) + $(QUIET) $(CHMOD) u+x $(DOCMAN_BIN) -$(PROJECT_ROOT)deployment/build/manual.html: ~/.local/bin/docman - docman document html --config $(PROJECT_ROOT)documentation/config.yaml +$(PROJECT_ROOT)deployment/build/manual.html: $(DOCMAN_BIN) + $(DOCMAN_BIN) document html --config $(PROJECT_ROOT)documentation/config.yaml -$(PROJECT_ROOT)deployment/build/manual.pdf: ~/.local/bin/docman - docman document pdf --config $(PROJECT_ROOT)documentation/config.yaml +$(PROJECT_ROOT)deployment/build/manual.pdf: $(DOCMAN_BIN) + $(DOCMAN_BIN) document pdf --config $(PROJECT_ROOT)documentation/config.yaml .PHONY: build-doc-pdf ## creating the documentation in pdf format @@ -29,11 +36,3 @@ build-doc-html: $(PROJECT_ROOT)deployment/build/manual.html build-doc: build-doc-pdf build-doc-html -~/.local/bin/docman: - wget -O ~/.local/bin/docman https://download.schukai.com/tools/docman/docman-linux-amd64 - chmod u+x ~/.local/bin/docman - - -.PHONY: install-docman -install-docman: ~/.local/bin/docman - diff --git a/development/makefiles/target-git.mk b/development/makefiles/target-git.mk index 7453d893b2488fd027e1c4a05095f5d613ff0279..d4ac20d62ba4489b6ab175b615c2324b5674272b 100644 --- a/development/makefiles/target-git.mk +++ b/development/makefiles/target-git.mk @@ -6,7 +6,9 @@ ############################################################################################# ############################################################################################# -EXECUTABLES = $(EXECUTABLES:-) uuidgen +ifeq ($(GIT),) + $(error $(ERRORMARKER) Git is not defined, check your Makefile if git.mk is included) +endif ## Current Branch-GIT_TAG GIT_TAG := - @@ -17,7 +19,6 @@ GIT_MESSAGE := current status .PHONY: git-branch ## create new branch (use GIT_TAG-Variable) git-branch: - $(QUIET) export BRANCH="b$(GIT_TAG)/$(shell uuidgen --random)" ; \ $(QUIET) $(GIT) checkout -b $${BRANCH} && \ RESULT=$$($(GIT) push origin $$BRANCH 2>&1) && \ @@ -45,3 +46,13 @@ git-push: git-branch git-push-to-server ## git create version tag git-tag: $(QUIET) $(GIT) tag -a "$(COMPONENT_VERSION)" -m "release $(COMPONENT_VERSION)" + +.PHONY: git-prune-remote +## removes your local remote tracking branches where the branch no longer exists on the remote +git-prune-remote: + $(QUIET) $(GIT) remote prune origin + +.PHONY: git-prune-local +## deletes local merged branches except the master branch +git-prune-local: + $(QUIET) $(GIT) branch --merged master | grep -v '^[ *]*master$$' | xargs git branch -d \ No newline at end of file diff --git a/development/makefiles/target-go-build.mk b/development/makefiles/target-go-build.mk index 267cd95f04cc8e6bba559f6b199cfd9635ee7293..23139cdceb1f8f01d2a8d52d9308c38a751989e4 100644 --- a/development/makefiles/target-go-build.mk +++ b/development/makefiles/target-go-build.mk @@ -6,6 +6,12 @@ ############################################################################################# ############################################################################################# +ifeq ($(GO),) + $(error $(ERRORMARKER) Go is not defined, check your Makefile if go.mk is included) +endif + +GO_RELEASE_PACKAGE_NAME ?= main + .PHONY: compile ## Compiling for every OS and Platform compile: next-patch-version @@ -14,9 +20,9 @@ compile: next-patch-version $(ECHO) "Build: $(PROJECT_BUILD_DATE)" $(QUIET) cd $(SOURCE_PATH) ; \ - GO111MODULE=on GOOS=linux GOARCH=arm $(GO) build -ldflags "-X main.version=$(PROJECT_VERSION) -X main.build=$(PROJECT_BUILD_DATE)" -o $(BUILD_PATH)$(COMPONENT_SLUG)-linux-arm ; \ - GOOS=linux GOARCH=amd64 $(GO) build -ldflags "-X main.version=$(PROJECT_VERSION) -X main.build=$(PROJECT_BUILD_DATE)" -o $(BUILD_PATH)$(COMPONENT_SLUG)-linux-amd64 ; \ - GOOS=linux GOARCH=arm64 $(GO) build -ldflags "-X main.version=$(PROJECT_VERSION) -X main.build=$(PROJECT_BUILD_DATE)" -o $(BUILD_PATH)$(COMPONENT_SLUG)-linux-arm64 ; \ - GOOS=linux GOARCH=386 $(GO) build -ldflags "-X main.version=$(PROJECT_VERSION) -X main.build=$(PROJECT_BUILD_DATE)" -o $(BUILD_PATH)$(COMPONENT_SLUG)-linux-386 ; \ - GOOS=windows GOARCH=amd64 $(GO) build -ldflags "-X main.version=$(PROJECT_VERSION) -X main.build=$(PROJECT_BUILD_DATE)" -o $(BUILD_PATH)$(COMPONENT_SLUG)-windows ; \ + GO111MODULE=on GOOS=linux GOARCH=arm $(GO) build -ldflags "-X $(GO_RELEASE_PACKAGE_NAME).version=$(PROJECT_VERSION) -X $(GO_RELEASE_PACKAGE_NAME).build=$(PROJECT_BUILD_DATE)" -o $(BUILD_PATH)$(COMPONENT_SLUG)-linux-arm ; \ + GOOS=linux GOARCH=amd64 $(GO) build -ldflags "-X $(GO_RELEASE_PACKAGE_NAME).version=$(PROJECT_VERSION) -X $(GO_RELEASE_PACKAGE_NAME).build=$(PROJECT_BUILD_DATE)" -o $(BUILD_PATH)$(COMPONENT_SLUG)-linux-amd64 ; \ + GOOS=linux GOARCH=arm64 $(GO) build -ldflags "-X $(GO_RELEASE_PACKAGE_NAME).version=$(PROJECT_VERSION) -X $(GO_RELEASE_PACKAGE_NAME).build=$(PROJECT_BUILD_DATE)" -o $(BUILD_PATH)$(COMPONENT_SLUG)-linux-arm64 ; \ + GOOS=linux GOARCH=386 $(GO) build -ldflags "-X $(GO_RELEASE_PACKAGE_NAME).version=$(PROJECT_VERSION) -X $(GO_RELEASE_PACKAGE_NAME).build=$(PROJECT_BUILD_DATE)" -o $(BUILD_PATH)$(COMPONENT_SLUG)-linux-386 ; \ + GOOS=windows GOARCH=amd64 $(GO) build -ldflags "-X $(GO_RELEASE_PACKAGE_NAME).version=$(PROJECT_VERSION) -X $(GO_RELEASE_PACKAGE_NAME).build=$(PROJECT_BUILD_DATE)" -o $(BUILD_PATH)$(COMPONENT_SLUG)-windows ; \ cd $(PROJECT_ROOT); diff --git a/development/makefiles/target-go-fetch-licenses.mk b/development/makefiles/target-go-fetch-licenses.mk index 4bd753cb137214c430e7bf306ff66a031a447df4..242f3d346950f04bdc2ae8bb3d465b0ba9b7ebda 100644 --- a/development/makefiles/target-go-fetch-licenses.mk +++ b/development/makefiles/target-go-fetch-licenses.mk @@ -6,12 +6,16 @@ ############################################################################################# ############################################################################################# +ifeq ($(GO),) + $(error $(ERRORMARKER) Go is not defined, check your Makefile if go.mk is included) +endif + GO_MOD_FILE := $(SOURCE_PATH)go.mod ifeq ($(shell test -e $(GO_MOD_FILE) && echo -n yes),yes) - GO_CURRENT_MODULE := $(shell cat $(GO_MOD_FILE) | head -n1 | cut -d" " -f2) - # go install github.com/google/go-licenses@latest - EXECUTABLES = $(EXECUTABLES:-) go-licenses; + GO_CURRENT_MODULE := $(shell cat $(GO_MOD_FILE) | head -n1 | cut -d" " -f2) + # go install github.com/google/go-licenses@latest + EXECUTABLES = $(EXECUTABLES:-) go-licenses; endif .PHONY: go-fetch-licenses @@ -21,6 +25,6 @@ ifeq ($(GO_CURRENT_MODULE),) $(QUIET) $(ECHOERRORMARKER) "no go.mod file found, skipping fetching licenses" else $(ECHOMARKER) "Fetch licenses" - $(QUIET) cd $(SOURCE_PATH); go-licenses save $(GO_CURRENT_MODULE) $(GO_LICENSES_IGNORE_PACKAGES) --force --save_path $(DOCUMENTATION_PATH)licenses/ ; cd - + $(QUIET) cd $(SOURCE_PATH); $(GO_LICENSES_BIN) save $(GO_CURRENT_MODULE) $(GO_LICENSES_IGNORE_PACKAGES) --force --save_path $(DOCUMENTATION_PATH)licenses/ ; cd - endif diff --git a/development/makefiles/target-init-standard.mk b/development/makefiles/target-init-standard.mk index 7a69b0cc41a1a19e4a25cdca993cba7ac3505442..d19fd3774954075ff5152e2eef9c74900e3d9446 100644 --- a/development/makefiles/target-init-standard.mk +++ b/development/makefiles/target-init-standard.mk @@ -1,7 +1,7 @@ ############################################################################################# ############################################################################################# ## -## INIT-TARGETS +## INIT-STANDARD ## ############################################################################################# ############################################################################################# @@ -9,12 +9,41 @@ # @see .PHONY https://www.gnu.org/software/make/manual/html_node/Phony-Targets.html#Phony-Targets .PHONY: init-standard +# The default directories are defined in the +# directories-standard.mk file, but all other +# targets can define directories as well. + +$(PROJECT_DIRECTORIES): + $(foreach path,$(PROJECT_DIRECTORIES),\ + $(shell $(MKDIR) -p $(path))) + ## init standard project -init-standard: .gitignore - # The default directories are defined in the - # directories-standard.mk file, but all other - # targets can define directories as well. +init-standard: $(PROJECT_DIRECTORIES) .gitignore $(PROJECT_ROOT)README.md $(LICENSE_PATH)LICENSE $(ECHOMARKER) "Run init-standard" - $(foreach path,$(PROJECT_DIRECTORIES),\ - $(shell $(MKDIR) -p $(path))) $(ECHO) "Done" + +############################################################################################# +############################################################################################# +## +## LICENSE +## +############################################################################################# +############################################################################################# + +export LICENSE_FILE_CONTENT +$(LICENSE_PATH)LICENSE: + $(QUITE) $(ECHO) "$$LICENSE_FILE_CONTENT" >> $@ + +############################################################################################# +############################################################################################# +## +## README +## +############################################################################################# +############################################################################################# + +export README_FILE_CONTENT +$(PROJECT_ROOT)README.md: + $(QUITE) $(ECHO) "$$README_FILE_CONTENT" >> $@ + + diff --git a/development/makefiles/target-init-webcomponent.mk b/development/makefiles/target-init-webcomponent.mk new file mode 100644 index 0000000000000000000000000000000000000000..ebfe3afb9085d6bb852e73c8006055e3e658bde1 --- /dev/null +++ b/development/makefiles/target-init-webcomponent.mk @@ -0,0 +1,167 @@ +############################################################################################# +############################################################################################# +## +## INIT-WEBCOMPONENTS +## +############################################################################################# +############################################################################################# + +# @see .PHONY https://www.gnu.org/software/make/manual/html_node/Phony-Targets.html#Phony-Targets +.PHONY: init-webcomponent + +# The default directories are defined in the +# directories-standard.mk file, but all other +# targets can define directories as well. + +$(PROJECT_DIRECTORIES): + $(foreach path,$(PROJECT_DIRECTORIES),\ + $(shell $(MKDIR) -p $(path))) + +## init standard project +init-webcomponent: $(PROJECT_DIRECTORIES) .gitignore $(DEVELOPMENT_PATH)package.json $(APPLICATION_PATH)package.json $(PROJECT_ROOT)README.md $(LICENSE_PATH)LICENSE $(APPLICATION_PATH)LICENSE + $(ECHOMARKER) "Run init-webcomponent" + $(ECHO) "Done" + +############################################################################################# +############################################################################################# +## +## LICENSE +## +############################################################################################# +############################################################################################# + +export LICENSE_FILE_CONTENT +$(LICENSE_PATH)LICENSE: + $(QUITE) $(ECHO) "$$LICENSE_FILE_CONTENT" >> $@ + +export LICENSE_AGPL_FILE_CONTENT +$(APPLICATION_PATH)LICENSE: + $(QUITE) $(ECHO) "$$LICENSE_AGPL_FILE_CONTENT" >> $@ + +############################################################################################# +############################################################################################# +## +## README +## +############################################################################################# +############################################################################################# + +export README_FILE_CONTENT +$(PROJECT_ROOT)README.md: + $(QUITE) $(ECHO) "$$README_FILE_CONTENT" >> $@ + + +############################################################################################# +############################################################################################# +## +## PACKAGE JSON +## +############################################################################################# +############################################################################################# +define WEBCOMPONENTS_PACKAGE_CONTENT +{ + "name": "component-$(COMPONENT_SLUG)", + "version": "0.1.0", + "description": "component $(COMPONENT_NAME)", + "repository": { + "type": "git", + "url": "https://gitlab.schukai.com/oss/libraries/javascript/web-components/$(COMPONENT_SLUG).git" + }, + "keywords": [ + "web", + "dom", + "css", + "mobile-first", + "app", + "front-end", + "ui", + "form", + "templates", + "schukai", + "component", + "web-component", + "monster" + ], + "dependencies": { + "@popperjs/core": "^2.9.2", + "@schukai/monster": "^2.0.8" + }, + "main": "source/component.mjs", + "module": "source/component.mjs", + "type": "module", + "homepage": "https://monsterjs.org/", + "repository": { + "type": "git", + "url": "https://gitlab.schukai.com/oss/libraries/javascript/web-components/$(COMPONENT_SLUG).git" + }, + "author": "schukai GmbH", + "license": "AGPL 3.0" +} +endef + +export WEBCOMPONENTS_PACKAGE_CONTENT +$(APPLICATION_PATH)package.json: + $(QUITE) $(ECHO) "$$WEBCOMPONENTS_PACKAGE_CONTENT" >> $@ + +############################################################################################# +############################################################################################# +## +## BUILD PACKAGE JSON +## +############################################################################################# +############################################################################################# +define WEBCOMPONENTS_BUILD_PACKAGE_CONTENT +{ + "name": "component-$(COMPONENT_SLUG)", + "version": "0.1.0", + "description": "component $(COMPONENT_NAME)", + "repository": { + "type": "git", + "url": "https://gitlab.schukai.com/oss/libraries/javascript/web-components/$(COMPONENT_SLUG).git" + }, + "scripts": { + "test": "npx mocha --recursive test/cases/", + "web-test": "script/web-test.sh", + "publish": "script/release-and-publish.sh", + "build-doc": "script/build-doc.sh" + }, + "type": "module", + "author": "schukai GmbH", + "license": "see LICENSE file", + "dependencies": { + "@popperjs/core": "^2.11.2", + "@schukai/monster": "^2.0.8" + }, + "devDependencies": { + "@peculiar/webcrypto": "^1.4.0", + "btoa": "^1.2.1", + "c8": "^7.12.0", + "chai": "^4.3.6", + "chai-dom": "^1.11.0", + "clean-jsdoc-theme": "^4.1.6", + "create-polyfill-service-url": "^2.2.6", + "crypt": "^0.0.2", + "esbuild": "^0.14.53", + "flow-bin": "^0.184.0", + "fs": "^0.0.1-security", + "graphviz": "^0.0.9", + "jsdoc": "^3.6.11", + "jsdoc-external-example": "github:volker-schukai/jsdoc-external-example", + "jsdoc-plantuml": "^1.0.2", + "jsdom": "^19.0.0", + "jsdom-global": "^3.0.2", + "mocha": "^10.0.0", + "node-plantuml": "^0.9.0", + "sinon": "^14.0.0", + "url": "^0.11.0", + "url-exist": "3.0.0", + "util": "^0.12.4" + } +} +endef + +export WEBCOMPONENTS_BUILD_PACKAGE_CONTENT +$(DEVELOPMENT_PATH)package.json: + $(QUITE) $(ECHO) "$$WEBCOMPONENTS_BUILD_PACKAGE_CONTENT" >> $@ + +###### diff --git a/development/makefiles/target-node-build.mk b/development/makefiles/target-node-build.mk index d8c5c938b5f230394918ff86a5552b0e49ccd1c6..62e86b1a0b1de5968e99d6f93cd04cecf913cace 100644 --- a/development/makefiles/target-node-build.mk +++ b/development/makefiles/target-node-build.mk @@ -17,8 +17,7 @@ node-build: $(NODE_MODULES_MODIFIED) $(NODE_PACKAGES) $(ECHO) "Version: $(PROJECT_VERSION)" $(ECHO) "Source Path: $(SOURCE_PATH)" $(QUIET) $(JQ) '.version = "$(PROJECT_VERSION)"' $(PACKAGE_JSON) | $(SPONGE) $(PACKAGE_JSON) - $(QUIET) for p in $(NODE_PACKAGES); do \ - $(JQ) '.version = "$(PROJECT_VERSION)"' $${p} | $(SPONGE) $${p}; \ - done ; \ + $(QUIET) for p in $(NODE_PACKAGES); do $(JQ) '.version = "$(PROJECT_VERSION)"' $${p} | $(SPONGE) $${p}; done + $(QUIET) $(SCRIPTS_PATH)update-version.sh diff --git a/development/makefiles/target-npm-publish.mk b/development/makefiles/target-npm-publish.mk index 41b1f54d9e105fbb6112377d192f2aaf71960e46..d2c19e7206ee54d9f84a04c54becf169a782ea62 100644 --- a/development/makefiles/target-npm-publish.mk +++ b/development/makefiles/target-npm-publish.mk @@ -8,25 +8,28 @@ .PHONY: npm-publish-major ## release major version of package -npm-publish-major: node-test +npm-publish-major: $(ECHOMARKER) "release major version" $(QUIET) $(MAKE) next-major-version $(QUIET) $(MAKE) node-build + $(QUIET) $(MAKE) node-test $(QUIET) $(NPM) --prefix $(NODE_ROOT_DIR) run publish .PHONY: npm-publish-minor ## release minor version of package -npm-publish-minor: node-test +npm-publish-minor: $(ECHOMARKER) "release minor version" $(QUIET) $(MAKE) next-minor-version $(QUIET) $(MAKE) node-build + $(QUIET) $(MAKE) node-test $(QUIET) $(NPM) --prefix $(NODE_ROOT_DIR) run publish .PHONY: npm-publish-patch ## release patch version of package -npm-publish-patch: node-test +npm-publish-patch: $(ECHOMARKER) "release patch version" $(QUIET) $(MAKE) next-patch-version $(QUIET) $(MAKE) node-build + $(QUIET) $(MAKE) node-test $(QUIET) $(NPM) --prefix $(NODE_ROOT_DIR) run publish diff --git a/development/makefiles/target-reqman.mk b/development/makefiles/target-reqman.mk new file mode 100644 index 0000000000000000000000000000000000000000..37db2ecad810f1ef0137cfe3bb4bb22bd025148b --- /dev/null +++ b/development/makefiles/target-reqman.mk @@ -0,0 +1,40 @@ +############################################################################################# +############################################################################################# +## +## REQMAN-TARGETS +## +############################################################################################# +############################################################################################# + + +# @TODO not working, check if this is a bug in this definition!!! + +ifeq ($(REQMAN_BIN),) + $(error "$(REQMAN_BIN) is not installed. Please check your makefile and include the reqman.mk") +endif + +$(REQMAN_BIN): + $(QUIET) $(MKDIR) -p $(VENDOR_PATH) + $(QUIET) $(WGET) -O $(REQMAN_BIN) http://download.schukai.com/tools/reqman/reqman-$(shell uname -s | tr [:upper:] [:lower:])-$(shell echo `uname -m | sed s/aarch64/arm64/ | sed s/x86_64/amd64/`) + $(QUIET) $(CHMOD) u+x $(REQMAN_BIN) + +$(PROJECT_ROOT)deployment/build/manual.html: $(DOCMAN_BIN) + $(REQMAN_BIN) print html --config $(PROJECT_ROOT)requirement/config.yaml + +$(PROJECT_ROOT)deployment/build/manual.pdf: $(DOCMAN_BIN) + $(REQMAN_BIN) print pdf --config $(PROJECT_ROOT)requirement/config.yaml + +.PHONY: build-req-pdf +## creating the requirement in pdf format +build-req-pdf: $(PROJECT_ROOT)deployment/build/requirement.pdf + +.PHONY: build-req-html +## creating the requirement in html format +build-req-html: $(PROJECT_ROOT)deployment/build/requirement.html + + +.PHONY: build-req +## creating the requirement in pdf and html format +build-req: build-req-pdf build-req-html + + diff --git a/development/makefiles/target-update-makefiles.mk b/development/makefiles/target-update-makefiles.mk index a1c73d7129336266c058f40db67b3b0d2a3eef5e..284df847df3b474d9d040de2a4fc424bbcff9b85 100644 --- a/development/makefiles/target-update-makefiles.mk +++ b/development/makefiles/target-update-makefiles.mk @@ -6,14 +6,24 @@ ############################################################################################# ############################################################################################# +ifeq ($(GIT),) + $(error $(ERRORMARKER) Git is not defined, check your Makefile if git.mk is included) +endif + # @see .PHONY https://www.gnu.org/software/make/manual/html_node/Phony-Targets.html#Phony-Targets .PHONY: update-makefiles +ifeq ($(QUIET),) + _COPYVERBOSE = -v +endif + ## update standard makefiles update-makefiles: + $(ECHOMARKER) "update standard makefiles" $(QUIET) $(eval TEMPD := $(shell mktemp -d)) - $(QUIET) $(GIT) clone --depth=1 https://gitlab.schukai.com/schukai/utilities/makefile.git/ "$(TEMPD)" > /dev/null - $(QUIET) $(CP) -rv $(TEMPD)/makefiles/* $(MAKEFILE_IMPORT_PATH) + $(QUIET) $(GIT) clone --quiet --depth=1 https://gitlab.schukai.com/schukai/utilities/makefile.git/ "$(TEMPD)" + $(QUIET) $(CP) -r $(_COPYVERBOSE) $(TEMPD)/makefiles/* $(MAKEFILE_IMPORT_PATH) + $(QUIET) $(CP) -r $(_COPYVERBOSE) $(TEMPD)/Makefile $(PROJECT_ROOT)Makefile.example $(QUIET) $(RM) -rf $(TEMPD) diff --git a/development/makefiles/target-variable.mk b/development/makefiles/target-variable.mk index 93f99c07fcc8ab3a8e000e865d7ddca2f2843220..3ad8267a765d377db7fa2d8e4037cfa7a4c6d698 100644 --- a/development/makefiles/target-variable.mk +++ b/development/makefiles/target-variable.mk @@ -9,4 +9,5 @@ .PHONY: variables ## Print all variables variables: - @$(foreach v, $(.VARIABLES), $(if $(filter file,$(origin $(v))), $(info $(INFO)$(v)$(RESET)=$($(v))$(RESET)))) \ No newline at end of file + $(ECHOMARKER) "print all variables" + $(QUIET) $(foreach v, $(.VARIABLES), $(if $(filter file,$(origin $(v))), $(info $(INFO)$(v)$(RESET)=$($(v))$(RESET)))) \ No newline at end of file diff --git a/development/makefiles/target-version.mk b/development/makefiles/target-version.mk new file mode 100644 index 0000000000000000000000000000000000000000..b68287b453726a26e8eb7933a633c64279596d10 --- /dev/null +++ b/development/makefiles/target-version.mk @@ -0,0 +1,71 @@ +############################################################################################# +############################################################################################# +## +## VARIABLES-TARGETS +## +############################################################################################# +############################################################################################# + +ifeq ($(VERSION_BIN),) + $(error "$(VERSION_BIN) is not installed. Please check your makefile and include the version.mk") +endif + +ifeq ($(GIT),) + $(error $(ERRORMARKER) Git is not defined, check your Makefile if git.mk is included) +endif + +ifeq ($(GIT_CHGLOG_BIN),) + $(error $(ERRORMARKER) Chglog is not defined, check your Makefile if changelog.mk is included) +endif + +$(VERSION_BIN): + $(QUIET) $(MKDIR) -p $(VENDOR_PATH) + $(QUIET) $(WGET) -O $(VERSION_BIN) http://download.schukai.com/tools/version/version-$(shell uname -s | tr [:upper:] [:lower:])-$(shell echo `uname -m | sed s/aarch64/arm64/ | sed s/x86_64/amd64/`) + $(QUIET) $(CHMOD) u+x $(VERSION_BIN) + + +.PHONY: next-patch-version +next-patch-version: check-clean-repo $(VERSION_BIN) + $(ECHOMARKER) "Creating next version" + $(QUIET) $(VERSION_BIN) patch --path $(RELEASE_FILE) --selector "version" + $(QUIET) $(GIT) add $(RELEASE_FILE) && $(GIT) commit -m "Bump version to $$(cat $(RELEASE_FILE) | jq -r .version)" + +.PHONY: next-minor-version +next-minor-version: check-clean-repo $(VERSION_BIN) + $(ECHOMARKER) "Creating next minor version" + $(QUIET) $(VERSION_BIN) minor --path $(RELEASE_FILE) --selector "version" + $(QUIET) $(GIT) add $(RELEASE_FILE) && $(GIT) commit -m "Bump version to $$( cat $(RELEASE_FILE) | jq -r .version)" + +.PHONY: next-major-version +next-major-version: check-clean-repo $(VERSION_BIN) + $(ECHOMARKER) "Creating next minor version" + $(QUIET) $(VERSION_BIN) major --path $(RELEASE_FILE) --selector "version" + $(QUIET) $(GIT) add $(RELEASE_FILE) && $(GIT) commit -m "Bump version to $$(cat $(RELEASE_FILE) | jq -r .version)" + +.PHONY: check-clean-repo +check-clean-repo: + $(QUIET) $(GIT) diff-index --quiet HEAD || (echo "There are uncommitted changes after running make. Please commit or stash them before running make."; exit 1) + +## tag repository with next patch version +tag-patch-version: $(GIT_CHGLOG_CONFIG_DIR)/config.yml $(GIT_CHGLOG_CONFIG_DIR)/CHANGELOG.tpl.md next-patch-version + $(ECHOMARKER) "Tagging patch version" + $(eval PROJECT_VERSION := $(shell cat $(RELEASE_FILE) | jq -r .version)) + $(GIT_CHGLOG_BIN) --next-tag v$(PROJECT_VERSION) -o $(CHANGELOG_FILE) + $(QUIET) $(GIT) add $(CHANGELOG_FILE) && $(GIT) commit -m "Update changelog" + $(QUIET) $(GIT) tag -a v$(PROJECT_VERSION) -m "Version $(PROJECT_VERSION)" + +## tag repository with next minor version +tag-minor-version: $(GIT_CHGLOG_CONFIG_DIR)/config.yml $(GIT_CHGLOG_CONFIG_DIR)/CHANGELOG.tpl.md next-patch-version next-minor-version + $(ECHOMARKER) "Tagging minor version" + $(eval PROJECT_VERSION := $(shell cat $(RELEASE_FILE) | jq -r .version)) + $(GIT_CHGLOG_BIN) --next-tag v$(PROJECT_VERSION) -o $(CHANGELOG_FILE) + $(QUIET) $(GIT) add $(CHANGELOG_FILE) && $(GIT) commit -m "Update changelog" + $(QUIET) $(GIT) tag -a v$(PROJECT_VERSION) -m "Version $(PROJECT_VERSION)" + +## tag repository with next major version +tag-major-version: $(GIT_CHGLOG_CONFIG_DIR)/config.yml $(GIT_CHGLOG_CONFIG_DIR)/CHANGELOG.tpl.md next-patch-version next-major-version + $(ECHOMARKER) "Tagging major version" + $(eval PROJECT_VERSION := $(shell cat $(RELEASE_FILE) | jq -r .version)) + $(GIT_CHGLOG_BIN) --next-tag v$(PROJECT_VERSION) -o $(CHANGELOG_FILE) + $(QUIET) $(GIT) add $(CHANGELOG_FILE) && $(GIT) commit -m "Update changelog" + $(QUIET) $(GIT) tag -a v$(PROJECT_VERSION) -m "Version $(PROJECT_VERSION)" diff --git a/development/makefiles/terminal.mk b/development/makefiles/terminal.mk index fa2fb145e4db8907ef758a6572246b0b9635e6f9..905b88a161ddcd5fe32958201df6aac8639c88ae 100644 --- a/development/makefiles/terminal.mk +++ b/development/makefiles/terminal.mk @@ -28,15 +28,13 @@ RSYNC ?= rsync XARGS ?= xargs GREP ?= grep MAKE ?= make -GIT ?= git LN ?= ln -TOUCH ?= touch +TOUCH ?= touch TEST ?= test -JQ ?= jq +JQ ?= jq - -EXECUTABLES = $(EXECUTABLES:-) $(JQ) $(AWK) $(CP) $(KILL) $(MV) $(SED) $(FIND) $(SORT) $(TOUCH) $(WGET) $(CHMOD) $(RSYNC) $(XARGS) $(GREP) $(MAKE) $(GIT) +EXECUTABLES = $(EXECUTABLES:-) $(JQ) $(AWK) $(CP) $(KILL) $(MV) $(SED) $(FIND) $(SORT) $(TOUCH) $(WGET) $(CHMOD) $(RSYNC) $(XARGS) $(GREP) $(MAKE) $(LN) \ No newline at end of file diff --git a/development/makefiles/version.mk b/development/makefiles/version.mk index da81bea9a379dc08674bb3589a6d2fa02163212c..0f643ee2209221ea08cb31cb6ccd51bef825d8e8 100644 --- a/development/makefiles/version.mk +++ b/development/makefiles/version.mk @@ -6,10 +6,8 @@ ############################################################################################# ############################################################################################# -VERSION_BIN := version -EXECUTABLES = $(EXECUTABLES:-) $(VERSION_BIN) - -RELEASE_FILE ?= $(PROJECT_ROOT)release.json +VERSION_BIN ?= $(VENDOR_PATH)version +RELEASE_FILE ?= $(PROJECT_ROOT)release.json ifeq ("$(wildcard $(RELEASE_FILE))","") $(shell echo '{"version":"0.1.0"}' > $(RELEASE_FILE)) @@ -17,24 +15,3 @@ endif PROJECT_VERSION ?= $(shell cat $(RELEASE_FILE) | jq -r .version) PROJECT_BUILD_DATE ?= $(shell $(VERSION_BIN) date) - -.PHONY: next-patch-version -## create next patch version -next-patch-version: - $(ECHOMARKER) "Creating next version" - $(QUIET) $(VERSION_BIN) patch --path $(RELEASE_FILE) --selector "version" - $(QUIET) $(eval PROJECT_VERSION := $(shell cat $(RELEASE_FILE) | jq -r .version)) - -.PHONY: next-minor-version -## create next minor version -next-minor-version: - $(ECHOMARKER) "Creating next minor version" - $(QUIET) $(VERSION_BIN) minor --path $(RELEASE_FILE) --selector "version" - $(QUIET) $(eval PROJECT_VERSION := $(shell cat $(RELEASE_FILE) | jq -r .version)) - -.PHONY: next-major-version -## create next major version -next-major-version: - $(ECHOMARKER) "Creating next minor version" - $(QUIET) $(VERSION_BIN) major --path $(RELEASE_FILE) --selector "version" - $(QUIET) $(eval PROJECT_VERSION := $(shell cat $(RELEASE_FILE) | jq -r .version)) diff --git a/development/package.json b/development/package.json index 05e5a89aa6e26fe129ffcce3e1482c0f0222bd7b..8d95189fac0ca31cf062c69fd208e2c7de778506 100644 --- a/development/package.json +++ b/development/package.json @@ -1,6 +1,6 @@ { "name": "monster", - "version": "2.0.8", + "version": "2.0.14", "description": "monster", "repository": { "type": "git", diff --git a/development/playground/drag-and-drop/index.html b/development/playground/drag-and-drop/index.html new file mode 100644 index 0000000000000000000000000000000000000000..e69de29bb2d1d6434b8b29ae775ad8c2e48c5391 diff --git a/development/script/build-doc.sh b/development/script/build-doc.sh index 18f66d5b38241434e0d2c02f8fbbd2697feb5c7f..45ff852c5048da8d67401ff294f2dc481bfa0fc3 100755 --- a/development/script/build-doc.sh +++ b/development/script/build-doc.sh @@ -5,12 +5,23 @@ PROJECT_ROOT="$(realpath $SCRIPT_DIR'../../')/" TUTORIALS_PATH=${PROJECT_ROOT}documentation/tutorial/ BUILD_PATH=${PROJECT_ROOT}deployment/build/docs/ +BUILD_TUTORIAL_PATH=${PROJECT_ROOT}deployment/build/docs/tutorials/ DOCUMENTATION_CONFIG_PATH=${PROJECT_ROOT}documentation/config/jsdoc.json +rm -rf $BUILD_PATH + npx jsdoc --tutorials ${TUTORIALS_PATH} \ --readme ${PROJECT_ROOT}documentation/README.md \ --configure ${DOCUMENTATION_CONFIG_PATH} \ +mkdir -p ${BUILD_TUTORIAL_PATH}images/ +mkdir -p ${BUILD_TUTORIAL_PATH}videos/ + +mkdir -p ${TUTORIALS_PATH}images/ +mkdir -p ${TUTORIALS_PATH}videos/ + +rsync -av ${TUTORIALS_PATH}images/ ${BUILD_PATH}tutorials/images/ +rsync -av ${TUTORIALS_PATH}videos/ ${BUILD_PATH}tutorials/videos/ ${SCRIPT_DIR}replace-codepen-skypack.cjs \ No newline at end of file diff --git a/development/script/build-stylesheets.cjs b/development/script/build-stylesheets.cjs new file mode 100755 index 0000000000000000000000000000000000000000..e0809507ac6ed1af610572774117c9bdeef37126 --- /dev/null +++ b/development/script/build-stylesheets.cjs @@ -0,0 +1,137 @@ +#!/usr/bin/env node + +const regex = /^\s*(?<exp>(export\s+{[^}]+)})/gm; + +const fs = require('fs'); +const path = require('path') +const postcss = require('postcss'); +const normalizeCss = require('postcss-normalize'); +const importCss = require('postcss-import'); +const postcssNested = require('postcss-nested'); +const autoprefixer = require('autoprefixer'); +const styleSourceRoot = __dirname + '/../../application/source/style/' +const styleSheetRoot = __dirname + '/../../application/source/stylesheet/' + +let promises = []; +let styles = new Map(); + +const codeTemplate = ` +/** + * Copyright schukai GmbH and contributors 2022. All Rights Reserved. + * Node module: @schukai/component-empty-state + * This file is licensed under the AGPLv3 License. + * License text available at https://www.gnu.org/licenses/agpl-3.0.en.html + */ + +import {addAttributeToken} from "@schukai/monster/source/dom/attributes.mjs"; +import {ATTRIBUTE_ERRORMESSAGE} from "@schukai/monster/source/dom/constants.mjs"; + +/** + * @private + * @type {CSSStyleSheet} + */ +export const {{ClassName}}Stylesheet = new CSSStyleSheet(); + +try { + {{ClassName}}Stylesheet.insertRule(\` +@layer component { +{{css}} +}\`, 0); +} catch (e) { + addAttributeToken(document.getRootNode().querySelector('html'), ATTRIBUTE_ERRORMESSAGE, e + ""); +} +`; + + +function scanFiles(root, keyPath) { + + if (keyPath === undefined) { + keyPath = []; + } + + return new Promise((resolve, reject) => { + + let localPromises = []; + let f; + + const dir = fs.opendirSync(root); + while ((f = dir.readSync()) !== null) { + + const key = f.name; + const fn = path.join(root, f.name); + const currentPath = [...keyPath] + currentPath.push(key); + + + if (f.isDirectory()) { + localPromises.push(scanFiles(fn), currentPath); + continue; + } else if (!f.isFile()) { + continue; + } + + if ((path.extname(f.name) !== ".css" && path.extname(f.name) !== ".pcss")) { + continue; + } + + let content = fs.readFileSync(fn, 'utf8'); + localPromises.push(rewriteCSS(content, fn, currentPath)); + } + + Promise.all(localPromises).then(resolve).catch(reject); + + }) +} + + +function rewriteCSS(content, sourceFile, keyPath) { + + const newPath = path.format({...path.parse(keyPath.join("/")), base:'',ext: '.mjs'}) + + return new Promise((resolve, reject) => { + + + return postcss([ + importCss({ + path: [styleSourceRoot], + }), + normalizeCss, + postcssNested(), + autoprefixer, + ]).process(content, { + from: undefined, + + }).catch(reject).then(result => { + + styles.set(newPath, result.css); + resolve(); + + }); + + }) + +} + + +scanFiles(path.normalize(styleSourceRoot)).then(() => { + + styles.forEach((css, fn) => { + + + let className = path.parse(fn).name; + className = className.charAt(0).toUpperCase() + className.slice(1); + className = className.replace(/-([a-z])/g, function (g) { return g[1].toUpperCase(); }); + + css = css.replace(/"/g, '\\"'); + const code = codeTemplate.replaceAll("{{ClassName}}", className).replaceAll("{{css}}", css); + + const targetFile = path.normalize(path.join(styleSheetRoot, fn)); + fs.mkdirSync(path.dirname(targetFile), {recursive: true}); + fs.writeFileSync(targetFile, code); + }) + +}).catch(e => { + console.log("Error styles.css"); + console.error(e); +}) +console.log("Done"); diff --git a/development/script/create-polyfill.sh b/development/script/create-polyfill.sh index ef004c986ef5df40247d1ab62a3f0aef7a0806ae..96b75d9c8df53e3f5d4a48f42bc72295624a8e24 100755 --- a/development/script/create-polyfill.sh +++ b/development/script/create-polyfill.sh @@ -9,7 +9,7 @@ TMPFILE=monster.temp touch $TMPFILE trap "rm -f $TMPFILE" 0 2 3 15 -${PROJECT_ROOT}development/node_modules/.bin/esbuild --platform=browser --bundle ${SOURCE_PATH}monster.mjs --outfile=${TMPFILE} +${PROJECT_ROOT}development/node_modules/.bin/esbuild --platform=browser --bundle ${SOURCE_PATH}component.mjs --outfile=${TMPFILE} url="$(${PROJECT_ROOT}development/node_modules/.bin/create-polyfill-service-url analyse --file "$TMPFILE")" if [ ! -x {$url} ] diff --git a/development/script/release-and-publish.sh b/development/script/release-and-publish.sh index 385c619e4088e3bdba58bdfa35bcce08f5cec7db..d67a06ab9660b7165a711189f24b8a6c5df34dd8 100755 --- a/development/script/release-and-publish.sh +++ b/development/script/release-and-publish.sh @@ -10,8 +10,6 @@ DEVELOPMENT_PATH="${PROJECT_ROOT}development/" if [ -d $BUILD_PATH ]; then rm -rf ${BUILD_PATH} fi - -${SCRIPT_DIR}update-version.sh mkdir -p ${BUILD_PATH} diff --git a/development/script/update-version.sh b/development/script/update-version.sh index e7ca2ab8c261b6ecf80614a00e4578cc0d5b7d32..ecf98ec40d4002f8e193f3ac1fa09edf4def46bf 100755 --- a/development/script/update-version.sh +++ b/development/script/update-version.sh @@ -8,4 +8,4 @@ VERSION=$(cat "$PROJECT_ROOT/release.json" | jq -r '.version') sed -i -E "s_('[0-9]+\.[0-9]+\.[0-9]+')_'${VERSION}'_g" "${PROJECT_ROOT}application/source/types/version.mjs" sed -i -E "s_('[0-9]+\.[0-9]+\.[0-9]+')_'${VERSION}'_g" "${PROJECT_ROOT}development/test/cases/monster.mjs" - + \ No newline at end of file diff --git a/development/test/cases/monster.mjs b/development/test/cases/monster.mjs index f4906fa311fd40e4649a3f1c2f4f261b147b34d5..9e2dfecf742e16c35a266f5b9a737f738a8dbdf1 100644 --- a/development/test/cases/monster.mjs +++ b/development/test/cases/monster.mjs @@ -7,7 +7,7 @@ describe('Monster', function () { let monsterVersion /** don´t touch, replaced by make with package.json version */ - monsterVersion = new Version('2.0.8') + monsterVersion = new Version('2.0.14') let m = getMonsterVersion(); diff --git a/documentation/tutorial/dom-style-guide.md b/documentation/tutorial/dom-style-guide.md new file mode 100644 index 0000000000000000000000000000000000000000..b650ea05fa604e47ddbb567c15ca4afe72b00bc5 --- /dev/null +++ b/documentation/tutorial/dom-style-guide.md @@ -0,0 +1,130 @@ +# Style Guide + +The style guide reflects the patterns and components that are the foundation of the Monster System. + +These patterns provide a common language and a consistent look and feel when developing +applications and products within the Monster ecosystem. + +## CSS Properties + +Where possible, components should use global uniform CSS properties to create a consistent look and feel. + +With the following script, you can see the list of all the CSS properties that are available +in the Monster UI Framework. + +```bash +ag -o --nofilename 'var\(\-\-monster[^)]*\)' | grep var | cut -d"," -f1 | cut -d"(" -f2 | sort | uniq +``` + +Actually, the following CSS properties are in use: + + +```css + +--monster-accent-color +--monster-bg-color +--monster-border-color +--monster-border-radius +--monster-border-radius) +--monster-border-width +--monster-btn-bg-color +--monster-btn-border-color +--monster-btn-color +--monster-color +--monster-color-activity +--monster-color-failed +--monster-color-successful +--monster-disabled-background-color +--monster-disabled-border-color +--monster-disabled-color +--monster-empty-state-background-color +--monster-empty-state-layout-padding-margin-bottom +--monster-empty-state-margin-top +--monster-empty-state-padding-bottom +--monster-empty-state-padding-left +--monster-empty-state-padding-right +--monster-empty-state-padding-top +--monster-font-family +--monster-hover-color +--monster-message-bg-color +--monster-message-border-color +--monster-message-border-radius +--monster-message-border-style +--monster-message-border-width +--monster-message-color +--monster-message-margin-bottom +--monster-message-margin-left +--monster-message-margin-right +--monster-message-margin-top +--monster-message-padding-bottom +--monster-message-padding-left +--monster-message-padding-right +--monster-message-padding-top +--monster-notify-duration +--monster-popper-witharrrow-distance +--monster-selected-color +``` + + +### Colors + +[black, white, red, yellow, grey, pink, green](https://coolors.co/0a0f0d-ffffff-b00020-f6aa1c-656176-ff69b4-003d00) + + +| Code | Description | +|-------------------------------------------|--------------| +| var(--monster-color, #0a0f0d) | black | +| var(--monster-color-activity, #656176) | grey | +| var(--monster-color-failed, #b00020) | red | +| var(--monster-color-successful, #003d00) | green | +| var(--monster-color-accent, #ff69b4) | pink | +| var(--monster-color-dark, #0a0f0d) | black | +| var(--monster-color-light, #ffffff) | white | +| var(--monster-color-hover, #ff69b4) | pink | +| var(--monster-color-highlight, f6aa1c) | yellow | +| var(--monster-color-selected, #0a0f0d) | black | +| var(--monster-color-disabled, #656176) | grey | +| var(--monster-bg-color, #ffffff) | white | +| var(--monster-bg-color-dark, #656176) | grey | +| var(--monster-bg-color-light, #ffffff) | white | +| var(--monster-bg-color-disabled, #656176) | grey | +| var(--monster-disabled-color) | (deprecated) | +| var(--monster-disabled-bg-color) | (deprecated) | +| var(--monster-hover-color) | (deprecated) | +| var(--monster-selected-color) | (deprecated) | +| var(--monster-accent-color) | (deprecated) | +| var(--monster-disabled-background-color) | (deprecated) | + +### Fonts + +```css +font-size: calc([minimum size] + ([maximum size] - [minimum size]) * ((100vw - + [minimum viewport width]) / ([maximum viewport width] - [minimum viewport width]))); +``` + +| Property | Description | +|-------------------------------------------------------------------------------------------------------------------------------------------------|-------------| +| var(--monster-font-family, -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Oxygen-Sans, Ubuntu, Cantarell, "Helvetica Neue", sans-serif) | | +| var(--monster-font-size, calc(14px + (26 - 14) * ((100vw - 300px) / (1600 - 300))) | | +| var(--monster-font-weight | | +| var(--monster-font-weight-bold | | +| var(--monster-font-weight-light | | +| var(--monster-line-height, calc(1.3em + (1.5 - 1.2) * ((100vw - 300px)/(1600 - 300))); | | + + +### Borders + +| Property | Description | +|--------------------------------------|-------------| +| var(--monster-border-color, #0a0f0d) | black | +| var(--monster-border-radius, 0) | | +| var(--monster-border-style, solid) | | +| var(--monster-border-width, 2px) | | + +### Shadows + +| Property | Description | +|------------------------------------------------------------------------------------------------------------------------|-------------| +| var(--monster-text-shadow, none) | | +| var(--monster-box-shadow, box-shadow: rgba(60, 64, 67, 0.3) 0px 1px 2px 0px, rgba(60, 64, 67, 0.15) 0px 1px 3px 1px;) | | + diff --git a/documentation/tutorial/tutorials.json b/documentation/tutorial/tutorials.json index 00375446f2764b1ed18f97e9fa8a647523cd960e..d8dd74c3fc873cd2be5f4fd63bf9661b31bf3879 100644 --- a/documentation/tutorial/tutorials.json +++ b/documentation/tutorial/tutorials.json @@ -17,6 +17,9 @@ "dom-based-templating-implementation": { "title": "DOM-based templating implementation" }, + "dom-style-guide": { + "title": "Monster Style Guide" + }, "how-to-write-a-customcontrol": { "title": "How to write a CustomControl" } diff --git a/monster.iml b/monster.iml index 8021953ed9f8cc6cd6d71c79462bad4cd2b5394c..cb8f4ea3a6e997a1fc9282a707f1dba31f46ce3f 100644 --- a/monster.iml +++ b/monster.iml @@ -2,7 +2,9 @@ <module type="WEB_MODULE" version="4"> <component name="NewModuleRootManager" inherit-compiler-output="true"> <exclude-output /> - <content url="file://$MODULE_DIR$" /> + <content url="file://$MODULE_DIR$"> + <excludeFolder url="file://$MODULE_DIR$/deployment/build" /> + </content> <orderEntry type="inheritedJdk" /> <orderEntry type="sourceFolder" forTests="false" /> </component> diff --git a/release.json b/release.json index be61af377901152febde0d880df7373586ab86bc..39e20cc04650069fbd04705bc6cb18728ded9f23 100644 --- a/release.json +++ b/release.json @@ -1 +1 @@ -{"version":"2.0.8"} +{"version":"2.0.14"}