@webikon/webentor-codemods 0.2.0 → 0.3.0

package/CHANGELOG.md

@@ -1,5 +1,23 @@
 # Webentor Codemods Changelog
 
+## 0.3.0
+
+- Add the `starter-2.1.1` migration (theme **2.1.0 → 2.1.1**, **Acorn 6 / Laravel
+  13**) — the first **package-scoped** migration (`appliesTo.package:
+  webentor-starter`), selectable by id or `--package webentor-starter`. It does
+  **not** bump `webentor-core`.
+  - `deps.yml` (JSON): rewrites the theme's `composer.json` `roots/acorn` to `^6.0`.
+    This is the complete dependency delta from the 2.1.0 baseline — `roots/acorn` is
+    the only change; `webikon/webentor-core` stays `^0.15` (it already covers the
+    transparent `0.15.1` patch). Scoped to `composer.json` (the project root
+    `composer.json` has no `roots/acorn`), value-is-string guarded, idempotent.
+  - Changelog sync prepends the `2.1.1` block to the project root `changelog.md`
+    (marker `### 2.1.1`) and the theme `web/app/themes/*/changelog.md` (marker
+    `### Version 2.1.1`), matching the coupled starter + theme `2.1.1` bump.
+  - The Acorn 6 `.env` runtime changes (pin `CACHE_PREFIX`/`SESSION_COOKIE`/
+    `REDIS_PREFIX` to preserve caches/sessions; rename `MAIL_ENCRYPTION` →
+    `MAIL_SCHEME`) are a documented manual step (see the migration README).
+
 ## 0.2.0
 
 - **New capability — changelog sync.** A migration can now declare a `changelog`

package/migrations/__fixtures__/starter-2.1.1/after/composer.json

@@ -0,0 +1,63 @@
+{
+  "name": "webikon/webentor-theme",
+  "type": "wordpress-theme",
+  "version": "2.1.0",
+  "description": "Webentor starter theme",
+  "homepage": "https://webikon.sk",
+  "authors": [
+    {
+      "name": "Roots",
+      "homepage": "https://github.com/roots/sage"
+    },
+    {
+      "name": "Webikon s.r.o.",
+      "email": "support@webikon.sk",
+      "homepage": "https://webikon.sk"
+    },
+    {
+      "name": "Pavol Caban",
+      "email": "pavol.caban@webikon.sk",
+      "homepage": "https://webikon.sk"
+    }
+  ],
+  "repositories": [
+    {
+      "type": "github",
+      "url": "https://github.com/webikon/webentor-core.git"
+    }
+  ],
+  "autoload": {
+    "psr-4": {
+      "App\\": "app/"
+    }
+  },
+  "require": {
+    "php": ">=8.3",
+    "johnbillion/extended-cpts": "^5.0",
+    "log1x/acf-composer": "^3.0",
+    "log1x/sage-directives": "^2.0",
+    "log1x/sage-svg": "^2.0",
+    "roots/acorn": "^6.0",
+    "roots/acorn-prettify": "^1.0",
+    "stoutlogic/acf-builder": "^1.12",
+    "webikon/webentor-core": "^0.15"
+  },
+  "require-dev": {
+    "squizlabs/php_codesniffer": "^3.8.0"
+  },
+  "config": {
+    "optimize-autoloader": true,
+    "preferred-install": "dist",
+    "sort-packages": true
+  },
+  "minimum-stability": "dev",
+  "prefer-stable": true,
+  "scripts": {
+    "post-autoload-dump": [
+      "Roots\\Acorn\\ComposerScripts::postAutoloadDump"
+    ],
+    "lint": [
+      "phpcs --extensions=php --standard=PSR12 app"
+    ]
+  }
+}

package/migrations/__fixtures__/starter-2.1.1/before/composer.json

