chayns-toolkit 3.0.12 → 3.0.14

package/LICENSE

@@ -1,21 +1,21 @@
-MIT License
-
-Copyright (c) 2021 Tobit Software Laboratories AG
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
-
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+MIT License
+
+Copyright (c) 2021 Tobit Software Laboratories AG
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,88 +1,88 @@
-<div align="center">
-    <a href="https://tobitsoftware.github.io/chayns-toolkit/" target="_blank">
-        <h1 align="center">
-            <img src="https://raw.githubusercontent.com/TobitSoftware/chayns-toolkit/HEAD/assets/logo.png" width="500px" alt="chayns-toolkit" />
-        </h1>
-    </a>
-    <p align="center">A zero-config toolchain for developing chayns® apps.</p>
-    <p align="center">
-        <a href="https://github.com/TobitSoftware/chayns-toolkit/blob/master/LICENSE" target="_blank">
-            <img src="https://img.shields.io/github/license/TobitSoftware/chayns-toolkit?color=%23A855F7&labelColor=%2327272A&style=for-the-badge" alt="" />
-        </a>
-        <a href="https://www.npmjs.com/package/chayns-toolkit" target="_blank">
-            <img src="https://img.shields.io/npm/v/chayns-toolkit?color=%236366F1&labelColor=%2327272A&style=for-the-badge" alt="" />
-        </a>
-        <a href="https://github.com/TobitSoftware/chayns-toolkit/branches" target="_blank">
-            <img src="https://img.shields.io/github/last-commit/TobitSoftware/chayns-toolkit?color=%2310B981&labelColor=%2327272A&style=for-the-badge" alt="" />
-        </a>
-    </p>
-</div>
-
----
-
-**chayns-toolkit** contains pre-configured tools for the development, publishing and quality
-assurance of your app. It was created to simplify the development experience when working with
-[React](https://reactjs.org).
-
-> This toolchain is specialized in developing apps and plugins for the
-> [chayns®](https://chayns.org/) platform. If you want to develop a general purpose web app, take a
-> look at [Next.js](https://nextjs.org/). <br>
-
-<br>
-
-## ❯ Getting Started
-
-For the easiest way to start a new chayns® project with chayns-toolkit check out
-[`create-chayns-app`](https://github.com/TobitSoftware/create-chayns-app).
-
-<br>
-
-## ❯ Documentation
-
-Visit
-[https://tobitsoftware.github.io/chayns-toolkit/](https://tobitsoftware.github.io/chayns-toolkit/)
-to view the full documentation.
-
-<br>
-
-## ❯ Migration v2 to v3
-
-The chayns-toolkit moved RsBuild instead of webpack in this version. This means customizing the
-config has changed significantly.
-
--   **output.apiVersion** has been removed
--   **remoteEntry.js** has been renamed to **v2.remoteEntry.js**
--   **output.serverSideRendering** has been added. This creates a build to use for modules in SSR.
-    -   Creates two subdirectories in build directory for client- and server-build.
--   dotenv-Files will be automatically loaded now depending on the current NODE_ENV/BUILD_ENV
-    -   Only variables which start with PUBLIC\_ are passed to the javascript context. Other
-        variables are only available in the toolkit.config.js to customize the config
--   Not defined environment-variables are not replaced by RsBuild which can cause errors (webpack
-    replaced them with empty string)
--   **output.entryPoints** has been added and changes how to configure the entry points of the
-    application
-    [https://tobitsoftware.github.io/chayns-toolkit/docs/configuration/output](https://tobitsoftware.github.io/chayns-toolkit/docs/configuration/output)
-
-## ❯ Contributing
-
-Please see our
-[contributing document](https://tobitsoftware.github.io/chayns-toolkit/docs/contributing).
-
-<br>
-
----
-
-<p align="center">
-    <sub>
-        Project created by Leo Driesch at Tobit.Software.
-    </sub>
-</p>
-<p align="center">
-    <a href="https://labs.tobit.com/">
-        <img alt="Tobit.Software homepage" src="./assets/icons/globe.svg">
-    </a>
-    &nbsp;&nbsp;
-    <a href="https://github.com/TobitSoftware">
-        <img alt="Tobit.Software on GitHub" src="./assets/icons/github.svg">
-    </a>
-</p>
+<div align="center">
+    <a href="https://tobitsoftware.github.io/chayns-toolkit/" target="_blank">
+        <h1 align="center">
+            <img src="https://raw.githubusercontent.com/TobitSoftware/chayns-toolkit/HEAD/assets/logo.png" width="500px" alt="chayns-toolkit" />
+        </h1>
+    </a>
+    <p align="center">A zero-config toolchain for developing chayns® apps.</p>
+    <p align="center">
+        <a href="https://github.com/TobitSoftware/chayns-toolkit/blob/master/LICENSE" target="_blank">
+            <img src="https://img.shields.io/github/license/TobitSoftware/chayns-toolkit?color=%23A855F7&labelColor=%2327272A&style=for-the-badge" alt="" />
+        </a>
+        <a href="https://www.npmjs.com/package/chayns-toolkit" target="_blank">
+            <img src="https://img.shields.io/npm/v/chayns-toolkit?color=%236366F1&labelColor=%2327272A&style=for-the-badge" alt="" />
+        </a>
+        <a href="https://github.com/TobitSoftware/chayns-toolkit/branches" target="_blank">
+            <img src="https://img.shields.io/github/last-commit/TobitSoftware/chayns-toolkit?color=%2310B981&labelColor=%2327272A&style=for-the-badge" alt="" />
+        </a>
+    </p>
+</div>
+
+---
+
+**chayns-toolkit** contains pre-configured tools for the development, publishing and quality
+assurance of your app. It was created to simplify the development experience when working with
+[React](https://reactjs.org).
+
+> This toolchain is specialized in developing apps and plugins for the
+> [chayns®](https://chayns.org/) platform. If you want to develop a general purpose web app, take a
+> look at [Next.js](https://nextjs.org/). <br>
+
+<br>
+
+## ❯ Getting Started
+
+For the easiest way to start a new chayns® project with chayns-toolkit check out
+[`create-chayns-app`](https://github.com/TobitSoftware/create-chayns-app).
+
+<br>
+
+## ❯ Documentation
+
+Visit
+[https://tobitsoftware.github.io/chayns-toolkit/](https://tobitsoftware.github.io/chayns-toolkit/)
+to view the full documentation.
+
+<br>
+
+## ❯ Migration v2 to v3
+
+The chayns-toolkit moved RsBuild instead of webpack in this version. This means customizing the
+config has changed significantly.
+
+-   **output.apiVersion** has been removed
+-   **remoteEntry.js** has been renamed to **v2.remoteEntry.js**
+-   **output.serverSideRendering** has been added. This creates a build to use for modules in SSR.
+    -   Creates two subdirectories in build directory for client- and server-build.
+-   dotenv-Files will be automatically loaded now depending on the current NODE_ENV/BUILD_ENV
+    -   Only variables which start with PUBLIC\_ are passed to the javascript context. Other
+        variables are only available in the toolkit.config.js to customize the config
+-   Not defined environment-variables are not replaced by RsBuild which can cause errors (webpack
+    replaced them with empty string)
+-   **output.entryPoints** has been added and changes how to configure the entry points of the
+    application
+    [https://tobitsoftware.github.io/chayns-toolkit/docs/configuration/output](https://tobitsoftware.github.io/chayns-toolkit/docs/configuration/output)
+
+## ❯ Contributing
+
+Please see our
+[contributing document](https://tobitsoftware.github.io/chayns-toolkit/docs/contributing).
+
+<br>
+
+---
+
+<p align="center">
+    <sub>
+        Project created by Leo Driesch at Tobit.Software.
+    </sub>
+</p>
+<p align="center">
+    <a href="https://labs.tobit.com/">
+        <img alt="Tobit.Software homepage" src="./assets/icons/globe.svg">
+    </a>
+    &nbsp;&nbsp;
+    <a href="https://github.com/TobitSoftware">
+        <img alt="Tobit.Software on GitHub" src="./assets/icons/github.svg">
+    </a>
+</p>

package/cli.js

@@ -1,3 +1,3 @@
 #! /usr/bin/env node
-
-require("./lib/cli.js")
+
+require("./lib/cli.js")

package/eslint/index.js

@@ -1,65 +1,65 @@
-const path = require("path")
-const javascriptRules = require("./javascriptRules")
-const sharedRules = require("./sharedRules")
-const typescriptRules = require("./typescriptRules")
-
-// eslint-disable-next-line import/no-dynamic-require
-const packageJson = require(path.resolve("package.json"))
-
-const usesTypeScript = Object.keys({
-	...packageJson.dependencies,
-	...packageJson.devDependencies,
-}).includes("typescript")
-
-module.exports = {
-	env: {
-		browser: true,
-		es6: true,
-	},
-	extends: ["airbnb", "airbnb/hooks", "prettier"],
-	globals: { chayns: true },
-	rules: { ...sharedRules, ...javascriptRules },
-	parser: "@babel/eslint-parser",
-	parserOptions: {
-		requireConfigFile: false,
-	},
-	settings: {
-		"import/resolver": {
-			typescript: { project: "@(jsconfig|tsconfig).json" },
-		},
-		"import/extensions": [".js", ".jsx", ".ts", ".tsx"],
-	},
-	overrides: [
-		usesTypeScript && {
-			files: ["**/*.ts?(x)"],
-			extends: [
-				"airbnb-typescript",
-				"airbnb/hooks",
-				"plugin:@typescript-eslint/recommended",
-				"plugin:@typescript-eslint/recommended-requiring-type-checking",
-				"prettier",
-				"plugin:import/typescript",
-			],
-			rules: {
-				...sharedRules,
-				...typescriptRules,
-			},
-			parserOptions: {
-				project: "./tsconfig.json",
-			},
-		},
-		{
-			files: ["**/*.@(test|spec).@(js|jsx|ts|tsx)"],
-			env: { "jest/globals": true },
-			plugins: ["jest"],
-			rules: {
-				...sharedRules,
-				"jest/no-disabled-tests": "warn",
-				"jest/no-focused-tests": "error",
-				"jest/no-identical-title": "error",
-				"jest/prefer-to-have-length": "warn",
-				"jest/valid-expect": "error",
-			},
-		},
-	].filter(Boolean),
-}
+const path = require("path")
+const javascriptRules = require("./javascriptRules")
+const sharedRules = require("./sharedRules")
+const typescriptRules = require("./typescriptRules")
+
+// eslint-disable-next-line import/no-dynamic-require
+const packageJson = require(path.resolve("package.json"))
+
+const usesTypeScript = Object.keys({
+	...packageJson.dependencies,
+	...packageJson.devDependencies,
+}).includes("typescript")
+
+module.exports = {
+	env: {
+		browser: true,
+		es6: true,
+	},
+	extends: ["airbnb", "airbnb/hooks", "prettier"],
+	globals: { chayns: true },
+	rules: { ...sharedRules, ...javascriptRules },
+	parser: "@babel/eslint-parser",
+	parserOptions: {
+		requireConfigFile: false,
+	},
+	settings: {
+		"import/resolver": {
+			typescript: { project: "@(jsconfig|tsconfig).json" },
+		},
+		"import/extensions": [".js", ".jsx", ".ts", ".tsx"],
+	},
+	overrides: [
+		usesTypeScript && {
+			files: ["**/*.ts?(x)"],
+			extends: [
+				"airbnb-typescript",
+				"airbnb/hooks",
+				"plugin:@typescript-eslint/recommended",
+				"plugin:@typescript-eslint/recommended-requiring-type-checking",
+				"prettier",
+				"plugin:import/typescript",
+			],
+			rules: {
+				...sharedRules,
+				...typescriptRules,
+			},
+			parserOptions: {
+				project: "./tsconfig.json",
+			},
+		},
+		{
+			files: ["**/*.@(test|spec).@(js|jsx|ts|tsx)"],
+			env: { "jest/globals": true },
+			plugins: ["jest"],
+			rules: {
+				...sharedRules,
+				"jest/no-disabled-tests": "warn",
+				"jest/no-focused-tests": "error",
+				"jest/no-identical-title": "error",
+				"jest/prefer-to-have-length": "warn",
+				"jest/valid-expect": "error",
+			},
+		},
+	].filter(Boolean),
+}

package/eslint/javascriptRules.js

@@ -1,8 +1,8 @@
-const javascriptRules = {
-	"no-use-before-define": [
-		"error",
-		{ functions: false, classes: false, variables: false },
-	],
-}
-
-module.exports = javascriptRules
+const javascriptRules = {
+	"no-use-before-define": [
+		"error",
+		{ functions: false, classes: false, variables: false },
+	],
+}
+
+module.exports = javascriptRules

package/eslint/sharedRules.js

@@ -1,32 +1,32 @@
-const sharedRules = {
-	"import/extensions": [
-		"error",
-		"always",
-		{ js: "never", jsx: "never", ts: "never", tsx: "never" },
-	],
-	"import/no-unresolved": ["error", { ignore: ["chayns-components"] }],
-	"import/prefer-default-export": "off",
-	"jsx-a11y/anchor-has-content": "off",
-	"jsx-a11y/anchor-is-valid": "off",
-	"jsx-a11y/click-events-have-key-events": "off",
-	"jsx-a11y/heading-has-content": "off",
-	"jsx-a11y/href-no-hash": "off",
-	"jsx-a11y/no-noninteractive-element-interactions": "off",
-	"jsx-a11y/no-static-element-interactions": "off",
-	"no-console": ["warn", { allow: ["warn", "error"] }],
-	"no-param-reassign": [
-		"error",
-		{ ignorePropertyModificationsFor: ["draft"], props: true },
-	],
-	"no-plusplus": "off",
-	"no-restricted-imports": [
-		"error",
-		{
-			message: "Use 'chayns-components' instead to enable tree-shaking.",
-			name: "chayns-components/lib",
-		},
-	],
-	"react/no-danger": "off",
-}
-
-module.exports = sharedRules
+const sharedRules = {
+	"import/extensions": [
+		"error",
+		"always",
+		{ js: "never", jsx: "never", ts: "never", tsx: "never" },
+	],
+	"import/no-unresolved": ["error", { ignore: ["chayns-components"] }],
+	"import/prefer-default-export": "off",
+	"jsx-a11y/anchor-has-content": "off",
+	"jsx-a11y/anchor-is-valid": "off",
+	"jsx-a11y/click-events-have-key-events": "off",
+	"jsx-a11y/heading-has-content": "off",
+	"jsx-a11y/href-no-hash": "off",
+	"jsx-a11y/no-noninteractive-element-interactions": "off",
+	"jsx-a11y/no-static-element-interactions": "off",
+	"no-console": ["warn", { allow: ["warn", "error"] }],
+	"no-param-reassign": [
+		"error",
+		{ ignorePropertyModificationsFor: ["draft"], props: true },
+	],
+	"no-plusplus": "off",
+	"no-restricted-imports": [
+		"error",
+		{
+			message: "Use 'chayns-components' instead to enable tree-shaking.",
+			name: "chayns-components/lib",
+		},
+	],
+	"react/no-danger": "off",
+}
+
+module.exports = sharedRules

package/eslint/typescriptRules.js

@@ -1,20 +1,20 @@
-const typescriptRules = {
-	"react/prop-types": "off",
-	"react/require-default-props": "off",
-	"@typescript-eslint/no-use-before-define": [
-		"error",
-		{ functions: false, classes: false, variables: false, enums: false },
-	],
-	"@typescript-eslint/ban-ts-comment": [
-		"error",
-		{
-			"ts-expect-error": "allow-with-description",
-			"ts-ignore": true,
-			"ts-nocheck": true,
-			"ts-check": true,
-			minimumDescriptionLength: 4,
-		},
-	],
-}
-
-module.exports = typescriptRules
+const typescriptRules = {
+	"react/prop-types": "off",
+	"react/require-default-props": "off",
+	"@typescript-eslint/no-use-before-define": [
+		"error",
+		{ functions: false, classes: false, variables: false, enums: false },
+	],
+	"@typescript-eslint/ban-ts-comment": [
+		"error",
+		{
+			"ts-expect-error": "allow-with-description",
+			"ts-ignore": true,
+			"ts-nocheck": true,
+			"ts-check": true,
+			minimumDescriptionLength: 4,
+		},
+	],
+}
+
+module.exports = typescriptRules

package/lib/assets/react-testing-library.setup.js

@@ -1,2 +1,2 @@
-// eslint-disable-next-line import/no-extraneous-dependencies
-require("@testing-library/jest-dom")
+// eslint-disable-next-line import/no-extraneous-dependencies
+require("@testing-library/jest-dom")