Added a new "name" configuration option to customize a project name // …

…Resolve #4498
platformio · Jan 14, 2023 · 42f1197 · 42f1197
1 parent 2337dbd
commit 42f1197
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 3 deletions.
diff --git a/HISTORY.rst b/HISTORY.rst
@@ -17,10 +17,11 @@ PlatformIO Core 6
 ~~~~~~~~~~~~~~~~~~
 
 * Added support for Python 3.11
+* Added a new `name <https://docs.platformio.org/en/latest/projectconf/sections/platformio/options/generic/description.html>`__ configuration option to customize a project name (`pull #4498 <https://github.com/platformio/platformio-core/pull/4498>`_)
 * Made assets (templates, ``99-platformio-udev.rules``) part of Python's module (`issue #4458 <https://github.com/platformio/platformio-core/issues/4458>`_)
 * Updated `Clang-Tidy <https://docs.platformio.org/en/latest/plus/check-tools/clang-tidy.html>`__ check tool to v15.0.5 with new diagnostics and bugfixes
 * Removed dependency on the "zeroconf" package and install it only when a user lists mDNS devices (issue with zeroconf's LGPL license)
-* Show the real error message instead of "Can not remove temporary directory" when "platform.ini" is broken (`issue #4480 <https://github.com/platformio/platformio-core/issues/4480>`_)
+* Show the real error message instead of "Can not remove temporary directory" when |PIOCONF| is broken (`issue #4480 <https://github.com/platformio/platformio-core/issues/4480>`_)
 
 6.1.5 (2022-11-01)
 ~~~~~~~~~~~~~~~~~~

diff --git a/docs b/docs
diff --git a/platformio/project/integration/generator.py b/platformio/project/integration/generator.py
@@ -82,7 +82,9 @@ def _load_tplvars(self):
         tpl_vars = {
             "config": self.config,
             "systype": util.get_systype(),
-            "project_name": os.path.basename(self.project_dir),
+            "project_name": self.config.get(
+                "platformio", "name", os.path.basename(self.project_dir)
+            ),
             "project_dir": self.project_dir,
             "original_env_name": self.original_env_name,
             "env_name": self.env_name,

diff --git a/platformio/project/options.py b/platformio/project/options.py
@@ -133,6 +133,11 @@ def get_default_core_dir():
             #
             # [platformio]
             #
+            ConfigPlatformioOption(
+                group="generic",
+                name="name",
+                description="A project name",
+            ),
             ConfigPlatformioOption(
                 group="generic",
                 name="description",