Merge pull request #69 from it-at-m/main

update beta-branch

Author: FabianWilms

.eslintrc.cjs

@@ -1,15 +1,15 @@
 /* eslint-env node */
-require('@rushstack/eslint-patch/modern-module-resolution')
+require("@rushstack/eslint-patch/modern-module-resolution");
 
 module.exports = {
   root: true,
-  'extends': [
-    'plugin:vue/vue3-essential',
-    'eslint:recommended',
-    '@vue/eslint-config-typescript',
-    '@vue/eslint-config-prettier/skip-formatting'
+  extends: [
+    "plugin:vue/vue3-essential",
+    "eslint:recommended",
+    "@vue/eslint-config-typescript",
+    "@vue/eslint-config-prettier/skip-formatting",
   ],
   parserOptions: {
-    ecmaVersion: 'latest'
-  }
-}
+    ecmaVersion: "latest",
+  },
+};

.github/workflows/build.yaml

@@ -16,17 +16,17 @@ jobs:
           registry-url: "https://registry.npmjs.org"
       - run: npm ci             # install dependencies
       - run: npm run build      # build library
-      - run: npm run docs:build # build docs
+      - run: npm run build-storybook # build docs
       - name: upload library artifacts
         uses: actions/upload-artifact@v4
         with:
           name: library_dist
           path: ./dist
-      - name: upload vitepress artifacts
+      - name: upload storybook artifacts
         uses: actions/upload-artifact@v4
         with:
-          name: vitepress_dist
-          path: ./docs/.vitepress/dist
+          name: storybook_dist
+          path: ./storybook-static
 
   deploy-npm:
     runs-on: ubuntu-latest
@@ -71,11 +71,11 @@ jobs:
       - name: Download build-results
         uses: actions/download-artifact@v4
         with:
-          name: vitepress_dist
-          path: ./docs/.vitepress/dist
+          name: storybook_dist
+          path: ./storybook-static
       - name: Deploy to GitHub Pages
         uses: peaceiris/actions-gh-pages@v4
         id: deployment
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./docs/.vitepress/dist
+          publish_dir: ./storybook-static

.gitignore

@@ -28,3 +28,5 @@ coverage
 *.sw?
 
 *.tsbuildinfo
+
+storybook-static

.prettierignore

@@ -0,0 +1,19 @@
+# Folders
+.github
+.idea
+.vscode
+dist
+public
+storybook-static
+
+# Files
+package.json
+package-lock.json
+.gitignore
+.npmignore
+.prettierignore
+
+# Readme
+LICENSE
+CODE_OF_CONDUCT.md
+README.md

.prettierrc.json

@@ -1,8 +1 @@
-{
-  "$schema": "https://json.schemastore.org/prettierrc",
-  "semi": false,
-  "tabWidth": 2,
-  "singleQuote": true,
-  "printWidth": 100,
-  "trailingComma": "none"
-}
+"@muenchen/prettier-codeformat"

.releaserc.js

@@ -0,0 +1,79 @@
+const { promisify } = require("util");
+const dateFormat = require("dateformat");
+const { join } = require("node:path");
+const readFileAsync = promisify(require("fs").readFile);
+
+const TEMPLATE_DIR =
+  "node_modules/semantic-release-gitmoji/lib/assets/templates";
+// the *.hbs template and partials should be passed as strings of contents
+const template = readFileAsync(join(TEMPLATE_DIR, "default-template.hbs"));
+const commitTemplate = readFileAsync(join(TEMPLATE_DIR, "commit-template.hbs"));
+
+module.exports = {
+  branches: [
+    "main",
+    "+([0-9])?(.{+([0-9]),x}).x",
+    "next",
+    "next-major",
+    {
+      name: "alpha",
+      prerelease: true,
+    },
+    {
+      name: "beta",
+      prerelease: true,
+    },
+  ],
+  plugins: [
+    [
+      "semantic-release-gitmoji",
+      {
+        releaseRules: {
+          major: [":boom:"],
+          minor: [":sparkles:"],
+          patch: [":bug:", ":ambulance:", ":lock:", ":lipstick"],
+        },
+        releaseNotes: {
+          template,
+          partials: { commitTemplate },
+          helpers: {
+            datetime: function (format = "UTC:yyyy-mm-dd") {
+              return dateFormat(new Date(), format);
+            },
+          },
+          issueResolution: {
+            template: "{baseUrl}/{owner}/{repo}/issues/{ref}",
+            baseUrl: "https://github.com",
+            source: "github.com",
+            removeFromCommit: false,
+            regex: /#\d+/g,
+          },
+        },
+      },
+    ],
+    "@semantic-release/npm",
+    [
+      "@semantic-release/github",
+      {
+        assets: [
+          {
+            path: "dist/muc-patternlab-vue.es.js",
+            label: "JS distribution",
+          },
+          {
+            path: "dist/assets/temporary/muenchende-style.css",
+            label: "CSS distribution",
+          },
+          {
+            path: "dist/assets/temporary/muenchende-fontfaces.css",
+            label: "CSS fontface distribution",
+          },
+          {
+            path: "dist/assets/temporary/muc-icons.svg",
+            label: "SVG sprite distribution",
+          },
+        ],
+      },
+    ],
+  ],
+};

.releaserc.json

@@ -0,0 +1,9 @@
+import { create } from '@storybook/theming/create';
+
+export default create({
+    base: 'light',
+    brandTitle: 'muc-patternlab-vue',
+    brandUrl: 'https://github.com/it-at-m/muc-patternlab-vue',
+    brandImage: './muc-patternlab-vue.png',
+    brandTarget: '_blank',
+});

.storybook/MucTheme.ts

@@ -0,0 +1,36 @@
+import { StorybookConfig } from "@storybook/vue3-vite";
+
+/**
+ * Load Muc-SVG-Sprite and inject it into storybook-Preview.
+ */
+const fs = require("fs");
+const path = require("path");
+const mucIconsSvg = fs.readFileSync(
+  path.resolve(__dirname, "../public/assets/temporary/muc-icons.svg"),
+  "utf8"
+);
+
+const config: StorybookConfig = {
+  stories: ["../docs/*.mdx", "../src/components/**/*.stories.ts"],
+  staticDirs: ["../public", "../docs/images"],
+  addons: [
+    "@storybook/addon-links",
+    "@storybook/addon-essentials",
+    "@storybook/addon-interactions",
+    "@storybook/addon-a11y",
+    "@storybook/addon-docs",
+  ],
+  framework: {
+    name: "@storybook/vue3-vite",
+    options: {},
+  },
+  previewBody: (body) => `
+    ${body}
+    ${mucIconsSvg}
+ `,
+  docs: {
+    autodocs: "tag",
+  },
+};
+
+export default config;

.storybook/main.ts

@@ -0,0 +1,6 @@
+import { addons } from '@storybook/manager-api';
+import mucTheme from './MucTheme';
+
+addons.setConfig({
+    theme: mucTheme,
+});