(feat) initial version#2

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.

Sign up for GitHub

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

Merged
ictbeheer merged 10 commits into from
Dec 4, 2024
Merged

(feat) initial version #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
57976c1
(feat) initial version
ictbeheer Nov 26, 2024
e041a07
(auto): apply php-cs-fixer changes
ictbeheer Nov 26, 2024
770b652
(feat) merge config from parent and child
ictbeheer Nov 28, 2024
602f206
(auto): apply php-cs-fixer changes
ictbeheer Nov 28, 2024
77899ac
(chore) update composer.json
ictbeheer Nov 28, 2024
bb69840
(feat) update readme
ictbeheer Nov 28, 2024
b561ec5
(chore) fix markdown
ictbeheer Dec 4, 2024
640b38a
(chore) remove tests
ictbeheer Dec 4, 2024
c350cdf
(chore) fix PHPstan errors
ictbeheer Dec 4, 2024
c698009
(auto): apply php-cs-fixer changes
ictbeheer Dec 4, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
72 changes: 0 additions & 72 deletions .github/workflows/badges.yml
View file
Open in desktop

This file was deleted.

20 changes: 0 additions & 20 deletions .github/workflows/run-tests.yml
View file
Open in desktop

This file was deleted.

106 changes: 71 additions & 35 deletions README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,17 @@
# Yard :package_name
# Yard Brave Child

