pio extra script: registering my custom option in the config

https://community.platformio.org/t/custom-platformio-ini-options-as-list-str-not-str/34380/7
MacDada · Jun 20, 2023 · 29d08ce · 29d08ce
1 parent f2539f1
commit 29d08ce
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 6 deletions.
diff --git a/scripts/pio_extra_script_helper.py b/scripts/pio_extra_script_helper.py
@@ -3,6 +3,9 @@
 from platformio.compat import MISSING
 from platformio.platform.base import PlatformBase
 from platformio.project.config import ProjectConfigBase
+from platformio.project.config import ProjectOptions
+from platformio.project.options import ConfigEnvOption
+from typing import Callable
 from utils import partition
 
 
@@ -33,15 +36,35 @@ def __init__(self, script_globals: dict):
             self.env,
         ]
 
+    def register_custom_config_option(
+        self,
+        name: str,
+        description: str,
+        default=None,
+        multiple: bool = False,
+        type: Callable = str,
+        processor: Callable = None
+    ) -> None:
+        """
+        https://docs.platformio.org/en/latest/scripting/examples/platformio_ini_custom_options.html
+        https://community.platformio.org/t/custom-platformio-ini-options-as-list-str-not-str/34380/6
+        """
+
+        option = ConfigEnvOption(
+            group='custom',
+            name=name,
+            description=description,
+            type=type,
+            multiple=multiple,
+            default=default,
+            validate=processor,
+        )
+        ProjectOptions['%s.%s' % (option.scope, option.name)] = option
+
     def get_config_value_as_list(self, name: str) -> list[str]:
         """
         https://docs.platformio.org/en/latest/scripting/examples/platformio_ini_custom_options.html
         https://community.platformio.org/t/custom-platformio-ini-options-as-list-str-not-str/34380/2
-
-        todo: why `env.GetProjectOption()` sometimes returns `str` instead of `list[str]`?
-              for example `build_src_flags` returns a list,
-              while my `custom_system_packages` is a string…
-              https://community.platformio.org/t/custom-platformio-ini-options-as-list-str-not-str/34380
         """
 
         return self.get_project_config().parse_multi_values(

diff --git a/scripts/pio_post_extra_script.py b/scripts/pio_post_extra_script.py
@@ -3,6 +3,7 @@
 # https://docs.platformio.org/en/latest/projectconf/sections/env/options/advanced/extra_scripts.html
 # https://docs.platformio.org/en/latest/scripting/actions.html
 
+import click
 from pio_extra_script_helper import Helper
 
 helper = Helper(globals())
@@ -43,6 +44,16 @@
 # https://github.com/platformio/platformio-core/issues/1728#issuecomment-403297776
 helper.env.Append(CXXFLAGS=['-Wno-volatile'])
 
+helper.register_custom_config_option(
+    name='custom_system_packages',
+    description=(
+        'Adds `-isystem` flag for the specified packages. '
+        'As the result, warnings for those packages will be silenced.'
+    ),
+    multiple=True,
+    type=click.Choice(helper.list_available_packages()),
+)
+
 helper.mark_packages_as_system(
-    helper.get_config_value_as_list('custom_system_packages')
+    helper.get_config_value('custom_system_packages')
 )