@@ -0,0 +1,63 @@
+{
+  "name": "webikon/webentor-theme",
+  "type": "wordpress-theme",
+  "version": "2.1.0",
+  "description": "Webentor starter theme",
+  "homepage": "https://webikon.sk",
+  "authors": [
+    {
+      "name": "Roots",
+      "homepage": "https://github.com/roots/sage"
+    },
+    {
+      "name": "Webikon s.r.o.",
+      "email": "support@webikon.sk",
+      "homepage": "https://webikon.sk"
+    },
+    {
+      "name": "Pavol Caban",
+      "email": "pavol.caban@webikon.sk",
+      "homepage": "https://webikon.sk"
+    }
+  ],
+  "repositories": [
+    {
+      "type": "github",
+      "url": "https://github.com/webikon/webentor-core.git"
+    }
+  ],
+  "autoload": {
+    "psr-4": {
+      "App\\": "app/"
+    }
+  },
+  "require": {
+    "php": ">=8.3",
+    "johnbillion/extended-cpts": "^5.0",
+    "log1x/acf-composer": "^3.0",
+    "log1x/sage-directives": "^2.0",
+    "log1x/sage-svg": "^2.0",
+    "roots/acorn": "^5.0",
+    "roots/acorn-prettify": "^1.0",
+    "stoutlogic/acf-builder": "^1.12",
+    "webikon/webentor-core": "^0.15"
+  },
+  "require-dev": {
+    "squizlabs/php_codesniffer": "^3.8.0"
+  },
+  "config": {
+    "optimize-autoloader": true,
+    "preferred-install": "dist",
+    "sort-packages": true
+  },
+  "minimum-stability": "dev",
+  "prefer-stable": true,
+  "scripts": {
+    "post-autoload-dump": [
+      "Roots\\Acorn\\ComposerScripts::postAutoloadDump"
+    ],
+    "lint": [
+      "phpcs --extensions=php --standard=PSR12 app"
+    ]
+  }
+}

package/migrations/__fixtures__/starter-2.1.1/customized/composer.json

@@ -0,0 +1,55 @@
+{
+  "name": "acme/acme-theme",
+  "type": "wordpress-theme",
+  "version": "1.4.0",
+  "description": "Acme project theme",
+  "homepage": "https://acme.example",
+  "authors": [
+    {
+      "name": "Acme s.r.o.",
+      "email": "dev@acme.example",
+      "homepage": "https://acme.example"
+    }
+  ],
+  "repositories": [
+    {
+      "type": "github",
+      "url": "https://github.com/webikon/webentor-core.git"
+    }
+  ],
+  "autoload": {
+    "psr-4": {
+      "App\\": "app/"
+    }
+  },
+  "require": {
+    "php": ">=8.3",
+    "johnbillion/extended-cpts": "^5.0",
+    "log1x/acf-composer": "^3.4",
+    "log1x/sage-directives": "^2.0",
+    "log1x/sage-svg": "^2.0",
+    "roots/acorn": "^6.0",
+    "roots/acorn-prettify": "^1.0",
+    "stoutlogic/acf-builder": "^1.12",
+    "webikon/webentor-core": "^0.15",
+    "wpackagist-plugin/safe-svg": "^2.2"
+  },
+  "require-dev": {
+    "squizlabs/php_codesniffer": "^3.8.0"
+  },
+  "config": {
+    "optimize-autoloader": true,
+    "preferred-install": "dist",
+    "sort-packages": true
+  },
+  "minimum-stability": "dev",
+  "prefer-stable": true,
+  "scripts": {
+    "post-autoload-dump": [
+      "Roots\\Acorn\\ComposerScripts::postAutoloadDump"
+    ],
+    "lint": [
+      "phpcs --extensions=php --standard=PSR12 app"
+    ]
+  }
+}

package/migrations/index.json

@@ -32,6 +32,22 @@
         { "entry": "changelog/theme.md", "target": "web/app/themes/*/changelog.md", "marker": "### Version 2.1.0" }
       ],
       "docs": "README.md"
+    },
+    {
+      "id": "starter-2.1.1",
+      "title": "Upgrade consumer theme to Acorn 6 (Laravel 13) — theme 2.1.1",
+      "description": "Starter/theme-only release (no webentor-core bump): bump roots/acorn ^5.0 -> ^6.0 (Acorn 6 / Laravel 13) in the theme composer.json. webentor-core stays ^0.15 (covers the transparent 0.15.1 patch). The Acorn 6 .env changes (CACHE_PREFIX/SESSION_COOKIE/REDIS_PREFIX pinning, MAIL_ENCRYPTION -> MAIL_SCHEME) are a documented manual step (see README).",
+      "appliesTo": {
+        "package": "webentor-starter",
+        "from": "2.1.0",
+        "to": "2.1.1"
+      },
+      "rules": ["rules/deps.yml"],
+      "changelog": [
+        { "entry": "changelog/root.md", "target": "changelog.md", "marker": "### 2.1.1" },
+        { "entry": "changelog/theme.md", "target": "web/app/themes/*/changelog.md", "marker": "### Version 2.1.1" }
+      ],
+      "docs": "README.md"
     }
   ]
 }

