Skip to content

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

Merged
jasonvarga merged 26 commits into
5.xfrom
starter-kit-export-package-folder
Dec 4, 2024
Merged

[5.x] Add new updatable and package starter kit conventions#11119
jasonvarga merged 26 commits into
5.xfrom
starter-kit-export-package-folder

Conversation

@jesseleite

@jesseleitejesseleite commented Nov 12, 2024•
edited
Loading

Copy link
Copy Markdown
Contributor

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
@jasonvargajasonvarga mentioned this pull request Nov 13, 2024
Draft
@jesseleitejesseleite changed the title [5.x] Export starter kit package folder when it exists[5.x] Add new package folder convention for starter kitsNov 14, 2024
@robdekortrobdekort mentioned this pull request Nov 28, 2024
Closed
1 task
@jesseleite
Tweak error output to use $this->components, like we do in exporter.
be31121
@jesseleite
Less !.
3c4ce12
@jesseleite
Fix assertions.
3bccefd
@jesseleite
[5.x] Give starter kit devs an opt-in config to help make parts of th…
0cc5cba
…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.
@jesseleitejesseleite changed the title [5.x] Add new package folder convention for starter kits[5.x] Add new updatable and package folder conventions for starter kitsDec 2, 2024
@jesseleitejesseleite changed the title [5.x] Add new updatable and package folder conventions for starter kits[5.x] Add new updatable and package starter kit conventionsDec 2, 2024
@jesseleitejesseleite mentioned this pull request Dec 4, 2024
Merged
@jasonvarga
jasonvarga merged commit 67463fe into 5.xDec 4, 2024
@jasonvarga
jasonvarga deleted the starter-kit-export-package-folder branch December 4, 2024 17:18
@duncanmccleanduncanmcclean mentioned this pull request Jul 14, 2025
Merged
Sign up for freeto join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@jasonvargajasonvargaAwaiting requested review from jasonvarga

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@jesseleite@jasonvarga
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
[5.x] Add new `updatable` and `package` starter kit conventions by jesseleite · Pull Request #11119 · statamic/cms · GitHub
Skip to content
[5.x] Add new updatable and package starter kit conventions - #11119
Merged
jasonvarga merged 26 commits into
5.xfrom 
starter-kit-export-package-folder
Dec 4, 2024
Merged
[5.x] Add new updatable and package starter kit conventions#11119
jasonvarga merged 26 commits into
5.xfrom 
starter-kit-export-package-folder
Conversation
@jesseleite
@jesseleitejesseleite
commented
Nov 12, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
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
@jasonvargajasonvarga
mentioned this pull request
Nov 13, 2024
 Draft

@jesseleitejesseleite
changed the title
[5.x] Export starter kit package folder when it exists[5.x] Add new package folder convention for starter kitsNov 14, 2024
@robdekortrobdekort
mentioned this pull request
Nov 28, 2024
 Closed

1 task
@jesseleite
Tweak error output to use $this->components, like we do in exporter.
be31121
@jesseleite
Less !.
3c4ce12
@jesseleite
Fix assertions.
3bccefd
@jesseleite
[5.x] Give starter kit devs an opt-in config to help make parts of th…
0cc5cba
…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.
@jesseleitejesseleite
changed the title
[5.x] Add new package folder convention for starter kits[5.x] Add new updatable and package folder conventions for starter kitsDec 2, 2024
@jesseleitejesseleite
changed the title
[5.x] Add new updatable and package folder conventions for starter kits[5.x] Add new updatable and package starter kit conventionsDec 2, 2024
@jesseleitejesseleite
mentioned this pull request
Dec 4, 2024
 Merged

@jasonvarga
jasonvarga
merged commit 67463fe
into
5.xDec 4, 2024
@jasonvarga
jasonvarga
deleted the

starter-kit-export-package-folder

branch
December 4, 2024 17:18
@duncanmccleanduncanmcclean
mentioned this pull request
Jul 14, 2025
 Merged

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@jasonvargajasonvargaAwaiting requested review from jasonvarga

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

2 participants

