@graupl/graupl 1.0.0-beta.1 → 1.0.0-beta.10

package/.devcontainer/devcontainer.json

@@ -0,0 +1,221 @@
+// @see https://github.com/microsoft/vscode-dev-containers/blob/main/containers/docker-existing-docker-compose/.devcontainer/devcontainer.json
+{
+  "name": "Graupl Dev",
+
+  // Update the 'dockerComposeFile' list if you have more compose files or use different names.
+  // The .devcontainer/docker-compose.extend.yml file contains any overrides you need/want to make.
+  "dockerComposeFile": [
+    "../container/docker-compose.yml"
+  ],
+
+  // The 'service' property is the name of the service for the container that VS Code should
+  // use. Update this value and .devcontainer/docker-compose.yml to the real service name.
+  "service": "app",
+
+  // The optional 'workspaceFolder' property is the path VS Code should open by default when
+  // connected. This is typically a file mount in .devcontainer/docker-compose.yml
+  "workspaceFolder": "/var/www/html",
+
+  // Update the path to include vendor/bin and ~/bin
+  // Enable bash history.
+  "remoteEnv": {
+    "PATH": "${containerEnv:HOME}/.vscode-server/bin/**/bin:${containerEnv:PATH}",
+    "PROMPT_COMMAND": "history -a",
+    "HISTFILE": "/commandhistory/.bash_history"
+  },
+
+  // Set *default* container specific settings.json values on container create.
+  "customizations": {
+    "vscode": {
+      "settings": {
+        "breadcrumbs.enabled": true,
+        "better-comments.tags": [
+          {
+            "tag": "!",
+            "color": "#FF2D00",
+            "strikethrough": false,
+            "underline": false,
+            "backgroundColor": "transparent",
+            "bold": false,
+            "italic": false
+          },
+          {
+            "tag": "?",
+            "color": "#3498DB",
+            "strikethrough": false,
+            "underline": false,
+            "backgroundColor": "transparent",
+            "bold": false,
+            "italic": false
+          },
+          {
+            "tag": "//",
+            "color": "#474747",
+            "strikethrough": true,
+            "underline": false,
+            "backgroundColor": "transparent",
+            "bold": false,
+            "italic": false
+          },
+          {
+            "tag": "todo",
+            "color": "#FF8C00",
+            "strikethrough": false,
+            "underline": false,
+            "backgroundColor": "transparent",
+            "bold": false,
+            "italic": false
+          },
+              {
+            "tag": "@todo",
+            "color": "#FF8C00",
+            "strikethrough": false,
+            "underline": false,
+            "backgroundColor": "transparent",
+            "bold": false,
+            "italic": false
+          },
+          {
+            "tag": "*",
+            "color": "#98C379",
+            "strikethrough": false,
+            "underline": false,
+            "backgroundColor": "transparent",
+            "bold": false,
+            "italic": false
+          }
+        ],
+        "css.validate": true,
+        "debug.allowBreakpointsEverywhere": true,
+        "debug.showBreakpointsInOverviewRuler": true,
+        "diffEditor.ignoreTrimWhitespace": false,
+        "drupalSDCHelper.componentDirectories": [
+          "web/themes/custom/*/components/**",
+          "web/modules/custom/*/components/**",
+          "docroot/themes/custom/*/components/**",
+          "docroot/modules/custom/*/components/**",
+          "public_html/modules/custom/*/components/**",
+          "public_html/themes/custom/*/components/**"
+        ],
+        "docker.containers.label": "ContainerName",
+        // @see https: //github.com/microsoft/vscode/issues/174632#issuecomment-1608114637
+        "extensions.verifySignature": false,
+        "editor.autoIndent": "full",
+        "editor.detectIndentation": true,
+        "editor.codeActionsOnSave": {
+          "source.fixAll.eslint": true
+        },
+        "editor.formatOnPaste": true,
+        "editor.formatOnSave": false,
+        "editor.insertSpaces": true,
+        "editor.minimap.maxColumn": 200,
+        "editor.minimap.renderCharacters": false,
+        "editor.renderWhitespace": "boundary",
+        "editor.rulers": [80],
+        "editor.tabSize": 2,
+        "editor.wordWrap": "off",
+        "editor.wordWrapColumn": 80,
+        "flashpost.saveDataToWorkspace": true,
+        "flashpost.workspaceDataRelativePath": "testing/flashpost",
+        "workbench.editor.labelFormat": "medium",
+        "workbench.sideBar.location": "right",
+        "[javascript]": {
+          "editor.defaultFormatter": "esbenp.prettier-vscode"
+        },
+        "[json]": {
+          "editor.defaultFormatter": "esbenp.prettier-vscode"
+        },
+        "[typescript]": {
+          "editor.defaultFormatter": "vscode.typescript-language-features"
+        },
+        "[vue]": {
+          "editor.defaultFormatter": "esbenp.prettier-vscode"
+        },
+        "[yaml]": {
+          "editor.defaultFormatter": "redhat.vscode-yaml"
+        },
+        "files.associations": {
+          ".env.*": "env",
+          "devcontainer.json": "jsonc",
+          "settings.json": "jsonc"
+        },
+        "files.trimTrailingWhitespace": true,
+        "files.insertFinalNewline": true,
+        "html.format.enable": true,
+        "html.format.wrapLineLength": 80,
+        "telemetry.enableTelemetry": false,
+        "todo-tree.regex.regex": "(//|#|<!--|;|/?\\*|^|^[ \\t]*(-|\\d+.))\\s*($TAGS)",
+        "todo-tree.general.tags": ["@todo", "TODO", "FIXME"],
+        "typescript.suggest.paths": false,
+
+        "conventionalCommits.scopes": [
+          "vscode",
+          "ci",
+          "config",
+          "code",
+          "tests",
+          "docs"
+        ],
+
+        "scm.showHistoryGraph": false
+      },
+      // Add the IDs of extensions you want installed when the container is created.
+      "extensions": [
+        /* General VSCode QoL */
+        "DavidAnson.vscode-markdownlint",
+        "mikestead.dotenv",
+        "tyriar.sort-lines",
+
+        /* Git, Build, Debug */
+        "aaron-bond.better-comments",
+        "eamodio.gitlens",
+        "vivaxy.vscode-conventional-commits",
+        "Gruntfuggly.todo-tree",
+        "streetsidesoftware.code-spell-checker",
+
+        /* HTML, JS*/
+        "formulahendry.auto-rename-tag",
+        "christian-kohler.path-intellisense",
+        "dbaeumer.vscode-eslint",
+        "editorconfig.editorconfig",
+        "esbenp.prettier-vscode",
+        "mrmlnc.vscode-scss",
+        "ms-vscode.live-server",
+        "octref.vetur",
+        "shardulm94.trailing-spaces",
+        "stevencl.adddoccomments",
+        "stylelint.vscode-stylelint",
+        "syler.sass-indented",
+        "vivek9patel.vscode-css-compatibility",
+
+        /* Vite */
+        "antfu.vite",
+        "fantasy.vp-preview",
+        "vitest.explorer"
+      ]
+    }
+  },
+
+  "overrideCommand": true,
+
+  // Install npm build tools automatically.
+  "postStartCommand": "test -f /var/www/html/node_modules/.package-lock.json || (npm i -y; npm run build)",
+
+  // Fix permissions on the project directory.
+  "postAttachCommand": "/usr/bin/git config --global --add safe.directory /var/www/html",
+
+  // Use 'forwardPorts' to make a list of ports inside the container available locally.
+  "forwardPorts": [4000, 4001]
+
+  // Uncomment the next line if you want start specific services in your Docker Compose config.
+  // "runServices": [],
+
+  // Uncomment the next line if you want to keep your containers running after VS Code shuts down.
+  // "shutdownAction": "none",
+
+  // Uncomment the next line to run commands after the container is created - for example installing curl.
+  // "postCreateCommand": ""
+
+  // Uncomment to connect as a non-root user if you've added one. See https://aka.ms/vscode-remote/containers/non-root.
+  // "remoteUser": "vscode"
+}

