Add custom KiCad autocomplete list settings

2026-05-18 17:31:35 +00:00 · 2026-04-10 13:19:30 +02:00 · 2026-04-10 13:19:30 +02:00 · 955e622c1a
commit 955e622c1a
parent 2d37330155
12 changed files with 231 additions and 24 deletions
--- a/.gitignore
+++ b/.gitignore
@ -50,4 +50,11 @@ phpstan.neon
 ###< phpstan/phpstan ###

 .claude/
-CLAUDE.md
+CLAUDE.md
+
+.codex
+migrations/.codex
+docker-data/
+scripts/
+db/
+docker-compose.yaml
--- a/docs/usage/eda_integration.md
+++ b/docs/usage/eda_integration.md
@ -67,6 +67,7 @@ You can define this on a per-part basis using the KiCad symbol and KiCad footpri
 For example, to configure the values for a BC547 transistor you would put `Transistor_BJT:BC547` in the part's KiCad symbol field to give it the right schematic symbol in Eeschema and `Package_TO_SOT_THT:TO-92` to give it the right footprint in Pcbnew.

 If you type in a character, you will get an autocomplete list of all symbols and footprints available in the KiCad standard library. You can also input your own value.
+If you want to keep custom suggestions across updates, open the server settings page and use the "Autocomplete settings" page. There you can edit `public/kicad/footprints_custom.txt` and `public/kicad/symbols_custom.txt` and enable the "Use custom autocomplete lists" option to use those files instead of the autogenerated defaults.

 ### Parts and category visibility

--- a/public/kicad/footprints_custom.txt
+++ b/public/kicad/footprints_custom.txt
@ -0,0 +1 @@
+# Custom KiCad autocomplete entries. One entry per line.
--- a/public/kicad/symbols_custom.txt
+++ b/public/kicad/symbols_custom.txt
@ -0,0 +1 @@
+# Custom KiCad autocomplete entries. One entry per line.
--- a/src/Controller/KicadListEditorController.php
+++ b/src/Controller/KicadListEditorController.php
@ -23,7 +23,10 @@ declare(strict_types=1);
 namespace App\Controller;

 use App\Form\Settings\KicadListEditorType;
+use App\Settings\MiscSettings\KiCadEDASettings;
 use App\Services\EDA\KicadListFileManager;
+use Jbtronics\SettingsBundle\Exception\SettingsNotValidException;
+use Jbtronics\SettingsBundle\Manager\SettingsManagerInterface;
 use RuntimeException;
 use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
 use Symfony\Component\HttpFoundation\Request;
