Adds webpack-utils package; a fabric-optimized async loader

common/changes/@uifabric/webpack-utils/loader_2018-06-06-20-44.json

@@ -0,0 +1,11 @@
+{
+  "changes": [
+    {
+      "packageName": "@uifabric/webpack-utils",
+      "comment": "Creates a new webpack-utils package",
+      "type": "major"
+    }
+  ],
+  "packageName": "@uifabric/webpack-utils",
+  "email": "kchau@microsoft.com"
+}

packages/webpack-utils/.npmignore

@@ -0,0 +1,22 @@
+*.config.js
+*.nuspec
+*.yml
+*.test.*
+.editorconfig
+.gitattributes
+.gitignore
+.vscode
+coverage
+dist/*.stats.html
+dist/demo*.*
+gulpfile.js
+index.html
+jsconfig.json
+karma.config.js
+node_modules
+src
+tsconfig.json
+tsd.json
+tslint.json
+typings
+webpack.config.js

packages/webpack-utils/.npmrc

@@ -0,0 +1,2 @@
+registry=https://registry.npmjs.org/
+

packages/webpack-utils/LICENSE

@@ -0,0 +1,15 @@
+Office UI Fabric React - utilities
+
+Copyright (c) Microsoft Corporation
+
+All rights reserved.
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the ""Software""), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED *AS IS*, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+Note: Usage of the fonts and icons referenced in Office UI Fabric is subject to the terms listed at http://aka.ms/fabric-assets-license

packages/webpack-utils/README.md

@@ -0,0 +1,35 @@
+# Office UI Fabric React - Webpack utilities
+This package contains different utilities for optimizing the use of Office UI Fabric React for the [Webpack](https://webpack.js.org) bundler.
+
+## Installation
+To use any of these Webpack utilities, you must install it into your project:
+
+`npm i -D @uifabric/webpack-utils`
+
+or
+
+`yarn add -D @uifabric/webpack-utils`
+
+
+## Fabric Async Loader
+This is a Webpack loader that will automatically perform code splitting with no code changes needed on the Fabric or the application side. It accomplishes this through the Webpack loader mechanism filtered through the `include` property. To use this, modify your `webpack.config.js` like so:
+
+```js
+module.exports = {
+  ...,
+  module: {
+    rules: [
+      {
+        test: /\.(jsx?|tsx?)$/,
+        include: [/office-ui-fabric-react\/lib(-commonjs)?\/components\/ContextualMenu\/ContextualMenu.js/],
+        loader: '@uifabric/webpack-utils/lib/FabricAsyncLoader.js'
+      },
+    ...
+  }
+};
+```
+
+### Credits
+Thanks to:
+* [react-loadable](https://github.com/jamiebuilds/react-loadable) by @jamiebuilds who created a delay loaded component
+* [react-loadable-loader](https://github.com/baflo/react-loadable-loader) by @baflo who inspired this project; Fabric modified that implementation to work with non-default exports

packages/webpack-utils/config/api-extractor.json.disabled

@@ -0,0 +1,6 @@
+{
+  "enabled": true,
+  "apiReviewFolder": "./api",
+  "apiJsonFolder": "./temp",
+  "entry": "src/index.ts"
+}

packages/webpack-utils/config/tests.js

@@ -0,0 +1 @@
+/** Jest test setup file. */

packages/webpack-utils/jest.config.js

@@ -0,0 +1,7 @@
+let path = require('path');
+let { createConfig } = require('../../scripts/tasks/jest-resources');
+module.exports = createConfig({
+  setupFiles: [path.resolve(path.join(__dirname, 'config', 'tests.js'))]
+});
+
+console.log(module.exports.setupFiles);

packages/webpack-utils/package.json

