@mrpelz/boilerplate-preact 9.0.0

package/Makefile

@@ -0,0 +1,8 @@
+BASE_FILE := $(shell npm ls --parseable --silent "@mrpelz/boilerplate-dom" 2>/dev/null)
+
+include $(BASE_FILE)/Makefile
+
+watch_lint:
+	nodemon --quiet --watch "**/*" --watch "src/**/*" --ignore "dist/**/*" --ignore "node_modules/**/*" --ignore "*.d.ts" --ext "js,mjs,jsx,ts,tsx" \
+		--exec 'clear; eslint $(ESLINT_ARGS) .'; \
+	exit 0;

package/commitlint.config.mjs

@@ -0,0 +1,5 @@
+// @ts-ignore
+import config from '@mrpelz/boilerplate-dom/commitlint.config.mjs';
+
+/** @type {import('@commitlint/types').UserConfig} */
+export default config;

package/eslint.config.js

@@ -0,0 +1,29 @@
+import {
+  config as configUpstream,
+  configMeta,
+  // @ts-ignore
+} from '@mrpelz/boilerplate-dom/eslint.config.js';
+// @ts-ignore
+import pluginReactHooks from 'eslint-plugin-react-hooks';
+
+export { configMeta };
+
+const reactHooksRecommendedRules =
+  /** @type {import('eslint').Linter.RulesRecord} */ (
+    pluginReactHooks.configs.recommended.rules
+  );
+
+/** @type {import('eslint').Linter.FlatConfig} */
+export const config = {
+  ...configUpstream,
+  files: ['src/**/*.{js,jsx,ts,tsx}'],
+  plugins: {
+    ...configUpstream.plugins,
+    // @ts-ignore
+    'react-hooks': pluginReactHooks,
+  },
+  rules: { ...configUpstream.rules, ...reactHooksRecommendedRules },
+};
+
+/** @type {import('eslint').Linter.FlatConfig[]} */
+export default [configMeta, config];

package/jest.config.js

@@ -0,0 +1,13 @@
+// @ts-ignore
+import configUpstream from '@mrpelz/boilerplate-dom/jest.config.js';
+
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+const config = {
+  ...configUpstream,
+  moduleNameMapper: {
+    '^(\\./.+)\\.m?jsx?$': '$1',
+  },
+};
+
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+export default config;

package/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@mrpelz/boilerplate-preact",
+  "version": "9.0.0",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/mrpelz/boilerplate.git",
+    "directory": "packages/boilerplate-preact"
+  },
+  "license": "UNLICENSED",
+  "author": "Lennart Pelz <mail@mrpelz.de>",
+  "type": "module",
+  "main": "dist/main.js",
+  "module": "dist/main.js",
+  "types": "dist/main.d.ts",
+  "bin": {
+    "boilerplate-preact-bootstrap": "scripts/bootstrap.sh"
+  },
+  "files": [
+    "dist/**/*.{js,map,ts}",
+    "dist/**/*.tsx",
+    "commitlint.config.mjs",
+    "eslint.config.js",
+    "jest.config.js",
+    "Makefile",
+    "scripts/**/*.sh",
+    "stylelint.config.js",
+    "tsconfig.json",
+    "tsconfig.meta.json",
+    "webpack.config.js"
+  ],
+  "dependencies": {
+    "@mrpelz/boilerplate-dom": "*",
+    "eslint-plugin-react-hooks": "latest",
+    "preact": "latest"
+  }
+}

package/scripts/bootstrap.sh