@ -34,14 +37,26 @@ use function Symfony\Component\Translation\t;

 final class KicadListEditorController extends AbstractController
 {
+    public function __construct(
+        private readonly SettingsManagerInterface $settingsManager,
+    ) {
+    }
+
    #[Route('/settings/misc/kicad-lists', name: 'settings_kicad_lists')]
    public function __invoke(Request $request, KicadListFileManager $fileManager): Response
    {
+        $this->denyAccessUnlessGranted('IS_AUTHENTICATED_FULLY');
        $this->denyAccessUnlessGranted('@config.change_system_settings');

+        /** @var KiCadEDASettings $settings */
+        $settings = $this->settingsManager->createTemporaryCopy(KiCadEDASettings::class);
        $form = $this->createForm(KicadListEditorType::class, [
-            'footprints' => $fileManager->getFootprintsContent(),
-            'symbols' => $fileManager->getSymbolsContent(),
+            'useCustomList' => $settings->useCustomList,
+            'customFootprints' => $fileManager->getCustomFootprintsContent(),
+            'customSymbols' => $fileManager->getCustomSymbolsContent(),
+        ], [
+            'default_footprints' => $fileManager->getFootprintsContent(),
+            'default_symbols' => $fileManager->getSymbolsContent(),
        ]);

        $form->handleRequest($request);
@ -50,11 +65,14 @@ final class KicadListEditorController extends AbstractController
            $data = $form->getData();

            try {
-                $fileManager->save($data['footprints'], $data['symbols']);
+                $fileManager->saveCustom($data['customFootprints'], $data['customSymbols']);
+                $settings->useCustomList = (bool) $data['useCustomList'];
+                $this->settingsManager->mergeTemporaryCopy($settings);
+                $this->settingsManager->save($settings);
                $this->addFlash('success', t('settings.flash.saved'));

                return $this->redirectToRoute('settings_kicad_lists');
-            } catch (RuntimeException $exception) {
+            } catch (RuntimeException|SettingsNotValidException $exception) {
                $this->addFlash('error', $exception->getMessage());
            }
        }
--- a/src/Form/Part/EDA/KicadFieldAutocompleteType.php
+++ b/src/Form/Part/EDA/KicadFieldAutocompleteType.php
@ -24,6 +24,7 @@ declare(strict_types=1);
 namespace App\Form\Part\EDA;

 use App\Form\Type\StaticFileAutocompleteType;
+use App\Settings\MiscSettings\KiCadEDASettings;
 use Symfony\Component\Form\AbstractType;
 use Symfony\Component\OptionsResolver\Options;
 use Symfony\Component\OptionsResolver\OptionsResolver;
@ -39,6 +40,13 @@ class KicadFieldAutocompleteType extends AbstractType
    //Do not use a leading slash here! otherwise it will not work under prefixed reverse proxies
    public const FOOTPRINT_PATH = 'kicad/footprints.txt';
    public const SYMBOL_PATH = 'kicad/symbols.txt';
+    public const CUSTOM_FOOTPRINT_PATH = 'kicad/footprints_custom.txt';
+    public const CUSTOM_SYMBOL_PATH = 'kicad/symbols_custom.txt';
+
+    public function __construct(
+        private readonly KiCadEDASettings $kiCadEDASettings,
+    ) {
+    }

    public function configureOptions(OptionsResolver $resolver): void
    {
@ -47,8 +55,8 @@ class KicadFieldAutocompleteType extends AbstractType

        $resolver->setDefaults([
            'file' => fn(Options $options) => match ($options['type']) {
-                self::TYPE_FOOTPRINT => self::FOOTPRINT_PATH,
-                self::TYPE_SYMBOL => self::SYMBOL_PATH,
+                self::TYPE_FOOTPRINT => $this->kiCadEDASettings->useCustomList ? self::CUSTOM_FOOTPRINT_PATH : self::FOOTPRINT_PATH,
+                self::TYPE_SYMBOL => $this->kiCadEDASettings->useCustomList ? self::CUSTOM_SYMBOL_PATH : self::SYMBOL_PATH,
                default => throw new \InvalidArgumentException('Invalid type'),
            }
        ]);
@ -58,4 +66,4 @@ class KicadFieldAutocompleteType extends AbstractType
    {
        return StaticFileAutocompleteType::class;
    }
-}
+}
--- a/src/Form/Settings/KicadListEditorType.php
+++ b/src/Form/Settings/KicadListEditorType.php
@ -23,17 +23,24 @@ declare(strict_types=1);
 namespace App\Form\Settings;

 use Symfony\Component\Form\AbstractType;
+use Symfony\Component\Form\Extension\Core\Type\CheckboxType;
 use Symfony\Component\Form\Extension\Core\Type\SubmitType;
 use Symfony\Component\Form\Extension\Core\Type\TextareaType;
 use Symfony\Component\Form\FormBuilderInterface;
