upy-fs-hex: Add formatFirst flag to importFilesFromIntelHex.

It erases the filesystem before importing the new files.

Author: microbit-carlos

src/__tests__/micropython-fs-hex.spec.ts

@@ -482,6 +482,45 @@ describe('Test importing files from hex.', () => {
 
     expect(failCase).toThrow(Error);
   });
+
+  it('Enabling formatFirst flag erases the previous files.', () => {
+    const micropythonFs = new MicropythonFsHex(uPyHexFile);
+    micropythonFs.write('old_file.py', 'Some content.');
+
+    const fileList = micropythonFs.importFilesFromIntelHex(
+      hexStrWithFiles,
+      false,
+      true
+    );
+
+    Object.keys(extraFiles).forEach((filename) => {
+      expect(fileList).toContain(filename);
+      expect(micropythonFs.read(filename)).toEqual(extraFiles[filename]);
+    });
+    expect(micropythonFs.ls()).not.toContain('old_file.py');
+  });
+
+  it('Disabling formatFirst flag, and by default, keeps old files.', () => {
+    const micropythonFs = new MicropythonFsHex(uPyHexFile);
+    micropythonFs.write('old_file.py', 'Some content.');
+
+    const fileList1 = micropythonFs.importFilesFromIntelHex(
+      hexStrWithFiles,
+      false
+    );
+    const fileList2 = micropythonFs.importFilesFromIntelHex(
+      hexStrWithFiles,
+      true,
+      false
+    );
+
+    Object.keys(extraFiles).forEach((filename) => {
+      expect(fileList1).toContain(filename);
+      expect(fileList2).toContain(filename);
+      expect(micropythonFs.read(filename)).toEqual(extraFiles[filename]);
+    });
+    expect(micropythonFs.ls()).toContain('old_file.py');
+  });
 });
 
 /*

src/micropython-fs-hex.ts

@@ -152,10 +152,20 @@ export class MicropythonFsHex implements FsInterface {
    *
    * @param intelHex - MicroPython hex string with files.
    * @param overwrite - Flag to overwrite existing files in this instance.
+   * @param formatFirst - Erase all the previous files before importing. It only
+   *     erases the files after there are no error during hex file parsing.
    * @returns A filename list of added files.
    */
-  importFilesFromIntelHex(intelHex: string, overwrite?: boolean): string[] {
+  importFilesFromIntelHex(
+    intelHex: string,
+    overwrite?: boolean,
+    formatFirst?: boolean
+  ): string[] {
     const files = getIntelHexFiles(intelHex);
+    if (formatFirst) {
+      delete this._files;
+      this._files = {};
+    }
     const existingFiles: string[] = [];
     Object.keys(files).forEach((filename) => {
       if (!overwrite && this.exists(filename)) {