package/migrations/starter-2.1.1/README.md

@@ -0,0 +1,95 @@
+# `starter-2.1.1` — upgrade a consumer theme to Acorn 6 (Laravel 13)
+
+**Applies to:** consumer themes on the **2.1.0** baseline (webentor-core `0.15.x`).
+This is a **starter/theme-only** release — it does **not** bump `webentor-core`, so
+select it by id (or `--package webentor-starter`). Coming from an older baseline?
+Run the `0.15.0` core codemod first.
+
+Run from your project root:
+
+```sh
+pnpm dlx @webikon/webentor-codemods run starter-2.1.1          # preview (dry-run)
+pnpm dlx @webikon/webentor-codemods run starter-2.1.1 --apply  # apply
+```
+
+Then reinstall, rebuild, and clear caches:
+
+```sh
+# in the theme dir
+composer update
+wp acorn optimize:clear
+```
+
+This migration has **one automated rule** (a `composer.json` dependency bump) plus
+**manual `.env` steps** for the Acorn 6 runtime changes.
+
+## 1. Dependency (`rules/deps.yml`, JSON)
+
+Rewrites the theme's `roots/acorn` range to the **2.1.1 baseline** (`^6.0`). This is
+the complete delta from the 2.1.0 baseline — only `roots/acorn` changed.
+`webikon/webentor-core` stays `^0.15` (it already covers the transparent `0.15.1`
+patch), so it is intentionally absent here. The rule matches `roots/acorn` by its
+exact key (value-is-string guarded) and is scoped to `composer.json` via `files:`;
+the project root `composer.json` has no `roots/acorn`, so only the theme manifest
+matches.
+
+| manifest | dependency | → range |
+|---|---|---|
+| composer.json | `roots/acorn` (major 5→6) | `^6.0` |
+
+- **Idempotent:** re-running rewrites to the same range → no diff.
+- **Baseline caveat:** the fix pins `^6.0`, so a project already *ahead* within the
+  major would be set back to it. Expected for a 2.1.0 → 2.1.1 upgrade.
+
+After applying, run `composer update` to refresh `composer.lock`.
+
+## 2. Acorn 6 runtime changes (manual `.env`)
+
+Acorn 6 bundles Laravel 13. These are **not** codemodded — `.env` is project- and
+environment-specific — so apply them by hand on each environment:
+
+- **Cache / session / Redis prefixes.** Laravel 13 changed the default prefix and
+  cookie separators from underscores to hyphens. On an existing site this
+  **invalidates the object cache and logs out every session** unless you pin the
+  values explicitly:
+
+  ```dotenv
+  CACHE_PREFIX=your_existing_prefix
+  SESSION_COOKIE=your_existing_cookie
+  REDIS_PREFIX=your_existing_prefix
+  ```
+
+  A fresh project can ignore this (there is no cache/session to preserve).
+
+- **Mail scheme.** If you set `MAIL_ENCRYPTION`, rename it to `MAIL_SCHEME`:
+
+  ```diff
+  - MAIL_ENCRYPTION=tls
+  + MAIL_SCHEME=smtps
+  ```
+
+- **PHP floor.** Acorn 6 requires PHP `>=8.3` (already the theme's floor).
+
+After any `.env` change, run `wp acorn optimize:clear`.
+
+Reference: the starter theme's `composer.json` at theme 2.1.1, and the upstream
+[Acorn v6 upgrade notes](https://roots.io/acorn/docs/upgrading-acorn/).
+
+## Changelog sync
+
+Prepends the `2.1.1` version block to the project's changelogs so they match the
+stack:
+
+- `changelog.md` (project root) ← `changelog/root.md` (marker `### 2.1.1`)
+- `web/app/themes/*/changelog.md` ← `changelog/theme.md` (marker `### Version 2.1.1`)
+
+Idempotent (skipped if the heading is already present) and additive (inserted under
+the `# … Changelog` H1, above existing entries). If you've customized the changelog,
+your entries are preserved.
+
+## Relationship to `update-dependencies`
+
+This codemod only encodes the `roots/acorn` major as the released theme baseline.
+Routine third-party dependency maintenance (in-range patch/minor bumps) is a
+separate concern handled by the `update-dependencies` flow and is not part of a
+migration.

package/migrations/starter-2.1.1/changelog/root.md

@@ -0,0 +1,7 @@
+### 2.1.1
+
+- Bump the bundled theme to `2.1.1` — `roots/acorn` to `^6.0` (from `^5.0`), i.e. **Acorn 6 / Laravel 13**.
+  - **Requires consumer action on existing sites:** Laravel 13 changes the default cache-prefix / session-cookie / Redis-prefix separators (underscores → hyphens), which **invalidates the object cache and logs out all sessions** unless `CACHE_PREFIX`, `SESSION_COOKIE`, and `REDIS_PREFIX` are pinned in `.env`. Rename the SMTP `MAIL_ENCRYPTION` env var to `MAIL_SCHEME`. Acorn 6 requires PHP `>=8.3` (already the floor).
+  - After upgrading, run `composer update` then `wp acorn optimize:clear`.
+- Bump `webentor-core` to `0.15.1` (transparent patch within the existing `^0.15` range: focal-point `<source srcset>` fix; no API change for consumers).
+- Existing projects can apply the `roots/acorn` bump via `pnpm dlx @webikon/webentor-codemods run starter-2.1.1`; the `.env` changes are a documented manual step in that codemod's README.

package/migrations/starter-2.1.1/changelog/theme.md

@@ -0,0 +1,7 @@
+### Version 2.1.1
+
+- Bump `roots/acorn` to `^6.0` (from `^5.0`) — Acorn 6 ships Laravel 13 components.
+  - **Breaking runtime behavior for existing sites:** Laravel 13 changes the default cache-prefix / session-cookie / Redis-prefix separators (underscores → hyphens), which **invalidates existing caches and logs out all sessions** unless `CACHE_PREFIX`, `SESSION_COOKIE`, and `REDIS_PREFIX` are pinned in `.env`. The SMTP `MAIL_ENCRYPTION` env var is renamed to `MAIL_SCHEME`. Requires PHP `>=8.3` (already the theme floor).
+  - After upgrading, run `composer update` then `wp acorn optimize:clear` to rebuild Acorn's cached bootstrap files.
+- Bump `webentor-core` to `0.15.1` (within the existing `^0.15` range — no constraint change). Transparent patch: fixes focal-point cropping in responsive `<source srcset>` (no API change for consumers).
+- The `roots/acorn` bump is reproducible in existing projects via `pnpm dlx @webikon/webentor-codemods run starter-2.1.1`; the `.env` changes above are a manual step (documented in the codemod README).

package/migrations/starter-2.1.1/rules/deps.yml

@@ -0,0 +1,24 @@
+# Dependency bump for the webentor-theme 2.1.1 upgrade (Acorn 6 / Laravel 13).
+#
+# Baseline = the 2.1.0 starter theme (webentor-core 0.15.x). This is the COMPLETE
+# `git diff starter-v2.1.0 -- <theme>/composer.json` dependency delta to the 2.1.1
+# baseline — only the `roots/acorn` major changed; everything else (including
+# `webikon/webentor-core ^0.15`, which already covers the transparent 0.15.1 patch)
+# carried over from 2.1.0 unchanged and is therefore absent here. Run the `0.15.0`
+# codemod first if coming from an older baseline.
+#
+# Same shape as the 0.15.0 deps rules: one rule per dependency, matched by its
+# exact key (anchored regex) with a value-is-string guard (so a config object that
+# shares a key is never clobbered), rewritten to the 2.1.1 baseline range
+# regardless of the consumer's current value. `files:` scopes the rule to
+# composer.json (the project root composer.json has no `roots/acorn`, so only the
+# theme manifest matches). `name`/`version` are never touched.
+id: deps-roots-acorn-composer
+language: json
+files: ['**/composer.json']
+rule:
+  kind: pair
+  all:
+    - has: { field: key, regex: '^"roots/acorn"$' }
+    - has: { field: value, kind: string }
+fix: '"roots/acorn": "^6.0"'

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@webikon/webentor-codemods",
-  "version": "0.2.0",
+  "version": "0.3.0",
   "description": "Reusable, polyglot codemods for migrating Webentor Stack consumer projects (theme PHP/TS/CSS/JSON) across webentor-core updates",
   "homepage": "https://webikon.sk",
   "license": "MIT",