+use Symfony\Component\OptionsResolver\OptionsResolver;

 final class KicadListEditorType extends AbstractType
 {
    public function buildForm(FormBuilderInterface $builder, array $options): void
    {
        $builder
-            ->add('footprints', TextareaType::class, [
-                'label' => 'settings.misc.kicad_eda.editor.footprints',
+            ->add('useCustomList', CheckboxType::class, [
+                'label' => 'settings.misc.kicad_eda.use_custom_list',
+                'help' => 'settings.misc.kicad_eda.use_custom_list.help',
+                'required' => false,
+            ])
+            ->add('customFootprints', TextareaType::class, [
+                'label' => 'settings.misc.kicad_eda.editor.custom_footprints',
                'help' => 'settings.misc.kicad_eda.editor.footprints.help',
                'attr' => [
                    'rows' => 16,
@ -41,8 +48,21 @@ final class KicadListEditorType extends AbstractType
                    'class' => 'font-monospace',
                ],
            ])
-            ->add('symbols', TextareaType::class, [
-                'label' => 'settings.misc.kicad_eda.editor.symbols',
+            ->add('defaultFootprints', TextareaType::class, [
+                'label' => 'settings.misc.kicad_eda.editor.default_footprints',
+                'help' => 'settings.misc.kicad_eda.editor.default_files_help',
+                'disabled' => true,
+                'mapped' => false,
+                'data' => $options['default_footprints'],
+                'attr' => [
+                    'rows' => 16,
+                    'spellcheck' => 'false',
+                    'class' => 'font-monospace',
+                    'readonly' => 'readonly',
+                ],
+            ])
+            ->add('customSymbols', TextareaType::class, [
+                'label' => 'settings.misc.kicad_eda.editor.custom_symbols',
                'help' => 'settings.misc.kicad_eda.editor.symbols.help',
                'attr' => [
                    'rows' => 16,
@ -50,8 +70,31 @@ final class KicadListEditorType extends AbstractType
                    'class' => 'font-monospace',
                ],
            ])
+            ->add('defaultSymbols', TextareaType::class, [
+                'label' => 'settings.misc.kicad_eda.editor.default_symbols',
+                'help' => 'settings.misc.kicad_eda.editor.default_files_help',
+                'disabled' => true,
+                'mapped' => false,
+                'data' => $options['default_symbols'],
+                'attr' => [
+                    'rows' => 16,
+                    'spellcheck' => 'false',
+                    'class' => 'font-monospace',
+                    'readonly' => 'readonly',
+                ],
+            ])
            ->add('save', SubmitType::class, [
                'label' => 'save',
            ]);
    }
+
+    public function configureOptions(OptionsResolver $resolver): void
+    {
+        $resolver->setDefaults([
+            'default_footprints' => '',
+            'default_symbols' => '',
+        ]);
+        $resolver->setAllowedTypes('default_footprints', 'string');
+        $resolver->setAllowedTypes('default_symbols', 'string');
+    }
 }
--- a/src/Services/EDA/KicadListFileManager.php
+++ b/src/Services/EDA/KicadListFileManager.php
@ -29,6 +29,8 @@ final class KicadListFileManager
 {
    private const FOOTPRINTS_PATH = '/public/kicad/footprints.txt';
    private const SYMBOLS_PATH = '/public/kicad/symbols.txt';
+    private const CUSTOM_FOOTPRINTS_PATH = '/public/kicad/footprints_custom.txt';
+    private const CUSTOM_SYMBOLS_PATH = '/public/kicad/symbols_custom.txt';

    public function __construct(
        #[Autowire('%kernel.project_dir%')]
@ -41,15 +43,25 @@ final class KicadListFileManager
        return $this->readFile(self::FOOTPRINTS_PATH);
    }

+    public function getCustomFootprintsContent(): string
+    {
+        return $this->readFile(self::CUSTOM_FOOTPRINTS_PATH);
+    }
+
    public function getSymbolsContent(): string
    {
        return $this->readFile(self::SYMBOLS_PATH);
    }

-    public function save(string $footprints, string $symbols): void
+    public function getCustomSymbolsContent(): string
    {
-        $this->writeFile(self::FOOTPRINTS_PATH, $this->normalizeContent($footprints));
-        $this->writeFile(self::SYMBOLS_PATH, $this->normalizeContent($symbols));
+        return $this->readFile(self::CUSTOM_SYMBOLS_PATH);
+    }
+
+    public function saveCustom(string $footprints, string $symbols): void
+    {
+        $this->writeFile(self::CUSTOM_FOOTPRINTS_PATH, $this->normalizeContent($footprints));
+        $this->writeFile(self::CUSTOM_SYMBOLS_PATH, $this->normalizeContent($symbols));
    }

    private function readFile(string $path): string
--- a/src/Settings/MiscSettings/KiCadEDASettings.php
+++ b/src/Settings/MiscSettings/KiCadEDASettings.php
@ -62,4 +62,10 @@ class KiCadEDASettings

    )]
    public bool $defaultOrderdetailsVisibility = false;
+
+    #[SettingsParameter(
+        label: new TM("settings.misc.kicad_eda.use_custom_list"),
+        description: new TM("settings.misc.kicad_eda.use_custom_list.help"),
+    )]
+    public bool $useCustomList = false;
 }
