From c20b4826165fafce14d55f833f0b9833280c8ade Mon Sep 17 00:00:00 2001
From: luxick <git@luxick.de>
Date: Fri, 9 Jan 2026 11:45:27 +0100
Subject: [PATCH] Refactor project structure

---
 README.md                                  |  8 ++++++
 _test/PathTest.php                         |  2 ++
 _test/ScratchpadMapTest.php                |  2 ++
 autoload.php                               | 30 ++++++++++++++++++++++
 file.php                                   |  2 ++
 scratchpad.php                             |  2 ++
 Crawler.php => src/Crawler.php             |  2 +-
 Output.php => src/Output.php               |  0
 Path.php => src/Path.php                   |  0
 ScratchpadMap.php => src/ScratchpadMap.php |  0
 syntax/AbstractSyntax.php                  |  2 ++
 syntax/scratchpad.php                      |  2 ++
 12 files changed, 51 insertions(+), 1 deletion(-)
 create mode 100644 autoload.php
 rename Crawler.php => src/Crawler.php (99%)
 rename Output.php => src/Output.php (100%)
 rename Path.php => src/Path.php (100%)
 rename ScratchpadMap.php => src/ScratchpadMap.php (100%)

diff --git a/README.md b/README.md
index 25e07a0..ee4319b 100644
--- a/README.md
+++ b/README.md
@@ -48,6 +48,14 @@ If you install this plugin manually, make sure it is installed in:
 If the folder is called differently, DokuWiki will not load it.
 
 
+## Project structure (developer notes)
+
+This repository follows DokuWiki's plugin conventions at the top level (e.g. `syntax.php`, `conf/`, `lang/`, endpoints like `file.php`).
+
+Reusable PHP code lives in `src/` and is loaded via `autoload.php`.
+When adding new internal classes under the `dokuwiki\plugin\luxtools\` namespace, place them in `src/<ClassName>.php`.
+
+
 ## Configuration
 
 luxtools is configured via its dedicated admin page:
diff --git a/_test/PathTest.php b/_test/PathTest.php
index 6ecbf4a..5a6fe36 100644
--- a/_test/PathTest.php
+++ b/_test/PathTest.php
@@ -5,6 +5,8 @@ namespace dokuwiki\plugin\luxtools\test;
 use dokuwiki\plugin\luxtools\Path;
 use DokuWikiTest;
 
+require_once(__DIR__ . '/../autoload.php');
+
 /**
  * Path related tests for the luxtools plugin
  *
diff --git a/_test/ScratchpadMapTest.php b/_test/ScratchpadMapTest.php
index 8346450..6a5fb7e 100644
--- a/_test/ScratchpadMapTest.php
+++ b/_test/ScratchpadMapTest.php
@@ -5,6 +5,8 @@ namespace dokuwiki\plugin\luxtools\test;
 use dokuwiki\plugin\luxtools\ScratchpadMap;
 use DokuWikiTest;
 
+require_once(__DIR__ . '/../autoload.php');
+
 /**
  * ScratchpadMap tests for the luxtools plugin
  *
diff --git a/autoload.php b/autoload.php
new file mode 100644
index 0000000..67e4ba3
--- /dev/null
+++ b/autoload.php
@@ -0,0 +1,30 @@
+<?php
+
+/**
+ * luxtools plugin autoloader.
+ *
+ * DokuWiki will often load plugin entrypoints (syntax.php, action.php, ...)
+ * directly. We keep those files small and place reusable code in src/.
+ *
+ * This file registers a minimal autoloader for the plugin namespace.
+ */
+
+spl_autoload_register(static function ($class) {
+    $prefix = 'dokuwiki\\plugin\\luxtools\\';
+    $prefixLen = strlen($prefix);
+
+    if (strncmp($class, $prefix, $prefixLen) !== 0) {
+        return;
+    }
+
+    $relative = substr($class, $prefixLen);
+    if ($relative === '') {
+        return;
+    }
+
+    $file = __DIR__ . '/src/' . str_replace('\\', '/', $relative) . '.php';
+
+    if (is_file($file)) {
+        require_once $file;
+    }
+});
diff --git a/file.php b/file.php
index 04077f3..1819d9e 100644
--- a/file.php
+++ b/file.php
@@ -4,6 +4,8 @@
 
 use dokuwiki\plugin\luxtools\Path;
 
+require_once(__DIR__ . '/autoload.php');
+
 if (!defined('DOKU_INC')) define('DOKU_INC', __DIR__ . '/../../../');
 if (!defined('DOKU_DISABLE_GZIP_OUTPUT')) define('DOKU_DISABLE_GZIP_OUTPUT', 1); // we gzip ourself here
 require_once(DOKU_INC . 'inc/init.php');
diff --git a/scratchpad.php b/scratchpad.php
index 83cab96..f8c83f6 100644
--- a/scratchpad.php
+++ b/scratchpad.php
@@ -5,6 +5,8 @@
 use dokuwiki\plugin\luxtools\Path;
 use dokuwiki\plugin\luxtools\ScratchpadMap;
 
+require_once(__DIR__ . '/autoload.php');
+
 if (!defined('DOKU_INC')) define('DOKU_INC', __DIR__ . '/../../../');
 require_once(DOKU_INC . 'inc/init.php');
 
diff --git a/Crawler.php b/src/Crawler.php
similarity index 99%
rename from Crawler.php
rename to src/Crawler.php
index b0cb486..b994fed 100644
--- a/Crawler.php
+++ b/src/Crawler.php
@@ -280,7 +280,7 @@ class Crawler
      */
     protected function loadIgnores()
     {
-        $file = __DIR__ . '/conf/ignore.txt';
+        $file = __DIR__ . '/../conf/ignore.txt';
         $ignore = file($file, FILE_IGNORE_NEW_LINES | FILE_SKIP_EMPTY_LINES);
         $ignore = array_map(static fn($line) => trim(preg_replace('/\s*#.*$/', '', $line)), $ignore);
         $ignore = array_filter($ignore);
diff --git a/Output.php b/src/Output.php
similarity index 100%
rename from Output.php
rename to src/Output.php
diff --git a/Path.php b/src/Path.php
similarity index 100%
rename from Path.php
rename to src/Path.php
diff --git a/ScratchpadMap.php b/src/ScratchpadMap.php
similarity index 100%
rename from ScratchpadMap.php
rename to src/ScratchpadMap.php
diff --git a/syntax/AbstractSyntax.php b/syntax/AbstractSyntax.php
index 6935531..eceab84 100644
--- a/syntax/AbstractSyntax.php
+++ b/syntax/AbstractSyntax.php
@@ -5,6 +5,8 @@ use dokuwiki\plugin\luxtools\Crawler;
 use dokuwiki\plugin\luxtools\Output;
 use dokuwiki\plugin\luxtools\Path;
 
+require_once(__DIR__ . '/../autoload.php');
+
 /**
  * luxtools Plugin: Abstract base class for file-listing syntax handlers.
  *
diff --git a/syntax/scratchpad.php b/syntax/scratchpad.php
index f2499a7..f05813e 100644
--- a/syntax/scratchpad.php
+++ b/syntax/scratchpad.php
@@ -4,6 +4,8 @@ use dokuwiki\Extension\SyntaxPlugin;
 use dokuwiki\plugin\luxtools\Path;
 use dokuwiki\plugin\luxtools\ScratchpadMap;
 
+require_once(__DIR__ . '/../autoload.php');
+
 /**
  * luxtools Plugin: Scratchpad syntax.
  *