package/.env

@@ -0,0 +1,3 @@
+## Docker Compose Settings.
+### N.B. Docker Compose settings must be placed in your workspace root .env as well ###
+COMPOSE_PROJECT_NAME=graupl

package/.github/workflows/docs.yml

@@ -20,28 +20,35 @@ concurrency:
   cancel-in-progress: false
 
 jobs:
+  test:
+    uses: ./.github/workflows/test.yml
+
   # Build job
   build:
     runs-on: ubuntu-latest
+    needs: test
     steps:
       - name: Checkout
         uses: actions/checkout@v4
-        with:
-          fetch-depth: 0 # Not needed if lastUpdated is not enabled
+
       - name: Setup Node
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 22.x
+
       - name: Setup Pages
         uses: actions/configure-pages@v3
+
       - name: Install dependencies
         run: npm install
+
       - name: Build with VitePress
         run: |
           npm run docs:build
           touch docs/.vitepress/dist/.nojekyll
+
       - name: Upload artifact
-        uses: actions/upload-pages-artifact@v2
+        uses: actions/upload-pages-artifact@v3
         with:
           path: docs/.vitepress/dist
 
@@ -56,4 +63,4 @@ jobs:
     steps:
       - name: Deploy to GitHub Pages
         id: deployment
-        uses: actions/deploy-pages@v2
+        uses: actions/deploy-pages@v4

