Use relative include, add check

This commit is contained in:
Otto Winter 2019-05-27 13:06:45 +02:00
parent dac624231f
commit 72a80f559a
No known key found for this signature in database
GPG key ID: DB66C0BE6013F97E
19 changed files with 65 additions and 32 deletions

View file

@ -1,4 +1,4 @@
#include "esphome/components/adc/adc_sensor.h" #include "adc_sensor.h"
#include "esphome/core/log.h" #include "esphome/core/log.h"
#ifdef USE_ADC_SENSOR_VCC #ifdef USE_ADC_SENSOR_VCC

View file

@ -1,10 +1,9 @@
import esphome.codegen as cg import esphome.codegen as cg
import esphome.config_validation as cv import esphome.config_validation as cv
from esphome.components import sensor, voltage_sampler from esphome.components import sensor, voltage_sampler
from esphome.components.ads1115 import ADS1115Component
from esphome.const import CONF_GAIN, CONF_MULTIPLEXER, ICON_FLASH, UNIT_VOLT, CONF_ID from esphome.const import CONF_GAIN, CONF_MULTIPLEXER, ICON_FLASH, UNIT_VOLT, CONF_ID
from esphome.py_compat import string_types from esphome.py_compat import string_types
from . import ads1115_ns from . import ads1115_ns, ADS1115Component
DEPENDENCIES = ['ads1115'] DEPENDENCIES = ['ads1115']

View file