--- a/templates/settings/kicad_list_editor.html.twig
+++ b/templates/settings/kicad_list_editor.html.twig
@ -10,8 +10,19 @@
    </p>

    {{ form_start(form) }}
-    {{ form_row(form.footprints) }}
-    {{ form_row(form.symbols) }}
+    {{ form_row(form.useCustomList) }}
+
+    <div class="row g-3">
+        <div class="col-12 col-xl-6">
+            {{ form_row(form.customFootprints) }}
+            {{ form_row(form.customSymbols) }}
+        </div>
+        <div class="col-12 col-xl-6">
+            {{ form_row(form.defaultFootprints) }}
+            {{ form_row(form.defaultSymbols) }}
+        </div>
+    </div>
+
    {{ form_row(form.save) }}
    {{ form_end(form) }}
 {% endblock %}
--- a/tests/Controller/KicadListEditorControllerTest.php
+++ b/tests/Controller/KicadListEditorControllerTest.php
@ -23,6 +23,8 @@ declare(strict_types=1);
 namespace App\Tests\Controller;

 use App\Entity\UserSystem\User;
+use App\Settings\MiscSettings\KiCadEDASettings;
+use Jbtronics\SettingsBundle\Manager\SettingsManagerInterface;
 use PHPUnit\Framework\Attributes\Group;
 use Symfony\Bundle\FrameworkBundle\Test\WebTestCase;

@ -32,8 +34,13 @@ final class KicadListEditorControllerTest extends WebTestCase
 {
    private string $footprintsPath;
    private string $symbolsPath;
+    private string $customFootprintsPath;
+    private string $customSymbolsPath;
    private string $originalFootprints;
    private string $originalSymbols;
+    private string $originalCustomFootprints;
+    private string $originalCustomSymbols;
+    private bool $originalUseCustomList;

    protected function setUp(): void
    {
@ -42,14 +49,37 @@ final class KicadListEditorControllerTest extends WebTestCase
        $projectDir = dirname(__DIR__, 2);
        $this->footprintsPath = $projectDir . '/public/kicad/footprints.txt';
        $this->symbolsPath = $projectDir . '/public/kicad/symbols.txt';
+        $this->customFootprintsPath = $projectDir . '/public/kicad/footprints_custom.txt';
+        $this->customSymbolsPath = $projectDir . '/public/kicad/symbols_custom.txt';
        $this->originalFootprints = (string) file_get_contents($this->footprintsPath);
        $this->originalSymbols = (string) file_get_contents($this->symbolsPath);
+        $this->originalCustomFootprints = is_file($this->customFootprintsPath) ? (string) file_get_contents($this->customFootprintsPath) : '';
+        $this->originalCustomSymbols = is_file($this->customSymbolsPath) ? (string) file_get_contents($this->customSymbolsPath) : '';
+
+        static::bootKernel();
+        /** @var SettingsManagerInterface $settingsManager */
+        $settingsManager = static::getContainer()->get(SettingsManagerInterface::class);
+        /** @var KiCadEDASettings $settings */
+        $settings = $settingsManager->get(KiCadEDASettings::class);
+        $this->originalUseCustomList = $settings->useCustomList;
+        static::ensureKernelShutdown();
    }

    protected function tearDown(): void
    {
        file_put_contents($this->footprintsPath, $this->originalFootprints);
        file_put_contents($this->symbolsPath, $this->originalSymbols);
+        file_put_contents($this->customFootprintsPath, $this->originalCustomFootprints);
+        file_put_contents($this->customSymbolsPath, $this->originalCustomSymbols);
+
+        static::bootKernel();
+        /** @var SettingsManagerInterface $settingsManager */
+        $settingsManager = static::getContainer()->get(SettingsManagerInterface::class);
+        /** @var KiCadEDASettings $settings */
+        $settings = $settingsManager->get(KiCadEDASettings::class);
+        $settings->useCustomList = $this->originalUseCustomList;
+        $settingsManager->save($settings);
+        static::ensureKernelShutdown();

        parent::tearDown();
    }
@ -73,21 +103,48 @@ final class KicadListEditorControllerTest extends WebTestCase
        $this->assertSelectorExists('form[name="kicad_list_editor"]');
    }

