spiffs auto format selector (true by default)

cores/esp8266/Esp.cpp

@@ -25,7 +25,7 @@
 #include "interrupts.h"
 #include "MD5Builder.h"
 #include "umm_malloc/umm_malloc.h"
-#include "cont.h"
+#include "coredecls.h"
 
 extern "C" {
 #include "user_interface.h"
@@ -574,3 +574,11 @@ String EspClass::getSketchMD5()
     result = md5.toString();
     return result;
 }
+
+void EspClass::setAutoFormatSPIFFS (bool autoFormat) {
+    _spiffsAutoFormat = autoFormat;
+}
+
+bool EspClass::getAutoFormatSPIFFS () {
+    return _spiffsAutoFormat;
+}

cores/esp8266/Esp.h

@@ -153,6 +153,9 @@ class EspClass {
         bool eraseConfig();
 
         inline uint32_t getCycleCount();
+
+        bool getAutoFormatSPIFFS ();
+        void setAutoFormatSPIFFS (bool autoFormat);
 };
 
 uint32_t EspClass::getCycleCount()

cores/esp8266/coredecls.h

@@ -12,6 +12,7 @@ extern "C" {
 #include <cont.h> // g_pcont declaration
 
 extern bool timeshift64_is_set;
+extern bool _spiffsAutoFormat;
 
 void esp_yield();
 void esp_schedule();

cores/esp8266/spiffs_api.cpp

@@ -23,6 +23,8 @@
  */
 #include "spiffs_api.h"
 
+bool _spiffsAutoFormat = true;
+
 using namespace fs;
 
 FileImplPtr SPIFFSImpl::open(const char* path, OpenMode openMode, AccessMode accessMode)

cores/esp8266/spiffs_api.h

@@ -32,6 +32,7 @@
 #include "spiffs/spiffs.h"
 #include "debug.h"
 #include "flash_utils.h"
+#include "coredecls.h" // _spiffsAutoFormat
 
 using namespace fs;
 
@@ -124,6 +125,9 @@ class SPIFFSImpl : public FSImpl
         if (_tryMount()) {
             return true;
         }
+        if (!_spiffsAutoFormat) {
+            return false;
+        }
         auto rc = SPIFFS_format(&_fs);
         if (rc != SPIFFS_OK) {
             DEBUGV("SPIFFS_format: rc=%d, err=%d\r\n", rc, _fs.err_code);

doc/filesystem.rst

@@ -136,6 +136,10 @@ This method mounts SPIFFS file system. It must be called before any
 other FS APIs are used. Returns *true* if file system was mounted
 successfully, false otherwise.
 
+This will by default format filesystem when SPIFFS is used the first time. 
+Note that this can be disabled with a call to
+``ESP.setAutoFormatSPIFFS(false);`` prior to ``SPIFFS.begin()``.
+
 end
 ~~~
 

libraries/esp8266/keywords.txt

@@ -60,6 +60,8 @@ getResetInfo	KEYWORD2
 getResetInfoPtr	KEYWORD2
 eraseConfig	KEYWORD2
 getCycleCount	KEYWORD2
+setAutoFormatSPIFFS	KEYWORD2
+getAutoFormatSPIFFS	KEYWORD2
 
 #######################################
 # Constants (LITERAL1)