@@ -0,0 +1,36 @@
+{
+  "name": "@uifabric/webpack-utils",
+  "version": "1.0.0",
+  "description": "Office UI Fabric utilities for Webpack bundler.",
+  "sideEffects": false,
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/OfficeDev/office-ui-fabric-react"
+  },
+  "license": "MIT",
+  "scripts": {
+    "build": "tsc",
+    "code-style": "node ../../scripts/code-style.js",
+    "clean": "node ../../scripts/clean.js"
+  },
+  "disabledTasks": [
+    "copy",
+    "karma",
+    "webpack"
+  ],
+  "devDependencies": {
+    "@types/jest": "23.0.0",
+    "@types/loader-utils": "1.1.3",
+    "@types/webpack": "4.4.0",
+    "office-ui-fabric-react-tslint": ">=6.0.0 <7.0.0",
+    "webpack": ">=4.0.0"
+  },
+  "dependencies": {
+    "loader-utils": "^1.1.0",
+    "tslib": "^1.7.1"
+  },
+  "peerDependencies": {
+    "webpack": ">=4.0.0",
+    "react-loadable": ">=5.0.0"
+  }
+}

packages/webpack-utils/src/fabricAsyncLoader.ts

@@ -0,0 +1,23 @@
+// This code is heavily inspired by https://github.com/baflo/react-loadable-loader.
+import * as webpack from 'webpack';
+import * as path from 'path';
+import * as loaderUtils from 'loader-utils';
+
+const fabricAsyncLoader: webpack.loader.Loader = (content: string) => {
+  return content;
+};
+
+fabricAsyncLoader.pitch = (remainingRequest: string, precedingRequest: string) => {
+  const moduleRequest = `!!${remainingRequest}`;
+  const normalizedRequest = loaderUtils.stringifyRequest(this, moduleRequest);
+  const moduleName = path.basename(normalizedRequest).replace(/\..*$/, '');
+  return [
+    "import Loadable from 'react-loadable';",
+    `export const ${moduleName} = Loadable({`,
+    `  loader: async() => (await import(${loaderUtils.stringifyRequest(this, moduleRequest)})).${moduleName},`,
+    `  loading: () => null`,
+    `});`
+  ].join('');
+};
+
+export = fabricAsyncLoader;

packages/webpack-utils/tsconfig.json

@@ -0,0 +1,24 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "outDir": "lib",
+    "module": "commonjs",
+    "lib": [
+      "es2017",
+      "dom"
+    ],
+    "jsx": "react",
+    "declaration": true,
+    "sourceMap": true,
+    "experimentalDecorators": true,
+    "importHelpers": true,
+    "noImplicitAny": true,
+    "strictNullChecks": true,
+    "forceConsistentCasingInFileNames": true,
+    "moduleResolution": "node",
+    "preserveConstEnums": true,
+  },
+  "include": [
+    "src"
+  ]
+}

packages/webpack-utils/tslint.json

@@ -0,0 +1,7 @@
+{
+  "extends": ["office-ui-fabric-react-tslint"],
+  "rules": {
+    "deprecation": false,
+    "prefer-const": false
+  }
+}

rush.json

@@ -12,6 +12,11 @@
       "versionPolicyName": "lockedMajor",
       "shouldPublish": true
     },
+    {
+      "packageName": "@uifabric/webpack-utils",
+      "projectFolder": "packages/webpack-utils",
+      "shouldPublish": true
+    },
     {
       "packageName": "@uifabric/experiments",
       "projectFolder": "packages/experiments",
@@ -46,14 +51,19 @@
       "packageName": "@uifabric/example-app-base",
       "projectFolder": "packages/example-app-base",
       "versionPolicyName": "lockedMajor",
-      "cyclicDependencyProjects": ["office-ui-fabric-react"],
+      "cyclicDependencyProjects": [
+        "office-ui-fabric-react"
+      ],
       "shouldPublish": true
     },
     {
       "packageName": "@uifabric/styling",
       "projectFolder": "packages/styling",
       "versionPolicyName": "lockedMajor",
-      "cyclicDependencyProjects": ["office-ui-fabric-react", "@uifabric/example-app-base"],
+      "cyclicDependencyProjects": [
+        "office-ui-fabric-react",
+        "@uifabric/example-app-base"
+      ],
       "shouldPublish": true
     },
     {
@@ -111,4 +121,4 @@
       "shouldPublish": false
     }
   ]
-}
+}