Making "gulp docs" work (#11929)

* update docs to use correct types * fixing tsconfig path * fixing relative imports of the react/package.json from docs * apparently the eslintplugin is stuck on a specific version (taking on deprecated utils) * gulp docs works!!
microsoft · Feb 12, 2020 · 60ff30a · 60ff30a
1 parent d83580c
commit 60ff30a
Show file tree

Hide file tree

Showing 28 changed files with 258 additions and 341 deletions.
diff --git a/packages/fluentui/ability-attributes/tsconfig.json b/packages/fluentui/ability-attributes/tsconfig.json
@@ -1,5 +1,5 @@
 {
-  "extends": "@uifabric/build/typescript/tsconfig.fluentui",
+  "extends": "../../../scripts/typescript/tsconfig.fluentui",
   "compilerOptions": {
     "composite": true,
     "outDir": "dist/dts",
@@ -9,8 +9,5 @@
     "noUnusedParameters": true,
     "strictNullChecks": true
   },
-  "include": [
-    "src",
-    "test"
-  ]
+  "include": ["src", "test"]
 }
diff --git a/packages/fluentui/accessibility/tsconfig.json b/packages/fluentui/accessibility/tsconfig.json
@@ -1,11 +1,8 @@
 {
-  "extends": "@uifabric/build/typescript/tsconfig.fluentui",
+  "extends": "../../../scripts/typescript/tsconfig.fluentui",
   "compilerOptions": {
     "composite": true,
     "outDir": "dist/dts"
   },
-  "include": [
-    "src",
-    "test"
-  ]
+  "include": ["src", "test"]
 }
diff --git a/packages/fluentui/code-sandbox/tsconfig.json b/packages/fluentui/code-sandbox/tsconfig.json
@@ -1,12 +1,10 @@
 {
-  "extends": "@uifabric/build/typescript/tsconfig.fluentui",
+  "extends": "../../../scripts/typescript/tsconfig.fluentui",
   "compilerOptions": {
     "composite": true,
     "outDir": "dist/dts"
   },
-  "include": [
-    "src"
-  ],
+  "include": ["src"],
   "references": [
     {
       "path": "../docs-components"

diff --git a/packages/fluentui/docs-components/tsconfig.json b/packages/fluentui/docs-components/tsconfig.json
@@ -1,10 +1,8 @@
 {
-  "extends": "@uifabric/build/typescript/tsconfig.fluentui",
+  "extends": "../../../scripts/typescript/tsconfig.fluentui",
   "compilerOptions": {
     "composite": true,
     "outDir": "dist/dts"
   },
-  "include": [
-    "src"
-  ]
+  "include": ["src"]
 }
diff --git a/packages/fluentui/docs/src/components/Sidebar/Sidebar.tsx b/packages/fluentui/docs/src/components/Sidebar/Sidebar.tsx
@@ -24,7 +24,7 @@ import { NavLink, NavLinkProps, withRouter } from 'react-router-dom';
 
 type ComponentMenuItem = { displayName: string; type: string };
 
-const pkg = require('../../../../packages/react/package.json');
+const pkg = require('@fluentui/react/package.json');
 const componentMenu: ComponentMenuItem[] = require('../../componentMenu');
 const behaviorMenu: ComponentMenuItem[] = require('../../behaviorMenu');
 

diff --git a/packages/fluentui/docs/src/views/Introduction.tsx b/packages/fluentui/docs/src/views/Introduction.tsx
@@ -1,10 +1,10 @@
-import * as _ from 'lodash'
-import * as React from 'react'
-import { NavLink } from 'react-router-dom'
-import { Flex, Header } from '@fluentui/react'
+import * as _ from 'lodash';
+import * as React from 'react';
+import { NavLink } from 'react-router-dom';
+import { Flex, Header } from '@fluentui/react';
 
-import pkg from '../../../packages/react/package.json'
-import Logo from '../components/Logo/Logo'
+import pkg from '@fluentui/react/package.json';
+import Logo from '../components/Logo/Logo';
 
 const Introduction = () => (
   <div style={{ margin: '0 225px', fontSize: '1.125em', maxWidth: '100ch' }}>
@@ -16,42 +16,36 @@ const Introduction = () => (
           marginTop: '24px',
           marginBottom: '0px',
           fontSize: '2rem',
-          textAlign: 'center',
+          textAlign: 'center'
         }}
       >
         {_.capitalize(pkg.name)}
         <Header.Description
           styles={{
             margin: 0,
-            fontSize: '1.14285714rem',
+            fontSize: '1.14285714rem'
           }}
         >
           {pkg.description}
         </Header.Description>
       </Header>
     </Flex>
     <p>
-      Fluent UI provides extensible vanilla JavaScript solutions to component state, styling, and
-      accessibility. These powerful features are exposed behind simple APIs based on natural
-      language.
-    </p>
-    <p>
-      Fluent UI React is being built as an exemplar of the Fluent UI design language, component
-      specifications, and utilities.
+      Fluent UI provides extensible vanilla JavaScript solutions to component state, styling, and accessibility. These powerful features are
+      exposed behind simple APIs based on natural language.
     </p>
+    <p>Fluent UI React is being built as an exemplar of the Fluent UI design language, component specifications, and utilities.</p>
 
     <h3>Learn</h3>
     <p>
-      The best place to start is with the <NavLink to="shorthand-props">Shorthand Props</NavLink>{' '}
-      concept.
+      The best place to start is with the <NavLink to="shorthand-props">Shorthand Props</NavLink> concept.
     </p>
 
     <h3>Start</h3>
     <p>
-      If you want to get going right away, see the <NavLink to="quick-start">Quick Start</NavLink>{' '}
-      guide.
+      If you want to get going right away, see the <NavLink to="quick-start">Quick Start</NavLink> guide.
     </p>
   </div>
-)
+);
 
-export default Introduction
+export default Introduction;
diff --git a/packages/fluentui/docs/tsconfig.json b/packages/fluentui/docs/tsconfig.json
@@ -1,32 +1,15 @@
 {
-  "extends": "@uifabric/build/typescript/tsconfig.common",
+  "extends": "../../../scripts/typescript/tsconfig.fluentui",
   "compilerOptions": {
     "module": "esnext",
     "paths": {
-      "@fluentui/*": [
-        "packages/fluentui/*/src"
-      ],
-      "docs/*": [
-        "packages/fluentui/docs/*"
-      ],
-      "src/*": [
-        "packages/fluentui/react/src/*"
-      ],
-      "test/*": [
-        "packages/fluentui/react/test/*"
-      ]
+      "@fluentui/*": ["packages/fluentui/*/src/index"],
+      "docs/*": ["packages/fluentui/docs/*"],
+      "src/*": ["packages/fluentui/react/src/*"],
+      "test/*": ["packages/fluentui/react/test/*"]
     },
-    "typeRoots": [
-      "../types",
-      "../node_modules/@types"
-    ],
-    "types": [
-      "node",
-      "webpack-env",
-      "screener-runner"
-    ]
+    "typeRoots": ["../../../typings", "../node_modules/@types"],
+    "types": ["node", "webpack-env", "screener-runner"]
   },
-  "include": [
-    "./src"
-  ]
+  "include": ["./src"]
 }
diff --git a/packages/fluentui/e2e/tsconfig.json b/packages/fluentui/e2e/tsconfig.json
@@ -1,15 +1,9 @@
 {
-  "extends": "@uifabric/build/typescript/tsconfig.common",
+  "extends": "../../../scripts/typescript/tsconfig.fluentui",
   "compilerOptions": {
     "module": "esnext",
     "allowSyntheticDefaultImports": true,
-    "types": [
-      "node",
-      "jest",
-      "webpack-env"
-    ]
+    "types": ["node", "jest", "webpack-env"]
   },
-  "include": [
-    "."
-  ]
+  "include": ["."]
 }
diff --git a/packages/fluentui/eslint-plugin/package.json b/packages/fluentui/eslint-plugin/package.json
@@ -2,8 +2,8 @@
   "name": "@fluentui/eslint-plugin",
   "version": "0.44.0",
   "dependencies": {
-    "@typescript-eslint/eslint-plugin": "^2.5.0",
-    "@typescript-eslint/experimental-utils": "^2.5.0"
+    "@typescript-eslint/eslint-plugin": "2.8.0",
+    "@typescript-eslint/experimental-utils": "2.8.0"
   },
   "files": [
     "rules"

diff --git a/packages/fluentui/perf/tsconfig.json b/packages/fluentui/perf/tsconfig.json
@@ -1,13 +1,8 @@
 {
-  "extends": "@uifabric/build/typescript/tsconfig.common",
+  "extends": "../../../scripts/typescript/tsconfig.fluentui",
   "compilerOptions": {
     "module": "esnext",
-    "types": [
-      "node",
-      "webpack-env"
-    ]
+    "types": ["node", "webpack-env"]
   },
-  "include": [
-    "./src"
-  ]
+  "include": ["./src"]
 }
diff --git a/packages/fluentui/react-bindings/tsconfig.json b/packages/fluentui/react-bindings/tsconfig.json
@@ -1,5 +1,5 @@
 {
-  "extends": "@uifabric/build/typescript/tsconfig.fluentui",
+  "extends": "../../../scripts/typescript/tsconfig.fluentui",
   "compilerOptions": {
     "composite": true,
     "outDir": "dist/dts",
@@ -9,10 +9,7 @@
     "noUnusedParameters": true,
     "strictNullChecks": true
   },
-  "include": [
-    "src",
-    "test"
-  ],
+  "include": ["src", "test"],
   "references": [
     {
       "path": "../accessibility"

diff --git a/packages/fluentui/react-component-event-listener/tsconfig.json b/packages/fluentui/react-component-event-listener/tsconfig.json
@@ -1,5 +1,5 @@
 {
-  "extends": "@uifabric/build/typescript/tsconfig.fluentui",
+  "extends": "../../../scripts/typescript/tsconfig.fluentui",
   "compilerOptions": {
     "composite": true,
     "outDir": "dist/dts",
@@ -9,9 +9,6 @@
     "noUnusedParameters": true,
     "strictNullChecks": true
   },
-  "include": [
-    "src",
-    "test"
-  ],
+  "include": ["src", "test"],
   "references": []
 }
diff --git a/packages/fluentui/react-component-nesting-registry/tsconfig.json b/packages/fluentui/react-component-nesting-registry/tsconfig.json
@@ -1,5 +1,5 @@
 {
-  "extends": "@uifabric/build/typescript/tsconfig.fluentui",
+  "extends": "../../../scripts/typescript/tsconfig.fluentui",
   "compilerOptions": {
     "composite": true,
     "outDir": "dist/dts",
@@ -9,9 +9,6 @@
     "noUnusedParameters": true,
     "strictNullChecks": true
   },
-  "include": [
-    "src",
-    "test"
-  ],
+  "include": ["src", "test"],
   "references": []
 }
diff --git a/packages/fluentui/react-component-ref/tsconfig.json b/packages/fluentui/react-component-ref/tsconfig.json
@@ -1,5 +1,5 @@
 {
-  "extends": "@uifabric/build/typescript/tsconfig.fluentui",
+  "extends": "../../../scripts/typescript/tsconfig.fluentui",
   "compilerOptions": {
     "composite": true,
     "outDir": "dist/dts",
@@ -9,9 +9,6 @@
     "noUnusedParameters": true,
     "strictNullChecks": true
   },
-  "include": [
-    "src",
-    "test"
-  ],
+  "include": ["src", "test"],
   "references": []
 }
diff --git a/packages/fluentui/react-proptypes/tsconfig.json b/packages/fluentui/react-proptypes/tsconfig.json
@@ -1,12 +1,9 @@
 {
-  "extends": "@uifabric/build/typescript/tsconfig.fluentui",
+  "extends": "../../../scripts/typescript/tsconfig.fluentui",
   "compilerOptions": {
     "composite": true,
     "outDir": "dist/dts"
   },
-  "include": [
-    "src",
-    "test"
-  ],
+  "include": ["src", "test"],
   "references": []
 }