@@ -0,0 +1,169 @@
+#!/usr/bin/env bash
+
+## ENVIRONMENT
+
+BOILERPLATE_MODULE_NAME="@mrpelz/boilerplate-common"
+BOILERPLATE_MODULE_PATH="$(realpath --relative-to=. "$(npm ls --parseable --silent "$BOILERPLATE_MODULE_NAME" 2>/dev/null)")"
+
+BOILERPLATE_DOM_MODULE_NAME="@mrpelz/boilerplate-dom"
+BOILERPLATE_DOM_MODULE_PATH="$(realpath --relative-to=. "$(npm ls --parseable --silent "$BOILERPLATE_DOM_MODULE_NAME" 2>/dev/null)")"
+
+BOILERPLATE_PREACT_MODULE_NAME="@mrpelz/boilerplate-preact"
+BOILERPLATE_PREACT_MODULE_PATH="$(realpath --relative-to=. "$(npm ls --parseable --silent "$BOILERPLATE_PREACT_MODULE_NAME" 2>/dev/null)")"
+
+SCRIPT_PATH="${BOILERPLATE_MODULE_PATH}/scripts"
+# shellcheck disable=SC1091
+source "${SCRIPT_PATH}/utils.sh"
+
+## FLOW
+
+# shellcheck disable=SC1091
+source "${SCRIPT_PATH}/common-pre.sh"
+
+if [[ $SKIP_FILES -ne 1 ]]; then
+	if check_response "🖇 install symbolic links referencing files in \"$BOILERPLATE_MODULE_NAME\" and \"$BOILERPLATE_DOM_MODULE_NAME\"?" y; then
+		make_ln "${BOILERPLATE_MODULE_PATH}/.editorconfig" .editorconfig
+
+		make_ln "${BOILERPLATE_MODULE_PATH}/.shellcheckrc" .shellcheckrc
+
+		make_ln "${BOILERPLATE_MODULE_PATH}/.vscode/extensions.json" .vscode/extensions.json
+		make_ln "${BOILERPLATE_MODULE_PATH}/.vscode/settings.json" .vscode/settings.json
+
+		make_ln "${BOILERPLATE_DOM_MODULE_PATH}/scripts/watch.sh" scripts/watch.sh
+		make_ln "${BOILERPLATE_DOM_MODULE_PATH}/scripts/watch-dev.sh" scripts/watch-dev.sh
+	fi
+
+	if check_response "📃 install bare config files extending base files in \"$BOILERPLATE_MODULE_NAME\", \"$BOILERPLATE_DOM_MODULE_NAME\" and \"$BOILERPLATE_PREACT_MODULE_PATH\"?" y; then
+
+		# no indent
+		make_config .gitignore "$(
+			cat <<EOF
+.DS_Store
+dist
+node_modules
+secrets.txt
+EOF
+		)"
+
+		make_config Makefile "$(
+			cat <<EOF
+BASE_FILE := \$(shell npm ls --parseable --silent "$BOILERPLATE_PREACT_MODULE_PATH" 2>/dev/null)
+
+include \$(BASE_FILE)/Makefile
+EOF
+		)"
+
+		make_config commitlint.config.mjs "$(
+			cat <<EOF
+// @ts-ignore
+import config from '$BOILERPLATE_PREACT_MODULE_PATH/commitlint.config.mjs';
+
+/** @type {import('@commitlint/types').UserConfig} */
+export default config;
+EOF
+		)"
+
+		make_config eslint.config.js "$(
+			cat <<EOF
+// @ts-ignore
+import config from '$BOILERPLATE_PREACT_MODULE_PATH/eslint.config.js';
+
+/** @type {import('eslint').Linter.FlatConfig[]} */
+export default config;
+EOF
+		)"
+
+		make_config jest.config.js "$(
+			cat <<EOF
+// @ts-ignore
+import config from '$BOILERPLATE_PREACT_MODULE_PATH/jest.config.js';
+
+/** @type {import('ts-jest').JestConfigWithTsJest} */
+export default config;
+EOF
+		)"
+
+		make_config stylelint.config.js "$(
+			cat <<EOF
+import { execSync } from 'node:child_process';
+import { resolve } from 'node:path';
+
+/** @type {import('stylelint').Config} */
+export default {
+  extends: [
+    resolve(
+      execSync('npm ls --parseable "$BOILERPLATE_PREACT_MODULE_PATH"', {
+        encoding: 'utf8',
+      }).trim(),
+      'stylelint.config.js',
+    ),
+  ],
+};
+EOF
+		)"
+
+		make_config webpack.config.js "$(
+			cat <<EOF
+// @ts-ignore
+import config from '$BOILERPLATE_PREACT_MODULE_PATH/webpack.config.js';
+
+/** @type {import('webpack').Configuration | import('webpack').WebpackOptionsNormalized} */
+export default config;
+EOF
+		)"
+
+		make_config tsconfig.json "$(
+			cat <<EOF
+{
+  "compilerOptions": {
+    "outDir": "dist",
+  },
+  "extends": "$BOILERPLATE_PREACT_MODULE_PATH/tsconfig.json",
+  "include": ["src/**/*"]
+}
+EOF
+		)"
+
+		make_config tsconfig.build.json "$(
+			cat <<EOF
+{
+  "compilerOptions": {
+    "noEmit": false
+  },
+  "exclude": ["**/*.test.ts"],
+  "extends": "./tsconfig.json",
+  "include": ["src/**/*"]
+}
+EOF
+		)"
+
+		make_config tsconfig.meta.json "$(
+			cat <<EOF
+{
+  "exclude": ["dist/**/*", "node_modules/**/*", "packages/**/*", "src/**/*"],
+  "extends": "$BOILERPLATE_PREACT_MODULE_PATH/tsconfig.meta.json",
+  "include": ["**/*.js", "**/*.mjs"]
+}
+EOF
+		)"
+
+		make_config .gitlab-ci.yml "$(
+			cat <<EOF
+include:
+  - project: "mrpelz/boilerplate"
+    ref: main
+    file: "/gitlab/.gitlab-ci.yml"
+    # file: "/gitlab/.monorepo.gitlab-ci.yml"
+EOF
+		)"
+	fi
+fi
+
+# shellcheck disable=SC1091
+source "${SCRIPT_PATH}/common-post.sh"
+
+if check_response "📂 create \"static\" directory (this will *not* overwrite/empty out existing directories)?" y; then
+	mkdir -p static
+fi
+
+echo "✅ done"