@jesseleite@jasonvarga

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[5.x] Add new `updatable` and `package` starter kit conventions by jesseleite · Pull Request #11119 · statamic/cms · GitHub
Skip to content
[5.x] Add new updatable and package starter kit conventions - #11119
Merged
jasonvarga merged 26 commits into
5.xfrom 
starter-kit-export-package-folder
Dec 4, 2024
Merged
[5.x] Add new updatable and package starter kit conventions#11119
jasonvarga merged 26 commits into
5.xfrom 
starter-kit-export-package-folder
Conversation
@jesseleite
@jesseleitejesseleite
commented
Nov 12, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
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
@jasonvargajasonvarga
mentioned this pull request
Nov 13, 2024
 Draft

@jesseleitejesseleite
changed the title
[5.x] Export starter kit package folder when it exists[5.x] Add new package folder convention for starter kitsNov 14, 2024
@robdekortrobdekort
mentioned this pull request
Nov 28, 2024
 Closed

1 task
@jesseleite
Tweak error output to use $this->components, like we do in exporter.
be31121
@jesseleite
Less !.
3c4ce12
@jesseleite
Fix assertions.
3bccefd
@jesseleite
[5.x] Give starter kit devs an opt-in config to help make parts of th…
0cc5cba
…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.
@jesseleitejesseleite
changed the title
[5.x] Add new package folder convention for starter kits[5.x] Add new updatable and package folder conventions for starter kitsDec 2, 2024
@jesseleitejesseleite
changed the title
[5.x] Add new updatable and package folder conventions for starter kits[5.x] Add new updatable and package starter kit conventionsDec 2, 2024
@jesseleitejesseleite
mentioned this pull request
Dec 4, 2024
 Merged

@jasonvarga
jasonvarga
merged commit 67463fe
into
5.xDec 4, 2024
@jasonvarga
jasonvarga
deleted the

starter-kit-export-package-folder

branch
December 4, 2024 17:18
@duncanmccleanduncanmcclean
mentioned this pull request
Jul 14, 2025
 Merged

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@jasonvargajasonvargaAwaiting requested review from jasonvarga

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

2 participants

@jesseleite@jasonvarga

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[5.x] Add new `updatable` and `package` starter kit conventions by jesseleite · Pull Request #11119 · statamic/cms · GitHub
Skip to content
[5.x] Add new updatable and package starter kit conventions - #11119
Merged
jasonvarga merged 26 commits into
5.xfrom 
starter-kit-export-package-folder
Dec 4, 2024
Merged
[5.x] Add new updatable and package starter kit conventions#11119
jasonvarga merged 26 commits into
5.xfrom 
starter-kit-export-package-folder
Conversation
@jesseleite
@jesseleitejesseleite
commented
Nov 12, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
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
@jasonvargajasonvarga
mentioned this pull request
Nov 13, 2024
 Draft

@jesseleitejesseleite
changed the title
[5.x] Export starter kit package folder when it exists[5.x] Add new package folder convention for starter kitsNov 14, 2024
@robdekortrobdekort
mentioned this pull request
Nov 28, 2024
 Closed

1 task
@jesseleite
Tweak error output to use $this->components, like we do in exporter.
be31121
@jesseleite
Less !.
3c4ce12
@jesseleite
Fix assertions.
3bccefd
@jesseleite
[5.x] Give starter kit devs an opt-in config to help make parts of th…
0cc5cba
…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.
@jesseleitejesseleite
changed the title
[5.x] Add new package folder convention for starter kits[5.x] Add new updatable and package folder conventions for starter kitsDec 2, 2024
@jesseleitejesseleite
changed the title
[5.x] Add new updatable and package folder conventions for starter kits[5.x] Add new updatable and package starter kit conventionsDec 2, 2024
@jesseleitejesseleite
mentioned this pull request
Dec 4, 2024
 Merged

@jasonvarga
jasonvarga
merged commit 67463fe
into
5.xDec 4, 2024
@jasonvarga
jasonvarga
deleted the

starter-kit-export-package-folder

branch
December 4, 2024 17:18
@duncanmccleanduncanmcclean
mentioned this pull request
Jul 14, 2025
 Merged

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@jasonvargajasonvargaAwaiting requested review from jasonvarga

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

2 participants