-    public function testEditorSavesFiles(): void
+    public function testEditorShowsDefaultAndCustomFiles(): void
+    {
+        $client = static::createClient();
+        $this->loginAsUser($client, 'admin');
+
+        file_put_contents($this->footprintsPath, "DefaultFootprint\n");
+        file_put_contents($this->symbolsPath, "DefaultSymbol\n");
+        file_put_contents($this->customFootprintsPath, "CustomFootprint\n");
+        file_put_contents($this->customSymbolsPath, "CustomSymbol\n");
+
+        $crawler = $client->request('GET', '/en/settings/misc/kicad-lists');
+
+        $this->assertSame("CustomFootprint\n", $crawler->filter('#kicad_list_editor_customFootprints')->getNode(0)->nodeValue);
+        $this->assertSame("CustomSymbol\n", $crawler->filter('#kicad_list_editor_customSymbols')->getNode(0)->nodeValue);
+        $this->assertSame("DefaultFootprint\n", $crawler->filter('#kicad_list_editor_defaultFootprints')->getNode(0)->nodeValue);
+        $this->assertSame("DefaultSymbol\n", $crawler->filter('#kicad_list_editor_defaultSymbols')->getNode(0)->nodeValue);
+    }
+
+    public function testEditorSavesCustomFilesAndSetting(): void
    {
        $client = static::createClient();
        $this->loginAsUser($client, 'admin');

        $crawler = $client->request('GET', '/en/settings/misc/kicad-lists');
        $form = $crawler->filter('form[name="kicad_list_editor"]')->form();
-        $form['kicad_list_editor[footprints]'] = "Package_DIP:DIP-8_W7.62mm\n";
-        $form['kicad_list_editor[symbols]'] = "Device:R\n";
+        $form['kicad_list_editor[customFootprints]'] = "Package_DIP:DIP-8_W7.62mm\n";
+        $form['kicad_list_editor[customSymbols]'] = "Device:R\n";
+        $form['kicad_list_editor[useCustomList]']->tick();

        $client->submit($form);

        $this->assertResponseRedirects('/en/settings/misc/kicad-lists');
-        $this->assertSame("Package_DIP:DIP-8_W7.62mm\n", (string) file_get_contents($this->footprintsPath));
-        $this->assertSame("Device:R\n", (string) file_get_contents($this->symbolsPath));
+        $this->assertSame("Package_DIP:DIP-8_W7.62mm\n", (string) file_get_contents($this->customFootprintsPath));
+        $this->assertSame("Device:R\n", (string) file_get_contents($this->customSymbolsPath));
+        $this->assertSame($this->originalFootprints, (string) file_get_contents($this->footprintsPath));
+        $this->assertSame($this->originalSymbols, (string) file_get_contents($this->symbolsPath));
+
+        /** @var SettingsManagerInterface $settingsManager */
+        $settingsManager = $client->getContainer()->get(SettingsManagerInterface::class);
+        /** @var KiCadEDASettings $settings */
+        $settings = $settingsManager->reload(KiCadEDASettings::class);
+        $this->assertTrue($settings->useCustomList);
    }

    private function loginAsUser($client, string $username): void
