Type augmentation for mem-fs-editor (#815)

* trying to outsource type fixes

* better?

* use new types for tests

* besser

* better text

* use enhanced mem-fs-editor type everywhere

Co-authored-by: Nicolas Lunet <nicolas.lunet@sap.com>

Author: tobiasqueck

packages/fe-fpm-writer/test/integration/index.test.ts

@@ -246,7 +246,7 @@ describe('use FPM with existing apps', () => {
 
         afterAll(() => {
             expect(
-                (fs as any).dump(testOutput, '**/test-output/**/webapp/{manifest.json,Component.ts,ext/**/*}')
+                fs.dump(testOutput, '**/test-output/**/webapp/{manifest.json,Component.ts,ext/**/*}')
             ).toMatchSnapshot();
         });
     });

packages/fe-fpm-writer/test/unit/building-block.test.ts

@@ -215,7 +215,7 @@ describe('Building Blocks', () => {
                 },
                 fs
             );
-            expect((fs as any).dump(testAppPath)).toMatchSnapshot(
+            expect(fs.dump(testAppPath)).toMatchSnapshot(
                 `generate-${testData.buildingBlockData.buildingBlockType}-with-id-no-macros-ns`
             );
             await writeFilesForDebugging(fs);
@@ -260,7 +260,7 @@ describe('Building Blocks', () => {
                 },
                 fs
             );
-            expect((fs as any).dump(testAppPath)).toMatchSnapshot(
+            expect(fs.dump(testAppPath)).toMatchSnapshot(
                 `generate-${testData.buildingBlockData.buildingBlockType}-with-id`
             );
             await writeFilesForDebugging(fs);
@@ -323,7 +323,7 @@ describe('Building Blocks', () => {
                 },
                 fs
             );
-            expect((fs as any).dump(testAppPath)).toMatchSnapshot(
+            expect(fs.dump(testAppPath)).toMatchSnapshot(
                 `generate-${testData.buildingBlockData.buildingBlockType}-with-optional-params`
             );
             await writeFilesForDebugging(fs);

packages/fe-fpm-writer/tsconfig.json

@@ -1,11 +1,13 @@
 {
     "extends": "../../tsconfig.json",
-    "include": ["src", "src/**/*.json"],
+    "include": [
+        "../../types/mem-fs-editor.d.ts",
+        "src", 
+        "src/**/*.json"
+    ],
     "compilerOptions": {
         "rootDir": "src",
         "outDir": "dist"
     },
-    "references": [
-        { "path": "../project-access" }
-    ]
-}
+    "references": [{ "path": "../project-access" }]
+}

packages/fiori-elements-writer/test/alp.test.ts

@@ -86,7 +86,7 @@ describe(`Fiori Elements template: ${TEST_NAME}`, () => {
     test.each(alpConfigs)('Generate files for template: $name', async ({ name, config }) => {
         const testPath = join(curTestOutPath, name);
         const fs = await generate(testPath, config);
-        expect((fs as any).dump(testPath)).toMatchSnapshot();
+        expect(fs.dump(testPath)).toMatchSnapshot();
 
         return new Promise((resolve) => {
             // write out the files for debugging

packages/fiori-elements-writer/test/feop.test.ts

@@ -47,7 +47,7 @@ describe(`Fiori Elements template: ${TEST_NAME}`, () => {
     test.each(feopConfigs)('Generate files for template: $name', async ({ name, config }) => {
         const testPath = join(curTestOutPath, name);
         const fs = await generate(testPath, config);
-        expect((fs as any).dump(testPath)).toMatchSnapshot();
+        expect(fs.dump(testPath)).toMatchSnapshot();
 
         return new Promise((resolve) => {
             // write out the files for debugging

packages/fiori-elements-writer/test/fpm.test.ts

@@ -55,7 +55,7 @@ describe(`Flexible Programming Model template: ${TEST_NAME}`, () => {
     test.each(fpmConfigs)('Generate files for template: $name', async ({ name, config }) => {
         const testPath = join(curTestOutPath, name);
         const fs = await generate(testPath, config);
-        expect((fs as any).dump(testPath)).toMatchSnapshot();
+        expect(fs.dump(testPath)).toMatchSnapshot();
 
         return new Promise((resolve) => {
             // write out the files for debugging

packages/fiori-elements-writer/test/lrop.test.ts

@@ -179,7 +179,7 @@ describe(`Fiori Elements template: ${TEST_NAME}`, () => {
     test.each(lropConfigs)('Generate files for template: $name', async ({ name, config }) => {
         const testPath = join(curTestOutPath, name);
         const fs = await generate(testPath, config);
-        expect((fs as any).dump(testPath)).toMatchSnapshot();
+        expect(fs.dump(testPath)).toMatchSnapshot();
 
         return new Promise((resolve) => {
             // write out the files for debugging

packages/fiori-elements-writer/test/ovp.test.ts

@@ -71,7 +71,7 @@ describe(`Fiori Elements template: ${TEST_NAME}`, () => {
     test.each(configuration)('Generate files for template: $name', async ({ name, config }) => {
         const testPath = join(curTestOutPath, name);
         const fs = await generate(testPath, config);
-        expect((fs as any).dump(testPath)).toMatchSnapshot();
+        expect(fs.dump(testPath)).toMatchSnapshot();
 
         return new Promise((resolve) => {
             // write out the files for debugging

packages/fiori-elements-writer/test/worklist.test.ts

@@ -56,7 +56,7 @@ describe(`Fiori Elements template: ${TEST_NAME}`, () => {
     test.each(configuration)('Generate files for template: $name', async ({ name, config }) => {
         const testPath = join(curTestOutPath, name);
         const fs = await generate(testPath, config);
-        expect((fs as any).dump(testPath)).toMatchSnapshot();
+        expect(fs.dump(testPath)).toMatchSnapshot();
 
         return new Promise((resolve) => {
             // write out the files for debugging

packages/fiori-elements-writer/tsconfig.json

@@ -1,6 +1,7 @@
 {
     "extends": "../../tsconfig.json",
     "include": [
+        "../../types/mem-fs-editor.d.ts",
         "src",
         "src/**/*.json"
     ],

packages/fiori-freestyle-writer/test/basic.test.ts

@@ -119,7 +119,7 @@ describe(`Fiori freestyle template: ${TEST_NAME}`, () => {
         config.template.settings = settings;
         const testPath = join(curTestOutPath, name);
         const fs = await generate(testPath, config);
-        expect((fs as any).dump(testPath)).toMatchSnapshot();
+        expect(fs.dump(testPath)).toMatchSnapshot();
 
         return new Promise((resolve) => {
             // write out the files for debugging

packages/fiori-freestyle-writer/test/index.test.ts

@@ -103,7 +103,7 @@ describe(`Fiori freestyle templates: ${TEST_NAME}`, () => {
     test.each(configuration)('Generate files for template: $name', async ({ name, config }) => {
         const testPath = join(curTestOutPath, name);
         const fs = await generate(testPath, config);
-        expect((fs as any).dump(testPath)).toMatchSnapshot();
+        expect(fs.dump(testPath)).toMatchSnapshot();
         return new Promise((resolve) => {
             // write out the files for debugging
             if (debug?.enabled) {

packages/fiori-freestyle-writer/test/listdetail.test.ts

@@ -63,7 +63,7 @@ describe(`Fiori freestyle template: ${TEST_NAME}`, () => {
     test.each(configuration)('Generate files for template: $name', async ({ name, config }) => {
         const testPath = join(curTestOutPath, name);
         const fs = await generate(join(testPath), config);
-        expect((fs as any).dump(testPath)).toMatchSnapshot();
+        expect(fs.dump(testPath)).toMatchSnapshot();
         return new Promise((resolve) => {
             // write out the files for debugging
             if (debug?.enabled) {

packages/fiori-freestyle-writer/test/worklist.test.ts

@@ -156,7 +156,7 @@ describe(`Fiori freestyle template: ${TEST_NAME}`, () => {
     test.each(configuration)('Generate files for template: $name', async ({ name, config }) => {
         const testPath = join(curTestOutPath, name);
         const fs = await generate(testPath, config);
-        expect((fs as any).dump(testPath)).toMatchSnapshot();
+        expect(fs.dump(testPath)).toMatchSnapshot();
         return new Promise((resolve) => {
             // write out the files for debugging
             if (debug?.enabled) {

packages/fiori-freestyle-writer/tsconfig.json

@@ -1,6 +1,10 @@
 {
     "extends": "../../tsconfig.json",
-    "include": ["src", "src/**/*.json"],
+    "include": [
+        "../../types/mem-fs-editor.d.ts",
+        "src",
+        "src/**/*.json"
+    ],
     "compilerOptions": {
         "rootDir": "src",
         "outDir": "dist"

packages/odata-service-writer/test/index.test.ts

@@ -67,7 +67,7 @@ describe('ODataService templates', () => {
     it('generate: valid project with standard valid input', async () => {
         const testDir = await createTestDir('odata-service-v2');
         await generate(testDir, validServiceConfig as OdataService, fs);
-        expect((fs as any).dump(testDir)).toMatchSnapshot();
+        expect(fs.dump(testDir)).toMatchSnapshot();
     });
 
     it('generate: project with local annotations', async () => {
@@ -84,6 +84,6 @@ describe('ODataService templates', () => {
 
         const testDir = await createTestDir('local-annotations');
         await generate(testDir, serviceConfigWithAnnotations, fs);
-        expect((fs as any).dump(testDir)).toMatchSnapshot();
+        expect(fs.dump(testDir)).toMatchSnapshot();
     });
 });

packages/odata-service-writer/tsconfig.json

@@ -1,6 +1,10 @@
 {
     "extends": "../../tsconfig.json",
-    "include": ["src", "src/**/*.json"],
+    "include": [
+        "../../types/mem-fs-editor.d.ts",
+        "src", 
+        "src/**/*.json"
+    ],
     "compilerOptions": {
         "rootDir": "src",
         "outDir": "dist",

packages/project-access/src/file/file-search.ts

@@ -3,23 +3,6 @@ import { basename, dirname, join, sep } from 'path';
 import { default as find } from 'findit2';
 import { fileExists } from './file-access';
 
-/**
- * Add missing dump function declaration as mem-fs-editor types do not expose this.
- */
-declare module 'mem-fs-editor' {
-    type FileMap = { [key: string]: { state: 'modified' | 'deleted' } };
-
-    export interface Editor {
-        /**
-         * Dump files to compare expected result. Provide a cwd for relative path.
-         * See also https://github.com/SBoudrias/mem-fs-editor#dumpcwd-filter for further details.
-         *
-         * @param [cwd] - optional, relative path
-         */
-        dump(cwd?: string): FileMap;
-    }
-}
-
 /**
  * Creates a filter function that removes files that have been deleted in an instance of a mem-fs-editor.
  *

packages/project-access/tsconfig.json

@@ -1,6 +1,7 @@
 {
     "extends": "../../tsconfig.json",
     "include": [
+        "../../types/mem-fs-editor.d.ts",
         "src"
     ],
     "compilerOptions": {

packages/ui5-application-writer/test/index.test.ts

@@ -46,7 +46,7 @@ describe('UI5 templates', () => {
     it('generates files correctly', async () => {
         let projectDir = join(outputDir, 'testapp-simple');
         await generate(projectDir, ui5AppConfig, fs);
-        expect((fs as any).dump(projectDir)).toMatchSnapshot();
+        expect(fs.dump(projectDir)).toMatchSnapshot();
 
         // Test `sap.app.sourceTemplate.toolsId` is correctly written
         ui5AppConfig.app.sourceTemplate = {

packages/ui5-application-writer/test/options.test.ts

@@ -31,7 +31,7 @@ describe('UI5 templates', () => {
                 sapux: true
             }
         });
-        expect((fs as any).dump(projectDir)).toMatchSnapshot();
+        expect(fs.dump(projectDir)).toMatchSnapshot();
         return new Promise((resolve) => {
             // write out the files for debugging
             if (debug) {
@@ -50,7 +50,7 @@ describe('UI5 templates', () => {
                 loadReuseLibs: true
             }
         });
-        expect((fs as any).dump(projectDir)).toMatchSnapshot();
+        expect(fs.dump(projectDir)).toMatchSnapshot();
         return new Promise((resolve) => {
             // write out the files for debugging
             if (debug) {
@@ -72,7 +72,7 @@ describe('UI5 templates', () => {
                 version: '1.92.1'
             }
         });
-        expect((fs as any).dump(projectDir)).toMatchSnapshot();
+        expect(fs.dump(projectDir)).toMatchSnapshot();
         return new Promise((resolve) => {
             // write out the files for debugging
             if (debug) {
@@ -95,7 +95,7 @@ describe('UI5 templates', () => {
                 }
             })
         );
-        expect((fs as any).dump(projectDir)).toMatchSnapshot();
+        expect(fs.dump(projectDir)).toMatchSnapshot();
         return new Promise((resolve) => {
             // write out the files for debugging
             if (debug) {

packages/ui5-application-writer/tsconfig.json

@@ -1,6 +1,7 @@
 {
     "extends": "../../tsconfig.json",
     "include": [
+        "../../types/mem-fs-editor.d.ts",
         "src",
         "src/**/*.json"
     ],

packages/ui5-test-writer/test/integration/index.test.ts

@@ -91,6 +91,6 @@ describe('ui5-test-writer - Integration tests', () => {
         );
         fs = await generatePageObjectFile(projectDir, { targetKey: 'EmployeesCustomPage' }, fs);
 
-        expect((fs as any).dump(projectDir)).toMatchSnapshot();
+        expect(fs.dump(projectDir)).toMatchSnapshot();
     });
 });

packages/ui5-test-writer/test/unit/index.test.ts

@@ -80,7 +80,7 @@ describe('ui5-test-writer', () => {
         it.each(testPages)('$description', async (config) => {
             const projectDir = prepareTestFiles('Pages');
             fs = await generatePageObjectFile(projectDir, { targetKey: config.targetKey }, fs);
-            expect((fs as any).dump(projectDir)).toMatchSnapshot();
+            expect(fs.dump(projectDir)).toMatchSnapshot();
         });
 
         it.each(testUnsupportedPages)('$description', async (config) => {
@@ -114,7 +114,7 @@ describe('ui5-test-writer', () => {
                 { targetKey: 'EmployeesListTarget', appID: 'test.ui5-test-writer' },
                 fs
             );
-            expect((fs as any).dump(projectDir)).toMatchSnapshot();
+            expect(fs.dump(projectDir)).toMatchSnapshot();
         });
     });
 
@@ -165,7 +165,7 @@ describe('ui5-test-writer', () => {
         it.each(testApplications)('$description', async (config) => {
             const projectDir = prepareTestFiles(config.dirPath);
             fs = await generateOPAFiles(projectDir, { scriptName: config.scriptName }, fs);
-            expect((fs as any).dump(projectDir)).toMatchSnapshot();
+            expect(fs.dump(projectDir)).toMatchSnapshot();
         });
 
         it('No manifest', async () => {
@@ -195,7 +195,7 @@ describe('ui5-test-writer', () => {
         it('Providing an app ID', async () => {
             const projectDir = prepareTestFiles('MissingAppId');
             fs = await generateOPAFiles(projectDir, { appID: 'test.ui5-test-writer' }, fs);
-            expect((fs as any).dump(projectDir)).toMatchSnapshot();
+            expect(fs.dump(projectDir)).toMatchSnapshot();
         });
 
         it('Freestyle app not supported', async () => {

packages/ui5-test-writer/tsconfig.json

@@ -1,6 +1,10 @@
 {
     "extends": "../../tsconfig.json",
-    "include": ["src", "src/**/*.json"],
+    "include": [
+        "../../types/mem-fs-editor.d.ts",
+        "src", 
+        "src/**/*.json"
+    ],
     "compilerOptions": {
         "rootDir": "src",
         "outDir": "dist"