@ -1,4 +1,4 @@
#include "esphome/components/binary_sensor/binary_sensor.h" #include "binary_sensor.h"
#include "esphome/core/log.h" #include "esphome/core/log.h"
namespace esphome { namespace esphome {

View file

@ -1,5 +1,5 @@
#include "esphome/components/binary_sensor/filter.h" #include "filter.h"
#include "esphome/components/binary_sensor/binary_sensor.h" #include "binary_sensor.h"
namespace esphome { namespace esphome {

View file

@ -1,4 +1,4 @@
#include "esphome/components/dht/dht.h" #include "dht.h"
#include "esphome/core/log.h" #include "esphome/core/log.h"
#include "esphome/core/helpers.h" #include "esphome/core/helpers.h"

View file

@ -1,10 +1,9 @@
import esphome.codegen as cg import esphome.codegen as cg
import esphome.config_validation as cv import esphome.config_validation as cv
from esphome.components import binary_sensor from esphome.components import binary_sensor
from esphome.components.esp32_touch import ESP32TouchComponent
from esphome.const import CONF_NAME, CONF_PIN, CONF_THRESHOLD, ESP_PLATFORM_ESP32, CONF_ID from esphome.const import CONF_NAME, CONF_PIN, CONF_THRESHOLD, ESP_PLATFORM_ESP32, CONF_ID
from esphome.pins import validate_gpio_pin from esphome.pins import validate_gpio_pin
from . import esp32_touch_ns from . import esp32_touch_ns, ESP32TouchComponent
ESP_PLATFORMS = [ESP_PLATFORM_ESP32] ESP_PLATFORMS = [ESP_PLATFORM_ESP32]
DEPENDENCIES = ['esp32_touch'] DEPENDENCIES = ['esp32_touch']

View file

@ -1,4 +1,4 @@
#include "esphome/components/gpio/binary_sensor/gpio_binary_sensor.h" #include "gpio_binary_sensor.h"
#include "esphome/core/log.h" #include "esphome/core/log.h"
namespace esphome { namespace esphome {

View file

@ -1,4 +1,4 @@
#include "esphome/components/gpio/switch/gpio_switch.h" #include "gpio_switch.h"
#include "esphome/core/log.h" #include "esphome/core/log.h"
namespace esphome { namespace esphome {

View file

@ -1,4 +1,4 @@
#include "esphome/components/logger/logger.h" #include "logger.h"
#ifdef ARDUINO_ARCH_ESP32 #ifdef ARDUINO_ARCH_ESP32
#include <esp_log.h> #include <esp_log.h>

View file

@ -1,8 +1,8 @@
import esphome.codegen as cg import esphome.codegen as cg
import esphome.config_validation as cv import esphome.config_validation as cv
from esphome.components import output from esphome.components import output
from esphome.components.my9231 import MY9231OutputComponent
from esphome.const import CONF_CHANNEL, CONF_ID from esphome.const import CONF_CHANNEL, CONF_ID
from . import MY9231OutputComponent
DEPENDENCIES = ['my9231'] DEPENDENCIES = ['my9231']

View file

@ -1,4 +1,4 @@
#include "esphome/components/ota/ota_component.h" #include "ota_component.h"
#include "esphome/core/log.h" #include "esphome/core/log.h"
#include "esphome/core/helpers.h" #include "esphome/core/helpers.h"

View file

@ -1,5 +1,5 @@
#include "esphome/components/sensor/filter.h" #include "filter.h"
#include "esphome/components/sensor/sensor.h" #include "sensor.h"
#include "esphome/core/log.h" #include "esphome/core/log.h"
namespace esphome { namespace esphome {

View file

@ -1,4 +1,4 @@
#include "esphome/components/sensor/sensor.h" #include "sensor.h"
#include "esphome/core/log.h" #include "esphome/core/log.h"
namespace esphome { namespace esphome {

View file

@ -1,4 +1,4 @@
#include "esphome/components/switch/switch.h" #include "switch.h"
#include "esphome/core/log.h" #include "esphome/core/log.h"
namespace esphome { namespace esphome {

View file

@ -1,4 +1,4 @@
#include "esphome/components/uptime/uptime_sensor.h" #include "uptime_sensor.h"
#include "esphome/core/log.h" #include "esphome/core/log.h"
#include "esphome/core/helpers.h" #include "esphome/core/helpers.h"

View file

@ -1,4 +1,4 @@
#include "esphome/components/wifi/wifi_component.h" #include "wifi_component.h"
#ifdef ARDUINO_ARCH_ESP32 #ifdef ARDUINO_ARCH_ESP32
#include <esp_wifi.h> #include <esp_wifi.h>

View file

@ -1,4 +1,4 @@
#include "esphome/components/wifi/wifi_component.h" #include "wifi_component.h"
#ifdef ARDUINO_ARCH_ESP32 #ifdef ARDUINO_ARCH_ESP32

View file

@ -1,4 +1,4 @@
#include "esphome/components/wifi/wifi_component.h" #include "wifi_component.h"
#ifdef ARDUINO_ARCH_ESP8266 #ifdef ARDUINO_ARCH_ESP8266

View file

@ -86,9 +86,12 @@ def lint_content_find_check(find, **kwargs):
decor = lint_content_check(**kwargs) decor = lint_content_check(**kwargs)
def decorator(func): def decorator(func):
def new_func(content): def new_func(fname, content):
for line, col in find_all(content, find): find_ = find
err = func() if callable(find):
find_ = find(fname, content)
for line, col in find_all(content, find_):
err = func(fname)
return "{err} See line {line}:{col}.".format(err=err, line=line+1, col=col+1) return "{err} See line {line}:{col}.".format(err=err, line=line+1, col=col+1)
return decor(new_func) return decor(new_func)
return decorator return decorator
@ -123,31 +126,63 @@ def lint_executable_bit(fname):
'esphome/dashboard/static/ace.js', 'esphome/dashboard/static/ext-searchbox.js', 'esphome/dashboard/static/ace.js', 'esphome/dashboard/static/ext-searchbox.js',
'script/.neopixelbus.patch', 'script/.neopixelbus.patch',
]) ])
def lint_tabs(): def lint_tabs(fname):
return "File contains tab character. Please convert tabs to spaces." return "File contains tab character. Please convert tabs to spaces."
@lint_content_find_check('\r') @lint_content_find_check('\r')
def lint_newline(): def lint_newline(fname):
return "File contains windows newline. Please set your editor to unix newline mode." return "File contains windows newline. Please set your editor to unix newline mode."
@lint_content_check() @lint_content_check()
def lint_end_newline(content): def lint_end_newline(fname, content):
if content and not content.endswith('\n'): if content and not content.endswith('\n'):
return "File does not end with a newline, please add an empty line at the end of the file." return "File does not end with a newline, please add an empty line at the end of the file."
return None return None
def relative_cpp_search_text(fname, content):
parts = fname.split('/')
integration = parts[2]
return '#include "esphome/components/{}'.format(integration)
@lint_content_find_check(relative_cpp_search_text, include=['esphome/components/*.cpp'])
def lint_relative_cpp_import(fname):
return ("Component contains absolute import - Components must always use "
"relative imports.\n"
"Change:\n"
' #include "esphome/components/abc/abc.h"\n'
'to:\n'
' #include "abc.h"\n\n')
def relative_py_search_text(fname, content):
parts = fname.split('/')
integration = parts[2]
return 'esphome.components.{}'.format(integration)
@lint_content_find_check(relative_py_search_text, include=['esphome/components/*.py'])
def lint_relative_py_import(fname):
return ("Component contains absolute import - Components must always use "
"relative imports within the integration.\n"
"Change:\n"
' from esphome.components.abc import abc_ns"\n'
'to:\n'
' from . import abc_ns\n\n')
@lint_content_find_check('"esphome.h"', include=cpp_include, exclude=['tests/custom.h']) @lint_content_find_check('"esphome.h"', include=cpp_include, exclude=['tests/custom.h'])
def lint_esphome_h(): def lint_esphome_h(fname):
return ("File contains reference to 'esphome.h' - This file is " return ("File contains reference to 'esphome.h' - This file is "
"auto-generated and should only be used for *custom* " "auto-generated and should only be used for *custom* "
"components. Please replace with references to the direct files.") "components. Please replace with references to the direct files.")
@lint_content_check(include=['*.h']) @lint_content_check(include=['*.h'])
def lint_pragma_once(content): def lint_pragma_once(fname, content):
if '#pragma once' not in content: if '#pragma once' not in content:
return ("Header file contains no 'pragma once' header guard. Please add a " return ("Header file contains no 'pragma once' header guard. Please add a "
"'#pragma once' line at the top of the file.") "'#pragma once' line at the top of the file.")
@ -171,7 +206,7 @@ def lint_pragma_once(content):
'esphome/core/log.h', 'esphome/core/log.h',
'tests/custom.h', 'tests/custom.h',
]) ])
def lint_log_in_header(): def lint_log_in_header(fname):
return ('Found reference to ESP_LOG in header file. Using ESP_LOG* in header files ' return ('Found reference to ESP_LOG in header file. Using ESP_LOG* in header files '
'is currently not possible - please move the definition to a source file (.cpp)') 'is currently not possible - please move the definition to a source file (.cpp)')
@ -202,7 +237,7 @@ for fname in files:
except UnicodeDecodeError: except UnicodeDecodeError:
add_errors(fname, "File is not readable as UTF-8. Please set your editor to UTF-8 mode.") add_errors(fname, "File is not readable as UTF-8. Please set your editor to UTF-8 mode.")
continue continue
run_checks(LINT_CONTENT_CHECKS, fname, content) run_checks(LINT_CONTENT_CHECKS, fname, fname, content)
for f, errs in sorted(errors.items()): for f, errs in sorted(errors.items()):
print("\033[0;32m************* File \033[1;32m{}\033[0m".format(f)) print("\033[0;32m************* File \033[1;32m{}\033[0m".format(f))