--- a/translations/messages.en.xlf
+++ b/translations/messages.en.xlf
@ -10038,13 +10038,13 @@ Please note, that you can not impersonate a disabled user. If you try you will g
    <unit id="qjv1VVx" name="settings.misc.kicad_eda.editor.link">
      <segment state="translated">
        <source>settings.misc.kicad_eda.editor.link</source>
-        <target>Edit autocomplete lists</target>
+        <target>Autocomplete settings</target>
      </segment>
    </unit>
    <unit id="f0qkcqg" name="settings.misc.kicad_eda.editor.description">
      <segment state="translated">
        <source>settings.misc.kicad_eda.editor.description</source>
-        <target>Edit the contents of public/kicad/footprints.txt and public/kicad/symbols.txt. These files are used by the KiCad autocomplete fields in the admin UI.</target>
+        <target>Configure whether KiCad autocomplete uses the autogenerated default lists or your custom override files. The custom files are editable here, while the default files are shown read-only for reference.</target>
      </segment>
    </unit>
    <unit id="AS3yDlb" name="settings.misc.kicad_eda.editor.footprints">
@ -10071,6 +10071,48 @@ Please note, that you can not impersonate a disabled user. If you try you will g
        <target>One entry per line. Used as autocomplete suggestions for KiCad symbol fields.</target>
      </segment>
    </unit>
+    <unit id="tWYlL0u" name="settings.misc.kicad_eda.use_custom_list">
+      <segment state="translated">
+        <source>settings.misc.kicad_eda.use_custom_list</source>
+        <target>Use custom autocomplete lists</target>
+      </segment>
+    </unit>
+    <unit id="v0LK7n6" name="settings.misc.kicad_eda.use_custom_list.help">
+      <segment state="translated">
+        <source>settings.misc.kicad_eda.use_custom_list.help</source>
+        <target>When enabled, KiCad autocomplete uses public/kicad/footprints_custom.txt and public/kicad/symbols_custom.txt instead of the autogenerated default files.</target>
+      </segment>
+    </unit>
+    <unit id="Yl_fqfV" name="settings.misc.kicad_eda.editor.custom_footprints">
+      <segment state="translated">
+        <source>settings.misc.kicad_eda.editor.custom_footprints</source>
+        <target>Custom footprints list</target>
+      </segment>
+    </unit>
+    <unit id="GuD2JcQ" name="settings.misc.kicad_eda.editor.custom_symbols">
+      <segment state="translated">
+        <source>settings.misc.kicad_eda.editor.custom_symbols</source>
+        <target>Custom symbols list</target>
+      </segment>
+    </unit>
+    <unit id="k6m9b5F" name="settings.misc.kicad_eda.editor.default_footprints">
+      <segment state="translated">
+        <source>settings.misc.kicad_eda.editor.default_footprints</source>
+        <target>Default footprints list</target>
+      </segment>
+    </unit>
+    <unit id="bKkF8mM" name="settings.misc.kicad_eda.editor.default_symbols">
+      <segment state="translated">
+        <source>settings.misc.kicad_eda.editor.default_symbols</source>
+        <target>Default symbols list</target>
+      </segment>
+    </unit>
+    <unit id="mIj_i4E" name="settings.misc.kicad_eda.editor.default_files_help">
+      <segment state="translated">
+        <source>settings.misc.kicad_eda.editor.default_files_help</source>
+        <target>Autogenerated file shown for reference only. Changes must be made in the custom list.</target>
+      </segment>
+    </unit>
    <unit id="VwvmcWE" name="settings.behavior.sidebar">
      <segment state="translated">
        <source>settings.behavior.sidebar</source>
				`@ -0,0 +1 @@`
				`# Custom KiCad autocomplete entries. One entry per line.`