package/.github/workflows/prerelease.yml

@@ -0,0 +1,125 @@
+name: Pre-release
+
+on:
+  push:
+    # Push events to match v*.*.*-alpha.*, v*.*.*-beta.*, and v*.*.*-rc.* where * is a number.
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+-[a-zA-Z]+.[0-9]+'
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  test:
+    uses: ./.github/workflows/test.yml
+
+  release_github:
+    # Prevent this action from running on forks.
+    if: github.repository == 'graupl/graupl'
+    needs: test
+    runs-on: ubuntu-latest
+    environment: Release
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22.x
+
+      - name: Install modules
+        run: npm install
+
+      # Get the version from the package.json
+      - name: Get version
+        id: get_version
+        run: |
+          export VERSION=$(node -p "require('./package.json').version")
+          echo "VERSION=$VERSION" >> $GITHUB_ENV
+
+      - name: Create GitHub release
+        uses: softprops/action-gh-release@v2
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          name: ${{ env.VERSION }}
+          prerelease: true
+
+  publish_npm:
+    # Prevent this action from running on forks.
+    if: github.repository == 'graupl/graupl'
+    needs: [release_github]
+    runs-on: ubuntu-latest
+    environment: Release
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22.x
+          registry-url: 'https://registry.npmjs.org/'
+          scope: '@graupl'
+
+      - name: Install modules
+        run: npm install
+
+      # Get the prerelease type from the package.json, e.g., 'alpha', 'beta', or 'rc'.
+      - name: Get prerelease type
+        id: get_prerelease_type
+        run: |
+          export PRERELEASE_TYPE=$(node -p "require('./package.json').version.split('-')[1].split('.')[0]")
+          echo "PRERELEASE_TYPE=$PRERELEASE_TYPE" >> $GITHUB_ENV
+
+      - name: Publish workspaces to npm
+        if: github.tag
+        run: npm publish --workspaces --access public --tag ${{ env.PRERELEASE_TYPE }}
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Publish to npm
+        if: github.tag
+        run: npm publish --access public --tag ${{ env.PRERELEASE_TYPE }}
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+  publish_github:
+    # Prevent this action from running on forks.
+    if: github.repository == 'graupl/graupl'
+    needs: [release_github]
+    runs-on: ubuntu-latest
+    environment: Release
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22.x
+          registry-url: 'https://npm.pkg.github.com/'
+          scope: '@graupl'
+
+      - name: Install modules
+        run: npm install
+
+      # Get the prerelease type from the package.json, e.g., 'alpha', 'beta', or 'rc'.
+      - name: Get prerelease type
+        id: get_prerelease_type
+        run: |
+          export PRERELEASE_TYPE=$(node -p "require('./package.json').version.split('-')[1].split('.')[0]")
+          echo "PRERELEASE_TYPE=$PRERELEASE_TYPE" >> $GITHUB_ENV
+
+      - name: Publish workspaces to GitHub Packages
+        if: github.tag
+        run: npm publish --workspaces --access public --tag ${{ env.PRERELEASE_TYPE }}
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Publish to GitHub Packages
+        if: github.tag
+        run: npm publish --access public --tag ${{ env.PRERELEASE_TYPE }}
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/.github/workflows/release.yml