package/stylelint.config.js

@@ -0,0 +1,14 @@
+import { execSync } from 'node:child_process';
+import { resolve } from 'node:path';
+
+/** @type {import('stylelint').Config} */
+export default {
+  extends: [
+    resolve(
+      execSync('npm ls --parseable "@mrpelz/boilerplate-dom"', {
+        encoding: 'utf8',
+      }).trim(),
+      'stylelint.config.js',
+    ),
+  ],
+};

package/tsconfig.json

@@ -0,0 +1,8 @@
+{
+  "compilerOptions": {
+    "jsx": "react-jsx",
+    "jsxImportSource": "preact"
+  },
+  "extends": "@mrpelz/boilerplate-dom/tsconfig.json",
+  "include": ["src/**/*"]
+}

package/tsconfig.meta.json

@@ -0,0 +1,5 @@
+{
+  "exclude": ["dist/**/*", "node_modules/**/*", "packages/**/*", "src/**/*"],
+  "extends": "@mrpelz/boilerplate-dom/tsconfig.meta.json",
+  "include": ["**/*.js", "**/*.mjs"]
+}

package/webpack.config.js

@@ -0,0 +1,26 @@
+import { resolve } from 'node:path';
+
+import config, {
+  dirBase,
+  dirSrc,
+  // @ts-ignore
+} from '@mrpelz/boilerplate-dom/webpack.config.js';
+
+const { entry } = config;
+if (entry) entry[0] = resolve(dirSrc, 'main.tsx');
+
+config.module?.rules?.push({
+  exclude: /node_modules/,
+  test: /\.tsx$/i,
+  use: [
+    {
+      loader: 'ts-loader',
+      options: {
+        configFile: resolve(dirBase, 'tsconfig.build.json'),
+      },
+    },
+  ],
+});
+
+/** @type {import('webpack').Configuration | import('webpack').WebpackOptionsNormalized} */
+export default config;