@jesseleite@jasonvarga

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
[5.x] Add new `updatable` and `package` starter kit conventions by jesseleite · Pull Request #11119 · statamic/cms · GitHub
Skip to content
[5.x] Add new updatable and package starter kit conventions - #11119
Merged
jasonvarga merged 26 commits into
5.xfrom 
starter-kit-export-package-folder
Dec 4, 2024
Merged
[5.x] Add new updatable and package starter kit conventions#11119
jasonvarga merged 26 commits into
5.xfrom 
starter-kit-export-package-folder
Conversation
@jesseleite
@jesseleitejesseleite
commented
Nov 12, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
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
@jasonvargajasonvarga
mentioned this pull request
Nov 13, 2024
 Draft

@jesseleitejesseleite
changed the title
[5.x] Export starter kit package folder when it exists[5.x] Add new package folder convention for starter kitsNov 14, 2024
@robdekortrobdekort
mentioned this pull request
Nov 28, 2024
 Closed

1 task
@jesseleite
Tweak error output to use $this->components, like we do in exporter.
be31121
@jesseleite
Less !.
3c4ce12
@jesseleite
Fix assertions.
3bccefd
@jesseleite
[5.x] Give starter kit devs an opt-in config to help make parts of th…
0cc5cba
…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.
@jesseleitejesseleite
changed the title
[5.x] Add new package folder convention for starter kits[5.x] Add new updatable and package folder conventions for starter kitsDec 2, 2024
@jesseleitejesseleite
changed the title
[5.x] Add new updatable and package folder conventions for starter kits[5.x] Add new updatable and package starter kit conventionsDec 2, 2024
@jesseleitejesseleite
mentioned this pull request
Dec 4, 2024
 Merged

@jasonvarga
jasonvarga
merged commit 67463fe
into
5.xDec 4, 2024
@jasonvarga
jasonvarga
deleted the

starter-kit-export-package-folder

branch
December 4, 2024 17:18
@duncanmccleanduncanmcclean
mentioned this pull request
Jul 14, 2025
 Merged

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@jasonvargajasonvargaAwaiting requested review from jasonvarga

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

2 participants

@jesseleite@jasonvarga

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[5.x] Add new `updatable` and `package` starter kit conventions by jesseleite · Pull Request #11119 · statamic/cms · GitHub
Skip to content
[5.x] Add new updatable and package starter kit conventions - #11119
Merged
jasonvarga merged 26 commits into
5.xfrom 
starter-kit-export-package-folder
Dec 4, 2024
Merged
[5.x] Add new updatable and package starter kit conventions#11119
jasonvarga merged 26 commits into
5.xfrom 
starter-kit-export-package-folder
Conversation
@jesseleite
@jesseleitejesseleite
commented
Nov 12, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
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
@jasonvargajasonvarga
mentioned this pull request
Nov 13, 2024
 Draft

@jesseleitejesseleite
changed the title
[5.x] Export starter kit package folder when it exists[5.x] Add new package folder convention for starter kitsNov 14, 2024
@robdekortrobdekort
mentioned this pull request
Nov 28, 2024
 Closed

1 task
@jesseleite
Tweak error output to use $this->components, like we do in exporter.
be31121
@jesseleite
Less !.
3c4ce12
@jesseleite
Fix assertions.
3bccefd
@jesseleite
[5.x] Give starter kit devs an opt-in config to help make parts of th…
0cc5cba
…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.
@jesseleitejesseleite
changed the title
[5.x] Add new package folder convention for starter kits[5.x] Add new updatable and package folder conventions for starter kitsDec 2, 2024
@jesseleitejesseleite
changed the title
[5.x] Add new updatable and package folder conventions for starter kits[5.x] Add new updatable and package starter kit conventionsDec 2, 2024
@jesseleitejesseleite
mentioned this pull request
Dec 4, 2024
 Merged

@jasonvarga
jasonvarga
merged commit 67463fe
into
5.xDec 4, 2024
@jasonvarga
jasonvarga
deleted the

starter-kit-export-package-folder

branch
December 4, 2024 17:18
@duncanmccleanduncanmcclean
mentioned this pull request
Jul 14, 2025
 Merged

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@jasonvargajasonvargaAwaiting requested review from jasonvarga

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

2 participants

