MC-10833: Resolve TypeScript errors

davemacaulay · davemacaulay · commit ac962dc3ded8 · 2019-01-23T15:41:48.000+01:00
- Resolve issues with loadModule
- Ensure types files only export default when expected
- Remove tslint disable from dts-generator and ignore file in tslint config
- Update npm run scripts
diff --git a/app/code/Magento/PageBuilder/view/adminhtml/web/ts/js/config-field.types.ts b/app/code/Magento/PageBuilder/view/adminhtml/web/ts/js/config-field.types.ts
diff --git a/app/code/Magento/PageBuilder/view/adminhtml/web/ts/js/content-type-config.types.ts b/app/code/Magento/PageBuilder/view/adminhtml/web/ts/js/content-type-config.types.ts
@@ -3,8 +3,6 @@
  * See COPYING.txt for license details.
  */
 
-import ConfigFieldInterface from "./config-field.types";
-
 /**
  * @api
  */
@@ -26,6 +24,12 @@ export default interface ContentTypeConfigInterface {
     additional_data: AdditionalDataConfigInterface;
 }
 
+export interface ConfigFieldInterface {
+    [key: string]: {
+        default: null | string | number;
+    };
+}
+
 export interface ContentTypeConfigAppearanceElementInterface {
     style: DataMappingStyleInterface[];
     attributes: DataMappingAttributesInterface[];
diff --git a/app/code/Magento/PageBuilder/view/adminhtml/web/ts/js/content-type-factory.ts b/app/code/Magento/PageBuilder/view/adminhtml/web/ts/js/content-type-factory.ts
@@ -4,8 +4,8 @@
  */
 
 import events from "Magento_PageBuilder/js/events";
-import loadModule from "Magento_PageBuilder/js/utils/loader";
 import _ from "underscore";
+import loadModule from "utils/loader";
 import ContentType from "./content-type";
 import ContentTypeCollectionInterface from "./content-type-collection.types";
 import ContentTypeConfigInterface from "./content-type-config.types";
diff --git a/app/code/Magento/PageBuilder/view/adminhtml/web/ts/js/content-type/content-type-events.types.ts b/app/code/Magento/PageBuilder/view/adminhtml/web/ts/js/content-type/content-type-events.types.ts
@@ -125,6 +125,6 @@ export interface ContentTypeMoveParamsInterface {
 /**
  * @api
  */
-export default interface PreviewDataUpdateAfterParamsInterface {
+export interface PreviewDataUpdateAfterParamsInterface {
     preview: Preview;
 }
diff --git a/app/code/Magento/PageBuilder/view/adminhtml/web/ts/js/content-type/master-factory.ts b/app/code/Magento/PageBuilder/view/adminhtml/web/ts/js/content-type/master-factory.ts
@@ -3,9 +3,9 @@
  * See COPYING.txt for license details.
  */
 
-import loadModule from "Magento_PageBuilder/js/utils/loader";
 import ContentTypeConfigInterface from "../content-type-config.types";
 import ContentTypeInterface from "../content-type.types";
+import loadModule from "../utils/loader";
 import converterResolver from "./converter-resolver";
 import Master from "./master";
 import MasterCollection from "./master-collection";
diff --git a/app/code/Magento/PageBuilder/view/adminhtml/web/ts/js/content-type/preview-factory.ts b/app/code/Magento/PageBuilder/view/adminhtml/web/ts/js/content-type/preview-factory.ts
@@ -3,9 +3,9 @@
  * See COPYING.txt for license details.
  */
 
-import loadModule from "Magento_PageBuilder/js/utils/loader";
 import ContentTypeConfigInterface from "../content-type-config.types";
 import ContentTypeInterface from "../content-type.types";
+import loadModule from "../utils/loader";
 import observableUpdaterFactory from "./observable-updater-factory";
 import Preview from "./preview";
 import PreviewCollection from "./preview-collection";
diff --git a/app/code/Magento/PageBuilder/view/adminhtml/web/ts/js/converter/converter-pool-factory.ts b/app/code/Magento/PageBuilder/view/adminhtml/web/ts/js/converter/converter-pool-factory.ts
@@ -3,9 +3,9 @@
  * See COPYING.txt for license details.
  */
 
-import loadModule from "Magento_PageBuilder/js/utils/loader";
 import Config from "../config";
 import ContentTypeConfigInterface from "../content-type-config.types";
+import loadModule from "../utils/loader";
 import ConverterPool from "./converter-pool";
 
 /**
diff --git a/app/code/Magento/PageBuilder/view/adminhtml/web/ts/js/mass-converter/converter-pool-factory.ts b/app/code/Magento/PageBuilder/view/adminhtml/web/ts/js/mass-converter/converter-pool-factory.ts
@@ -3,8 +3,8 @@
  * See COPYING.txt for license details.
  */
 
-import loadModule from "Magento_PageBuilder/js/utils/loader";
 import Config from "../config";
+import loadModule from "../utils/loader";
 import ConverterPool from "./converter-pool";
 
 /**
diff --git a/app/code/Magento/PageBuilder/view/adminhtml/web/ts/js/property/property-reader-pool-factory.ts b/app/code/Magento/PageBuilder/view/adminhtml/web/ts/js/property/property-reader-pool-factory.ts
@@ -3,8 +3,8 @@
  * See COPYING.txt for license details.
  */
 
-import loadModule from "Magento_PageBuilder/js/utils/loader";
 import Config from "../config";
+import loadModule from "../utils/loader";
 import PropertyReaderPool from "./property-reader-pool";
 
 /**
diff --git a/app/code/Magento/PageBuilder/view/adminhtml/web/ts/js/stage-builder.ts b/app/code/Magento/PageBuilder/view/adminhtml/web/ts/js/stage-builder.ts
@@ -5,9 +5,9 @@
 
 import $t from "mage/translate";
 import events from "Magento_PageBuilder/js/events";
-import loadReader from "Magento_PageBuilder/js/utils/loader";
 import alertDialog from "Magento_Ui/js/modal/alert";
 import * as _ from "underscore";
+import loadReader from "utils/loader";
 import Config from "./config";
 import ContentTypeCollectionInterface from "./content-type-collection";
 import ContentTypeConfigInterface from "./content-type-config.types";
diff --git a/app/code/Magento/PageBuilder/view/adminhtml/web/ts/js/utils/loader.d.ts b/app/code/Magento/PageBuilder/view/adminhtml/web/ts/js/utils/loader.d.ts
diff --git a/app/code/Magento/PageBuilder/view/adminhtml/web/ts/js/wysiwyg/factory.ts b/app/code/Magento/PageBuilder/view/adminhtml/web/ts/js/wysiwyg/factory.ts
@@ -4,9 +4,9 @@
  */
 
 import $ from "jquery";
-import loadModule from "Magento_PageBuilder/js/utils/loader";
 import {AdditionalDataConfigInterface} from "../content-type-config.types";
 import DataStore from "../data-store";
+import loadModule from "../utils/loader";
 import Wysiwyg from "./tinymce4";
 import WysiwygInterface, {WysiwygConstructorInterface} from "./wysiwyg-interface";
 
diff --git a/dev/dts-generator.js b/dev/dts-generator.js
@@ -60,7 +60,7 @@ require('dts-generator').default({
             let modifiedContents = contents
                 .replace(/.*\/\*\*\n.*Copyright © Magento.*\n.*\n.*\*\//gm, '') // Strip all Magento copyright
                 .replace(/.*\/\*\*\n.*@api.*\n.*\*\//gm, ''); // Strip all @api comments
-            modifiedContents = `${copyrightComment}\n/* tslint:disable */\n${modifiedContents}`;
+            modifiedContents = `${copyrightComment}\n${modifiedContents}`;
             fs.writeFile(typesFile, prettier.format(modifiedContents, {parser: "typescript"}), null, () => {
                 console.log("Type definition generation completed.");
                 process.exit();
diff --git a/package.json b/package.json
@@ -7,11 +7,11 @@
         "test:static:log": "npm run test:static -- -o ./static-error-log.xml -t junit",
         "ts:errors": "tsc --noEmit",
         "ts:errors:watch": "npm run ts:errors -- -watch",
-        "ts:lint": "node_modules/tslint/bin/tslint --fix --project .",
+        "ts:lint": "tslint --fix --project .",
         "ts:defs": "node ./dev/dts-generator.js",
-        "ts:build": "npx babel app/code/Magento/PageBuilder/view/adminhtml/web/ts/js/ --out-dir app/code/Magento/PageBuilder/view/adminhtml/web/js/ --extensions '.ts,.tsx' --source-maps",
+        "ts:build": "babel app/code/Magento/PageBuilder/view/adminhtml/web/ts/js/ --out-dir app/code/Magento/PageBuilder/view/adminhtml/web/js/ --extensions '.ts,.tsx' --source-maps",
         "ts:watch": "npm run ts:build -- --watch",
-        "start": "npx concurrently -n \"compiler,errors\" -c \"green,red\" \"npm run ts:watch\" \"npm run ts:errors:watch\""
+        "start": "concurrently -n 'compiler,errors' -c 'green,red' 'npm run ts:watch' 'npm run ts:errors:watch'"
     },
     "repository": {
         "type": "git",
diff --git a/page-builder-types b/page-builder-types
@@ -1 +1 @@
-Subproject commit c8361f10954f4e139a7038293ffce961631a67ac
+Subproject commit 04cf95bd4f5417ebbae94754424485fb0fd950fc
diff --git a/tsconfig.json b/tsconfig.json
@@ -20,7 +20,7 @@
         "./**/*.ts"
     ],
     "exclude": [
-        "page-builder-types/index.d.ts",
+        "page-builder-types",
         "node_modules",
         "**/*.spec.ts",
         "**/*.types.ts"
diff --git a/tslint.json b/tslint.json
@@ -11,5 +11,10 @@
         "one-line": false,
         "no-empty-interface": false
     },
-    "rulesDirectory": []
+    "rulesDirectory": [],
+    "linterOptions": {
+        "exclude": [
+            "page-builder-types/*.d.ts"
+        ]
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -125,6 +125,6 @@ export interface ContentTypeMoveParamsInterface {`
`125`	`125`	`/**`
`126`	`126`	`* @api`
`127`	`127`	`*/`
`128`		`-export default interface PreviewDataUpdateAfterParamsInterface {`
	`128`	`+export interface PreviewDataUpdateAfterParamsInterface {`
`129`	`129`	`preview: Preview;`
`130`	`130`	`}`