tooling: scripts package cleanup (#2261)

* scripts package cleanup

* getAllPackageInfo returns relative paths

* really replace git root

Author: ecraig12345

build/package.json

@@ -24,6 +24,7 @@
     "@types/gulp-remember": "^0.0.31",
     "@types/jest-axe": "^3.2.1",
     "@types/jest": "^24.0.19",
+    "@types/lerna-alias": "^3.0.0",
     "@types/node": "^10.3.2",
     "@types/puppeteer": "^1.11.1",
     "@types/webpack-dev-middleware": "^2.0.1",

scripts/monorepo/findGitRoot.ts

@@ -1,7 +1,7 @@
-const fs = require('fs')
-const path = require('path')
+import fs from 'fs'
+import path from 'path'
 
-function findGitRoot() {
+export function findGitRoot(): string {
   let cwd = process.cwd()
   const root = path.parse(cwd).root
   let found = false
@@ -16,5 +16,3 @@ function findGitRoot() {
 
   return cwd
 }
-
-export { findGitRoot }

scripts/monorepo/getAllPackageDeps.ts

@@ -1,6 +1,6 @@
-import { getAllPackageInfo } from './getAllPackageInfo'
+import { getAllPackageInfo, PackageJson } from './getAllPackageInfo'
 
-function getDeps(packageJson: any, repoPackages: string[]) {
+function getDeps(packageJson: PackageJson, repoPackages: string[]) {
   if (!packageJson) {
     return []
   }
@@ -11,9 +11,10 @@ function getDeps(packageJson: any, repoPackages: string[]) {
 }
 
 /**
- * Find all the dependencies (and their dependencies) within the repo for a specific package (in the CWD when this was called)
+ * Find all the dependencies (and their dependencies) within the repo for a specific package
+ * (in the CWD when this was called)
  */
-function getAllPackageDeps() {
+export function getAllPackageDeps() {
   const allInfo = getAllPackageInfo()
   const repoPackages = Object.keys(allInfo)
   const allDeps = new Map<string, Set<string>>()
@@ -50,4 +51,3 @@ function getAllPackageDeps() {
 
   return allDeps
 }
-export { getAllPackageDeps }

scripts/monorepo/getAllPackageInfo.ts

@@ -1,52 +1,50 @@
-import { spawnSync } from 'child_process'
+import { rollup as lernaAliases } from 'lerna-alias'
 import path from 'path'
 import { findGitRoot } from './findGitRoot'
 
-interface PackageJson {
+export interface PackageJson {
   name: string
   version: string
   main: string
   types?: string
   module?: string
   dependencies?: { [key: string]: string }
   devDependencies?: { [key: string]: string }
+  [key: string]: any
 }
 
-interface PackageInfo {
+export interface PackageInfo {
+  /** Package path relative to the project root */
   packagePath: string
+  /** package.json contents */
   packageJson: PackageJson
 }
 
-type AllPackageInfo = { [key: string]: PackageInfo }
+export type AllPackageInfo = { [packageName: string]: PackageInfo }
 
-let packageInfoCache: AllPackageInfo = null
+let packageInfoCache: AllPackageInfo | null = null
 
 export function getAllPackageInfo(): AllPackageInfo {
   if (packageInfoCache) {
     return packageInfoCache
   }
 
   const gitRoot = findGitRoot()
-  const results = spawnSync('git', ['ls-tree', '-r', '--name-only', '--full-tree', 'HEAD'])
+  const packagePaths = lernaAliases({ sourceDirectory: false })
+
   const packageInfo: { [key: string]: PackageInfo } = {}
 
-  results.stdout
-    .toString()
-    .split('\n')
-    .map((line: string) => {
-      return line.trim()
-    })
-    .filter((line: string) => line.endsWith('package.json'))
-    .forEach((packageJsonFile: string) => {
-      const packageJson = require(path.join(gitRoot, packageJsonFile))
-
-      if (packageJson) {
-        packageInfo[packageJson.name] = {
-          packagePath: path.dirname(packageJsonFile),
-          packageJson,
-        }
+  for (const [packageName, packagePath] of Object.entries(packagePaths)) {
+    try {
+      packageInfo[packageName] = {
+        packagePath: path.relative(gitRoot, packagePath),
+        packageJson: require(path.join(packagePath, 'package.json')),
       }
-    })
+    } catch (ex) {
+      /* eslint-disable-next-line no-console */
+      console.warn(`Error parsing package.json for ${packageName}: ${ex}`)
+    }
+  }
 
   packageInfoCache = packageInfo
 

scripts/package.json

@@ -21,6 +21,8 @@
     "@types/fs-extra": "^8.0.1",
     "@types/jest": "^24.0.19",
     "@types/jest-environment-puppeteer": "^4.3.1",
+    "@types/jju": "^1.4.1",
+    "@types/lerna-alias": "^3.0.0",
     "@types/node": "^10.3.2",
     "@types/react": "^16.8.10",
     "@types/storybook__react": "^4.0.2",
@@ -39,9 +41,12 @@
     "http-server": "^0.11.1",
     "jest": "^24.9.0",
     "jest-puppeteer": "^4.3.0",
+    "jju": "^1.4.0",
     "just-scripts": "^0.35.0",
+    "lerna-alias": "^3.0.3-0",
     "puppeteer": "^1.13.0",
     "react-docgen-typescript-loader": "^3.2.0",
+    "read-package-json": "^2.0.13",
     "rollup": "^1.25.1",
     "rollup-plugin-dts": "^1.1.10",
     "ts-jest": "^24.1.0",

scripts/tasks/autoProjectRefsTask.ts

@@ -1,17 +1,32 @@
 import { getAllPackageDeps } from '../monorepo/getAllPackageDeps'
 import path from 'path'
 import fs from 'fs'
+import jju from 'jju'
 import { getAllPackageInfo } from '../monorepo/getAllPackageInfo'
 import { findGitRoot } from '../monorepo/findGitRoot'
 import { logger } from 'just-task'
 
+interface TSConfig {
+  references: { path: string }[]
+  [key: string]: any
+}
+
 export function autoProjectRefsTask() {
   const updatedTsconfigs = getUpdatedTsconfigs()
 
   if (updatedTsconfigs.size > 0) {
-    for (const [file, blob] of updatedTsconfigs.entries()) {
+    for (const [file, [originalText, updatedJson]] of updatedTsconfigs.entries()) {
       logger.info(`Updating ${file} with project references`)
-      fs.writeFileSync(file, JSON.stringify(blob, null, 2))
+      fs.writeFileSync(
+        file,
+        jju.update(originalText, updatedJson, {
+          mode: 'json5',
+          indent: 2,
+          quote: '"',
+          quote_keys: true,
+          no_trailing_comma: true,
+        }),
+      )
     }
   }
 }
@@ -28,22 +43,23 @@ export function autoProjectRefsVerifyTask() {
 }
 
 function getUpdatedTsconfigs() {
-  const excluded = ['@fluentui/scripts', 'fluent-ui-monorepo']
+  const excluded = ['@fluentui/scripts', '@fluentui/build']
   const repoDeps = getAllPackageDeps()
   const allInfo = getAllPackageInfo()
   const root = findGitRoot()
   let isDirty = false
-  const updatedTsconfigs = new Map<string, string>()
+  const updatedTsconfigs = new Map<string, [string, TSConfig]>()
 
   for (const [name, info] of Object.entries(allInfo)) {
     if (excluded.includes(name)) {
       continue
     }
 
     isDirty = false
-    const deps = repoDeps.get(name)
+    const deps = repoDeps.get(name)!
     const tsconfigFile = path.join(root, info.packagePath, 'tsconfig.json')
-    const tsconfigJson = JSON.parse(fs.readFileSync(tsconfigFile, 'utf-8'))
+    const tsconfigText = fs.readFileSync(tsconfigFile, 'utf-8')
+    const tsconfigJson: TSConfig = jju.parse(tsconfigText)
 
     const newRefs = [...deps]
       .sort()
@@ -64,7 +80,7 @@ function getUpdatedTsconfigs() {
     }
 
     if (isDirty) {
-      updatedTsconfigs.set(tsconfigFile, tsconfigJson)
+      updatedTsconfigs.set(tsconfigFile, [tsconfigText, tsconfigJson])
     }
   }
   return updatedTsconfigs

scripts/tasks/e2eTask.ts

@@ -2,10 +2,17 @@ import { jestTask, resolveCwd } from 'just-scripts'
 import path from 'path'
 import os from 'os'
 
+const noOp = (done: () => void) => done()
+
 export function e2eTask() {
+  const config = resolveCwd('jest.puppeteer.js')
+  if (!config) {
+    return noOp
+  }
+
   return jestTask({
     runInBand: true,
-    config: resolveCwd('jest.puppeteer.js'),
+    config,
     env: {
       ...process.env,
       JEST_E2E_HEADLESS: 'true',
@@ -16,9 +23,14 @@ export function e2eTask() {
 }
 
 export function e2eWatchTask() {
+  const config = resolveCwd('jest.puppeteer.js')
+  if (!config) {
+    return noOp
+  }
+
   return jestTask({
     runInBand: true,
-    config: resolveCwd('jest.puppeteer.js'),
+    config,
     _: ['--watchAll'],
     env: {
       ...process.env,
@@ -28,12 +40,17 @@ export function e2eWatchTask() {
 }
 
 export function e2ePerfTask() {
+  const config = resolveCwd('jest.puppeteer.js')
+  if (!config) {
+    return noOp
+  }
+
   const tmpDir = os.tmpdir()
   const logFile = path.join(tmpDir, 'puppeteer.log')
 
   return jestTask({
     runInBand: true,
-    config: resolveCwd('jest.puppeteer.js'),
+    config,
     env: {
       ...process.env,
       JEST_E2E_PROFILE: logFile,

scripts/tasks/httpServerTask.ts

@@ -2,9 +2,10 @@ import { createServer, Options } from 'http-server'
 import { ListenOptions } from 'net'
 
 export function httpServerTask(options: Options & ListenOptions = {}) {
-  return function httpServer(done) {
+  return function httpServer(done: () => void) {
     const server = createServer(options)
     server.listen({ host: 'localhost', port: options.port }, () => {
+      /* eslint-disable-next-line no-console */
       console.log(`running on http://localhost:${options.port}/`)
       done()
     })

scripts/tasks/publishPrepareTask.ts

@@ -3,20 +3,37 @@ import { findGitRoot } from '../monorepo/findGitRoot'
 import fs from 'fs'
 import path from 'path'
 
-export function publishPrepareTask() {
+export interface IPublishPrepareOptions {
+  /** Don't update package.json for these packages */
+  excludePackages?: string[]
+}
+
+/**
+ * Update package.json for each project so that its `main` points to the build output
+ * rather than the source.
+ */
+export function publishPrepare(options: IPublishPrepareOptions = {}) {
   const root = findGitRoot()
   const allInfo = getAllPackageInfo()
 
-  for (const info of Object.values(allInfo)) {
-    if (info.packageJson.main && info.packageJson.main.startsWith('src/index')) {
+  const { excludePackages = [] } = options
+
+  for (const [packageName, info] of Object.entries(allInfo)) {
+    const oldMain = info.packageJson.main
+    if (oldMain && oldMain.startsWith('src/') && !excludePackages.includes(packageName)) {
       const newPackageJson = {
         ...info.packageJson,
-        main: info.packageJson.main.replace('src/', 'lib/').replace(/\.tsx?/, '.js'),
+        main: oldMain.replace('src/', 'lib/').replace(/\.tsx?/, '.js'),
       }
+
       fs.writeFileSync(
         path.join(root, info.packagePath, 'package.json'),
         `${JSON.stringify(newPackageJson, null, 2)}\n`,
       )
     }
   }
 }
+
+export function publishPrepareTask() {
+  publishPrepare()
+}

scripts/tasks/storybookTask.ts

@@ -1,6 +1,7 @@
 import { resolveCwd, argv } from 'just-scripts'
 import path from 'path'
 
+// @ts-ignore
 import storybook from '@storybook/react/standalone'
 
 interface StorybookTaskOptions {

scripts/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "./config/typescript/tsconfig.common.json",
+  "compilerOptions": {
+    "target": "es2015",
+    "lib": ["es2015"]
+  }
+}

yarn.lock

@@ -4348,6 +4348,11 @@
   dependencies:
     jest-diff "^24.3.0"
 
+"@types/jju@^1.4.1":
+  version "1.4.1"
+  resolved "https://registry.yarnpkg.com/@types/jju/-/jju-1.4.1.tgz#0a39f5f8e84fec46150a7b9ca985c3f89ad98e9f"
+  integrity sha512-LFt+YA7Lv2IZROMwokZKiPNORAV5N3huMs3IKnzlE430HWhWYZ8b+78HiwJXJJP1V2IEjinyJURuRJfGoaFSIA==
+
 "@types/json-schema@^7.0.3":
   version "7.0.3"
   resolved "https://registry.npmjs.org/@types/json-schema/-/json-schema-7.0.3.tgz#bdfd69d61e464dcc81b25159c270d75a73c1a636"
@@ -4366,6 +4371,11 @@
     csstype "^2.0.0"
     indefinite-observable "^1.0.1"
 
+"@types/lerna-alias@^3.0.0":
+  version "3.0.0"
+  resolved "https://registry.yarnpkg.com/@types/lerna-alias/-/lerna-alias-3.0.0.tgz#e4d70f75bad9f5a7b697f76b7d7b3fa97aa57844"
+  integrity sha512-EfwEzSWxAxrZgUJT5sECi4RPFCIgOm/K9e5EWXp2hR9H6wzV1QIBgjGtGEl/OpOCcglNWzmqrVRX/qjvNwli9Q==
+
 "@types/lodash@^4.14.118":
   version "4.14.118"
   resolved "https://registry.yarnpkg.com/@types/lodash/-/lodash-4.14.118.tgz#247bab39bfcc6d910d4927c6e06cbc70ec376f27"