Ability to only track folders containing a .wakatime-project file

Author: alanhamlett

README.rst

@@ -60,14 +60,15 @@ format. An example config file with all available options::
     [settings]
     debug = false
     api_key = your-api-key
-    hidefilenames = false
+    hide_filenames = false
     exclude =
         ^COMMIT_EDITMSG$
         ^TAG_EDITMSG$
         ^/var/(?!www/).*
         ^/etc/
     include =
         .*
+    only_include_with_project_file = false
     offline = true
     proxy = https://user:pass@localhost:8080
     no_ssl_verify = false

tests/samples/configs/has_ssl_verify_disabled.cfg

@@ -1,8 +1,8 @@
 [settings]
 verbose = true
 api_key = d491a956-c8f2-44a9-98a7-987814bd71ba
-logfile = /tmp/waka
-hidefilenames = true
+log_file = /tmp/waka
+hide_filenames = true
 exclude =
     ^COMMIT_EDITMSG$
     ^TAG_EDITMSG$

tests/samples/configs/hide_file_names.cfg

@@ -1,6 +1,6 @@
 [settings]
 debug = false
 api_key = 033c47c9-0441-4eb5-8b3f-b51f27b31049
-hidefilenames =
+hide_filenames =
   missingfile
   python\.py$

tests/samples/configs/include_only_with_project_file.cfg

@@ -0,0 +1,3 @@
+[settings]
+api_key = 1090a6ae-855f-4be7-b8fb-3edbaf1aa3ec
+include_only_with_project_file = true

tests/samples/configs/invalid_hide_file_names.cfg

@@ -1,4 +1,4 @@
 [settings]
 debug = false
 api_key = 033c47c9-0441-4eb5-8b3f-b51f27b31049
-hidefilenames = invalid(regex
+hide_filenames = invalid(regex

tests/samples/configs/paranoid.cfg

@@ -12,4 +12,4 @@ include =
     \(invalid regex)
     includeme
 offline = true
-hidefilenames = true
+hide_filenames = true

tests/samples/configs/paranoid_legacy.cfg

@@ -0,0 +1,15 @@
+[settings]
+debug = false
+api_key = c21f8ebd-6a6a-48a0-900b-0870db3d7afe
+api_url = https://api.wakatime.com/api/v1/heartbeats
+ignore =
+    COMMIT_EDITMSG$
+    TAG_EDITMSG$
+exclude =
+    excludeme
+    \(invalid regex)
+include =
+    \(invalid regex)
+    includeme
+offline = true
+hidefilenames = true

tests/samples/output/configs_test_config_file_not_passed_in_command_line_args

@@ -2,8 +2,9 @@ usage: wakatime [-h] [--entity FILE] [--key KEY] [--write] [--plugin PLUGIN]
                 [--time time] [--lineno LINENO] [--cursorpos CURSORPOS]
                 [--entity-type ENTITY_TYPE] [--proxy PROXY] [--no-ssl-verify]
                 [--project PROJECT] [--alternate-project ALTERNATE_PROJECT]
-                [--language LANGUAGE] [--hostname HOSTNAME] [--disableoffline]
-                [--hidefilenames] [--exclude EXCLUDE] [--include INCLUDE]
-                [--extra-heartbeats] [--logfile LOGFILE] [--apiurl API_URL]
+                [--language LANGUAGE] [--hostname HOSTNAME]
+                [--disable-offline] [--hide-filenames] [--exclude EXCLUDE]
+                [--include INCLUDE] [--include-only-with-project-file]
+                [--extra-heartbeats] [--log-file LOG_FILE] [--api-url API_URL]
                 [--timeout TIMEOUT] [--config CONFIG] [--verbose] [--version]
 wakatime: error: Missing api key. Find your api key from wakatime.com/settings.

tests/samples/output/configs_test_missing_config_file

@@ -2,8 +2,9 @@ usage: wakatime [-h] [--entity FILE] [--key KEY] [--write] [--plugin PLUGIN]
                 [--time time] [--lineno LINENO] [--cursorpos CURSORPOS]
                 [--entity-type ENTITY_TYPE] [--proxy PROXY] [--no-ssl-verify]
                 [--project PROJECT] [--alternate-project ALTERNATE_PROJECT]
-                [--language LANGUAGE] [--hostname HOSTNAME] [--disableoffline]
-                [--hidefilenames] [--exclude EXCLUDE] [--include INCLUDE]
-                [--extra-heartbeats] [--logfile LOGFILE] [--apiurl API_URL]
+                [--language LANGUAGE] [--hostname HOSTNAME]
+                [--disable-offline] [--hide-filenames] [--exclude EXCLUDE]
+                [--include INCLUDE] [--include-only-with-project-file]
+                [--extra-heartbeats] [--log-file LOG_FILE] [--api-url API_URL]
                 [--timeout TIMEOUT] [--config CONFIG] [--verbose] [--version]
 wakatime: error: Missing api key. Find your api key from wakatime.com/settings.

tests/samples/output/main_test_timeout_passed_via_command_line

@@ -2,8 +2,9 @@ usage: wakatime [-h] [--entity FILE] [--key KEY] [--write] [--plugin PLUGIN]
                 [--time time] [--lineno LINENO] [--cursorpos CURSORPOS]
                 [--entity-type ENTITY_TYPE] [--proxy PROXY] [--no-ssl-verify]
                 [--project PROJECT] [--alternate-project ALTERNATE_PROJECT]
-                [--language LANGUAGE] [--hostname HOSTNAME] [--disableoffline]
-                [--hidefilenames] [--exclude EXCLUDE] [--include INCLUDE]
-                [--extra-heartbeats] [--logfile LOGFILE] [--apiurl API_URL]
+                [--language LANGUAGE] [--hostname HOSTNAME]
+                [--disable-offline] [--hide-filenames] [--exclude EXCLUDE]
+                [--include INCLUDE] [--include-only-with-project-file]
+                [--extra-heartbeats] [--log-file LOG_FILE] [--api-url API_URL]
                 [--timeout TIMEOUT] [--config CONFIG] [--verbose] [--version]
 wakatime: error: argument --timeout: invalid int value: 'abc'