@jesseleite@jasonvarga

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
[5.x] Add new `updatable` and `package` starter kit conventions by jesseleite · Pull Request #11119 · statamic/cms · GitHub
Skip to content
[5.x] Add new updatable and package starter kit conventions - #11119
Merged
jasonvarga merged 26 commits into
5.xfrom 
starter-kit-export-package-folder
Dec 4, 2024
Merged
[5.x] Add new updatable and package starter kit conventions#11119
jasonvarga merged 26 commits into
5.xfrom 
starter-kit-export-package-folder
Conversation
@jesseleite
@jesseleitejesseleite
commented
Nov 12, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
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
@jasonvargajasonvarga
mentioned this pull request
Nov 13, 2024
 Draft

@jesseleitejesseleite
changed the title
[5.x] Export starter kit package folder when it exists[5.x] Add new package folder convention for starter kitsNov 14, 2024
@robdekortrobdekort
mentioned this pull request
Nov 28, 2024
 Closed

1 task
@jesseleite
Tweak error output to use $this->components, like we do in exporter.
be31121
@jesseleite
Less !.
3c4ce12
@jesseleite
Fix assertions.
3bccefd
@jesseleite
[5.x] Give starter kit devs an opt-in config to help make parts of th…
0cc5cba
…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.
@jesseleitejesseleite
changed the title
[5.x] Add new package folder convention for starter kits[5.x] Add new updatable and package folder conventions for starter kitsDec 2, 2024
@jesseleitejesseleite
changed the title
[5.x] Add new updatable and package folder conventions for starter kits[5.x] Add new updatable and package starter kit conventionsDec 2, 2024
@jesseleitejesseleite
mentioned this pull request
Dec 4, 2024
 Merged

@jasonvarga
jasonvarga
merged commit 67463fe
into
5.xDec 4, 2024
@jasonvarga
jasonvarga
deleted the

starter-kit-export-package-folder

branch
December 4, 2024 17:18
@duncanmccleanduncanmcclean
mentioned this pull request
Jul 14, 2025
 Merged

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@jasonvargajasonvargaAwaiting requested review from jasonvarga

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

2 participants

@jesseleite@jasonvarga

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
[5.x] Add new `updatable` and `package` starter kit conventions by jesseleite · Pull Request #11119 · statamic/cms · GitHub
Skip to content
[5.x] Add new updatable and package starter kit conventions - #11119
Merged
jasonvarga merged 26 commits into
5.xfrom 
starter-kit-export-package-folder
Dec 4, 2024
Merged
[5.x] Add new updatable and package starter kit conventions#11119
jasonvarga merged 26 commits into
5.xfrom 
starter-kit-export-package-folder
Conversation
@jesseleite
@jesseleitejesseleite
commented
Nov 12, 2024•

edited

Loading

Copy link


Copy Markdown

Contributor
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
@jasonvargajasonvarga
mentioned this pull request
Nov 13, 2024
 Draft

@jesseleitejesseleite
changed the title
[5.x] Export starter kit package folder when it exists[5.x] Add new package folder convention for starter kitsNov 14, 2024
@robdekortrobdekort
mentioned this pull request
Nov 28, 2024
 Closed

1 task
@jesseleite
Tweak error output to use $this->components, like we do in exporter.
be31121
@jesseleite
Less !.
3c4ce12
@jesseleite
Fix assertions.
3bccefd
@jesseleite
[5.x] Give starter kit devs an opt-in config to help make parts of th…
0cc5cba
…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.
@jesseleitejesseleite
changed the title
[5.x] Add new package folder convention for starter kits[5.x] Add new updatable and package folder conventions for starter kitsDec 2, 2024
@jesseleitejesseleite
changed the title
[5.x] Add new updatable and package folder conventions for starter kits[5.x] Add new updatable and package starter kit conventionsDec 2, 2024
@jesseleitejesseleite
mentioned this pull request
Dec 4, 2024
 Merged

@jasonvarga
jasonvarga
merged commit 67463fe
into
5.xDec 4, 2024
@jasonvarga
jasonvarga
deleted the

starter-kit-export-package-folder

branch
December 4, 2024 17:18
@duncanmccleanduncanmcclean
mentioned this pull request
Jul 14, 2025
 Merged

Sign up for freeto join this conversation on GitHub.
Already have an account?
Sign in to comment

Reviewers

@jasonvargajasonvargaAwaiting requested review from jasonvarga

Assignees


No one assigned


Labels


None yet


Projects


None yet


Milestone


No milestone


Development

Successfully merging this pull request may close these issues.

2 participants

@jesseleite@jasonvarga