@@ -0,0 +1,111 @@
+name: Release
+
+on:
+  push:
+    # Push events to match v*.*.* where * is a number.
+    tags:
+      - 'v[0-9]+.[0-9]+.[0-9]+'
+
+permissions:
+  contents: write
+  id-token: write
+
+jobs:
+  test:
+    uses: ./.github/workflows/test.yml
+
+  release_github:
+    # Prevent this action from running on forks.
+    if: github.repository == 'graupl/graupl'
+    needs: test
+    runs-on: ubuntu-latest
+    environment: Release
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22.x
+
+      - name: Install modules
+        run: npm install
+
+      # Get the version from the package.json
+      - name: Get version
+        id: get_version
+        run: |
+          export VERSION=$(node -p "require('./package.json').version")
+          echo "VERSION=$VERSION" >> $GITHUB_ENV
+
+      - name: Create GitHub release
+        uses: softprops/action-gh-release@v2
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          name: ${{ env.VERSION }}
+          make_latest: true
+
+  publish_npm:
+    # Prevent this action from running on forks.
+    if: github.repository == 'graupl/graupl'
+    needs: [release_github]
+    runs-on: ubuntu-latest
+    environment: Release
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22.x
+          registry-url: 'https://registry.npmjs.org/'
+          scope: '@graupl'
+
+      - name: Install modules
+        run: npm install
+
+      - name: Publish workspaces to npm
+        if: github.tag
+        run: npm publish --workspaces --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Publish to npm
+        if: github.tag
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+  publish_github:
+    # Prevent this action from running on forks.
+    if: github.repository == 'graupl/graupl'
+    needs: [release_github]
+    runs-on: ubuntu-latest
+    environment: Release
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22.x
+          registry-url: 'https://npm.pkg.github.com/'
+          scope: '@graupl'
+
+      - name: Install modules
+        run: npm install
+
+      - name: Publish workspaces to GitHub Packages
+        if: github.tag
+        run: npm publish --workspaces --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Publish to GitHub Packages
+        if: github.tag
+        run: npm publish --access public
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/.github/workflows/test.yml

@@ -1,27 +1,78 @@
 name: Tests
+
 on:
   push:
     branches: [ '*.x' ]
   pull_request:
     branches: [ '*.x' ]
+  workflow_dispatch:
+  workflow_call:
+
 jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22.x
+
       - name: Install modules
         run: npm install
+
       - name: Run build
         run: npm run build
-  lint:
+
+  eslint:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22.x
+
       - name: Install modules
         run: npm install
+
       - name: Run eslint
         run: npm run eslint
+
+  stylelint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22.x
+
+      - name: Install modules
+        run: npm install
+
       - name: Run stylelint
         run: npm run stylelint
+
+  prettier:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22.x
+
+      - name: Install modules
+        run: npm install
+
       - name: Run prettier
         run: npm run prettier -- --check

package/.versionrc.cjs

@@ -1,3 +1,11 @@
+const fs = require("fs");
+
+// Get all package.json files in the packages/*/ directories
+const packageJsonFiles = fs
+  .readdirSync("packages")
+  .filter((dir) => fs.statSync(`packages/${dir}`).isDirectory())
+  .map((dir) => `packages/${dir}/package.json`);
+
 const config = {
   types: [
     {
@@ -58,4 +66,8 @@ const config = {
   ],
 };
 
+config.packageFiles = ["package.json"];
+
+config.bumpFiles = [...config.packageFiles, ...packageJsonFiles];
+
 module.exports = config;

package/.vscode/settings.json

@@ -0,0 +1,10 @@
+{
+  "cSpell.words": [
+    "mbse",
+    "pbse",
+    "pise"
+  ],
+  "liveServer.settings.port": 5501,
+  "vp.docsDir": "docs",
+  "vite.autoStart": false
+}