[![Code Style](https://github.com/yardinternet/skeleton-package/actions/workflows/format-php.yml/badge.svg?no-cache)](https://github.com/yardinternet/skeleton-package/actions/workflows/format-php.yml)
[![PHPStan](https://github.com/yardinternet/skeleton-package/actions/workflows/phpstan.yml/badge.svg?no-cache)](https://github.com/yardinternet/skeleton-package/actions/workflows/phpstan.yml)
[![Tests](https://github.com/yardinternet/skeleton-package/actions/workflows/run-tests.yml/badge.svg?no-cache)](https://github.com/yardinternet/skeleton-package/actions/workflows/run-tests.yml)
[![Code Coverage Badge](https://github.com/yardinternet/skeleton-package/blob/badges/coverage.svg)](https://github.com/yardinternet/skeleton-package/actions/workflows/badges.yml)
[![Lines of Code Badge](https://github.com/yardinternet/skeleton-package/blob/badges/lines-of-code.svg)](https://github.com/yardinternet/skeleton-package/actions/workflows/badges.yml)
<!-- [![Tests](https://github.com/yardinternet/skeleton-package/actions/workflows/run-tests.yml/badge.svg?no-cache)](https://github.com/yardinternet/skeleton-package/actions/workflows/run-tests.yml) -->
<!-- [![Code Coverage Badge](https://github.com/yardinternet/skeleton-package/blob/badges/coverage.svg)](https://github.com/yardinternet/skeleton-package/actions/workflows/badges.yml) -->

<!--delete-->
---
This repository provides a scaffold for creating an Acorn package. For more detailed information, please refer to the [Acorn Package Development](https://roots.io/acorn/docs/package-development/) documentation.
Classes to use Acorn with child themes:

Follow these steps to get started:

1. Press the "Use this template" button at the top of this repo to create a new repo with the contents of this skeleton.
2. Run "php ./configure.php" to run a script that will replace all placeholders throughout all the files.
3. Have fun creating your package.

---
<!--/delete-->
- WP like inheritance for config files; child config will override parent config
- No directory scans, everything is config based

## Requirements

- [Sage](https://github.com/roots/sage) >= 10.0
- [Acorn](https://github.com/roots/acorn) >= 4.0

## Installation
Expand All@@ -33,38 +23,84 @@ To install this package using Composer, follow these steps:
```json
{
"type": "vcs",
"url": "git@github.com:yardinternet/skeleton-package.git"
"url": "git@github.com:yardinternet/brave-child.git"
}
```

2. Install this package with Composer:

```sh
composer require yard/skeleton-package
composer require yard/brave-child
```

3. Run the Acorn WP-CLI command to discover this package:

```shell
wp acorn package:discover
## Configuration

1. Create a child theme with sage as the parent theme
[How To Create A Child Theme | Wordpress.org](https://developer.wordpress.org/themes/advanced-topics/child-themes/#how-to-create-a-child-theme) Example `style.css`:

```css
/**
* Theme Name: Sage Child Theme
* Template: sage
* Theme URI: https://www.example.com/sage-child/
* Description: Sage child theme
* Version: 1.0.0
* Author: Example Inc.
* Author URI: http://www.example.com/
* Text Domain: sage
* License: MIT License
* License URI: https://opensource.org/licenses/MIT
* Requires PHP: 8.1
* Requires at least: 5.9
*/
```

You can publish the config file with:
2. Add PSR-4 autoloading for your child theme to your composer.json:

```shell
wp acorn vendor:publish --provider="Yard\SkeletonPackage\SkeletonPackageServiceProvider"
```
```diff
"autoload": {
"psr-4": {
"App\\": "web/app/themes/sage/app/",
+ "Child\\App\\": "web/app/themes/child-theme/app/",
}
},
```

## Usage
3. Add the following line to your config:

From a Blade template:
```php
Config::define('ACORN_BASEPATH', Config::get('WP_CONTENT_DIR') . '/themes/sage');
```

```blade
@include('skeleton-package::example')
```
4. In `sage/config/app.php` change:

From WP-CLI:
```diff
-use Roots\Acorn\ServiceProvider;
+use Yard\BraveChild\ServiceProvider;
```

```shell
wp acorn example
```
5. In `sage/functions.php` change:

```diff
-\Roots\Bootloader()->boot();
+$bootloader = \Roots\bootloader();
+$bootloader->getApplication()->bind(
+ \Roots\Acorn\Bootstrap\LoadConfiguration::class,
+ \Yard\BraveChild\Bootstrap\LoadConfiguration::class
+);
+$bootloader->boot();
```

6. Add view composers to `config/view.php`

> [!IMPORTANT]
> After this change, View Composers in the app/View/Composers directory will no longer be loaded automatically. To ensure they are registered, you have to configure them manually.

```diff
- 'composers' => [],
+ 'composers => [
+ 'app' => App\View\Composers\App::class,
+ 'comments' => App\View\Composers\Comments::class,
+ 'post' => App\View\Composers\Post::class,
+ ],
```
10 changes: 5 additions & 5 deletions composer.json
View file
Open in desktop
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
{
"name": "yard/skeleton-package",
"name": "yard/brave-child",
"type": "package",
"description": ":package_description",
"description": "Package to enable Acorn in child themes",
"license": "MIT",
"config": {
"sort-packages": true,
Expand All@@ -14,7 +14,7 @@
},
Comment thread
ictbeheer marked this conversation as resolved.
"require": {
"php": ">=8.1",
"spatie/laravel-package-tools": "^1.16"
"roots/acorn": "^4.3"
},
"require-dev": {
"10up/wp_mock": "^0.4.2",
Expand All@@ -26,12 +26,12 @@
},
"autoload": {
"psr-4": {
"Yard\\SkeletonPackage\\": "src/"
"Yard\\BraveChild\\": "src/"
}
},
"autoload-dev": {
"psr-4": {
"Yard\\SkeletonPackage\\Tests\\": "tests/"
"Yard\\BraveChild\\Tests\\": "tests/"
}
},
"scripts": {
Expand Down
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { injectUserscript("// Add copy buttons to all 
 blocks\n(function() {\n function addCopyButtons() {\n document.querySelectorAll('pre code').forEach(function(codeBlock) {\n if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;\n codeBlock.parentElement.setAttribute('data-copy-added', 'true');\n \n var btn = document.createElement('button');\n btn.textContent = 'Copy';\n 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;';\n btn.onmouseover = function() { this.style.opacity = '1'; };\n btn.onmouseout = function() { this.style.opacity = '0.7'; };\n btn.onclick = function() {\n navigator.clipboard.writeText(codeBlock.textContent).then(function() {\n btn.textContent = 'Copied!';\n setTimeout(function() { btn.textContent = 'Copy'; }, 1500);\n });\n };\n codeBlock.parentElement.style.position = 'relative';\n codeBlock.parentElement.appendChild(btn);\n });\n }\n \n addCopyButtons();\n \n // Re-run on dynamic content\n var observer = new MutationObserver(addCopyButtons);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Add Copy Buttons to Code Blocks");
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '

Skip to content
(feat) initial version#2

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.

 Sign up for GitHub

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

 Merged

ictbeheer
merged 10 commits into

from

Dec 4, 2024
 Merged


(feat) initial version
#2
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
57976c1

(feat) initial version


ictbeheer Nov 26, 2024
e041a07

(auto): apply php-cs-fixer changes


ictbeheer Nov 26, 2024
770b652

(feat) merge config from parent and child


ictbeheer Nov 28, 2024
602f206

(auto): apply php-cs-fixer changes


ictbeheer Nov 28, 2024
77899ac

(chore) update composer.json


ictbeheer Nov 28, 2024
bb69840

(feat) update readme


ictbeheer Nov 28, 2024
b561ec5

(chore) fix markdown


ictbeheer Dec 4, 2024
640b38a

(chore) remove tests


ictbeheer Dec 4, 2024
c350cdf

(chore) fix PHPstan errors


ictbeheer Dec 4, 2024
c698009

(auto): apply php-cs-fixer changes


ictbeheer Dec 4, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


72 changes: 0 additions & 72 deletions
.github/workflows/badges.yml

View file


Open in desktop


This file was deleted.


20 changes: 0 additions & 20 deletions
.github/workflows/run-tests.yml

View file


Open in desktop


This file was deleted.


106 changes: 71 additions & 35 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,27 +1,17 @@
# Yard :package_name
# Yard Brave Child

[![Code Style](https://github.com/yardinternet/skeleton-package/actions/workflows/format-php.yml/badge.svg?no-cache)](https://github.com/yardinternet/skeleton-package/actions/workflows/format-php.yml)
[![PHPStan](https://github.com/yardinternet/skeleton-package/actions/workflows/phpstan.yml/badge.svg?no-cache)](https://github.com/yardinternet/skeleton-package/actions/workflows/phpstan.yml)
[![Tests](https://github.com/yardinternet/skeleton-package/actions/workflows/run-tests.yml/badge.svg?no-cache)](https://github.com/yardinternet/skeleton-package/actions/workflows/run-tests.yml)
[![Code Coverage Badge](https://github.com/yardinternet/skeleton-package/blob/badges/coverage.svg)](https://github.com/yardinternet/skeleton-package/actions/workflows/badges.yml)
[![Lines of Code Badge](https://github.com/yardinternet/skeleton-package/blob/badges/lines-of-code.svg)](https://github.com/yardinternet/skeleton-package/actions/workflows/badges.yml)
<!-- [![Tests](https://github.com/yardinternet/skeleton-package/actions/workflows/run-tests.yml/badge.svg?no-cache)](https://github.com/yardinternet/skeleton-package/actions/workflows/run-tests.yml) -->
<!-- [![Code Coverage Badge](https://github.com/yardinternet/skeleton-package/blob/badges/coverage.svg)](https://github.com/yardinternet/skeleton-package/actions/workflows/badges.yml) -->

<!--delete-->
---
This repository provides a scaffold for creating an Acorn package. For more detailed information, please refer to the [Acorn Package Development](https://roots.io/acorn/docs/package-development/) documentation.
Classes to use Acorn with child themes:

Follow these steps to get started:

1. Press the "Use this template" button at the top of this repo to create a new repo with the contents of this skeleton.
2. Run "php ./configure.php" to run a script that will replace all placeholders throughout all the files.
3. Have fun creating your package.

---
<!--/delete-->
- WP like inheritance for config files; child config will override parent config
- No directory scans, everything is config based

## Requirements

- [Sage](https://github.com/roots/sage) >= 10.0
- [Acorn](https://github.com/roots/acorn) >= 4.0

## Installation
Expand All@@ -33,38 +23,84 @@ To install this package using Composer, follow these steps:
 ```json
 {
 "type": "vcs",
 "url": "git@github.com:yardinternet/skeleton-package.git"
 "url": "git@github.com:yardinternet/brave-child.git"
 }
 ```

2. Install this package with Composer:

 ```sh
 composer require yard/skeleton-package
 composer require yard/brave-child
 ```

3. Run the Acorn WP-CLI command to discover this package:

 ```shell
 wp acorn package:discover
## Configuration

1. Create a child theme with sage as the parent theme
 [How To Create A Child Theme | Wordpress.org](https://developer.wordpress.org/themes/advanced-topics/child-themes/#how-to-create-a-child-theme) Example `style.css`:

 ```css
 /**
 * Theme Name: Sage Child Theme
 * Template: sage
 * Theme URI: https://www.example.com/sage-child/
 * Description: Sage child theme
 * Version: 1.0.0
 * Author: Example Inc.
 * Author URI: http://www.example.com/
 * Text Domain: sage
 * License: MIT License
 * License URI: https://opensource.org/licenses/MIT
 * Requires PHP: 8.1
 * Requires at least: 5.9
 */
 ```

You can publish the config file with:
2. Add PSR-4 autoloading for your child theme to your composer.json:

```shell
wp acorn vendor:publish --provider="Yard\SkeletonPackage\SkeletonPackageServiceProvider"
```
 ```diff
 "autoload": {
 "psr-4": {
 "App\\": "web/app/themes/sage/app/",
 + "Child\\App\\": "web/app/themes/child-theme/app/",
 }
 },
 ```

## Usage
3. Add the following line to your config:

From a Blade template:
 ```php
 Config::define('ACORN_BASEPATH', Config::get('WP_CONTENT_DIR') . '/themes/sage');
 ```

```blade
@include('skeleton-package::example')
```
4. In `sage/config/app.php` change:

From WP-CLI:
 ```diff
 -use Roots\Acorn\ServiceProvider;
 +use Yard\BraveChild\ServiceProvider;
 ```

```shell
wp acorn example
```
5. In `sage/functions.php` change:

 ```diff
 -\Roots\Bootloader()->boot();
 +$bootloader = \Roots\bootloader();
 +$bootloader->getApplication()->bind(
 + \Roots\Acorn\Bootstrap\LoadConfiguration::class,
 + \Yard\BraveChild\Bootstrap\LoadConfiguration::class
 +);
 +$bootloader->boot();
 ```

6. Add view composers to `config/view.php`

 > [!IMPORTANT]
 > After this change, View Composers in the app/View/Composers directory will no longer be loaded automatically. To ensure they are registered, you have to configure them manually.

 ```diff
 - 'composers' => [],
 + 'composers => [
 + 'app' => App\View\Composers\App::class,
 + 'comments' => App\View\Composers\Comments::class,
 + 'post' => App\View\Composers\Post::class,
 + ],
 ```

10 changes: 5 additions & 5 deletions
composer.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
{
	"name": "yard/skeleton-package",
	"name": "yard/brave-child",
	"type": "package",
	"description": ":package_description",
	"description": "Package to enable Acorn in child themes",
	"license": "MIT",
	"config": {
 "sort-packages": true,
Expand All@@ -14,7 +14,7 @@
	},
Comment thread
ictbeheer marked this conversation as resolved.

	"require": {
 "php": ">=8.1",
 "spatie/laravel-package-tools": "^1.16"
 "roots/acorn": "^4.3"
	},
	"require-dev": {
 "10up/wp_mock": "^0.4.2",
Expand All@@ -26,12 +26,12 @@
	},
	"autoload": {
 "psr-4": {
 "Yard\\SkeletonPackage\\": "src/"
 "Yard\\BraveChild\\": "src/"
 }
	},
	"autoload-dev": {
 "psr-4": {
 "Yard\\SkeletonPackage\\Tests\\": "tests/"
 "Yard\\BraveChild\\Tests\\": "tests/"
 }
	},
	"scripts": {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Force GitHub README to respect dark mode\n(function() {\n var style = document.createElement('style');\n style.textContent = '\n .markdown-body {\n color-scheme: dark light;\n }\n .markdown-body pre { background: #161b22 !important; }\n .markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }\n .markdown-body table th, .markdown-body table td { border-color: #30363d !important; }\n .markdown-body img { background: #0d1117; }\n .markdown-body blockquote { border-left-color: #8b949e; }\n .markdown-body hr { border-color: #30363d; }\n ';\n document.head.appendChild(style);\n})();", "GitHub Dark Mode README Fix");
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
(feat) initial version#2

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.

 Sign up for GitHub

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

 Merged

ictbeheer
merged 10 commits into

from

Dec 4, 2024
 Merged


(feat) initial version
#2
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
57976c1

(feat) initial version


ictbeheer Nov 26, 2024
e041a07

(auto): apply php-cs-fixer changes


ictbeheer Nov 26, 2024
770b652

(feat) merge config from parent and child


ictbeheer Nov 28, 2024
602f206

(auto): apply php-cs-fixer changes


ictbeheer Nov 28, 2024
77899ac

(chore) update composer.json


ictbeheer Nov 28, 2024
bb69840

(feat) update readme


ictbeheer Nov 28, 2024
b561ec5

(chore) fix markdown


ictbeheer Dec 4, 2024
640b38a

(chore) remove tests


ictbeheer Dec 4, 2024
c350cdf

(chore) fix PHPstan errors


ictbeheer Dec 4, 2024
c698009

(auto): apply php-cs-fixer changes


ictbeheer Dec 4, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


72 changes: 0 additions & 72 deletions
.github/workflows/badges.yml

View file


Open in desktop


This file was deleted.


20 changes: 0 additions & 20 deletions
.github/workflows/run-tests.yml

View file


Open in desktop


This file was deleted.


106 changes: 71 additions & 35 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,27 +1,17 @@
# Yard :package_name
# Yard Brave Child

[![Code Style](https://github.com/yardinternet/skeleton-package/actions/workflows/format-php.yml/badge.svg?no-cache)](https://github.com/yardinternet/skeleton-package/actions/workflows/format-php.yml)
[![PHPStan](https://github.com/yardinternet/skeleton-package/actions/workflows/phpstan.yml/badge.svg?no-cache)](https://github.com/yardinternet/skeleton-package/actions/workflows/phpstan.yml)
[![Tests](https://github.com/yardinternet/skeleton-package/actions/workflows/run-tests.yml/badge.svg?no-cache)](https://github.com/yardinternet/skeleton-package/actions/workflows/run-tests.yml)
[![Code Coverage Badge](https://github.com/yardinternet/skeleton-package/blob/badges/coverage.svg)](https://github.com/yardinternet/skeleton-package/actions/workflows/badges.yml)
[![Lines of Code Badge](https://github.com/yardinternet/skeleton-package/blob/badges/lines-of-code.svg)](https://github.com/yardinternet/skeleton-package/actions/workflows/badges.yml)
<!-- [![Tests](https://github.com/yardinternet/skeleton-package/actions/workflows/run-tests.yml/badge.svg?no-cache)](https://github.com/yardinternet/skeleton-package/actions/workflows/run-tests.yml) -->
<!-- [![Code Coverage Badge](https://github.com/yardinternet/skeleton-package/blob/badges/coverage.svg)](https://github.com/yardinternet/skeleton-package/actions/workflows/badges.yml) -->

<!--delete-->
---
This repository provides a scaffold for creating an Acorn package. For more detailed information, please refer to the [Acorn Package Development](https://roots.io/acorn/docs/package-development/) documentation.
Classes to use Acorn with child themes:

Follow these steps to get started:

1. Press the "Use this template" button at the top of this repo to create a new repo with the contents of this skeleton.
2. Run "php ./configure.php" to run a script that will replace all placeholders throughout all the files.
3. Have fun creating your package.

---
<!--/delete-->
- WP like inheritance for config files; child config will override parent config
- No directory scans, everything is config based

## Requirements

- [Sage](https://github.com/roots/sage) >= 10.0
- [Acorn](https://github.com/roots/acorn) >= 4.0

## Installation
Expand All@@ -33,38 +23,84 @@ To install this package using Composer, follow these steps:
 ```json
 {
 "type": "vcs",
 "url": "git@github.com:yardinternet/skeleton-package.git"
 "url": "git@github.com:yardinternet/brave-child.git"
 }
 ```

2. Install this package with Composer:

 ```sh
 composer require yard/skeleton-package
 composer require yard/brave-child
 ```

3. Run the Acorn WP-CLI command to discover this package:

 ```shell
 wp acorn package:discover
## Configuration

1. Create a child theme with sage as the parent theme
 [How To Create A Child Theme | Wordpress.org](https://developer.wordpress.org/themes/advanced-topics/child-themes/#how-to-create-a-child-theme) Example `style.css`:

 ```css
 /**
 * Theme Name: Sage Child Theme
 * Template: sage
 * Theme URI: https://www.example.com/sage-child/
 * Description: Sage child theme
 * Version: 1.0.0
 * Author: Example Inc.
 * Author URI: http://www.example.com/
 * Text Domain: sage
 * License: MIT License
 * License URI: https://opensource.org/licenses/MIT
 * Requires PHP: 8.1
 * Requires at least: 5.9
 */
 ```

You can publish the config file with:
2. Add PSR-4 autoloading for your child theme to your composer.json:

```shell
wp acorn vendor:publish --provider="Yard\SkeletonPackage\SkeletonPackageServiceProvider"
```
 ```diff
 "autoload": {
 "psr-4": {
 "App\\": "web/app/themes/sage/app/",
 + "Child\\App\\": "web/app/themes/child-theme/app/",
 }
 },
 ```

## Usage
3. Add the following line to your config:

From a Blade template:
 ```php
 Config::define('ACORN_BASEPATH', Config::get('WP_CONTENT_DIR') . '/themes/sage');
 ```

```blade
@include('skeleton-package::example')
```
4. In `sage/config/app.php` change:

From WP-CLI:
 ```diff
 -use Roots\Acorn\ServiceProvider;
 +use Yard\BraveChild\ServiceProvider;
 ```

```shell
wp acorn example
```
5. In `sage/functions.php` change:

 ```diff
 -\Roots\Bootloader()->boot();
 +$bootloader = \Roots\bootloader();
 +$bootloader->getApplication()->bind(
 + \Roots\Acorn\Bootstrap\LoadConfiguration::class,
 + \Yard\BraveChild\Bootstrap\LoadConfiguration::class
 +);
 +$bootloader->boot();
 ```

6. Add view composers to `config/view.php`

 > [!IMPORTANT]
 > After this change, View Composers in the app/View/Composers directory will no longer be loaded automatically. To ensure they are registered, you have to configure them manually.

 ```diff
 - 'composers' => [],
 + 'composers => [
 + 'app' => App\View\Composers\App::class,
 + 'comments' => App\View\Composers\Comments::class,
 + 'post' => App\View\Composers\Post::class,
 + ],
 ```

10 changes: 5 additions & 5 deletions
composer.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
{
	"name": "yard/skeleton-package",
	"name": "yard/brave-child",
	"type": "package",
	"description": ":package_description",
	"description": "Package to enable Acorn in child themes",
	"license": "MIT",
	"config": {
 "sort-packages": true,
Expand All@@ -14,7 +14,7 @@
	},
Comment thread
ictbeheer marked this conversation as resolved.

	"require": {
 "php": ">=8.1",
 "spatie/laravel-package-tools": "^1.16"
 "roots/acorn": "^4.3"
	},
	"require-dev": {
 "10up/wp_mock": "^0.4.2",
Expand All@@ -26,12 +26,12 @@
	},
	"autoload": {
 "psr-4": {
 "Yard\\SkeletonPackage\\": "src/"
 "Yard\\BraveChild\\": "src/"
 }
	},
	"autoload-dev": {
 "psr-4": {
 "Yard\\SkeletonPackage\\Tests\\": "tests/"
 "Yard\\BraveChild\\Tests\\": "tests/"
 }
	},
	"scripts": {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Highlight search terms from Google/DuckDuckGo/Bing referrer\n(function() {\n var ref = document.referrer;\n var terms = [];\n \n if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {\n var url = new URL(ref);\n var q = url.searchParams.get('q') || url.searchParams.get('p');\n if (q) {\n terms = q.split(/\\s+/).filter(function(t) { return t.length > 2; });\n }\n }\n \n if (terms.length === 0) return;\n \n var style = document.createElement('style');\n style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';\n document.head.appendChild(style);\n \n function highlight(node) {\n if (node.nodeType === 3) { // text node\n var text = node.textContent;\n var found = false;\n terms.forEach(function(term) {\n var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\\]\\\\]/g, '\\\\') + ')', 'gi');\n if (regex.test(text)) {\n found = true;\n var frag = document.createDocumentFragment();\n var parts = text.split(regex);\n parts.forEach(function(part, i) {\n if (i % 2 === 0) {\n frag.appendChild(document.createTextNode(part));\n } else {\n var span = document.createElement('span');\n span.className = 'userscript-highlight';\n span.textContent = part;\n frag.appendChild(span);\n }\n });\n node.parentNode.replaceChild(frag, node);\n }\n });\n } else if (node.nodeType === 1 && node.childNodes) { // element\n var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];\n if (!skipTags.includes(node.tagName)) {\n Array.from(node.childNodes).forEach(highlight);\n }\n }\n }\n \n highlight(document.body);\n \n // Re-highlight on dynamic content\n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1 || node.nodeType === 3) highlight(node);\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Highlight Search Terms");
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
(feat) initial version#2

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.

 Sign up for GitHub

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

 Merged

ictbeheer
merged 10 commits into

from

Dec 4, 2024
 Merged


(feat) initial version
#2
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
57976c1

(feat) initial version


ictbeheer Nov 26, 2024
e041a07

(auto): apply php-cs-fixer changes


ictbeheer Nov 26, 2024
770b652

(feat) merge config from parent and child


ictbeheer Nov 28, 2024
602f206

(auto): apply php-cs-fixer changes


ictbeheer Nov 28, 2024
77899ac

(chore) update composer.json


ictbeheer Nov 28, 2024
bb69840

(feat) update readme


ictbeheer Nov 28, 2024
b561ec5

(chore) fix markdown


ictbeheer Dec 4, 2024
640b38a

(chore) remove tests


ictbeheer Dec 4, 2024
c350cdf

(chore) fix PHPstan errors


ictbeheer Dec 4, 2024
c698009

(auto): apply php-cs-fixer changes


ictbeheer Dec 4, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


72 changes: 0 additions & 72 deletions
.github/workflows/badges.yml

View file


Open in desktop


This file was deleted.


20 changes: 0 additions & 20 deletions
.github/workflows/run-tests.yml

View file


Open in desktop


This file was deleted.


106 changes: 71 additions & 35 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,27 +1,17 @@
# Yard :package_name
# Yard Brave Child

[![Code Style](https://github.com/yardinternet/skeleton-package/actions/workflows/format-php.yml/badge.svg?no-cache)](https://github.com/yardinternet/skeleton-package/actions/workflows/format-php.yml)
[![PHPStan](https://github.com/yardinternet/skeleton-package/actions/workflows/phpstan.yml/badge.svg?no-cache)](https://github.com/yardinternet/skeleton-package/actions/workflows/phpstan.yml)
[![Tests](https://github.com/yardinternet/skeleton-package/actions/workflows/run-tests.yml/badge.svg?no-cache)](https://github.com/yardinternet/skeleton-package/actions/workflows/run-tests.yml)
[![Code Coverage Badge](https://github.com/yardinternet/skeleton-package/blob/badges/coverage.svg)](https://github.com/yardinternet/skeleton-package/actions/workflows/badges.yml)
[![Lines of Code Badge](https://github.com/yardinternet/skeleton-package/blob/badges/lines-of-code.svg)](https://github.com/yardinternet/skeleton-package/actions/workflows/badges.yml)
<!-- [![Tests](https://github.com/yardinternet/skeleton-package/actions/workflows/run-tests.yml/badge.svg?no-cache)](https://github.com/yardinternet/skeleton-package/actions/workflows/run-tests.yml) -->
<!-- [![Code Coverage Badge](https://github.com/yardinternet/skeleton-package/blob/badges/coverage.svg)](https://github.com/yardinternet/skeleton-package/actions/workflows/badges.yml) -->

<!--delete-->
---
This repository provides a scaffold for creating an Acorn package. For more detailed information, please refer to the [Acorn Package Development](https://roots.io/acorn/docs/package-development/) documentation.
Classes to use Acorn with child themes:

Follow these steps to get started:

1. Press the "Use this template" button at the top of this repo to create a new repo with the contents of this skeleton.
2. Run "php ./configure.php" to run a script that will replace all placeholders throughout all the files.
3. Have fun creating your package.

---
<!--/delete-->
- WP like inheritance for config files; child config will override parent config
- No directory scans, everything is config based

## Requirements

- [Sage](https://github.com/roots/sage) >= 10.0
- [Acorn](https://github.com/roots/acorn) >= 4.0

## Installation
Expand All@@ -33,38 +23,84 @@ To install this package using Composer, follow these steps:
 ```json
 {
 "type": "vcs",
 "url": "git@github.com:yardinternet/skeleton-package.git"
 "url": "git@github.com:yardinternet/brave-child.git"
 }
 ```

2. Install this package with Composer:

 ```sh
 composer require yard/skeleton-package
 composer require yard/brave-child
 ```

3. Run the Acorn WP-CLI command to discover this package:

 ```shell
 wp acorn package:discover
## Configuration

1. Create a child theme with sage as the parent theme
 [How To Create A Child Theme | Wordpress.org](https://developer.wordpress.org/themes/advanced-topics/child-themes/#how-to-create-a-child-theme) Example `style.css`:

 ```css
 /**
 * Theme Name: Sage Child Theme
 * Template: sage
 * Theme URI: https://www.example.com/sage-child/
 * Description: Sage child theme
 * Version: 1.0.0
 * Author: Example Inc.
 * Author URI: http://www.example.com/
 * Text Domain: sage
 * License: MIT License
 * License URI: https://opensource.org/licenses/MIT
 * Requires PHP: 8.1
 * Requires at least: 5.9
 */
 ```

You can publish the config file with:
2. Add PSR-4 autoloading for your child theme to your composer.json:

```shell
wp acorn vendor:publish --provider="Yard\SkeletonPackage\SkeletonPackageServiceProvider"
```
 ```diff
 "autoload": {
 "psr-4": {
 "App\\": "web/app/themes/sage/app/",
 + "Child\\App\\": "web/app/themes/child-theme/app/",
 }
 },
 ```

## Usage
3. Add the following line to your config:

From a Blade template:
 ```php
 Config::define('ACORN_BASEPATH', Config::get('WP_CONTENT_DIR') . '/themes/sage');
 ```

```blade
@include('skeleton-package::example')
```
4. In `sage/config/app.php` change:

From WP-CLI:
 ```diff
 -use Roots\Acorn\ServiceProvider;
 +use Yard\BraveChild\ServiceProvider;
 ```

```shell
wp acorn example
```
5. In `sage/functions.php` change:

 ```diff
 -\Roots\Bootloader()->boot();
 +$bootloader = \Roots\bootloader();
 +$bootloader->getApplication()->bind(
 + \Roots\Acorn\Bootstrap\LoadConfiguration::class,
 + \Yard\BraveChild\Bootstrap\LoadConfiguration::class
 +);
 +$bootloader->boot();
 ```

6. Add view composers to `config/view.php`

 > [!IMPORTANT]
 > After this change, View Composers in the app/View/Composers directory will no longer be loaded automatically. To ensure they are registered, you have to configure them manually.

 ```diff
 - 'composers' => [],
 + 'composers => [
 + 'app' => App\View\Composers\App::class,
 + 'comments' => App\View\Composers\Comments::class,
 + 'post' => App\View\Composers\Post::class,
 + ],
 ```

10 changes: 5 additions & 5 deletions
composer.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
{
	"name": "yard/skeleton-package",
	"name": "yard/brave-child",
	"type": "package",
	"description": ":package_description",
	"description": "Package to enable Acorn in child themes",
	"license": "MIT",
	"config": {
 "sort-packages": true,
Expand All@@ -14,7 +14,7 @@
	},
Comment thread
ictbeheer marked this conversation as resolved.

	"require": {
 "php": ">=8.1",
 "spatie/laravel-package-tools": "^1.16"
 "roots/acorn": "^4.3"
	},
	"require-dev": {
 "10up/wp_mock": "^0.4.2",
Expand All@@ -26,12 +26,12 @@
	},
	"autoload": {
 "psr-4": {
 "Yard\\SkeletonPackage\\": "src/"
 "Yard\\BraveChild\\": "src/"
 }
	},
	"autoload-dev": {
 "psr-4": {
 "Yard\\SkeletonPackage\\Tests\\": "tests/"
 "Yard\\BraveChild\\Tests\\": "tests/"
 }
	},
	"scripts": {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Strip utm_, fbclid, gclid, etc. from all links on page\n(function() {\n var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',\n 'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',\n 'ref', 'ref_src', 'source', 'medium', 'campaign'];\n \n function cleanUrl(url) {\n try {\n var u = new URL(url, window.location.origin);\n var changed = false;\n trackingParams.forEach(function(p) {\n if (u.searchParams.has(p)) {\n u.searchParams.delete(p);\n changed = true;\n }\n });\n return changed ? u.toString() : url;\n } catch (e) {\n return url;\n }\n }\n \n function cleanLinks() {\n document.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n \n cleanLinks();\n \n var observer = new MutationObserver(function(mutations) {\n mutations.forEach(function(m) {\n m.addedNodes.forEach(function(node) {\n if (node.nodeType === 1) {\n if (node.tagName === 'A') cleanLinks();\n node.querySelectorAll('a[href]').forEach(function(a) {\n var clean = cleanUrl(a.href);\n if (clean !== a.href) a.href = clean;\n });\n }\n });\n });\n });\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "Remove Tracking Parameters from Links");
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '

Skip to content
(feat) initial version#2

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.

 Sign up for GitHub

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

 Merged

ictbeheer
merged 10 commits into

from

Dec 4, 2024
 Merged


(feat) initial version
#2
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
57976c1

(feat) initial version


ictbeheer Nov 26, 2024
e041a07

(auto): apply php-cs-fixer changes


ictbeheer Nov 26, 2024
770b652

(feat) merge config from parent and child


ictbeheer Nov 28, 2024
602f206

(auto): apply php-cs-fixer changes


ictbeheer Nov 28, 2024
77899ac

(chore) update composer.json


ictbeheer Nov 28, 2024
bb69840

(feat) update readme


ictbeheer Nov 28, 2024
b561ec5

(chore) fix markdown


ictbeheer Dec 4, 2024
640b38a

(chore) remove tests


ictbeheer Dec 4, 2024
c350cdf

(chore) fix PHPstan errors


ictbeheer Dec 4, 2024
c698009

(auto): apply php-cs-fixer changes


ictbeheer Dec 4, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


72 changes: 0 additions & 72 deletions
.github/workflows/badges.yml

View file


Open in desktop


This file was deleted.


20 changes: 0 additions & 20 deletions
.github/workflows/run-tests.yml

View file


Open in desktop


This file was deleted.


106 changes: 71 additions & 35 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,27 +1,17 @@
# Yard :package_name
# Yard Brave Child

[![Code Style](https://github.com/yardinternet/skeleton-package/actions/workflows/format-php.yml/badge.svg?no-cache)](https://github.com/yardinternet/skeleton-package/actions/workflows/format-php.yml)
[![PHPStan](https://github.com/yardinternet/skeleton-package/actions/workflows/phpstan.yml/badge.svg?no-cache)](https://github.com/yardinternet/skeleton-package/actions/workflows/phpstan.yml)
[![Tests](https://github.com/yardinternet/skeleton-package/actions/workflows/run-tests.yml/badge.svg?no-cache)](https://github.com/yardinternet/skeleton-package/actions/workflows/run-tests.yml)
[![Code Coverage Badge](https://github.com/yardinternet/skeleton-package/blob/badges/coverage.svg)](https://github.com/yardinternet/skeleton-package/actions/workflows/badges.yml)
[![Lines of Code Badge](https://github.com/yardinternet/skeleton-package/blob/badges/lines-of-code.svg)](https://github.com/yardinternet/skeleton-package/actions/workflows/badges.yml)
<!-- [![Tests](https://github.com/yardinternet/skeleton-package/actions/workflows/run-tests.yml/badge.svg?no-cache)](https://github.com/yardinternet/skeleton-package/actions/workflows/run-tests.yml) -->
<!-- [![Code Coverage Badge](https://github.com/yardinternet/skeleton-package/blob/badges/coverage.svg)](https://github.com/yardinternet/skeleton-package/actions/workflows/badges.yml) -->

<!--delete-->
---
This repository provides a scaffold for creating an Acorn package. For more detailed information, please refer to the [Acorn Package Development](https://roots.io/acorn/docs/package-development/) documentation.
Classes to use Acorn with child themes:

Follow these steps to get started:

1. Press the "Use this template" button at the top of this repo to create a new repo with the contents of this skeleton.
2. Run "php ./configure.php" to run a script that will replace all placeholders throughout all the files.
3. Have fun creating your package.

---
<!--/delete-->
- WP like inheritance for config files; child config will override parent config
- No directory scans, everything is config based

## Requirements

- [Sage](https://github.com/roots/sage) >= 10.0
- [Acorn](https://github.com/roots/acorn) >= 4.0

## Installation
Expand All@@ -33,38 +23,84 @@ To install this package using Composer, follow these steps:
 ```json
 {
 "type": "vcs",
 "url": "git@github.com:yardinternet/skeleton-package.git"
 "url": "git@github.com:yardinternet/brave-child.git"
 }
 ```

2. Install this package with Composer:

 ```sh
 composer require yard/skeleton-package
 composer require yard/brave-child
 ```

3. Run the Acorn WP-CLI command to discover this package:

 ```shell
 wp acorn package:discover
## Configuration

1. Create a child theme with sage as the parent theme
 [How To Create A Child Theme | Wordpress.org](https://developer.wordpress.org/themes/advanced-topics/child-themes/#how-to-create-a-child-theme) Example `style.css`:

 ```css
 /**
 * Theme Name: Sage Child Theme
 * Template: sage
 * Theme URI: https://www.example.com/sage-child/
 * Description: Sage child theme
 * Version: 1.0.0
 * Author: Example Inc.
 * Author URI: http://www.example.com/
 * Text Domain: sage
 * License: MIT License
 * License URI: https://opensource.org/licenses/MIT
 * Requires PHP: 8.1
 * Requires at least: 5.9
 */
 ```

You can publish the config file with:
2. Add PSR-4 autoloading for your child theme to your composer.json:

```shell
wp acorn vendor:publish --provider="Yard\SkeletonPackage\SkeletonPackageServiceProvider"
```
 ```diff
 "autoload": {
 "psr-4": {
 "App\\": "web/app/themes/sage/app/",
 + "Child\\App\\": "web/app/themes/child-theme/app/",
 }
 },
 ```

## Usage
3. Add the following line to your config:

From a Blade template:
 ```php
 Config::define('ACORN_BASEPATH', Config::get('WP_CONTENT_DIR') . '/themes/sage');
 ```

```blade
@include('skeleton-package::example')
```
4. In `sage/config/app.php` change:

From WP-CLI:
 ```diff
 -use Roots\Acorn\ServiceProvider;
 +use Yard\BraveChild\ServiceProvider;
 ```

```shell
wp acorn example
```
5. In `sage/functions.php` change:

 ```diff
 -\Roots\Bootloader()->boot();
 +$bootloader = \Roots\bootloader();
 +$bootloader->getApplication()->bind(
 + \Roots\Acorn\Bootstrap\LoadConfiguration::class,
 + \Yard\BraveChild\Bootstrap\LoadConfiguration::class
 +);
 +$bootloader->boot();
 ```

6. Add view composers to `config/view.php`

 > [!IMPORTANT]
 > After this change, View Composers in the app/View/Composers directory will no longer be loaded automatically. To ensure they are registered, you have to configure them manually.

 ```diff
 - 'composers' => [],
 + 'composers => [
 + 'app' => App\View\Composers\App::class,
 + 'comments' => App\View\Composers\Comments::class,
 + 'post' => App\View\Composers\Post::class,
 + ],
 ```

10 changes: 5 additions & 5 deletions
composer.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
{
	"name": "yard/skeleton-package",
	"name": "yard/brave-child",
	"type": "package",
	"description": ":package_description",
	"description": "Package to enable Acorn in child themes",
	"license": "MIT",
	"config": {
 "sort-packages": true,
Expand All@@ -14,7 +14,7 @@
	},
Comment thread
ictbeheer marked this conversation as resolved.

	"require": {
 "php": ">=8.1",
 "spatie/laravel-package-tools": "^1.16"
 "roots/acorn": "^4.3"
	},
	"require-dev": {
 "10up/wp_mock": "^0.4.2",
Expand All@@ -26,12 +26,12 @@
	},
	"autoload": {
 "psr-4": {
 "Yard\\SkeletonPackage\\": "src/"
 "Yard\\BraveChild\\": "src/"
 }
	},
	"autoload-dev": {
 "psr-4": {
 "Yard\\SkeletonPackage\\Tests\\": "tests/"
 "Yard\\BraveChild\\Tests\\": "tests/"
 }
	},
	"scripts": {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Auto-enable theater mode on YouTube\n(function() {\n function tryTheater() {\n var btn = document.querySelector('button[aria-label=\"Theater mode\"], ytd-player #player button[title=\"Theater mode\"]');\n if (btn && !btn.classList.contains('activated')) {\n btn.click();\n }\n }\n \n // Try immediately\n tryTheater();\n \n // Try after navigation (SPA)\n var lastUrl = location.href;\n setInterval(function() {\n if (location.href !== lastUrl) {\n lastUrl = location.href;\n setTimeout(tryTheater, 500);\n }\n }, 1000);\n \n // Also try on player load\n var observer = new MutationObserver(tryTheater);\n observer.observe(document.body, { childList: true, subtree: true });\n})();", "YouTube Theater Mode Default");
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
(feat) initial version#2

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.

 Sign up for GitHub

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

 Merged

ictbeheer
merged 10 commits into

from

Dec 4, 2024
 Merged


(feat) initial version
#2
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
57976c1

(feat) initial version


ictbeheer Nov 26, 2024
e041a07

(auto): apply php-cs-fixer changes


ictbeheer Nov 26, 2024
770b652

(feat) merge config from parent and child


ictbeheer Nov 28, 2024
602f206

(auto): apply php-cs-fixer changes


ictbeheer Nov 28, 2024
77899ac

(chore) update composer.json


ictbeheer Nov 28, 2024
bb69840

(feat) update readme


ictbeheer Nov 28, 2024
b561ec5

(chore) fix markdown


ictbeheer Dec 4, 2024
640b38a

(chore) remove tests


ictbeheer Dec 4, 2024
c350cdf

(chore) fix PHPstan errors


ictbeheer Dec 4, 2024
c698009

(auto): apply php-cs-fixer changes


ictbeheer Dec 4, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


72 changes: 0 additions & 72 deletions
.github/workflows/badges.yml

View file


Open in desktop


This file was deleted.


20 changes: 0 additions & 20 deletions
.github/workflows/run-tests.yml

View file


Open in desktop


This file was deleted.


106 changes: 71 additions & 35 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,27 +1,17 @@
# Yard :package_name
# Yard Brave Child

[![Code Style](https://github.com/yardinternet/skeleton-package/actions/workflows/format-php.yml/badge.svg?no-cache)](https://github.com/yardinternet/skeleton-package/actions/workflows/format-php.yml)
[![PHPStan](https://github.com/yardinternet/skeleton-package/actions/workflows/phpstan.yml/badge.svg?no-cache)](https://github.com/yardinternet/skeleton-package/actions/workflows/phpstan.yml)
[![Tests](https://github.com/yardinternet/skeleton-package/actions/workflows/run-tests.yml/badge.svg?no-cache)](https://github.com/yardinternet/skeleton-package/actions/workflows/run-tests.yml)
[![Code Coverage Badge](https://github.com/yardinternet/skeleton-package/blob/badges/coverage.svg)](https://github.com/yardinternet/skeleton-package/actions/workflows/badges.yml)
[![Lines of Code Badge](https://github.com/yardinternet/skeleton-package/blob/badges/lines-of-code.svg)](https://github.com/yardinternet/skeleton-package/actions/workflows/badges.yml)
<!-- [![Tests](https://github.com/yardinternet/skeleton-package/actions/workflows/run-tests.yml/badge.svg?no-cache)](https://github.com/yardinternet/skeleton-package/actions/workflows/run-tests.yml) -->
<!-- [![Code Coverage Badge](https://github.com/yardinternet/skeleton-package/blob/badges/coverage.svg)](https://github.com/yardinternet/skeleton-package/actions/workflows/badges.yml) -->

<!--delete-->
---
This repository provides a scaffold for creating an Acorn package. For more detailed information, please refer to the [Acorn Package Development](https://roots.io/acorn/docs/package-development/) documentation.
Classes to use Acorn with child themes:

Follow these steps to get started:

1. Press the "Use this template" button at the top of this repo to create a new repo with the contents of this skeleton.
2. Run "php ./configure.php" to run a script that will replace all placeholders throughout all the files.
3. Have fun creating your package.

---
<!--/delete-->
- WP like inheritance for config files; child config will override parent config
- No directory scans, everything is config based

## Requirements

- [Sage](https://github.com/roots/sage) >= 10.0
- [Acorn](https://github.com/roots/acorn) >= 4.0

## Installation
Expand All@@ -33,38 +23,84 @@ To install this package using Composer, follow these steps:
 ```json
 {
 "type": "vcs",
 "url": "git@github.com:yardinternet/skeleton-package.git"
 "url": "git@github.com:yardinternet/brave-child.git"
 }
 ```

2. Install this package with Composer:

 ```sh
 composer require yard/skeleton-package
 composer require yard/brave-child
 ```

3. Run the Acorn WP-CLI command to discover this package:

 ```shell
 wp acorn package:discover
## Configuration

1. Create a child theme with sage as the parent theme
 [How To Create A Child Theme | Wordpress.org](https://developer.wordpress.org/themes/advanced-topics/child-themes/#how-to-create-a-child-theme) Example `style.css`:

 ```css
 /**
 * Theme Name: Sage Child Theme
 * Template: sage
 * Theme URI: https://www.example.com/sage-child/
 * Description: Sage child theme
 * Version: 1.0.0
 * Author: Example Inc.
 * Author URI: http://www.example.com/
 * Text Domain: sage
 * License: MIT License
 * License URI: https://opensource.org/licenses/MIT
 * Requires PHP: 8.1
 * Requires at least: 5.9
 */
 ```

You can publish the config file with:
2. Add PSR-4 autoloading for your child theme to your composer.json:

```shell
wp acorn vendor:publish --provider="Yard\SkeletonPackage\SkeletonPackageServiceProvider"
```
 ```diff
 "autoload": {
 "psr-4": {
 "App\\": "web/app/themes/sage/app/",
 + "Child\\App\\": "web/app/themes/child-theme/app/",
 }
 },
 ```

## Usage
3. Add the following line to your config:

From a Blade template:
 ```php
 Config::define('ACORN_BASEPATH', Config::get('WP_CONTENT_DIR') . '/themes/sage');
 ```

```blade
@include('skeleton-package::example')
```
4. In `sage/config/app.php` change:

From WP-CLI:
 ```diff
 -use Roots\Acorn\ServiceProvider;
 +use Yard\BraveChild\ServiceProvider;
 ```

```shell
wp acorn example
```
5. In `sage/functions.php` change:

 ```diff
 -\Roots\Bootloader()->boot();
 +$bootloader = \Roots\bootloader();
 +$bootloader->getApplication()->bind(
 + \Roots\Acorn\Bootstrap\LoadConfiguration::class,
 + \Yard\BraveChild\Bootstrap\LoadConfiguration::class
 +);
 +$bootloader->boot();
 ```

6. Add view composers to `config/view.php`

 > [!IMPORTANT]
 > After this change, View Composers in the app/View/Composers directory will no longer be loaded automatically. To ensure they are registered, you have to configure them manually.

 ```diff
 - 'composers' => [],
 + 'composers => [
 + 'app' => App\View\Composers\App::class,
 + 'comments' => App\View\Composers\Comments::class,
 + 'post' => App\View\Composers\Post::class,
 + ],
 ```

10 changes: 5 additions & 5 deletions
composer.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
{
	"name": "yard/skeleton-package",
	"name": "yard/brave-child",
	"type": "package",
	"description": ":package_description",
	"description": "Package to enable Acorn in child themes",
	"license": "MIT",
	"config": {
 "sort-packages": true,
Expand All@@ -14,7 +14,7 @@
	},
Comment thread
ictbeheer marked this conversation as resolved.

	"require": {
 "php": ">=8.1",
 "spatie/laravel-package-tools": "^1.16"
 "roots/acorn": "^4.3"
	},
	"require-dev": {
 "10up/wp_mock": "^0.4.2",
Expand All@@ -26,12 +26,12 @@
	},
	"autoload": {
 "psr-4": {
 "Yard\\SkeletonPackage\\": "src/"
 "Yard\\BraveChild\\": "src/"
 }
	},
	"autoload-dev": {
 "psr-4": {
 "Yard\\SkeletonPackage\\Tests\\": "tests/"
 "Yard\\BraveChild\\Tests\\": "tests/"
 }
	},
	"scripts": {
Expand Down
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
injectUserscript("// Remove or un-stick sticky/fixed headers that block content\n(function() {\n function unstick() {\n document.querySelectorAll('header, nav, [role=\"banner\"], .header, .navbar, .sticky, .fixed-top, [style*=\"position: fixed\"], [style*=\"position:sticky\"]').forEach(function(el) {\n if (el.style.position === 'fixed' || el.style.position === 'sticky' || \n getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {\n el.style.position = 'static';\n el.style.top = 'auto';\n el.style.zIndex = 'auto';\n }\n });\n }\n \n unstick();\n \n var observer = new MutationObserver(unstick);\n observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });\n})();", "Kill Sticky Headers");
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '

Skip to content
(feat) initial version#2

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.

 Sign up for GitHub

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

 Merged

ictbeheer
merged 10 commits into

from

Dec 4, 2024
 Merged


(feat) initial version
#2
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
57976c1

(feat) initial version


ictbeheer Nov 26, 2024
e041a07

(auto): apply php-cs-fixer changes


ictbeheer Nov 26, 2024
770b652

(feat) merge config from parent and child


ictbeheer Nov 28, 2024
602f206

(auto): apply php-cs-fixer changes


ictbeheer Nov 28, 2024
77899ac

(chore) update composer.json


ictbeheer Nov 28, 2024
bb69840

(feat) update readme


ictbeheer Nov 28, 2024
b561ec5

(chore) fix markdown


ictbeheer Dec 4, 2024
640b38a

(chore) remove tests


ictbeheer Dec 4, 2024
c350cdf

(chore) fix PHPstan errors


ictbeheer Dec 4, 2024
c698009

(auto): apply php-cs-fixer changes


ictbeheer Dec 4, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


72 changes: 0 additions & 72 deletions
.github/workflows/badges.yml

View file


Open in desktop


This file was deleted.


20 changes: 0 additions & 20 deletions
.github/workflows/run-tests.yml

View file


Open in desktop


This file was deleted.


106 changes: 71 additions & 35 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,27 +1,17 @@
# Yard :package_name
# Yard Brave Child

[![Code Style](https://github.com/yardinternet/skeleton-package/actions/workflows/format-php.yml/badge.svg?no-cache)](https://github.com/yardinternet/skeleton-package/actions/workflows/format-php.yml)
[![PHPStan](https://github.com/yardinternet/skeleton-package/actions/workflows/phpstan.yml/badge.svg?no-cache)](https://github.com/yardinternet/skeleton-package/actions/workflows/phpstan.yml)
[![Tests](https://github.com/yardinternet/skeleton-package/actions/workflows/run-tests.yml/badge.svg?no-cache)](https://github.com/yardinternet/skeleton-package/actions/workflows/run-tests.yml)
[![Code Coverage Badge](https://github.com/yardinternet/skeleton-package/blob/badges/coverage.svg)](https://github.com/yardinternet/skeleton-package/actions/workflows/badges.yml)
[![Lines of Code Badge](https://github.com/yardinternet/skeleton-package/blob/badges/lines-of-code.svg)](https://github.com/yardinternet/skeleton-package/actions/workflows/badges.yml)
<!-- [![Tests](https://github.com/yardinternet/skeleton-package/actions/workflows/run-tests.yml/badge.svg?no-cache)](https://github.com/yardinternet/skeleton-package/actions/workflows/run-tests.yml) -->
<!-- [![Code Coverage Badge](https://github.com/yardinternet/skeleton-package/blob/badges/coverage.svg)](https://github.com/yardinternet/skeleton-package/actions/workflows/badges.yml) -->

<!--delete-->
---
This repository provides a scaffold for creating an Acorn package. For more detailed information, please refer to the [Acorn Package Development](https://roots.io/acorn/docs/package-development/) documentation.
Classes to use Acorn with child themes:

Follow these steps to get started:

1. Press the "Use this template" button at the top of this repo to create a new repo with the contents of this skeleton.
2. Run "php ./configure.php" to run a script that will replace all placeholders throughout all the files.
3. Have fun creating your package.

---
<!--/delete-->
- WP like inheritance for config files; child config will override parent config
- No directory scans, everything is config based

## Requirements

- [Sage](https://github.com/roots/sage) >= 10.0
- [Acorn](https://github.com/roots/acorn) >= 4.0

## Installation
Expand All@@ -33,38 +23,84 @@ To install this package using Composer, follow these steps:
 ```json
 {
 "type": "vcs",
 "url": "git@github.com:yardinternet/skeleton-package.git"
 "url": "git@github.com:yardinternet/brave-child.git"
 }
 ```

2. Install this package with Composer:

 ```sh
 composer require yard/skeleton-package
 composer require yard/brave-child
 ```

3. Run the Acorn WP-CLI command to discover this package:

 ```shell
 wp acorn package:discover
## Configuration

1. Create a child theme with sage as the parent theme
 [How To Create A Child Theme | Wordpress.org](https://developer.wordpress.org/themes/advanced-topics/child-themes/#how-to-create-a-child-theme) Example `style.css`:

 ```css
 /**
 * Theme Name: Sage Child Theme
 * Template: sage
 * Theme URI: https://www.example.com/sage-child/
 * Description: Sage child theme
 * Version: 1.0.0
 * Author: Example Inc.
 * Author URI: http://www.example.com/
 * Text Domain: sage
 * License: MIT License
 * License URI: https://opensource.org/licenses/MIT
 * Requires PHP: 8.1
 * Requires at least: 5.9
 */
 ```

You can publish the config file with:
2. Add PSR-4 autoloading for your child theme to your composer.json:

```shell
wp acorn vendor:publish --provider="Yard\SkeletonPackage\SkeletonPackageServiceProvider"
```
 ```diff
 "autoload": {
 "psr-4": {
 "App\\": "web/app/themes/sage/app/",
 + "Child\\App\\": "web/app/themes/child-theme/app/",
 }
 },
 ```

## Usage
3. Add the following line to your config:

From a Blade template:
 ```php
 Config::define('ACORN_BASEPATH', Config::get('WP_CONTENT_DIR') . '/themes/sage');
 ```

```blade
@include('skeleton-package::example')
```
4. In `sage/config/app.php` change:

From WP-CLI:
 ```diff
 -use Roots\Acorn\ServiceProvider;
 +use Yard\BraveChild\ServiceProvider;
 ```

```shell
wp acorn example
```
5. In `sage/functions.php` change:

 ```diff
 -\Roots\Bootloader()->boot();
 +$bootloader = \Roots\bootloader();
 +$bootloader->getApplication()->bind(
 + \Roots\Acorn\Bootstrap\LoadConfiguration::class,
 + \Yard\BraveChild\Bootstrap\LoadConfiguration::class
 +);
 +$bootloader->boot();
 ```

6. Add view composers to `config/view.php`

 > [!IMPORTANT]
 > After this change, View Composers in the app/View/Composers directory will no longer be loaded automatically. To ensure they are registered, you have to configure them manually.

 ```diff
 - 'composers' => [],
 + 'composers => [
 + 'app' => App\View\Composers\App::class,
 + 'comments' => App\View\Composers\Comments::class,
 + 'post' => App\View\Composers\Post::class,
 + ],
 ```

10 changes: 5 additions & 5 deletions
composer.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
{
	"name": "yard/skeleton-package",
	"name": "yard/brave-child",
	"type": "package",
	"description": ":package_description",
	"description": "Package to enable Acorn in child themes",
	"license": "MIT",
	"config": {
 "sort-packages": true,
Expand All@@ -14,7 +14,7 @@
	},
Comment thread
ictbeheer marked this conversation as resolved.

	"require": {
 "php": ">=8.1",
 "spatie/laravel-package-tools": "^1.16"
 "roots/acorn": "^4.3"
	},
	"require-dev": {
 "10up/wp_mock": "^0.4.2",
Expand All@@ -26,12 +26,12 @@
	},
	"autoload": {
 "psr-4": {
 "Yard\\SkeletonPackage\\": "src/"
 "Yard\\BraveChild\\": "src/"
 }
	},
	"autoload-dev": {
 "psr-4": {
 "Yard\\SkeletonPackage\\Tests\\": "tests/"
 "Yard\\BraveChild\\Tests\\": "tests/"
 }
	},
	"scripts": {
Expand Down
Loading

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

Skip to content
(feat) initial version#2

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.

 Sign up for GitHub

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

 Merged

ictbeheer
merged 10 commits into

from

Dec 4, 2024
 Merged


(feat) initial version
#2
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


10 commits


Select commit
Hold shift + click to select a range
57976c1

(feat) initial version


ictbeheer Nov 26, 2024
e041a07

(auto): apply php-cs-fixer changes


ictbeheer Nov 26, 2024
770b652

(feat) merge config from parent and child


ictbeheer Nov 28, 2024
602f206

(auto): apply php-cs-fixer changes


ictbeheer Nov 28, 2024
77899ac

(chore) update composer.json


ictbeheer Nov 28, 2024
bb69840

(feat) update readme


ictbeheer Nov 28, 2024
b561ec5

(chore) fix markdown


ictbeheer Dec 4, 2024
640b38a

(chore) remove tests


ictbeheer Dec 4, 2024
c350cdf

(chore) fix PHPstan errors


ictbeheer Dec 4, 2024
c698009

(auto): apply php-cs-fixer changes


ictbeheer Dec 4, 2024

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


72 changes: 0 additions & 72 deletions
.github/workflows/badges.yml

View file


Open in desktop


This file was deleted.


20 changes: 0 additions & 20 deletions
.github/workflows/run-tests.yml

View file


Open in desktop


This file was deleted.


106 changes: 71 additions & 35 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,27 +1,17 @@
# Yard :package_name
# Yard Brave Child

[![Code Style](https://github.com/yardinternet/skeleton-package/actions/workflows/format-php.yml/badge.svg?no-cache)](https://github.com/yardinternet/skeleton-package/actions/workflows/format-php.yml)
[![PHPStan](https://github.com/yardinternet/skeleton-package/actions/workflows/phpstan.yml/badge.svg?no-cache)](https://github.com/yardinternet/skeleton-package/actions/workflows/phpstan.yml)
[![Tests](https://github.com/yardinternet/skeleton-package/actions/workflows/run-tests.yml/badge.svg?no-cache)](https://github.com/yardinternet/skeleton-package/actions/workflows/run-tests.yml)
[![Code Coverage Badge](https://github.com/yardinternet/skeleton-package/blob/badges/coverage.svg)](https://github.com/yardinternet/skeleton-package/actions/workflows/badges.yml)
[![Lines of Code Badge](https://github.com/yardinternet/skeleton-package/blob/badges/lines-of-code.svg)](https://github.com/yardinternet/skeleton-package/actions/workflows/badges.yml)
<!-- [![Tests](https://github.com/yardinternet/skeleton-package/actions/workflows/run-tests.yml/badge.svg?no-cache)](https://github.com/yardinternet/skeleton-package/actions/workflows/run-tests.yml) -->
<!-- [![Code Coverage Badge](https://github.com/yardinternet/skeleton-package/blob/badges/coverage.svg)](https://github.com/yardinternet/skeleton-package/actions/workflows/badges.yml) -->

<!--delete-->
---
This repository provides a scaffold for creating an Acorn package. For more detailed information, please refer to the [Acorn Package Development](https://roots.io/acorn/docs/package-development/) documentation.
Classes to use Acorn with child themes:

Follow these steps to get started:

1. Press the "Use this template" button at the top of this repo to create a new repo with the contents of this skeleton.
2. Run "php ./configure.php" to run a script that will replace all placeholders throughout all the files.
3. Have fun creating your package.

---
<!--/delete-->
- WP like inheritance for config files; child config will override parent config
- No directory scans, everything is config based

## Requirements

- [Sage](https://github.com/roots/sage) >= 10.0
- [Acorn](https://github.com/roots/acorn) >= 4.0

## Installation
Expand All@@ -33,38 +23,84 @@ To install this package using Composer, follow these steps:
 ```json
 {
 "type": "vcs",
 "url": "git@github.com:yardinternet/skeleton-package.git"
 "url": "git@github.com:yardinternet/brave-child.git"
 }
 ```

2. Install this package with Composer:

 ```sh
 composer require yard/skeleton-package
 composer require yard/brave-child
 ```

3. Run the Acorn WP-CLI command to discover this package:

 ```shell
 wp acorn package:discover
## Configuration

1. Create a child theme with sage as the parent theme
 [How To Create A Child Theme | Wordpress.org](https://developer.wordpress.org/themes/advanced-topics/child-themes/#how-to-create-a-child-theme) Example `style.css`:

 ```css
 /**
 * Theme Name: Sage Child Theme
 * Template: sage
 * Theme URI: https://www.example.com/sage-child/
 * Description: Sage child theme
 * Version: 1.0.0
 * Author: Example Inc.
 * Author URI: http://www.example.com/
 * Text Domain: sage
 * License: MIT License
 * License URI: https://opensource.org/licenses/MIT
 * Requires PHP: 8.1
 * Requires at least: 5.9
 */
 ```

You can publish the config file with:
2. Add PSR-4 autoloading for your child theme to your composer.json:

```shell
wp acorn vendor:publish --provider="Yard\SkeletonPackage\SkeletonPackageServiceProvider"
```
 ```diff
 "autoload": {
 "psr-4": {
 "App\\": "web/app/themes/sage/app/",
 + "Child\\App\\": "web/app/themes/child-theme/app/",
 }
 },
 ```

## Usage
3. Add the following line to your config:

From a Blade template:
 ```php
 Config::define('ACORN_BASEPATH', Config::get('WP_CONTENT_DIR') . '/themes/sage');
 ```

```blade
@include('skeleton-package::example')
```
4. In `sage/config/app.php` change:

From WP-CLI:
 ```diff
 -use Roots\Acorn\ServiceProvider;
 +use Yard\BraveChild\ServiceProvider;
 ```

```shell
wp acorn example
```
5. In `sage/functions.php` change:

 ```diff
 -\Roots\Bootloader()->boot();
 +$bootloader = \Roots\bootloader();
 +$bootloader->getApplication()->bind(
 + \Roots\Acorn\Bootstrap\LoadConfiguration::class,
 + \Yard\BraveChild\Bootstrap\LoadConfiguration::class
 +);
 +$bootloader->boot();
 ```

6. Add view composers to `config/view.php`

 > [!IMPORTANT]
 > After this change, View Composers in the app/View/Composers directory will no longer be loaded automatically. To ensure they are registered, you have to configure them manually.

 ```diff
 - 'composers' => [],
 + 'composers => [
 + 'app' => App\View\Composers\App::class,
 + 'comments' => App\View\Composers\Comments::class,
 + 'post' => App\View\Composers\Post::class,
 + ],
 ```

10 changes: 5 additions & 5 deletions
composer.json

View file


Open in desktop

Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
{
	"name": "yard/skeleton-package",
	"name": "yard/brave-child",
	"type": "package",
	"description": ":package_description",
	"description": "Package to enable Acorn in child themes",
	"license": "MIT",
	"config": {
 "sort-packages": true,
Expand All@@ -14,7 +14,7 @@
	},
Comment thread
ictbeheer marked this conversation as resolved.

	"require": {
 "php": ">=8.1",
 "spatie/laravel-package-tools": "^1.16"
 "roots/acorn": "^4.3"
	},
	"require-dev": {
 "10up/wp_mock": "^0.4.2",
Expand All@@ -26,12 +26,12 @@
	},
	"autoload": {
 "psr-4": {
 "Yard\\SkeletonPackage\\": "src/"
 "Yard\\BraveChild\\": "src/"
 }
	},
	"autoload-dev": {
 "psr-4": {
 "Yard\\SkeletonPackage\\Tests\\": "tests/"
 "Yard\\BraveChild\\Tests\\": "tests/"
 }
	},
	"scripts": {
Expand Down
Loading