@webship.co/workspace-drupal-modules 0.0.0-stage → 1.0.0-beta1

package/README.md

@@ -1,3 +1,30 @@
-# Temporary Holding Version
+# @webship.co/workspace-drupal-modules
 
-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 modules** workspace of the [Webship Workspace](https://github.com/webship/workspace) dashboard:
+the `modules/` folder (type `code`), its settings file (`core/config/workspace.modules.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-modules
+bash core/scripts/plugins.sh --activate drupal-modules     # puts `modules` on the workspaces list of settings.yml
+bash core/scripts/plugins.sh --install drupal-modules      # 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-module.sh` |
+| `cmd-tool-git-change-filemode-to-false.sh` |
+| `cmd-tool-git-clone-all-modules.sh` |
+| `cmd-tools-checks.sh` |
+| `cmd-tools-gitlab-ci-local.sh` |
+| `cmd-tools-reclaim.sh` |
+
+The bash functions these commands call live in the dashboard's `core/scripts/functions`.

package/commands/cmd-tool-backup-module.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.modules.settings.yml);
+
+ARGPARSE_DESCRIPTION="Backup a module"
+argparse "$@" <<EOF || exit 1
+parser.add_argument('PROJECT_NAME',
+                    help='The name of the project.')
+EOF
+
+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,17 @@
+#!/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.modules.settings.yml);
+
+for dir_name in *; do
+    if [[ -d "$dir_name" && ! -L "$dir_name" ]]; then
+        if [ -f "${WORKSPACE_ROOT}/${doc_name}/${dir_name}/.git/config" ]; then
+          sed -i -e 's/filemode = true/filemode = false/g' ${WORKSPACE_ROOT}/${doc_name}/${dir_name}/.git/config
+        fi
+    fi
+done

package/commands/cmd-tool-git-clone-all-modules.sh

@@ -0,0 +1,37 @@
+#!/usr/bin/env bash
+
+# Clone every module named in workspace.modules.settings.yml from git.drupal.org.
+#
+# Fills an empty modules/ folder in one go: each name in the `modules:` list is cloned over SSH,
+# so it needs a drupal.org account with a key on it. An existing folder is left as it is.
+
+echo "*-----------------------------------------------------------*";
+echo "| GIT clone all modules in                                  |";
+echo "*-----------------------------------------------------------*";
+echo "| ${WORKSPACE_CONFIG}/workspace.modules.settings.yml";
+echo "*-----------------------------------------------------------*"
+
+current_path=$(pwd);
+
+# 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.modules.settings.yml);
+
+cd ${WORKSPACE_ROOT}/modules/ ;
+
+# Delete modules.
+for module_name in "${modules[@]}"
+do
+  sudo rm -rf ${WORKSPACE_ROOT}/modules/${module_name};
+done
+
+# GIT clone modules.
+for module_name in "${modules[@]}"
+do
+  git clone git@git.drupal.org:project/${module_name}.git ;
+  echo "*-----------------------------------------------------------*";
+done

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.modules.settings.yml);
+
+ARGPARSE_DESCRIPTION="Run the code-quality checks a modules 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.modules.settings.yml);
+
+ARGPARSE_DESCRIPTION="Run a modules 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-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.modules.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.modules.settings.yml

