Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[5.x] Add new updatable and package starter kit conventions #11119

Merged
merged 26 commits into from
Dec 4, 2024

Conversation

jesseleite
Copy link
Member

@jesseleite jesseleite commented Nov 12, 2024

Note: This PR does NOT make everything in a starter kit magically updatable; It merely adds the ABILITY for a starter kit developer to architect their kit in such a way that parts of a kit be composer updatable!

The Problem

When making a kit composer updatable (by setting updatable: true introduced by #11064, which this PR became a continuation of), you're likely going to want to provide your own package service provider class, PSR-4 namespace, vendor views, etc. that are separate from export_paths (which get installed into the users app, rather than remaining in vendor). Right now there is no way to automatically export those vendor files to your starter kit repo.

The Solution

In this PR, we now expect a package folder in your dev application for all your package's vendor files...

CleanShot 2024-11-14 at 16 41 18

These files will be exported to the root of your shippable repo when running starter-kit:export.

We also export all of your files export_paths to an export folder in your shippable repo to keep things clean and free from filename conflicts.

For example, if this is your dev app...

├─ app
│  └─ file.php
├─ config
├─ resources
├─ etc
│ 
├─ package
│  ├─ src
│  │  └─ Tags
│  │     └─ Foo.php
│  ├─ resources
│  │  ├─ css
│  │  ├─ js
│  │  └─ views
│  │     ├─ default.antlers.html
│  │     └─ layout.antlers.html
│  └─ composer.json
│ 
├─ composer.json
└─ starter-kit.yaml

Then this is what the final export will look like...

├─ export
│  └─ app
│     └─ file.php
├─ src
│  └─ Tags
│     └─ Foo.php
├─ resources
│  ├─ css
│  ├─ js
│  └─ views
│     ├─ default.antlers.html
│     └─ layout.antlers.html
├─ composer.json
└─ starter-kit.yaml

This lets you manage your package's composer.json, etc. from the package folder, and the exporter and installer will intelligently put Everything in Its Right Place, just like Radiohead.

Think of the exported directory similar to a compiled assets directory when using a build tool like Vite. You export/generate files into this directory, and shouldn't touch it manually.

Todo

  • Handle new updatable config
    • In the installer
      • If updatable: true, then the starter kit repository should remain installed in the end user's composer.json
    • In the exporter
  • Handle new package folder changes
    • In the installer
    • In the exporter
      • Remove stubbing/scaffolding of starter-kit.yaml and composer.json
        • This functionality will be re-introduced in upcoming starter-kit:init command PR
      • Add prompt helper to migrate to new package folder convention on first export after updating Statamic
  • Test coverage
  • Docs PR Starter Kits Rework docs#1549

@jesseleite jesseleite marked this pull request as draft November 12, 2024 20:58
@jesseleite jesseleite marked this pull request as ready for review November 12, 2024 23:19
@jesseleite jesseleite changed the title [5.x] Export starter kit package folder when it exists [5.x] Add new package folder convention for starter kits Nov 14, 2024
…eir kits composer updatable (#11064)

* Spec out `addon: true` for starter kits that should live on as composer updatable addons.

* Blink config, no reason to read it twice.

* Pass tests.

* Refactor to `updatable: true`.

* Add test coverage to ensure package remains in `require` (not `require-dev`).

* Pass test. (We don’t really have reason to `requireDev` here anymore.)

* Adjust these tests too.
@jesseleite jesseleite changed the title [5.x] Add new package folder convention for starter kits [5.x] Add new updatable and package folder conventions for starter kits Dec 2, 2024
@jesseleite jesseleite changed the title [5.x] Add new updatable and package folder conventions for starter kits [5.x] Add new updatable and package starter kit conventions Dec 2, 2024
@jasonvarga jasonvarga merged commit 67463fe into 5.x Dec 4, 2024
19 checks passed
@jasonvarga jasonvarga deleted the starter-kit-export-package-folder branch December 4, 2024 17:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants