Merge pull request #1463 from pnp/react-upgrade-me

React upgrade me

samples/react-upgrade-me/.editorconfig

@@ -0,0 +1,25 @@
+# EditorConfig helps developers define and maintain consistent
+# coding styles between different editors and IDEs
+# editorconfig.org
+
+root = true
+
+
+[*]
+
+# change these settings to your own preference
+indent_style = space
+indent_size = 2
+
+# we recommend you to keep these unchanged
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false
+
+[{package,bower}.json]
+indent_style = space
+indent_size = 2

samples/react-upgrade-me/.gitignore

@@ -0,0 +1,32 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# Dependency directories
+node_modules
+
+# Build generated files
+dist
+lib
+solution
+temp
+*.sppkg
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# OSX
+.DS_Store
+
+# Visual Studio files
+.ntvs_analysis.dat
+.vs
+bin
+obj
+
+# Resx Generated Code
+*.resx.ts
+
+# Styles Generated Code
+*.scss.ts

samples/react-upgrade-me/.yo-rc.json

@@ -0,0 +1,8 @@
+{
+  "@microsoft/generator-sharepoint": {
+    "version": "1.4.0",
+    "libraryName": "react-upgrade-me",
+    "libraryId": "c32676e6-9536-4db1-b59f-62c7be23f38b",
+    "environment": "onprem"
+  }
+}

samples/react-upgrade-me/README.md

@@ -0,0 +1,50 @@
+# Upgrade Me
+
+## Summary
+
+This web part does nothing, really. It is intended to be used to test upgrading SPFx web parts and demonstrating incompatibility issues between versions of SPFx and Node.js.
+
+![picture of the web part in action](./assets/react-upgrade-me.png)
+
+## Used SharePoint Framework Version
+
+![1.4.1](https://img.shields.io/badge/version-1.4.1-green.svg)
+
+## Applies to
+
+* [SharePoint Framework](https://docs.microsoft.com/sharepoint/dev/spfx/sharepoint-framework-overview)
+* [Office 365 tenant](https://docs.microsoft.com/sharepoint/dev/spfx/set-up-your-development-environment)
+
+
+## Prerequisites
+
+You'll need the [CLI for Microsoft 365](https://pnp.github.io/cli-microsoft365/) in order to perform an upgrade.
+
+## Solution
+
+Solution|Author(s)
+--------|---------
+react-upgrade-me | Hugo Bernier ([Tahoe Ninjas](https://tahoeninjas.blog), [@bernierh](https://twitter.com/bernierh))
+
+## Version history
+
+Version|Date|Comments
+-------|----|--------
+1.0|August 26, 2020|Initial release
+
+## Disclaimer
+
+**THIS CODE IS PROVIDED *AS IS* WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING ANY IMPLIED WARRANTIES OF FITNESS FOR A PARTICULAR PURPOSE, MERCHANTABILITY, OR NON-INFRINGEMENT.**
+
+---
+
+## Minimal Path to Awesome
+
+Not applicable.
+
+
+## Features
+
+This web part really does nothing. It is intended to be used with the CLI for Microsoft 365 [SPFx Project Upgrade](https://pnp.github.io/cli-microsoft365/cmd/spfx/project/project-upgrade/).
+
+<img src="https://telemetry.sharepointpnp.com/sp-dev-fx-webparts/samples/react-upgrade-me" />

samples/react-upgrade-me/config/config.json

@@ -0,0 +1,18 @@
+{
+  "version": "2.0",
+  "$schema": "https://dev.office.com/json-schemas/spfx-build/config.2.0.schema.json",
+  "externals": {},
+  "localizedResources": {
+    "UpgradeMeWebPartStrings": "lib/webparts/upgradeMe/loc/{locale}.js"
+  },
+  "bundles": {
+    "upgrade-me-web-part": {
+      "components": [
+        {
+          "entrypoint": "./lib/webparts/upgradeMe/UpgradeMeWebPart.js",
+          "manifest": "./src/webparts/upgradeMe/UpgradeMeWebPart.manifest.json"
+        }
+      ]
+    }
+  }
+}

samples/react-upgrade-me/config/copy-assets.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://dev.office.com/json-schemas/spfx-build/copy-assets.schema.json",
+  "deployCdnPath": "temp/deploy"
+}

samples/react-upgrade-me/config/deploy-azure-storage.json

@@ -0,0 +1,7 @@
+{
+  "$schema": "https://dev.office.com/json-schemas/spfx-build/deploy-azure-storage.schema.json",
+  "workingDir": "./temp/deploy/",
+  "account": "<!-- STORAGE ACCOUNT NAME -->",
+  "container": "react-upgrade-me",
+  "accessKey": "<!-- ACCESS KEY -->"
+}

samples/react-upgrade-me/config/package-solution.json

@@ -0,0 +1,12 @@
+{
+  "$schema": "https://dev.office.com/json-schemas/spfx-build/package-solution.schema.json",
+  "solution": {
+    "name": "react-upgrade-me-client-side-solution",
+    "id": "c32676e6-9536-4db1-b59f-62c7be23f38b",
+    "version": "1.0.0.0",
+    "includeClientSideAssets": true
+  },
+  "paths": {
+    "zippedPackage": "solution/react-upgrade-me.sppkg"
+  }
+}

samples/react-upgrade-me/config/serve.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "https://dev.office.com/json-schemas/core-build/serve.schema.json",
+  "port": 4321,
+  "https": true,
+  "initialPage": "https://localhost:5432/workbench",
+  "api": {
+    "port": 5432,
+    "entryPath": "node_modules/@microsoft/sp-webpart-workbench/lib/api/"
+  }
+}

samples/react-upgrade-me/config/tslint.json

@@ -0,0 +1,45 @@
+{
+  "$schema": "https://dev.office.com/json-schemas/core-build/tslint.schema.json",
+  // Display errors as warnings
+  "displayAsWarning": true,
+  // The TSLint task may have been configured with several custom lint rules
+  // before this config file is read (for example lint rules from the tslint-microsoft-contrib
+  // project). If true, this flag will deactivate any of these rules.
+  "removeExistingRules": true,
+  // When true, the TSLint task is configured with some default TSLint "rules.":
+  "useDefaultConfigAsBase": false,
+  // Since removeExistingRules=true and useDefaultConfigAsBase=false, there will be no lint rules
+  // which are active, other than the list of rules below.
+  "lintConfig": {
+    // Opt-in to Lint rules which help to eliminate bugs in JavaScript
+    "rules": {
+      "class-name": false,
+      "export-name": false,
+      "forin": false,
+      "label-position": false,
+      "member-access": true,
+      "no-arg": false,
+      "no-console": false,
+      "no-construct": false,
+      "no-duplicate-case": true,
+      "no-duplicate-variable": true,
+      "no-eval": false,
+      "no-function-expression": true,
+      "no-internal-module": true,
+      "no-shadowed-variable": true,
+      "no-switch-case-fall-through": true,
+      "no-unnecessary-semicolons": true,
+      "no-unused-expression": true,
+      "no-use-before-declare": true,
+      "no-with-statement": true,
+      "semicolon": true,
+      "trailing-comma": false,
+      "typedef": false,
+      "typedef-whitespace": false,
+      "use-named-parameter": true,
+      "valid-typeof": true,
+      "variable-name": false,
+      "whitespace": false
+    }
+  }
+}

samples/react-upgrade-me/config/write-manifests.json

@@ -0,0 +1,4 @@
+{
+  "$schema": "https://dev.office.com/json-schemas/spfx-build/write-manifests.schema.json",
+  "cdnBasePath": "<!-- PATH TO CDN -->"
+}

samples/react-upgrade-me/gulpfile.js

@@ -0,0 +1,7 @@
+'use strict';
+
+const gulp = require('gulp');
+const build = require('@microsoft/sp-build-web');
+build.addSuppression(`Warning - [sass] The local CSS class 'ms-Grid' is not camelCase and will not be type-safe.`);
+
+build.initialize(gulp);

samples/react-upgrade-me/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "react-upgrade-me",
+  "version": "0.0.1",
+  "private": true,
+  "engines": {
+    "node": ">=0.10.0"
+  },
+  "scripts": {
+    "build": "gulp bundle",
+    "clean": "gulp clean",
+    "test": "gulp test"
+  },
+  "dependencies": {
+    "@microsoft/sp-core-library": "1.4.1",
+    "@microsoft/sp-lodash-subset": "1.4.1",
+    "@microsoft/sp-office-ui-fabric-core": "1.4.1",
+    "@microsoft/sp-webpart-base": "1.4.1",
+    "@types/react": "15.6.6",
+    "@types/react-addons-shallow-compare": "0.14.17",
+    "@types/react-dom": "15.5.6",
+    "@types/webpack-env": ">=1.12.1 <1.14.0",
+    "react": "15.6.2",
+    "react-dom": "15.4.2"
+  },
+  "devDependencies": {
+    "@microsoft/sp-build-web": "1.4.1",
+    "@microsoft/sp-module-interfaces": "1.4.1",
+    "@microsoft/sp-webpart-workbench": "~1.1.0",
+    "@types/chai": ">=3.4.34 <3.6.0",
+    "@types/mocha": ">=2.2.33 <2.6.0",
+    "ajv": "5.2.2",
+    "gulp": "~3.9.1"
+  }
+}

samples/react-upgrade-me/src/webparts/upgradeMe/UpgradeMeWebPart.ts

@@ -0,0 +1,57 @@
+import * as React from 'react';
+import * as ReactDom from 'react-dom';
+import { Version } from '@microsoft/sp-core-library';
+import {
+  BaseClientSideWebPart,
+  IPropertyPaneConfiguration,
+  PropertyPaneTextField
+} from '@microsoft/sp-webpart-base';
+
+import * as strings from 'UpgradeMeWebPartStrings';
+import UpgradeMe from './components/UpgradeMe';
+import { IUpgradeMeProps } from './components/IUpgradeMeProps';
+
+export interface IUpgradeMeWebPartProps {
+  description: string;
+}
+
+export default class UpgradeMeWebPart extends BaseClientSideWebPart<IUpgradeMeWebPartProps> {
+
+  public render(): void {
+
+    const element: React.ReactElement<IUpgradeMeProps > = React.createElement(
+      UpgradeMe,
+      {
+        description: this.properties.description
+      }
+    );
+
+    ReactDom.render(element, this.domElement);
+  }
+
+  protected get dataVersion(): Version {
+    return Version.parse('1.0');
+  }
+
+  protected getPropertyPaneConfiguration(): IPropertyPaneConfiguration {
+    return {
+      pages: [
+        {
+          header: {
+            description: strings.PropertyPaneDescription
+          },
+          groups: [
+            {
+              groupName: strings.BasicGroupName,
+              groupFields: [
+                PropertyPaneTextField('description', {
+                  label: strings.DescriptionFieldLabel
+                })
+              ]
+            }
+          ]
+        }
+      ]
+    };
+  }
+}

samples/react-upgrade-me/src/webparts/upgradeMe/components/IUpgradeMeProps.ts

@@ -0,0 +1,3 @@
+export interface IUpgradeMeProps {
+  description: string;
+}

samples/react-upgrade-me/src/webparts/upgradeMe/components/UpgradeMe.module.scss

@@ -0,0 +1,75 @@
+@import '~@microsoft/sp-office-ui-fabric-core/dist/sass/SPFabricCore.scss';
+
+.upgradeMe {
+  .container {
+    max-width: 700px;
+    margin: 0px auto;
+    box-shadow: 0 2px 4px 0 rgba(0, 0, 0, 0.2), 0 25px 50px 0 rgba(0, 0, 0, 0.1);
+  }
+
+  .row {
+    @include ms-Grid-row;
+    @include ms-fontColor-white;
+    background-color: $ms-color-themeDark;
+    padding: 20px;
+  }
+
+  .column {
+    @include ms-Grid-col;
+    @include ms-lg10;
+    @include ms-xl8;
+    @include ms-xlPush2;
+    @include ms-lgPush1;
+  }
+
+  .title {
+    @include ms-font-xl;
+    @include ms-fontColor-white;
+  }
+
+  .subTitle {
+    @include ms-font-l;
+    @include ms-fontColor-white;
+  }
+
+  .description {
+    @include ms-font-l;
+    @include ms-fontColor-white;
+    font-weight: bold;
+  }
+
+  .button {
+    // Our button
+    text-decoration: none;
+    height: 32px;
+
+    // Primary Button
+    min-width: 80px;
+    background-color: $ms-color-themePrimary;
+    border-color: $ms-color-themePrimary;
+    color: $ms-color-white;
+
+    // Basic Button
+    outline: transparent;
+    position: relative;
+    font-family: "Segoe UI WestEuropean","Segoe UI",-apple-system,BlinkMacSystemFont,Roboto,"Helvetica Neue",sans-serif;
+    -webkit-font-smoothing: antialiased;
+    font-size: $ms-font-size-m;
+    font-weight: $ms-font-weight-regular;
+    border-width: 0;
+    text-align: center;
+    cursor: pointer;
+    display: inline-block;
+    padding: 0 16px;
+
+    .label {
+      font-weight: $ms-font-weight-semibold;
+      font-size: $ms-font-size-m;
+      height: 32px;
+      line-height: 32px;
+      margin: 0 4px;
+      vertical-align: top;
+      display: inline-block;
+    }
+  }
+}

samples/react-upgrade-me/src/webparts/upgradeMe/components/UpgradeMe.tsx

@@ -0,0 +1,22 @@
+import * as React from 'react';
+import styles from './UpgradeMe.module.scss';
+import { IUpgradeMeProps } from './IUpgradeMeProps';
+import { escape } from '@microsoft/sp-lodash-subset';
+
+export default class UpgradeMe extends React.Component<IUpgradeMeProps, {}> {
+  public render(): React.ReactElement<IUpgradeMeProps> {
+    return (
+      <div className={ styles.upgradeMe }>
+        <div className={ styles.container }>
+          <div className={ styles.row }>
+            <div className={ styles.column }>
+              <span className={ styles.title }>Upgrade Me!</span>
+              <p className={ styles.subTitle }>This web part does nothing. It is intended to be used to demonstrate how to upgrade SPFx solutions and to demonstrate incompatibilities between versions of SPFx/Node.js</p>
+              <p className={ styles.description }>{escape(this.props.description)}</p>
+            </div>
+          </div>
+        </div>
+      </div>
+    );
+  }
+}

samples/react-upgrade-me/src/webparts/upgradeMe/loc/en-us.js

@@ -0,0 +1,7 @@
+define([], function() {
+  return {
+    "PropertyPaneDescription": "You should use this web part to test upgrading solutions.",
+    "BasicGroupName": "Group Name",
+    "DescriptionFieldLabel": "Description Field"
+  }
+});

samples/react-upgrade-me/src/webparts/upgradeMe/loc/mystrings.d.ts

@@ -0,0 +1,10 @@
+declare interface IUpgradeMeWebPartStrings {
+  PropertyPaneDescription: string;
+  BasicGroupName: string;
+  DescriptionFieldLabel: string;
+}
+
+declare module 'UpgradeMeWebPartStrings' {
+  const strings: IUpgradeMeWebPartStrings;
+  export = strings;
+}

samples/react-upgrade-me/tsconfig.json

@@ -0,0 +1,25 @@
+{
+  "compilerOptions": {
+    "target": "es5",
+    "forceConsistentCasingInFileNames": true,
+    "module": "commonjs",
+    "jsx": "react",
+    "declaration": true,
+    "sourceMap": true,
+    "experimentalDecorators": true,
+    "skipLibCheck": true,
+    "typeRoots": [
+      "./node_modules/@types",
+      "./node_modules/@microsoft"
+    ],
+    "types": [
+      "es6-promise",
+      "webpack-env"
+    ],
+    "lib": [
+      "es5",
+      "dom",
+      "es2015.collection"
+    ]
+  }
+}

samples/react-upgrade-me/typings/@ms/odsp.d.ts

@@ -0,0 +1,30 @@
+/**
+ * @file index.ts
+ * Type definitions for Microsoft SPFx projects
+ */
+
+/**
+ * Global definition for UNIT_TEST builds.
+ * Code that is wrapped inside an if (UNIT_TEST) {...}
+ * block will not be included in the final bundle when the
+ * --ship flag is specified.
+ */
+declare const UNIT_TEST: boolean;
+
+/**
+ * @internal
+ * Global definition for NPM package builds
+ */
+declare const NPM_BUILD: boolean;
+
+/**
+ * @internal
+ * Global defintion for SharePoint Online builds
+ */
+declare const DATACENTER: boolean;
+
+/**
+ * @internal
+ * Global definition for BUILD_NUMBER
+ */
+declare const BUILD_NUMBER: string;

samples/react-upgrade-me/typings/tsd.d.ts

@@ -0,0 +1 @@
+/// <reference path="@ms/odsp.d.ts" />