Dawid Nowak
31218060db
ProjectOptionValueError: display the config option description It gives a bit more context of the problem for the user. Example message with the description included: `Error: Invalid value: 'invalid_debug_mode' is not one of 'always', 'modified', 'manual'. for option `debug_load_mode` (Allows one to control when PlatformIO should load debugging firmware to the end target) in section [env:nodemcu]` Co-authored-by: Ivan Kravets <me@ikravets.com>
55 lines
1.7 KiB
Python
55 lines
1.7 KiB
Python
# Copyright (c) 2014-present PlatformIO <contact@platformio.org>
|
|
#
|
|
# Licensed under the Apache License, Version 2.0 (the "License");
|
|
# you may not use this file except in compliance with the License.
|
|
# You may obtain a copy of the License at
|
|
#
|
|
# http://www.apache.org/licenses/LICENSE-2.0
|
|
#
|
|
# Unless required by applicable law or agreed to in writing, software
|
|
# distributed under the License is distributed on an "AS IS" BASIS,
|
|
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
# See the License for the specific language governing permissions and
|
|
# limitations under the License.
|
|
|
|
from platformio.exception import UserSideException
|
|
|
|
|
|
class ProjectError(UserSideException):
|
|
pass
|
|
|
|
|
|
class NotPlatformIOProjectError(ProjectError):
|
|
MESSAGE = (
|
|
"Not a PlatformIO project. `platformio.ini` file has not been "
|
|
"found in current working directory ({0}). To initialize new project "
|
|
"please use `platformio project init` command"
|
|
)
|
|
|
|
|
|
class InvalidProjectConfError(ProjectError):
|
|
MESSAGE = "Invalid '{0}' (project configuration file): '{1}'"
|
|
|
|
|
|
class UndefinedEnvPlatformError(ProjectError):
|
|
MESSAGE = "Please specify platform for '{0}' environment"
|
|
|
|
|
|
class ProjectEnvsNotAvailableError(ProjectError):
|
|
MESSAGE = "Please setup environments in `platformio.ini` file"
|
|
|
|
|
|
class UnknownEnvNamesError(ProjectError):
|
|
MESSAGE = "Unknown environment names '{0}'. Valid names are '{1}'"
|
|
|
|
|
|
class InvalidEnvNameError(ProjectError):
|
|
MESSAGE = (
|
|
"Invalid environment name '{0}'. The name can contain "
|
|
"alphanumeric, underscore, and hyphen characters (a-z, 0-9, -, _)"
|
|
)
|
|
|
|
|
|
class ProjectOptionValueError(ProjectError):
|
|
MESSAGE = "{0} for option `{1}`{2}in section [{3}]"
|