@@ -0,0 +1,159 @@
+doc:
+  name: modules
+modules:
+  - ace_editor
+  - adminimal_admin_toolbar
+  - admin_toolbar
+  - advanced_text_formatter
+  - anchor_link
+  - autocomplete_deluxe
+  - better_exposed_filters
+  - betterlogin
+  - better_normalizers
+  - blazy
+  - block_class
+  - bootstrap_layouts
+  - captcha
+  - charts
+  - checklistapi
+  - ckeditor_bidi
+  - ckeditor_media_embed
+  - coffee
+  - color_field
+  - config_filter
+  - config_ignore
+  - config_perms
+  - config_update
+  - consumers
+  - content_lock
+  - crop
+  - ctools
+  - default_content
+  - devel
+  - diff
+  - drd_agent
+  - dropzonejs
+  - ds
+  - embed
+  - entity
+  - entity_browser
+  - entity_browser_enhanced
+  - entity_clone
+  - entity_embed
+  - entityqueue
+  - entityqueue_form_widget
+  - entity_reference_revisions
+  - events_log_track
+  - extlink
+  - fast_404
+  - features
+  - field_group
+  - file_mdm
+  - focal_point
+  - genpass
+  - google_analytics
+  - google_analytics_reports
+  - honeypot
+  - imageapi_optimize
+  - imagemagick
+  - image_resize_filter
+  - inline_entity_form
+  - jsonapi_extras
+  - l10n_client
+  - layout_builder_restrictions
+  - length_indicator
+  - libraries
+  - libraries_ui
+  - link_attributes
+  - linkit
+  - login_destination
+  - mail_edit
+  - mailsystem
+  - masonry
+  - masquerade
+  - maxlength
+  - media_entity_instagram
+  - media_entity_twitter
+  - menu_admin_per_menu
+  - menu_block
+  - menu_position
+  - metatag
+  - node_edit_protection
+  - openapi
+  - openapi_ui
+  - openapi_ui_redoc
+  - openapi_ui_swagger
+  - page_manager
+  - panels
+  - paragraphs
+  - paragraphs_asymmetric_translation_widgets
+  - paragraphs_edit
+  - paragraphs_features
+  - paragraphs_previewer
+  - password_policy
+  - pathauto
+  - pathologic
+  - persistent_login
+  - rabbit_hole
+  - recaptcha
+  - redirect
+  - responsive_preview
+  - restui
+  - revision_log_default
+  - roleassign
+  - schema_metatag
+  - schemata
+  - search_api
+  - seckit
+  - security_review
+  - shield
+  - simple_oauth
+  - simple_sitemap
+  - slick
+  - slick_media
+  - slick_views
+  - smart_trim
+  - smtp
+  - social_api
+  - social_auth
+  - social_auth_facebook
+  - social_auth_google
+  - social_auth_linkedin
+  - social_auth_twitter
+  - styleguide
+  - swiftmailer
+  - taxonomy_access_fix
+  - taxonomy_menu
+  - token
+  - total_control
+  - tour_builder
+  - tour_ui
+  - ultimate_cron
+  - update_helper
+  - username_enumeration_prevention
+  - userprotect
+  - views_bootstrap
+  - views_bulk_edit
+  - views_bulk_operations
+  - views_infinite_scroll
+  - viewsreference
+  - vmi
+  - webform
+  - webform_analysis
+  - webform_views
+  - yoast_seo
+
+# What this folder's items ARE, which decides what the dashboard offers on each row:
+#   sites     — real projects with a DDEV environment: build, start, back up, graph, index
+#   code      — repositories checked out to work on, without a site of their own
+#   files     — markdown documents, edited in place
+#   ai-items  — agents, skills and prompts, installable into ~/.claude
+#   media     — recordings and images
+type: code
+
+# What the COMPOSER menu may do here: full | manifest.
+composer: manifest
+
+assistant:
+  name: default
+  placeholder: default

package/dist/src/index.d.ts

@@ -0,0 +1,11 @@
+/**
+ * The Drupal modules workspace for Webship Workspace: the `modules/` 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 = "modules";
+export declare function register(api: PluginApi): void;

package/dist/src/index.js

@@ -0,0 +1,17 @@
+"use strict";
+/**
+ * The Drupal modules workspace for Webship Workspace: the `modules/` 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 = 'modules';
+function register(api) {
+    api.addAssistantContext(() => `The modules/ workspace is the Drupal modules workspace (a plugin, @webship.co/workspace-drupal-modules); 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,34 @@
+# Modules
+
+Contrib and private modules, checked out to work on.
+
+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-module.sh                        # Bootstrap.
+bash cmd-tool-git-change-filemode-to-false.sh         # Bootstrap.
+bash cmd-tool-git-clone-all-modules.sh
+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 @@
+# Modules — workspace context
+
+You are inside the **modules** 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,5 @@
+# Modules
+--
+
+* You could place your custom modules
+* You could place contrib modules. so that you could patch them.

package/features/drupal-modules.feature

@@ -0,0 +1,13 @@
+Feature: The Drupal modules workspace plugin
+  Once the plugin is activated and installed, the modules 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 "/modules"
+     Then the element "h1" should be displayed
+      And the element "#webship-workspace-projects, .items-list, .workspace-page" should be attached
+
+  Scenario: The plugin is listed on the Plugins page
+    Given I am on "/settings/plugins"
+     Then I should see "Drupal modules"
+      And I should see "@webship.co/workspace-drupal-modules"

package/package.json

@@ -1,6 +1,58 @@
 {
   "name": "@webship.co/workspace-drupal-modules",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "1.0.0-beta1",
+  "description": "The Drupal modules workspace for Webship Workspace: the `modules/` folder (type code), its settings file, its 6 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-modules.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-modules",
+    "label": "Drupal modules",
+    "workspace": {
+      "key": "modules",
+      "settingsTemplate": "config/workspace.modules.settings.yml",
+      "files": [
+        "commands/cmd-tool-backup-module.sh",
+        "commands/cmd-tool-git-change-filemode-to-false.sh",
+        "commands/cmd-tool-git-clone-all-modules.sh",
+        "commands/cmd-tools-checks.sh",
+        "commands/cmd-tools-gitlab-ci-local.sh",
+        "commands/cmd-tools-reclaim.sh"
+      ],
+      "docs": [
+        "docs/AGENTS.md",
+        "docs/CLAUDE.md",
+        "docs/README.md"
+      ]
+    },
+    "features": [
+      "features/drupal-modules.feature"
+    ]
+  },
+  "devDependencies": {
+    "@types/node": "^24.0.0",
+    "@webship.co/workspace-plugin-api": "^1.0.0-beta1",
+    "typescript": "^5.9.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  }
+}