Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 2 additions & 16 deletions .github/dependabot.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@

version: 2
updates:

# Maintain dependencies for GitHub Actions
- package-ecosystem: "github-actions"
# Workflow files stored in the default location of `.github/workflows`. (You don't need to specify `/.github/workflows` for `directory`. You can use `directory: "/"`.)
Expand All@@ -14,20 +13,7 @@ updates:
patterns:
- "*"
commit-message:
prefix: "(chore)"

# Maintain dependencies for npm
# - package-ecosystem: "npm"
# directory: "/"
# schedule:
# interval: "weekly"
# groups:
# npm:
# patterns:
# - "*"
# commit-message:
# prefix: "(chore)"
# versioning-strategy: lockfile-only
prefix: "chore"

# Maintain dependencies for Composer
- package-ecosystem: "composer"
Expand All@@ -39,5 +25,5 @@ updates:
patterns:
- "*"
commit-message:
prefix: "(chore)"
prefix: "chore"
versioning-strategy: lockfile-only
1 change: 1 addition & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,3 +2,4 @@
.php-cs-fixer.cache
build
vendor
composer.lock
42 changes: 19 additions & 23 deletions README.md
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,26 @@
# Nutshell: Enhanced Acorn Support for WordPress Themes

[![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)
[![Code Style](https://github.com/yardinternet/nutshell/actions/workflows/format-php.yml/badge.svg)](https://github.com/yardinternet/nutshell/actions/workflows/format-php.yml)
[![PHPStan](https://github.com/yardinternet/nutshell/actions/workflows/phpstan.yml/badge.svg?no-cache)](https://github.com/yardinternet/nutshell/actions/workflows/phpstan.yml)
![Packagist Dependency Version](https://img.shields.io/packagist/dependency-v/yard/nutshell/php)
![Packagist Dependency Version](https://img.shields.io/packagist/dependency-v/yard/nutshell/roots%2Facorn)

**Nutshell** is a feature-rich package designed to extend [Acorn](https://roots.io/acorn/) for WordPress themes. It provides a flexible foundation for advanced theme development, including configuration inheritance, Sentry integration, Vite asset support, and more.
**Nutshell** is a feature-rich package designed to extend [Acorn](https://roots.io/acorn/) for WordPress themes. It provides a flexible foundation for advanced theme development, including configuration inheritance, Sentry integration, CSP header support, and more.

## Features

- **Child Theme Configuration Inheritance**:
- Allows child themes to override parent configuration files without directory scans.
- Uses a custom configuration repository to support unsetting and merging config values.
- **Vite Asset Support**:
- Integrates with Vite for modern asset bundling and hot reloading.
- **Sentry Integration**:
- Seamless error reporting via Sentry for Laravel.
- Seamless error reporting via [`sentry/sentry-laravel`](https://github.com/getsentry/sentry-laravel)
- **CSP Integration**:
- Add CSP headers via [`spatie/laravel-csp`](https://github.com/spatie/laravel-csp)
- **Custom View Composers**:
- Manual registration of view composers for fine-grained control.
- **Custom Console Commands**:
- Register custom Artisan commands via configuration.

## Requirements

- PHP >= 8.1
- [Acorn](https://github.com/roots/acorn) ^4.3
- Composer

## Installation

1. Install this package with composer
Expand DownExpand Up@@ -78,12 +74,17 @@

2. **Update Acorn Bootloader**

- In your theme's `functions.php`, use the `Yard\Nutshell\bootloader()` helper to bootstrap Acorn with Nutshell's enhancements.
- In your theme's `functions.php`, use `Yard\Nutshell\Application` to build Acorn with Nutshell's enhancements.

```diff
-\Roots\bootloader()->boot();
+define('ACORN_BASEPATH', __DIR__);
+\Yard\Nutshell\bootloader()->boot();
add_action('after_setup_theme', function () {
- Application::configure()
+ Yard\Nutshell\Application::configure()
->withProviders([
App\Providers\ThemeServiceProvider::class,
])
->boot();
}, 0);
```
Comment on lines 79 to 88

3. **Update app config**
Expand DownExpand Up@@ -116,21 +117,16 @@
+ ],
```

6. **Vite Integration**
- Vite is enabled by default. Use the provided `Yard\Nutshell\Assets\Vite` class for asset management.

7. **Sentry Integration**
- Sentry is automatically integrated if `sentry/sentry-laravel` is installed and configured.
6. **Sentry Integration**
- Sentry is automatically integrated via `sentry/sentry-laravel`.

## Usage

- **Configuration Inheritance**: Any config file in your child theme's `config/` directory will override the parent. Empty config files will unset the corresponding configuration.
- **View Composers**: Register all composers manually in `config/view.php`.
- **Console Commands**: Register all commands manually in `config/console.php`.
- **Vite**: Use the `@vite` directive or helper as usual; Nutshell ensures correct asset paths.
- **Sentry**: Errors and exceptions are reported to Sentry automatically.

## About us

[![banner](https://raw.githubusercontent.com/yardinternet/.github/refs/heads/main/profile/assets/small-banner-github.svg)](https://www.yard.nl/werken-bij/)

13 changes: 5 additions & 8 deletions composer.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,24 +11,21 @@
},
"require": {
"php": ">=8.2",
"roots/acorn": "^4.3",
"roots/acorn": "^5.0",
"sentry/sentry-laravel": "^4.4",
"spatie/laravel-csp": "^2.10",
"yard/logger": "^1.0"
Comment thread
ictbeheer marked this conversation as resolved.
},
"require-dev": {
"larastan/larastan": "^2.9",
"orchestra/testbench": "^8.31",
"szepeviktor/phpstan-wordpress": "^1.3",
"larastan/larastan": "^3.9",
"orchestra/testbench": "^10.11",
"szepeviktor/phpstan-wordpress": "^2.0",
"yard/php-cs-fixer-rules": "^1.0"
},
"autoload": {
"psr-4": {
"Yard\\Nutshell\\": "src/"
},
"files": [
"src/helpers.php"
]
}
},
"scripts": {
"post-autoload-dump": [
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
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 2 additions & 16 deletions .github/dependabot.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@

version: 2
updates:

# Maintain dependencies for GitHub Actions
- package-ecosystem: "github-actions"
# Workflow files stored in the default location of `.github/workflows`. (You don't need to specify `/.github/workflows` for `directory`. You can use `directory: "/"`.)
Expand All@@ -14,20 +13,7 @@ updates:
patterns:
- "*"
commit-message:
prefix: "(chore)"

# Maintain dependencies for npm
# - package-ecosystem: "npm"
# directory: "/"
# schedule:
# interval: "weekly"
# groups:
# npm:
# patterns:
# - "*"
# commit-message:
# prefix: "(chore)"
# versioning-strategy: lockfile-only
prefix: "chore"

# Maintain dependencies for Composer
- package-ecosystem: "composer"
Expand All@@ -39,5 +25,5 @@ updates:
patterns:
- "*"
commit-message:
prefix: "(chore)"
prefix: "chore"
versioning-strategy: lockfile-only
1 change: 1 addition & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,3 +2,4 @@
.php-cs-fixer.cache
build
vendor
composer.lock
42 changes: 19 additions & 23 deletions README.md
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,26 @@
# Nutshell: Enhanced Acorn Support for WordPress Themes

[![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)
[![Code Style](https://github.com/yardinternet/nutshell/actions/workflows/format-php.yml/badge.svg)](https://github.com/yardinternet/nutshell/actions/workflows/format-php.yml)
[![PHPStan](https://github.com/yardinternet/nutshell/actions/workflows/phpstan.yml/badge.svg?no-cache)](https://github.com/yardinternet/nutshell/actions/workflows/phpstan.yml)
![Packagist Dependency Version](https://img.shields.io/packagist/dependency-v/yard/nutshell/php)
![Packagist Dependency Version](https://img.shields.io/packagist/dependency-v/yard/nutshell/roots%2Facorn)

**Nutshell** is a feature-rich package designed to extend [Acorn](https://roots.io/acorn/) for WordPress themes. It provides a flexible foundation for advanced theme development, including configuration inheritance, Sentry integration, Vite asset support, and more.
**Nutshell** is a feature-rich package designed to extend [Acorn](https://roots.io/acorn/) for WordPress themes. It provides a flexible foundation for advanced theme development, including configuration inheritance, Sentry integration, CSP header support, and more.

## Features

- **Child Theme Configuration Inheritance**:
- Allows child themes to override parent configuration files without directory scans.
- Uses a custom configuration repository to support unsetting and merging config values.
- **Vite Asset Support**:
- Integrates with Vite for modern asset bundling and hot reloading.
- **Sentry Integration**:
- Seamless error reporting via Sentry for Laravel.
- Seamless error reporting via [`sentry/sentry-laravel`](https://github.com/getsentry/sentry-laravel)
- **CSP Integration**:
- Add CSP headers via [`spatie/laravel-csp`](https://github.com/spatie/laravel-csp)
- **Custom View Composers**:
- Manual registration of view composers for fine-grained control.
- **Custom Console Commands**:
- Register custom Artisan commands via configuration.

## Requirements

- PHP >= 8.1
- [Acorn](https://github.com/roots/acorn) ^4.3
- Composer

## Installation

1. Install this package with composer
Expand DownExpand Up@@ -78,12 +74,17 @@

2. **Update Acorn Bootloader**

- In your theme's `functions.php`, use the `Yard\Nutshell\bootloader()` helper to bootstrap Acorn with Nutshell's enhancements.
- In your theme's `functions.php`, use `Yard\Nutshell\Application` to build Acorn with Nutshell's enhancements.

```diff
-\Roots\bootloader()->boot();
+define('ACORN_BASEPATH', __DIR__);
+\Yard\Nutshell\bootloader()->boot();
add_action('after_setup_theme', function () {
- Application::configure()
+ Yard\Nutshell\Application::configure()
->withProviders([
App\Providers\ThemeServiceProvider::class,
])
->boot();
}, 0);
```
Comment on lines 79 to 88

3. **Update app config**
Expand DownExpand Up@@ -116,21 +117,16 @@
+ ],
```

6. **Vite Integration**
- Vite is enabled by default. Use the provided `Yard\Nutshell\Assets\Vite` class for asset management.

7. **Sentry Integration**
- Sentry is automatically integrated if `sentry/sentry-laravel` is installed and configured.
6. **Sentry Integration**
- Sentry is automatically integrated via `sentry/sentry-laravel`.

## Usage

- **Configuration Inheritance**: Any config file in your child theme's `config/` directory will override the parent. Empty config files will unset the corresponding configuration.
- **View Composers**: Register all composers manually in `config/view.php`.
- **Console Commands**: Register all commands manually in `config/console.php`.
- **Vite**: Use the `@vite` directive or helper as usual; Nutshell ensures correct asset paths.
- **Sentry**: Errors and exceptions are reported to Sentry automatically.

## About us

[![banner](https://raw.githubusercontent.com/yardinternet/.github/refs/heads/main/profile/assets/small-banner-github.svg)](https://www.yard.nl/werken-bij/)

13 changes: 5 additions & 8 deletions composer.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,24 +11,21 @@
},
"require": {
"php": ">=8.2",
"roots/acorn": "^4.3",
"roots/acorn": "^5.0",
"sentry/sentry-laravel": "^4.4",
"spatie/laravel-csp": "^2.10",
"yard/logger": "^1.0"
Comment thread
ictbeheer marked this conversation as resolved.
},
"require-dev": {
"larastan/larastan": "^2.9",
"orchestra/testbench": "^8.31",
"szepeviktor/phpstan-wordpress": "^1.3",
"larastan/larastan": "^3.9",
"orchestra/testbench": "^10.11",
"szepeviktor/phpstan-wordpress": "^2.0",
"yard/php-cs-fixer-rules": "^1.0"
},
"autoload": {
"psr-4": {
"Yard\\Nutshell\\": "src/"
},
"files": [
"src/helpers.php"
]
}
},
"scripts": {
"post-autoload-dump": [
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
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 2 additions & 16 deletions .github/dependabot.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@

version: 2
updates:

# Maintain dependencies for GitHub Actions
- package-ecosystem: "github-actions"
# Workflow files stored in the default location of `.github/workflows`. (You don't need to specify `/.github/workflows` for `directory`. You can use `directory: "/"`.)
Expand All@@ -14,20 +13,7 @@ updates:
patterns:
- "*"
commit-message:
prefix: "(chore)"

# Maintain dependencies for npm
# - package-ecosystem: "npm"
# directory: "/"
# schedule:
# interval: "weekly"
# groups:
# npm:
# patterns:
# - "*"
# commit-message:
# prefix: "(chore)"
# versioning-strategy: lockfile-only
prefix: "chore"

# Maintain dependencies for Composer
- package-ecosystem: "composer"
Expand All@@ -39,5 +25,5 @@ updates:
patterns:
- "*"
commit-message:
prefix: "(chore)"
prefix: "chore"
versioning-strategy: lockfile-only
1 change: 1 addition & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,3 +2,4 @@
.php-cs-fixer.cache
build
vendor
composer.lock
42 changes: 19 additions & 23 deletions README.md
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,26 @@
# Nutshell: Enhanced Acorn Support for WordPress Themes

[![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)
[![Code Style](https://github.com/yardinternet/nutshell/actions/workflows/format-php.yml/badge.svg)](https://github.com/yardinternet/nutshell/actions/workflows/format-php.yml)
[![PHPStan](https://github.com/yardinternet/nutshell/actions/workflows/phpstan.yml/badge.svg?no-cache)](https://github.com/yardinternet/nutshell/actions/workflows/phpstan.yml)
![Packagist Dependency Version](https://img.shields.io/packagist/dependency-v/yard/nutshell/php)
![Packagist Dependency Version](https://img.shields.io/packagist/dependency-v/yard/nutshell/roots%2Facorn)

**Nutshell** is a feature-rich package designed to extend [Acorn](https://roots.io/acorn/) for WordPress themes. It provides a flexible foundation for advanced theme development, including configuration inheritance, Sentry integration, Vite asset support, and more.
**Nutshell** is a feature-rich package designed to extend [Acorn](https://roots.io/acorn/) for WordPress themes. It provides a flexible foundation for advanced theme development, including configuration inheritance, Sentry integration, CSP header support, and more.

## Features

- **Child Theme Configuration Inheritance**:
- Allows child themes to override parent configuration files without directory scans.
- Uses a custom configuration repository to support unsetting and merging config values.
- **Vite Asset Support**:
- Integrates with Vite for modern asset bundling and hot reloading.
- **Sentry Integration**:
- Seamless error reporting via Sentry for Laravel.
- Seamless error reporting via [`sentry/sentry-laravel`](https://github.com/getsentry/sentry-laravel)
- **CSP Integration**:
- Add CSP headers via [`spatie/laravel-csp`](https://github.com/spatie/laravel-csp)
- **Custom View Composers**:
- Manual registration of view composers for fine-grained control.
- **Custom Console Commands**:
- Register custom Artisan commands via configuration.

## Requirements

- PHP >= 8.1
- [Acorn](https://github.com/roots/acorn) ^4.3
- Composer

## Installation

1. Install this package with composer
Expand DownExpand Up@@ -78,12 +74,17 @@

2. **Update Acorn Bootloader**

- In your theme's `functions.php`, use the `Yard\Nutshell\bootloader()` helper to bootstrap Acorn with Nutshell's enhancements.
- In your theme's `functions.php`, use `Yard\Nutshell\Application` to build Acorn with Nutshell's enhancements.

```diff
-\Roots\bootloader()->boot();
+define('ACORN_BASEPATH', __DIR__);
+\Yard\Nutshell\bootloader()->boot();
add_action('after_setup_theme', function () {
- Application::configure()
+ Yard\Nutshell\Application::configure()
->withProviders([
App\Providers\ThemeServiceProvider::class,
])
->boot();
}, 0);
```
Comment on lines 79 to 88

3. **Update app config**
Expand DownExpand Up@@ -116,21 +117,16 @@
+ ],
```

6. **Vite Integration**
- Vite is enabled by default. Use the provided `Yard\Nutshell\Assets\Vite` class for asset management.

7. **Sentry Integration**
- Sentry is automatically integrated if `sentry/sentry-laravel` is installed and configured.
6. **Sentry Integration**
- Sentry is automatically integrated via `sentry/sentry-laravel`.

## Usage

- **Configuration Inheritance**: Any config file in your child theme's `config/` directory will override the parent. Empty config files will unset the corresponding configuration.
- **View Composers**: Register all composers manually in `config/view.php`.
- **Console Commands**: Register all commands manually in `config/console.php`.
- **Vite**: Use the `@vite` directive or helper as usual; Nutshell ensures correct asset paths.
- **Sentry**: Errors and exceptions are reported to Sentry automatically.

## About us

[![banner](https://raw.githubusercontent.com/yardinternet/.github/refs/heads/main/profile/assets/small-banner-github.svg)](https://www.yard.nl/werken-bij/)

13 changes: 5 additions & 8 deletions composer.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,24 +11,21 @@
},
"require": {
"php": ">=8.2",
"roots/acorn": "^4.3",
"roots/acorn": "^5.0",
"sentry/sentry-laravel": "^4.4",
"spatie/laravel-csp": "^2.10",
"yard/logger": "^1.0"
Comment thread
ictbeheer marked this conversation as resolved.
},
"require-dev": {
"larastan/larastan": "^2.9",
"orchestra/testbench": "^8.31",
"szepeviktor/phpstan-wordpress": "^1.3",
"larastan/larastan": "^3.9",
"orchestra/testbench": "^10.11",
"szepeviktor/phpstan-wordpress": "^2.0",
"yard/php-cs-fixer-rules": "^1.0"
},
"autoload": {
"psr-4": {
"Yard\\Nutshell\\": "src/"
},
"files": [
"src/helpers.php"
]
}
},
"scripts": {
"post-autoload-dump": [
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
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 2 additions & 16 deletions .github/dependabot.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@

version: 2
updates:

# Maintain dependencies for GitHub Actions
- package-ecosystem: "github-actions"
# Workflow files stored in the default location of `.github/workflows`. (You don't need to specify `/.github/workflows` for `directory`. You can use `directory: "/"`.)
Expand All@@ -14,20 +13,7 @@ updates:
patterns:
- "*"
commit-message:
prefix: "(chore)"

# Maintain dependencies for npm
# - package-ecosystem: "npm"
# directory: "/"
# schedule:
# interval: "weekly"
# groups:
# npm:
# patterns:
# - "*"
# commit-message:
# prefix: "(chore)"
# versioning-strategy: lockfile-only
prefix: "chore"

# Maintain dependencies for Composer
- package-ecosystem: "composer"
Expand All@@ -39,5 +25,5 @@ updates:
patterns:
- "*"
commit-message:
prefix: "(chore)"
prefix: "chore"
versioning-strategy: lockfile-only
1 change: 1 addition & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,3 +2,4 @@
.php-cs-fixer.cache
build
vendor
composer.lock
42 changes: 19 additions & 23 deletions README.md
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,26 @@
# Nutshell: Enhanced Acorn Support for WordPress Themes

[![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)
[![Code Style](https://github.com/yardinternet/nutshell/actions/workflows/format-php.yml/badge.svg)](https://github.com/yardinternet/nutshell/actions/workflows/format-php.yml)
[![PHPStan](https://github.com/yardinternet/nutshell/actions/workflows/phpstan.yml/badge.svg?no-cache)](https://github.com/yardinternet/nutshell/actions/workflows/phpstan.yml)
![Packagist Dependency Version](https://img.shields.io/packagist/dependency-v/yard/nutshell/php)
![Packagist Dependency Version](https://img.shields.io/packagist/dependency-v/yard/nutshell/roots%2Facorn)

**Nutshell** is a feature-rich package designed to extend [Acorn](https://roots.io/acorn/) for WordPress themes. It provides a flexible foundation for advanced theme development, including configuration inheritance, Sentry integration, Vite asset support, and more.
**Nutshell** is a feature-rich package designed to extend [Acorn](https://roots.io/acorn/) for WordPress themes. It provides a flexible foundation for advanced theme development, including configuration inheritance, Sentry integration, CSP header support, and more.

## Features

- **Child Theme Configuration Inheritance**:
- Allows child themes to override parent configuration files without directory scans.
- Uses a custom configuration repository to support unsetting and merging config values.
- **Vite Asset Support**:
- Integrates with Vite for modern asset bundling and hot reloading.
- **Sentry Integration**:
- Seamless error reporting via Sentry for Laravel.
- Seamless error reporting via [`sentry/sentry-laravel`](https://github.com/getsentry/sentry-laravel)
- **CSP Integration**:
- Add CSP headers via [`spatie/laravel-csp`](https://github.com/spatie/laravel-csp)
- **Custom View Composers**:
- Manual registration of view composers for fine-grained control.
- **Custom Console Commands**:
- Register custom Artisan commands via configuration.

## Requirements

- PHP >= 8.1
- [Acorn](https://github.com/roots/acorn) ^4.3
- Composer

## Installation

1. Install this package with composer
Expand DownExpand Up@@ -78,12 +74,17 @@

2. **Update Acorn Bootloader**

- In your theme's `functions.php`, use the `Yard\Nutshell\bootloader()` helper to bootstrap Acorn with Nutshell's enhancements.
- In your theme's `functions.php`, use `Yard\Nutshell\Application` to build Acorn with Nutshell's enhancements.

```diff
-\Roots\bootloader()->boot();
+define('ACORN_BASEPATH', __DIR__);
+\Yard\Nutshell\bootloader()->boot();
add_action('after_setup_theme', function () {
- Application::configure()
+ Yard\Nutshell\Application::configure()
->withProviders([
App\Providers\ThemeServiceProvider::class,
])
->boot();
}, 0);
```
Comment on lines 79 to 88

3. **Update app config**
Expand DownExpand Up@@ -116,21 +117,16 @@
+ ],
```

6. **Vite Integration**
- Vite is enabled by default. Use the provided `Yard\Nutshell\Assets\Vite` class for asset management.

7. **Sentry Integration**
- Sentry is automatically integrated if `sentry/sentry-laravel` is installed and configured.
6. **Sentry Integration**
- Sentry is automatically integrated via `sentry/sentry-laravel`.

## Usage

- **Configuration Inheritance**: Any config file in your child theme's `config/` directory will override the parent. Empty config files will unset the corresponding configuration.
- **View Composers**: Register all composers manually in `config/view.php`.
- **Console Commands**: Register all commands manually in `config/console.php`.
- **Vite**: Use the `@vite` directive or helper as usual; Nutshell ensures correct asset paths.
- **Sentry**: Errors and exceptions are reported to Sentry automatically.

## About us

[![banner](https://raw.githubusercontent.com/yardinternet/.github/refs/heads/main/profile/assets/small-banner-github.svg)](https://www.yard.nl/werken-bij/)

13 changes: 5 additions & 8 deletions composer.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,24 +11,21 @@
},
"require": {
"php": ">=8.2",
"roots/acorn": "^4.3",
"roots/acorn": "^5.0",
"sentry/sentry-laravel": "^4.4",
"spatie/laravel-csp": "^2.10",
"yard/logger": "^1.0"
Comment thread
ictbeheer marked this conversation as resolved.
},
"require-dev": {
"larastan/larastan": "^2.9",
"orchestra/testbench": "^8.31",
"szepeviktor/phpstan-wordpress": "^1.3",
"larastan/larastan": "^3.9",
"orchestra/testbench": "^10.11",
"szepeviktor/phpstan-wordpress": "^2.0",
"yard/php-cs-fixer-rules": "^1.0"
},
"autoload": {
"psr-4": {
"Yard\\Nutshell\\": "src/"
},
"files": [
"src/helpers.php"
]
}
},
"scripts": {
"post-autoload-dump": [
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
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 2 additions & 16 deletions .github/dependabot.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@

version: 2
updates:

# Maintain dependencies for GitHub Actions
- package-ecosystem: "github-actions"
# Workflow files stored in the default location of `.github/workflows`. (You don't need to specify `/.github/workflows` for `directory`. You can use `directory: "/"`.)
Expand All@@ -14,20 +13,7 @@ updates:
patterns:
- "*"
commit-message:
prefix: "(chore)"

# Maintain dependencies for npm
# - package-ecosystem: "npm"
# directory: "/"
# schedule:
# interval: "weekly"
# groups:
# npm:
# patterns:
# - "*"
# commit-message:
# prefix: "(chore)"
# versioning-strategy: lockfile-only
prefix: "chore"

# Maintain dependencies for Composer
- package-ecosystem: "composer"
Expand All@@ -39,5 +25,5 @@ updates:
patterns:
- "*"
commit-message:
prefix: "(chore)"
prefix: "chore"
versioning-strategy: lockfile-only
1 change: 1 addition & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,3 +2,4 @@
.php-cs-fixer.cache
build
vendor
composer.lock
42 changes: 19 additions & 23 deletions README.md
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,26 @@
# Nutshell: Enhanced Acorn Support for WordPress Themes

[![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)
[![Code Style](https://github.com/yardinternet/nutshell/actions/workflows/format-php.yml/badge.svg)](https://github.com/yardinternet/nutshell/actions/workflows/format-php.yml)
[![PHPStan](https://github.com/yardinternet/nutshell/actions/workflows/phpstan.yml/badge.svg?no-cache)](https://github.com/yardinternet/nutshell/actions/workflows/phpstan.yml)
![Packagist Dependency Version](https://img.shields.io/packagist/dependency-v/yard/nutshell/php)
![Packagist Dependency Version](https://img.shields.io/packagist/dependency-v/yard/nutshell/roots%2Facorn)

**Nutshell** is a feature-rich package designed to extend [Acorn](https://roots.io/acorn/) for WordPress themes. It provides a flexible foundation for advanced theme development, including configuration inheritance, Sentry integration, Vite asset support, and more.
**Nutshell** is a feature-rich package designed to extend [Acorn](https://roots.io/acorn/) for WordPress themes. It provides a flexible foundation for advanced theme development, including configuration inheritance, Sentry integration, CSP header support, and more.

## Features

- **Child Theme Configuration Inheritance**:
- Allows child themes to override parent configuration files without directory scans.
- Uses a custom configuration repository to support unsetting and merging config values.
- **Vite Asset Support**:
- Integrates with Vite for modern asset bundling and hot reloading.
- **Sentry Integration**:
- Seamless error reporting via Sentry for Laravel.
- Seamless error reporting via [`sentry/sentry-laravel`](https://github.com/getsentry/sentry-laravel)
- **CSP Integration**:
- Add CSP headers via [`spatie/laravel-csp`](https://github.com/spatie/laravel-csp)
- **Custom View Composers**:
- Manual registration of view composers for fine-grained control.
- **Custom Console Commands**:
- Register custom Artisan commands via configuration.

## Requirements

- PHP >= 8.1
- [Acorn](https://github.com/roots/acorn) ^4.3
- Composer

## Installation

1. Install this package with composer
Expand DownExpand Up@@ -78,12 +74,17 @@

2. **Update Acorn Bootloader**

- In your theme's `functions.php`, use the `Yard\Nutshell\bootloader()` helper to bootstrap Acorn with Nutshell's enhancements.
- In your theme's `functions.php`, use `Yard\Nutshell\Application` to build Acorn with Nutshell's enhancements.

```diff
-\Roots\bootloader()->boot();
+define('ACORN_BASEPATH', __DIR__);
+\Yard\Nutshell\bootloader()->boot();
add_action('after_setup_theme', function () {
- Application::configure()
+ Yard\Nutshell\Application::configure()
->withProviders([
App\Providers\ThemeServiceProvider::class,
])
->boot();
}, 0);
```
Comment on lines 79 to 88

3. **Update app config**
Expand DownExpand Up@@ -116,21 +117,16 @@
+ ],
```

6. **Vite Integration**
- Vite is enabled by default. Use the provided `Yard\Nutshell\Assets\Vite` class for asset management.

7. **Sentry Integration**
- Sentry is automatically integrated if `sentry/sentry-laravel` is installed and configured.
6. **Sentry Integration**
- Sentry is automatically integrated via `sentry/sentry-laravel`.

## Usage

- **Configuration Inheritance**: Any config file in your child theme's `config/` directory will override the parent. Empty config files will unset the corresponding configuration.
- **View Composers**: Register all composers manually in `config/view.php`.
- **Console Commands**: Register all commands manually in `config/console.php`.
- **Vite**: Use the `@vite` directive or helper as usual; Nutshell ensures correct asset paths.
- **Sentry**: Errors and exceptions are reported to Sentry automatically.

## About us

[![banner](https://raw.githubusercontent.com/yardinternet/.github/refs/heads/main/profile/assets/small-banner-github.svg)](https://www.yard.nl/werken-bij/)

13 changes: 5 additions & 8 deletions composer.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,24 +11,21 @@
},
"require": {
"php": ">=8.2",
"roots/acorn": "^4.3",
"roots/acorn": "^5.0",
"sentry/sentry-laravel": "^4.4",
"spatie/laravel-csp": "^2.10",
"yard/logger": "^1.0"
Comment thread
ictbeheer marked this conversation as resolved.
},
"require-dev": {
"larastan/larastan": "^2.9",
"orchestra/testbench": "^8.31",
"szepeviktor/phpstan-wordpress": "^1.3",
"larastan/larastan": "^3.9",
"orchestra/testbench": "^10.11",
"szepeviktor/phpstan-wordpress": "^2.0",
"yard/php-cs-fixer-rules": "^1.0"
},
"autoload": {
"psr-4": {
"Yard\\Nutshell\\": "src/"
},
"files": [
"src/helpers.php"
]
}
},
"scripts": {
"post-autoload-dump": [
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
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 2 additions & 16 deletions .github/dependabot.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@

version: 2
updates:

# Maintain dependencies for GitHub Actions
- package-ecosystem: "github-actions"
# Workflow files stored in the default location of `.github/workflows`. (You don't need to specify `/.github/workflows` for `directory`. You can use `directory: "/"`.)
Expand All@@ -14,20 +13,7 @@ updates:
patterns:
- "*"
commit-message:
prefix: "(chore)"

# Maintain dependencies for npm
# - package-ecosystem: "npm"
# directory: "/"
# schedule:
# interval: "weekly"
# groups:
# npm:
# patterns:
# - "*"
# commit-message:
# prefix: "(chore)"
# versioning-strategy: lockfile-only
prefix: "chore"

# Maintain dependencies for Composer
- package-ecosystem: "composer"
Expand All@@ -39,5 +25,5 @@ updates:
patterns:
- "*"
commit-message:
prefix: "(chore)"
prefix: "chore"
versioning-strategy: lockfile-only
1 change: 1 addition & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,3 +2,4 @@
.php-cs-fixer.cache
build
vendor
composer.lock
42 changes: 19 additions & 23 deletions README.md
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,26 @@
# Nutshell: Enhanced Acorn Support for WordPress Themes

[![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)
[![Code Style](https://github.com/yardinternet/nutshell/actions/workflows/format-php.yml/badge.svg)](https://github.com/yardinternet/nutshell/actions/workflows/format-php.yml)
[![PHPStan](https://github.com/yardinternet/nutshell/actions/workflows/phpstan.yml/badge.svg?no-cache)](https://github.com/yardinternet/nutshell/actions/workflows/phpstan.yml)
![Packagist Dependency Version](https://img.shields.io/packagist/dependency-v/yard/nutshell/php)
![Packagist Dependency Version](https://img.shields.io/packagist/dependency-v/yard/nutshell/roots%2Facorn)

**Nutshell** is a feature-rich package designed to extend [Acorn](https://roots.io/acorn/) for WordPress themes. It provides a flexible foundation for advanced theme development, including configuration inheritance, Sentry integration, Vite asset support, and more.
**Nutshell** is a feature-rich package designed to extend [Acorn](https://roots.io/acorn/) for WordPress themes. It provides a flexible foundation for advanced theme development, including configuration inheritance, Sentry integration, CSP header support, and more.

## Features

- **Child Theme Configuration Inheritance**:
- Allows child themes to override parent configuration files without directory scans.
- Uses a custom configuration repository to support unsetting and merging config values.
- **Vite Asset Support**:
- Integrates with Vite for modern asset bundling and hot reloading.
- **Sentry Integration**:
- Seamless error reporting via Sentry for Laravel.
- Seamless error reporting via [`sentry/sentry-laravel`](https://github.com/getsentry/sentry-laravel)
- **CSP Integration**:
- Add CSP headers via [`spatie/laravel-csp`](https://github.com/spatie/laravel-csp)
- **Custom View Composers**:
- Manual registration of view composers for fine-grained control.
- **Custom Console Commands**:
- Register custom Artisan commands via configuration.

## Requirements

- PHP >= 8.1
- [Acorn](https://github.com/roots/acorn) ^4.3
- Composer

## Installation

1. Install this package with composer
Expand DownExpand Up@@ -78,12 +74,17 @@

2. **Update Acorn Bootloader**

- In your theme's `functions.php`, use the `Yard\Nutshell\bootloader()` helper to bootstrap Acorn with Nutshell's enhancements.
- In your theme's `functions.php`, use `Yard\Nutshell\Application` to build Acorn with Nutshell's enhancements.

```diff
-\Roots\bootloader()->boot();
+define('ACORN_BASEPATH', __DIR__);
+\Yard\Nutshell\bootloader()->boot();
add_action('after_setup_theme', function () {
- Application::configure()
+ Yard\Nutshell\Application::configure()
->withProviders([
App\Providers\ThemeServiceProvider::class,
])
->boot();
}, 0);
```
Comment on lines 79 to 88

3. **Update app config**
Expand DownExpand Up@@ -116,21 +117,16 @@
+ ],
```

6. **Vite Integration**
- Vite is enabled by default. Use the provided `Yard\Nutshell\Assets\Vite` class for asset management.

7. **Sentry Integration**
- Sentry is automatically integrated if `sentry/sentry-laravel` is installed and configured.
6. **Sentry Integration**
- Sentry is automatically integrated via `sentry/sentry-laravel`.

## Usage

- **Configuration Inheritance**: Any config file in your child theme's `config/` directory will override the parent. Empty config files will unset the corresponding configuration.
- **View Composers**: Register all composers manually in `config/view.php`.
- **Console Commands**: Register all commands manually in `config/console.php`.
- **Vite**: Use the `@vite` directive or helper as usual; Nutshell ensures correct asset paths.
- **Sentry**: Errors and exceptions are reported to Sentry automatically.

## About us

[![banner](https://raw.githubusercontent.com/yardinternet/.github/refs/heads/main/profile/assets/small-banner-github.svg)](https://www.yard.nl/werken-bij/)

13 changes: 5 additions & 8 deletions composer.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,24 +11,21 @@
},
"require": {
"php": ">=8.2",
"roots/acorn": "^4.3",
"roots/acorn": "^5.0",
"sentry/sentry-laravel": "^4.4",
"spatie/laravel-csp": "^2.10",
"yard/logger": "^1.0"
Comment thread
ictbeheer marked this conversation as resolved.
},
"require-dev": {
"larastan/larastan": "^2.9",
"orchestra/testbench": "^8.31",
"szepeviktor/phpstan-wordpress": "^1.3",
"larastan/larastan": "^3.9",
"orchestra/testbench": "^10.11",
"szepeviktor/phpstan-wordpress": "^2.0",
"yard/php-cs-fixer-rules": "^1.0"
},
"autoload": {
"psr-4": {
"Yard\\Nutshell\\": "src/"
},
"files": [
"src/helpers.php"
]
}
},
"scripts": {
"post-autoload-dump": [
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
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 2 additions & 16 deletions .github/dependabot.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@

version: 2
updates:

# Maintain dependencies for GitHub Actions
- package-ecosystem: "github-actions"
# Workflow files stored in the default location of `.github/workflows`. (You don't need to specify `/.github/workflows` for `directory`. You can use `directory: "/"`.)
Expand All@@ -14,20 +13,7 @@ updates:
patterns:
- "*"
commit-message:
prefix: "(chore)"

# Maintain dependencies for npm
# - package-ecosystem: "npm"
# directory: "/"
# schedule:
# interval: "weekly"
# groups:
# npm:
# patterns:
# - "*"
# commit-message:
# prefix: "(chore)"
# versioning-strategy: lockfile-only
prefix: "chore"

# Maintain dependencies for Composer
- package-ecosystem: "composer"
Expand All@@ -39,5 +25,5 @@ updates:
patterns:
- "*"
commit-message:
prefix: "(chore)"
prefix: "chore"
versioning-strategy: lockfile-only
1 change: 1 addition & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,3 +2,4 @@
.php-cs-fixer.cache
build
vendor
composer.lock
42 changes: 19 additions & 23 deletions README.md
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,26 @@
# Nutshell: Enhanced Acorn Support for WordPress Themes

[![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)
[![Code Style](https://github.com/yardinternet/nutshell/actions/workflows/format-php.yml/badge.svg)](https://github.com/yardinternet/nutshell/actions/workflows/format-php.yml)
[![PHPStan](https://github.com/yardinternet/nutshell/actions/workflows/phpstan.yml/badge.svg?no-cache)](https://github.com/yardinternet/nutshell/actions/workflows/phpstan.yml)
![Packagist Dependency Version](https://img.shields.io/packagist/dependency-v/yard/nutshell/php)
![Packagist Dependency Version](https://img.shields.io/packagist/dependency-v/yard/nutshell/roots%2Facorn)

**Nutshell** is a feature-rich package designed to extend [Acorn](https://roots.io/acorn/) for WordPress themes. It provides a flexible foundation for advanced theme development, including configuration inheritance, Sentry integration, Vite asset support, and more.
**Nutshell** is a feature-rich package designed to extend [Acorn](https://roots.io/acorn/) for WordPress themes. It provides a flexible foundation for advanced theme development, including configuration inheritance, Sentry integration, CSP header support, and more.

## Features

- **Child Theme Configuration Inheritance**:
- Allows child themes to override parent configuration files without directory scans.
- Uses a custom configuration repository to support unsetting and merging config values.
- **Vite Asset Support**:
- Integrates with Vite for modern asset bundling and hot reloading.
- **Sentry Integration**:
- Seamless error reporting via Sentry for Laravel.
- Seamless error reporting via [`sentry/sentry-laravel`](https://github.com/getsentry/sentry-laravel)
- **CSP Integration**:
- Add CSP headers via [`spatie/laravel-csp`](https://github.com/spatie/laravel-csp)
- **Custom View Composers**:
- Manual registration of view composers for fine-grained control.
- **Custom Console Commands**:
- Register custom Artisan commands via configuration.

## Requirements

- PHP >= 8.1
- [Acorn](https://github.com/roots/acorn) ^4.3
- Composer

## Installation

1. Install this package with composer
Expand DownExpand Up@@ -78,12 +74,17 @@

2. **Update Acorn Bootloader**

- In your theme's `functions.php`, use the `Yard\Nutshell\bootloader()` helper to bootstrap Acorn with Nutshell's enhancements.
- In your theme's `functions.php`, use `Yard\Nutshell\Application` to build Acorn with Nutshell's enhancements.

```diff
-\Roots\bootloader()->boot();
+define('ACORN_BASEPATH', __DIR__);
+\Yard\Nutshell\bootloader()->boot();
add_action('after_setup_theme', function () {
- Application::configure()
+ Yard\Nutshell\Application::configure()
->withProviders([
App\Providers\ThemeServiceProvider::class,
])
->boot();
}, 0);
```
Comment on lines 79 to 88

3. **Update app config**
Expand DownExpand Up@@ -116,21 +117,16 @@
+ ],
```

6. **Vite Integration**
- Vite is enabled by default. Use the provided `Yard\Nutshell\Assets\Vite` class for asset management.

7. **Sentry Integration**
- Sentry is automatically integrated if `sentry/sentry-laravel` is installed and configured.
6. **Sentry Integration**
- Sentry is automatically integrated via `sentry/sentry-laravel`.

## Usage

- **Configuration Inheritance**: Any config file in your child theme's `config/` directory will override the parent. Empty config files will unset the corresponding configuration.
- **View Composers**: Register all composers manually in `config/view.php`.
- **Console Commands**: Register all commands manually in `config/console.php`.
- **Vite**: Use the `@vite` directive or helper as usual; Nutshell ensures correct asset paths.
- **Sentry**: Errors and exceptions are reported to Sentry automatically.

## About us

[![banner](https://raw.githubusercontent.com/yardinternet/.github/refs/heads/main/profile/assets/small-banner-github.svg)](https://www.yard.nl/werken-bij/)

13 changes: 5 additions & 8 deletions composer.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,24 +11,21 @@
},
"require": {
"php": ">=8.2",
"roots/acorn": "^4.3",
"roots/acorn": "^5.0",
"sentry/sentry-laravel": "^4.4",
"spatie/laravel-csp": "^2.10",
"yard/logger": "^1.0"
Comment thread
ictbeheer marked this conversation as resolved.
},
"require-dev": {
"larastan/larastan": "^2.9",
"orchestra/testbench": "^8.31",
"szepeviktor/phpstan-wordpress": "^1.3",
"larastan/larastan": "^3.9",
"orchestra/testbench": "^10.11",
"szepeviktor/phpstan-wordpress": "^2.0",
"yard/php-cs-fixer-rules": "^1.0"
},
"autoload": {
"psr-4": {
"Yard\\Nutshell\\": "src/"
},
"files": [
"src/helpers.php"
]
}
},
"scripts": {
"post-autoload-dump": [
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
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
18 changes: 2 additions & 16 deletions .github/dependabot.yml
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,7 +2,6 @@

version: 2
updates:

# Maintain dependencies for GitHub Actions
- package-ecosystem: "github-actions"
# Workflow files stored in the default location of `.github/workflows`. (You don't need to specify `/.github/workflows` for `directory`. You can use `directory: "/"`.)
Expand All@@ -14,20 +13,7 @@ updates:
patterns:
- "*"
commit-message:
prefix: "(chore)"

# Maintain dependencies for npm
# - package-ecosystem: "npm"
# directory: "/"
# schedule:
# interval: "weekly"
# groups:
# npm:
# patterns:
# - "*"
# commit-message:
# prefix: "(chore)"
# versioning-strategy: lockfile-only
prefix: "chore"

# Maintain dependencies for Composer
- package-ecosystem: "composer"
Expand All@@ -39,5 +25,5 @@ updates:
patterns:
- "*"
commit-message:
prefix: "(chore)"
prefix: "chore"
versioning-strategy: lockfile-only
1 change: 1 addition & 0 deletions .gitignore
Original file line numberDiff line numberDiff line change
Expand Up@@ -2,3 +2,4 @@
.php-cs-fixer.cache
build
vendor
composer.lock
42 changes: 19 additions & 23 deletions README.md
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,26 @@
# Nutshell: Enhanced Acorn Support for WordPress Themes

[![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)
[![Code Style](https://github.com/yardinternet/nutshell/actions/workflows/format-php.yml/badge.svg)](https://github.com/yardinternet/nutshell/actions/workflows/format-php.yml)
[![PHPStan](https://github.com/yardinternet/nutshell/actions/workflows/phpstan.yml/badge.svg?no-cache)](https://github.com/yardinternet/nutshell/actions/workflows/phpstan.yml)
![Packagist Dependency Version](https://img.shields.io/packagist/dependency-v/yard/nutshell/php)
![Packagist Dependency Version](https://img.shields.io/packagist/dependency-v/yard/nutshell/roots%2Facorn)

**Nutshell** is a feature-rich package designed to extend [Acorn](https://roots.io/acorn/) for WordPress themes. It provides a flexible foundation for advanced theme development, including configuration inheritance, Sentry integration, Vite asset support, and more.
**Nutshell** is a feature-rich package designed to extend [Acorn](https://roots.io/acorn/) for WordPress themes. It provides a flexible foundation for advanced theme development, including configuration inheritance, Sentry integration, CSP header support, and more.

## Features

- **Child Theme Configuration Inheritance**:
- Allows child themes to override parent configuration files without directory scans.
- Uses a custom configuration repository to support unsetting and merging config values.
- **Vite Asset Support**:
- Integrates with Vite for modern asset bundling and hot reloading.
- **Sentry Integration**:
- Seamless error reporting via Sentry for Laravel.
- Seamless error reporting via [`sentry/sentry-laravel`](https://github.com/getsentry/sentry-laravel)
- **CSP Integration**:
- Add CSP headers via [`spatie/laravel-csp`](https://github.com/spatie/laravel-csp)
- **Custom View Composers**:
- Manual registration of view composers for fine-grained control.
- **Custom Console Commands**:
- Register custom Artisan commands via configuration.

## Requirements

- PHP >= 8.1
- [Acorn](https://github.com/roots/acorn) ^4.3
- Composer

## Installation

1. Install this package with composer
Expand DownExpand Up@@ -78,12 +74,17 @@

2. **Update Acorn Bootloader**

- In your theme's `functions.php`, use the `Yard\Nutshell\bootloader()` helper to bootstrap Acorn with Nutshell's enhancements.
- In your theme's `functions.php`, use `Yard\Nutshell\Application` to build Acorn with Nutshell's enhancements.

```diff
-\Roots\bootloader()->boot();
+define('ACORN_BASEPATH', __DIR__);
+\Yard\Nutshell\bootloader()->boot();
add_action('after_setup_theme', function () {
- Application::configure()
+ Yard\Nutshell\Application::configure()
->withProviders([
App\Providers\ThemeServiceProvider::class,
])
->boot();
}, 0);
```
Comment on lines 79 to 88

3. **Update app config**
Expand DownExpand Up@@ -116,21 +117,16 @@
+ ],
```

6. **Vite Integration**
- Vite is enabled by default. Use the provided `Yard\Nutshell\Assets\Vite` class for asset management.

7. **Sentry Integration**
- Sentry is automatically integrated if `sentry/sentry-laravel` is installed and configured.
6. **Sentry Integration**
- Sentry is automatically integrated via `sentry/sentry-laravel`.

## Usage

- **Configuration Inheritance**: Any config file in your child theme's `config/` directory will override the parent. Empty config files will unset the corresponding configuration.
- **View Composers**: Register all composers manually in `config/view.php`.
- **Console Commands**: Register all commands manually in `config/console.php`.
- **Vite**: Use the `@vite` directive or helper as usual; Nutshell ensures correct asset paths.
- **Sentry**: Errors and exceptions are reported to Sentry automatically.

## About us

[![banner](https://raw.githubusercontent.com/yardinternet/.github/refs/heads/main/profile/assets/small-banner-github.svg)](https://www.yard.nl/werken-bij/)

13 changes: 5 additions & 8 deletions composer.json
Original file line numberDiff line numberDiff line change
Expand Up@@ -11,24 +11,21 @@
},
"require": {
"php": ">=8.2",
"roots/acorn": "^4.3",
"roots/acorn": "^5.0",
"sentry/sentry-laravel": "^4.4",
"spatie/laravel-csp": "^2.10",
"yard/logger": "^1.0"
Comment thread
ictbeheer marked this conversation as resolved.
},
"require-dev": {
"larastan/larastan": "^2.9",
"orchestra/testbench": "^8.31",
"szepeviktor/phpstan-wordpress": "^1.3",
"larastan/larastan": "^3.9",
"orchestra/testbench": "^10.11",
"szepeviktor/phpstan-wordpress": "^2.0",
"yard/php-cs-fixer-rules": "^1.0"
},
"autoload": {
"psr-4": {
"Yard\\Nutshell\\": "src/"
},
"files": [
"src/helpers.php"
]
}
},
"scripts": {
"post-autoload-dump": [
Expand Down
Loading