@webship.co/workspace-drupal-recipes 0.0.0-stage → 1.0.0-alpha1

package/README.md

@@ -1,3 +1,32 @@
-# Temporary Holding Version
+# @webship.co/workspace-drupal-recipes
 
-This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
+The **Drupal recipes** workspace of the [Webship Workspace](https://github.com/webship/workspace) dashboard:
+the `recipes/` folder (type `code`), its settings file (`core/config/workspace.recipes.settings.yml`),
+its commands and its docs, as a plugin.
+
+## Use it
+
+```bash
+cd ~/workspace
+bash core/scripts/plugins.sh --require github:webship/workspace-drupal-recipes
+bash core/scripts/plugins.sh --activate drupal-recipes     # puts `recipes` on the workspaces list of settings.yml
+bash core/scripts/plugins.sh --install drupal-recipes      # the folder, its settings file (once), its commands, its docs (once)
+```
+
+The settings file and the docs are placed once and never overwritten: they hold what you put there.
+`--deactivate` takes the workspace off the list; the folder and its content stay.
+
+## The commands
+
+| Command |
+| --- |
+| `cmd-tool-backup-recipe.sh` |
+| `cmd-tool-git-change-filemode-to-false.sh` |
+| `cmd-tools-checks.sh` |
+| `cmd-tools-gitlab-ci-local.sh` |
+| `cmd-tools-graphify.sh` |
+| `cmd-tools-obsidian.sh` |
+| `cmd-tools-ragify.sh` |
+| `cmd-tools-reclaim.sh` |
+
+The bash functions these commands call live in the dashboard's `core/scripts/functions`.

package/commands/cmd-tool-backup-recipe.sh

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+
+# Bootstrap.
+# Find the workspace tooling from this script, so a fresh clone needs no setup.
+WORKSPACE_SCRIPTS="${WORKSPACE_SCRIPTS:-$(cd "$(dirname "${BASH_SOURCE[0]}")/../core/scripts" && pwd)}";
+source ${WORKSPACE_SCRIPTS}/bootstrap.sh || exit 1 ;
+
+# Load workspace settings and extra lists.
+eval $(parse_yaml ${WORKSPACE_CONFIG}/workspace.recipes.settings.yml);
+
+ARGPARSE_DESCRIPTION="Backup a recipe"
+argparse "$@" <<ARGEOF || exit 1
+parser.add_argument('PROJECT_NAME',
+                    help='The name of the project.')
+ARGEOF
+
+shift $#;
+trim_project_name ;   # "v11x00b1/" -> "v11x00b1" — see functions/fun-project-name.sh
+
+backup_workspace_item "${PROJECT_NAME}" || exit 1 ;

package/commands/cmd-tool-git-change-filemode-to-false.sh

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+
+# Bootstrap.
+# Find the workspace tooling from this script, so a fresh clone needs no setup.
+WORKSPACE_SCRIPTS="${WORKSPACE_SCRIPTS:-$(cd "$(dirname "${BASH_SOURCE[0]}")/../core/scripts" && pwd)}";
+source ${WORKSPACE_SCRIPTS}/bootstrap.sh || exit 1 ;
+
+# Load workspace settings and extra lists.
+eval $(parse_yaml ${WORKSPACE_CONFIG}/workspace.recipes.settings.yml);
+
+ARGPARSE_DESCRIPTION="Change a project's git core.fileMode to false"
+argparse "$@" <<ARGEOF || exit 1
+parser.add_argument('PROJECT_NAME',
+                    help='The name of the project.')
+ARGEOF
+
+shift $#;
+
+cd ${WORKSPACE_ROOT}/recipes/${PROJECT_NAME} ;
+git config core.fileMode false ;

package/commands/cmd-tools-checks.sh

@@ -0,0 +1,20 @@
+#!/usr/bin/env bash
+
+# Run the code-quality checks a package in this workspace already declares in its package.json —
+# lint:js, lint:css, lint:yaml, spellcheck, phpcs, and the browser suite — mapped onto one set of
+# canonical names so the command means the same thing in every workspace.
+
+# Bootstrap.
+# Find the workspace tooling from this script, so a fresh clone needs no setup.
+WORKSPACE_SCRIPTS="${WORKSPACE_SCRIPTS:-$(cd "$(dirname "${BASH_SOURCE[0]}")/../core/scripts" && pwd)}";
+source ${WORKSPACE_SCRIPTS}/bootstrap.sh || exit 1 ;
+
+# Load workspace settings and extra lists.
+eval $(parse_yaml ${WORKSPACE_CONFIG}/workspace.recipes.settings.yml);
+
+ARGPARSE_DESCRIPTION="Run the code-quality checks a recipes item already declares"
+source ${WORKSPACE_SCRIPTS}/args/arg-checks.sh || exit 1 ;
+
+shift $#;
+
+checks_command ;

package/commands/cmd-tools-gitlab-ci-local.sh

@@ -0,0 +1,25 @@
+#!/usr/bin/env bash
+
+# Run a project's GitLab CI pipeline locally with gitlab-ci-local — the Webship
+# green-gate before any push to git.drupalcode.org. Wires the
+# drupal/gitlab_templates remote variables through the drupal-ci-local wrapper
+# (installed on first run), checks Docker and SSH, and reports GREEN/RED.
+
+# Bootstrap.
+# Find the workspace tooling from this script, so a fresh clone needs no setup.
+WORKSPACE_SCRIPTS="${WORKSPACE_SCRIPTS:-$(cd "$(dirname "${BASH_SOURCE[0]}")/../core/scripts" && pwd)}";
+source ${WORKSPACE_SCRIPTS}/bootstrap.sh || exit 1 ;
+
+# Load workspace settings and extra lists.
+eval $(parse_yaml ${WORKSPACE_CONFIG}/workspace.recipes.settings.yml);
+
+ARGPARSE_DESCRIPTION="Run a recipes project's GitLab CI pipeline locally (the green-gate)"
+source ${WORKSPACE_SCRIPTS}/args/arg-gitlab-ci-local.sh || exit 1 ;
+
+shift $#;
+
+if [ "${DOCTOR}" == 'yes' ] ; then
+  gitlab_ci_local_doctor && echo "Everything a green-gate run needs is in place." ;
+else
+  gitlab_ci_local_run ;
+fi

package/commands/cmd-tools-graphify.sh

@@ -0,0 +1,27 @@
+#!/usr/bin/env bash
+
+# Map a project in this workspace into a queryable knowledge graph with
+# graphify (https://github.com/Graphify-Labs/graphify), or ask an existing
+# graph a question.
+
+# Bootstrap.
+# Find the workspace tooling from this script, so a fresh clone needs no setup.
+WORKSPACE_SCRIPTS="${WORKSPACE_SCRIPTS:-$(cd "$(dirname "${BASH_SOURCE[0]}")/../core/scripts" && pwd)}";
+source ${WORKSPACE_SCRIPTS}/bootstrap.sh || exit 1 ;
+
+# Load workspace settings and extra lists.
+eval $(parse_yaml ${WORKSPACE_CONFIG}/workspace.recipes.settings.yml);
+
+ARGPARSE_DESCRIPTION="Build or query the knowledge graph of a project in the recipes workspace"
+source ${WORKSPACE_SCRIPTS}/args/arg-graphify.sh || exit 1 ;
+
+shift $#;
+
+if [ ! "${STORE}" == '_none_' ] ; then
+  ensure_graphify || exit 1 ;
+  graphify_store_url "${WORKSPACE_ROOT}/${doc_name}/${PROJECT_NAME}" "${STORE}" ;
+elif [ -n "${QUERY}" ] ; then
+  graphify_query_project ;
+else
+  graphify_project ;
+fi

package/commands/cmd-tools-obsidian.sh

@@ -0,0 +1,31 @@
+#!/usr/bin/env bash
+
+# Turn a project's knowledge graph into an Obsidian vault — one note per entity,
+# a [[wikilink]] per relation, and a JSON Canvas of the map. Written next to the
+# graph in graphs/recipes/<project>/obsidian/.
+#
+# Build the graph first with cmd-tools-graphify.sh: this reads what that wrote
+# rather than parsing the project a second time.
+
+# Bootstrap.
+# Find the workspace tooling from this script, so a fresh clone needs no setup.
+WORKSPACE_SCRIPTS="${WORKSPACE_SCRIPTS:-$(cd "$(dirname "${BASH_SOURCE[0]}")/../core/scripts" && pwd)}";
+source ${WORKSPACE_SCRIPTS}/bootstrap.sh || exit 1 ;
+
+# Load workspace settings and extra lists.
+eval $(parse_yaml ${WORKSPACE_CONFIG}/workspace.recipes.settings.yml);
+
+ARGPARSE_DESCRIPTION="Build an Obsidian vault from the knowledge graph of a project in the recipes workspace"
+source ${WORKSPACE_SCRIPTS}/args/arg-obsidian.sh || exit 1 ;
+
+shift $#;
+
+export MAX_CANVAS_NODES="${MAX_CANVAS_NODES}";
+
+if [ "${REMOVE}" == 'yes' ] ; then
+  obsidian_remove ;
+elif [ "${STATUS}" == 'yes' ] ; then
+  obsidian_status ;
+else
+  obsidian_project ;
+fi

package/commands/cmd-tools-ragify.sh

@@ -0,0 +1,28 @@
+#!/usr/bin/env bash
+
+# Index a project in this workspace into the Milvus vector database
+# (https://github.com/milvus-io/milvus) held in ~/workspace/rag, or ask an
+# existing index a question.
+#
+# The RAG counterpart of cmd-tools-graphify.sh: graphify parses the CODE into a
+# graph and reads no Markdown, Twig, *.module hooks or Drupal wiring YAML — this
+# indexes the text of exactly those and retrieves passages from them.
+
+# Bootstrap.
+# Find the workspace tooling from this script, so a fresh clone needs no setup.
+WORKSPACE_SCRIPTS="${WORKSPACE_SCRIPTS:-$(cd "$(dirname "${BASH_SOURCE[0]}")/../core/scripts" && pwd)}";
+source ${WORKSPACE_SCRIPTS}/bootstrap.sh || exit 1 ;
+
+# Load workspace settings and extra lists.
+eval $(parse_yaml ${WORKSPACE_CONFIG}/workspace.recipes.settings.yml);
+
+ARGPARSE_DESCRIPTION="Build or query the Milvus RAG index of a project in the recipes workspace"
+source ${WORKSPACE_SCRIPTS}/args/arg-ragify.sh || exit 1 ;
+
+shift $#;
+
+if [ -n "${QUERY}" ] ; then
+  ragify_query_project ;
+else
+  ragify_project ;
+fi

package/commands/cmd-tools-reclaim.sh

@@ -0,0 +1,24 @@
+#!/usr/bin/env bash
+
+# Reclaim the disk that REMOVED projects left behind — their DDEV databases, snapshots, built images
+# and containers. A project whose folder is still on disk is never touched, stopped or not.
+#
+# The sweep is machine-wide wherever you run it: it takes no project name, reads WORKSPACE_ROOT, and
+# protects every project folder in the tree — so this copy behaves identically to the one in any other
+# workspace. It ships in each workspace that leans on DDEV, graphify or RAG for the same reason
+# cmd-tools-graphify.sh does: the folder you are standing in is where you look for a cmd-tools-*.
+
+# Bootstrap.
+# Find the workspace tooling from this script, so a fresh clone needs no setup.
+WORKSPACE_SCRIPTS="${WORKSPACE_SCRIPTS:-$(cd "$(dirname "${BASH_SOURCE[0]}")/../core/scripts" && pwd)}";
+source ${WORKSPACE_SCRIPTS}/bootstrap.sh || exit 1 ;
+
+# Load workspace settings and extra lists.
+eval $(parse_yaml ${WORKSPACE_CONFIG}/workspace.recipes.settings.yml);
+
+ARGPARSE_DESCRIPTION="Reclaim disk from projects that no longer have a folder — dry run unless --apply"
+source ${WORKSPACE_SCRIPTS}/args/arg-reclaim.sh || exit 1 ;
+
+shift $#;
+
+reclaim_command ;

package/config/workspace.recipes.settings.yml

@@ -0,0 +1,18 @@
+doc:
+  name: recipes
+
+# What this folder's projects are, and which actions their rows offer:
+# sites | code | files | media | ai-items — see core/workspace-app/WORKSPACES.md.
+type: code
+
+# What the COMPOSER menu may do here: full | manifest (the default). These folders hold package
+# clones, not sites: it only adds to composer.json without running an install (require/remove
+# --no-update, and validate). No install, update or scripts.
+composer: manifest
+
+# What the assistant is called on THIS workspace's page, and what its composer says when empty.
+# `default` in either means "whatever settings.yml says" — the global value, so a rename there
+# still reaches this page. Set a value here to override it for this workspace alone.
+assistant:
+  name: default
+  placeholder: default

package/dist/src/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * The Drupal recipes workspace for Webship Workspace: the `recipes/` folder as a plugin.
+ *
+ * What the package carries is placed by the installer from the manifest (the folder's settings file,
+ * its commands and its docs) and listed by --activate; the dashboard draws the workspace from the
+ * settings file like any other. Nothing to register at run time yet: this is where the folder's own
+ * rail buttons, row menus or assistant context would go.
+ */
+import type { PluginApi } from '@webship.co/workspace-plugin-api';
+export declare const WORKSPACE_KEY = "recipes";
+export declare function register(api: PluginApi): void;

package/dist/src/index.js

@@ -0,0 +1,17 @@
+"use strict";
+/**
+ * The Drupal recipes workspace for Webship Workspace: the `recipes/` folder as a plugin.
+ *
+ * What the package carries is placed by the installer from the manifest (the folder's settings file,
+ * its commands and its docs) and listed by --activate; the dashboard draws the workspace from the
+ * settings file like any other. Nothing to register at run time yet: this is where the folder's own
+ * rail buttons, row menus or assistant context would go.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.WORKSPACE_KEY = void 0;
+exports.register = register;
+exports.WORKSPACE_KEY = 'recipes';
+function register(api) {
+    api.addAssistantContext(() => `The recipes/ workspace is the Drupal recipes workspace (a plugin, @webship.co/workspace-drupal-recipes); its commands are the cmd-*.sh scripts in that folder.`);
+}
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":";AAAA;;;;;;;GAOG;;;AAMH,4BAEC;AAJY,QAAA,aAAa,GAAG,SAAS,CAAC;AAEvC,SAAgB,QAAQ,CAAC,GAAc;IACrC,GAAG,CAAC,mBAAmB,CAAC,GAAG,EAAE,CAAC,gKAAgK,CAAC,CAAC;AAClM,CAAC"}

package/docs/AGENTS.md

@@ -0,0 +1,33 @@
+# Recipes
+
+Drupal recipe packages.
+
+Part of the **Webship Workspace** (`~/workspace`), a DDEV-only harness. The rules in the root
+`CLAUDE.md` apply here too; what follows is what is specific to this folder.
+
+## The rule that matters here
+
+Everything goes through DDEV. Never a host `composer`, `drush` or `mysql`:
+
+```bash
+ddev composer require drupal/something
+ddev drush cr
+ddev export-db --file=…        # not mysqldump
+ddev delete -y -O              # not a dropped database
+```
+
+`ddev start` takes `-y`; **`ddev stop` does not**. Never write a `$databases` block into
+`settings.php` — DDEV's `settings.ddev.php` owns the connection.
+
+## Commands here
+
+```bash
+bash cmd-tool-backup-recipe.sh                        # Bootstrap.
+bash cmd-tool-git-change-filemode-to-false.sh         # Bootstrap.
+bash cmd-tools-graphify.sh                            # Map a project in this workspace into a queryable knowledge graph with
+bash cmd-tools-obsidian.sh                             # Turn a project graph into an Obsidian vault
+bash cmd-tools-ragify.sh                              # Index a project in this workspace into the Milvus vector database
+```
+
+Every one locates the workspace from its own path, so there is nothing to export and nothing to
+install. `--help` on any of them lists its arguments.

package/docs/CLAUDE.md

@@ -0,0 +1,7 @@
+# Recipes — workspace context
+
+You are inside the **recipes** workspace of the Webship Workspace (`~/workspace`).
+
+@AGENTS.md
+
+The rules in it apply to everything under this folder, however deep.

package/docs/README.md

@@ -0,0 +1,4 @@
+# Recipes
+--
+
+* You could place your recipes.

package/features/drupal-recipes.feature

@@ -0,0 +1,12 @@
+Feature: The Drupal recipes workspace plugin
+  Once the plugin is activated and installed, the recipes workspace is on the dashboard, and the
+  Plugins page lists the plugin with its four steps.
+
+  Scenario: The workspace page is there
+    Given I am on "/recipes"
+     Then I should see "Drupal recipes"
+
+  Scenario: The plugin is listed on the Plugins page
+    Given I am on "/settings/plugins"
+     Then I should see "Drupal recipes"
+      And I should see "@webship.co/workspace-drupal-recipes"

package/package.json

@@ -1,6 +1,60 @@
 {
   "name": "@webship.co/workspace-drupal-recipes",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.0-alpha1",
+  "description": "The Drupal recipes workspace for Webship Workspace: the `recipes/` folder (type code), its settings file, its 8 commands and its docs, activated as a plugin.",
+  "main": "dist/src/index.js",
+  "types": "dist/src/index.d.ts",
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/webship/workspace-drupal-recipes.git"
+  },
+  "files": [
+    "dist/src",
+    "commands",
+    "config",
+    "docs",
+    "features",
+    "README.md"
+  ],
+  "scripts": {
+    "build": "tsc -p tsconfig.json",
+    "prepare": "npm run build",
+    "test": "npm run build && node --test dist/tests/*.test.js",
+    "lint": "tsc -p tsconfig.json --noEmit"
+  },
+  "workspacePlugin": {
+    "name": "drupal-recipes",
+    "label": "Drupal recipes",
+    "workspace": {
+      "key": "recipes",
+      "settingsTemplate": "config/workspace.recipes.settings.yml",
+      "files": [
+        "commands/cmd-tool-backup-recipe.sh",
+        "commands/cmd-tool-git-change-filemode-to-false.sh",
+        "commands/cmd-tools-checks.sh",
+        "commands/cmd-tools-gitlab-ci-local.sh",
+        "commands/cmd-tools-graphify.sh",
+        "commands/cmd-tools-obsidian.sh",
+        "commands/cmd-tools-ragify.sh",
+        "commands/cmd-tools-reclaim.sh"
+      ],
+      "docs": [
+        "docs/AGENTS.md",
+        "docs/CLAUDE.md",
+        "docs/README.md"
+      ]
+    },
+    "features": [
+      "features/drupal-recipes.feature"
+    ]
+  },
+  "devDependencies": {
+    "@types/node": "^24.0.0",
+    "@webship.co/workspace-plugin-api": "^1.0.0-alpha1",
+    "typescript": "^5.9.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}