Convert get-workspaces to TypeScript (changesets#41)

* Convert get-workspaces to TypeScript

* Throw when a name field is missing and other things

* Collect packages with no name field and throw one error

Author: emmatown

.changeset/50f184c5/changes.json

@@ -0,0 +1,10 @@
+{
+  "releases": [{ "name": "get-workspaces", "type": "minor" }],
+  "dependents": [
+    {
+      "name": "@changesets/cli",
+      "type": "patch",
+      "dependencies": ["get-workspaces"]
+    }
+  ]
+}

.changeset/50f184c5/changes.md

@@ -0,0 +1 @@
+Throw when the name field is missing in a package.json

.changeset/cb4d5155/changes.json

@@ -0,0 +1,4 @@
+{
+  "releases": [{ "name": "get-workspaces", "type": "patch" }],
+  "dependents": []
+}

.changeset/cb4d5155/changes.md

@@ -0,0 +1 @@
+Convert package to TypeScript

babel.config.js

@@ -5,7 +5,10 @@ module.exports = {
       {
         targets: { node: 8 }
       }
-    ],
-    "@babel/preset-flow"
+    ]
+  ],
+  overrides: [
+    { test: "**/*.ts", presets: ["@babel/preset-typescript"] },
+    { test: "**/*.js", presets: ["@babel/preset-flow"] }
   ]
 };

package.json

@@ -11,6 +11,7 @@
     "lint": "yarn lint:eslint && yarn lint:prettier",
     "lint:eslint": "yarn eslint . --ext .ts,.tsx,.js",
     "lint:prettier": "prettier --list-different \"**/*.{js,ts,tsx}\"",
+    "types:check": "tsc",
     "prettier": "prettier --write \"**/*.{js,ts,tsx}\"",
     "changeset": "packages/cli/bin.js",
     "release": "yarn build && packages/cli/bin.js release --public"
@@ -22,6 +23,8 @@
   "license": "MIT",
   "dependencies": {
     "@babel/runtime": "^7.4.4",
+    "@types/fs-extra": "^5.1.0",
+    "@types/jest": "^24.0.12",
     "bolt": "^0.22.1",
     "boxen": "^1.3.0",
     "chalk": "^2.1.0",
@@ -40,13 +43,15 @@
     "projector-spawn": "^1.0.1",
     "semver": "^5.4.1",
     "tty-table": "^2.7.0",
+    "typescript": "^3.4.5",
     "uuid": "^3.3.2"
   },
   "devDependencies": {
     "@babel/cli": "^7.4.4",
     "@babel/core": "^7.0.0-0",
     "@babel/preset-env": "^7.4.4",
     "@babel/preset-flow": "^7.0.0",
+    "@babel/preset-typescript": "^7.3.3",
     "babel-eslint": "^10.0.1",
     "dotenv": "^8.0.0",
     "eslint": "^5.16.0",

packages/get-workspaces/__fixtures__/no-name-field/package.json

@@ -0,0 +1,9 @@
+{
+  "private": true,
+  "name": "yarn-workspace-base",
+  "description": "Base yarn workspace work",
+  "version": "1.0.0",
+  "workspaces": [
+    "packages/*"
+  ]
+}

packages/get-workspaces/__fixtures__/no-name-field/packages/pkg-a/package.json

@@ -0,0 +1,6 @@
+{
+  "version": "1.0.0",
+  "dependencies": {
+    "pkg-b": "1.0.0"
+  }
+}

packages/get-workspaces/__fixtures__/no-name-field/packages/pkg-b/package.json

@@ -0,0 +1,3 @@
+{
+  "version": "1.0.0"
+}

packages/get-workspaces/src/index.test.js renamed to packages/get-workspaces/src/index.test.ts

@@ -5,35 +5,54 @@ describe("get-workspaces", () => {
   it("should resolve yarn workspaces if the yarn option is passed", async () => {
     let cwd = await getFixturePath(__dirname, "yarn-workspace-base");
     const workspaces = await getWorkspaces({ cwd, tools: ["yarn"] });
+    if (workspaces === null) {
+      return expect(workspaces).not.toBeNull();
+    }
     expect(workspaces[0].name).toEqual("yarn-workspace-base-pkg-a");
     expect(workspaces[1].name).toEqual("yarn-workspace-base-pkg-b");
   });
   it("should resolve yarn workspaces if the yarn option is passed and packages field is used", async () => {
     let cwd = await getFixturePath(__dirname, "yarn-workspace-packages");
     const workspaces = await getWorkspaces({ cwd, tools: ["yarn"] });
+    if (workspaces === null) {
+      return expect(workspaces).not.toBeNull();
+    }
     expect(workspaces[0].name).toEqual("yarn-workspace-package-pkg-a");
     expect(workspaces[1].name).toEqual("yarn-workspace-package-pkg-b");
   });
   it("should resolve bolt workspaces if the bolt option is passed", async () => {
     let cwd = await getFixturePath(__dirname, "bolt-workspace");
     const workspaces = await getWorkspaces({ cwd, tools: ["bolt"] });
+    if (workspaces === null) {
+      return expect(workspaces).not.toBeNull();
+    }
     expect(workspaces[0].name).toEqual("bolt-workspace-pkg-a");
     expect(workspaces[1].name).toEqual("bolt-workspace-pkg-b");
   });
   it("should resolve main package if root option is passed", async () => {
     let cwd = await getFixturePath(__dirname, "root-only");
     const workspaces = await getWorkspaces({ cwd, tools: ["root"] });
+    if (workspaces === null) {
+      return expect(workspaces).not.toBeNull();
+    }
     expect(workspaces.length).toEqual(1);
+    expect(workspaces[0].dir).toEqual(cwd);
   });
   it("should by default resolve yarn workspaces", async () => {
     let cwd = await getFixturePath(__dirname, "yarn-workspace-base");
     const workspaces = await getWorkspaces({ cwd });
+    if (workspaces === null) {
+      return expect(workspaces).not.toBeNull();
+    }
     expect(workspaces[0].name).toEqual("yarn-workspace-base-pkg-a");
     expect(workspaces[1].name).toEqual("yarn-workspace-base-pkg-b");
   });
   it("should by default resolve bolt workspaces if yarn workspaces are absent", async () => {
     let cwd = await getFixturePath(__dirname, "bolt-workspace");
     const workspaces = await getWorkspaces({ cwd });
+    if (workspaces === null) {
+      return expect(workspaces).not.toBeNull();
+    }
     expect(workspaces[0].name).toEqual("bolt-workspace-pkg-a");
     expect(workspaces[1].name).toEqual("bolt-workspace-pkg-b");
   });
@@ -42,4 +61,17 @@ describe("get-workspaces", () => {
     const workspaces = await getWorkspaces({ cwd });
     expect(workspaces).toEqual(null);
   });
+
+  it("should throw an error if a package.json is missing the name field", async () => {
+    let cwd = await getFixturePath(__dirname, "no-name-field");
+    try {
+      await getWorkspaces({ cwd });
+    } catch (err) {
+      expect(err.message).toBe(
+        'The following package.jsons are missing the "name" field:\npackages/pkg-a/package.json\npackages/pkg-b/package.json'
+      );
+      return;
+    }
+    expect(true).toBe(false);
+  });
 });

packages/get-workspaces/src/index.js renamed to packages/get-workspaces/src/index.ts

@@ -6,7 +6,14 @@ import fs from "fs-extra";
 import path from "path";
 import globby from "globby";
 
-export default async function getWorkspaces(opts) {
+type Options = {
+  cwd?: string;
+  tools?: Array<"yarn" | "bolt" | "root">;
+};
+
+export default async function getWorkspaces(
+  opts: Options = {}
+): Promise<Array<{ config: object; name: string; dir: string }> | null> {
   const cwd = opts.cwd || process.cwd();
   const tools = opts.tools || ["yarn", "bolt"]; // We also support root, but don't do it by default
 
@@ -40,15 +47,29 @@ export default async function getWorkspaces(opts) {
     expandDirectories: false
   });
 
+  let pkgJsonsMissingNameField: Array<string> = [];
+
   const results = await Promise.all(
     folders
       .filter(dir => fs.existsSync(path.join(dir, "package.json")))
       .map(async dir =>
-        fs.readFile(path.join(dir, "package.json")).then(contents => {
+        fs.readFile(path.join(dir, "package.json"), "utf8").then(contents => {
           const config = JSON.parse(contents);
+          if (!config.name) {
+            pkgJsonsMissingNameField.push(
+              path.relative(cwd, path.join(dir, "package.json"))
+            );
+          }
           return { config, name: config.name, dir };
         })
       )
   );
+  if (pkgJsonsMissingNameField.length !== 0) {
+    throw new Error(
+      `The following package.jsons are missing the "name" field:\n${pkgJsonsMissingNameField.join(
+        "\n"
+      )}`
+    );
+  }
   return results;
 }

tsconfig.json

@@ -0,0 +1,63 @@
+{
+  "compilerOptions": {
+    /* Basic Options */
+    "target": "es5" /* Specify ECMAScript target version: 'ES3' (default), 'ES5', 'ES2015', 'ES2016', 'ES2017', 'ES2018', 'ES2019' or 'ESNEXT'. */,
+    "module": "commonjs" /* Specify module code generation: 'none', 'commonjs', 'amd', 'system', 'umd', 'es2015', or 'ESNext'. */,
+    // "lib": [],                             /* Specify library files to be included in the compilation. */
+    // "allowJs": true,                       /* Allow javascript files to be compiled. */
+    // "checkJs": true,                       /* Report errors in .js files. */
+    // "jsx": "preserve",                     /* Specify JSX code generation: 'preserve', 'react-native', or 'react'. */
+    // "declaration": true,                   /* Generates corresponding '.d.ts' file. */
+    // "declarationMap": true,                /* Generates a sourcemap for each corresponding '.d.ts' file. */
+    // "sourceMap": true,                     /* Generates corresponding '.map' file. */
+    // "outFile": "./",                       /* Concatenate and emit output to single file. */
+    // "outDir": "./",                        /* Redirect output structure to the directory. */
+    // "rootDir": "./",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
+    // "composite": true,                     /* Enable project compilation */
+    // "incremental": true,                   /* Enable incremental compilation */
+    // "tsBuildInfoFile": "./",               /* Specify file to store incremental compilation information */
+    // "removeComments": true,                /* Do not emit comments to output. */
+    // "noEmit": true,                        /* Do not emit outputs. */
+    // "importHelpers": true,                 /* Import emit helpers from 'tslib'. */
+    // "downlevelIteration": true,            /* Provide full support for iterables in 'for-of', spread, and destructuring when targeting 'ES5' or 'ES3'. */
+    // "isolatedModules": true,               /* Transpile each file as a separate module (similar to 'ts.transpileModule'). */
+
+    /* Strict Type-Checking Options */
+    "strict": true /* Enable all strict type-checking options. */,
+    // "noImplicitAny": true,                 /* Raise error on expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,              /* Enable strict null checks. */
+    // "strictFunctionTypes": true,           /* Enable strict checking of function types. */
+    // "strictBindCallApply": true,           /* Enable strict 'bind', 'call', and 'apply' methods on functions. */
+    // "strictPropertyInitialization": true,  /* Enable strict checking of property initialization in classes. */
+    // "noImplicitThis": true,                /* Raise error on 'this' expressions with an implied 'any' type. */
+    // "alwaysStrict": true,                  /* Parse in strict mode and emit "use strict" for each source file. */
+
+    /* Additional Checks */
+    // "noUnusedLocals": true,                /* Report errors on unused locals. */
+    // "noUnusedParameters": true,            /* Report errors on unused parameters. */
+    // "noImplicitReturns": true,             /* Report error when not all code paths in function return a value. */
+    // "noFallthroughCasesInSwitch": true,    /* Report errors for fallthrough cases in switch statement. */
+
+    /* Module Resolution Options */
+    // "moduleResolution": "node",            /* Specify module resolution strategy: 'node' (Node.js) or 'classic' (TypeScript pre-1.6). */
+    // "baseUrl": "./",                       /* Base directory to resolve non-absolute module names. */
+    // "paths": {},                           /* A series of entries which re-map imports to lookup locations relative to the 'baseUrl'. */
+    // "rootDirs": [],                        /* List of root folders whose combined content represents the structure of the project at runtime. */
+    // "typeRoots": [],                       /* List of folders to include type definitions from. */
+    // "types": [],                           /* Type declaration files to be included in compilation. */
+    // "allowSyntheticDefaultImports": true,  /* Allow default imports from modules with no default export. This does not affect code emit, just typechecking. */
+    "esModuleInterop": true /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */,
+    // "preserveSymlinks": true,              /* Do not resolve the real path of symlinks. */
+
+    /* Source Map Options */
+    // "sourceRoot": "",                      /* Specify the location where debugger should locate TypeScript files instead of source locations. */
+    // "mapRoot": "",                         /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,               /* Emit a single file with source maps instead of having a separate file. */
+    // "inlineSources": true,                 /* Emit the source alongside the sourcemaps within a single file; requires '--inlineSourceMap' or '--sourceMap' to be set. */
+
+    /* Experimental Options */
+    // "experimentalDecorators": true,        /* Enables experimental support for ES7 decorators. */
+    // "emitDecoratorMetadata": true,         /* Enables experimental support for emitting type metadata for decorators. */
+    "noEmit": true
+  }
+}

types/jest-fixtures.d.ts

@@ -0,0 +1,8 @@
+declare module "jest-fixtures" {
+  // this type is technically wrong because getFixturePath can return null
+  // but really we need jest-fixtures to throw an error when a fixture can't be found
+  // because checking for null in every usage of these things would be ridiculous
+  // or we could use fixturez which IMO has a better API and throws when fixtures
+  // can't be found
+  export function getFixturePath(dir: string, fixtureName: string): string;
+}

yarn.lock

@@ -276,6 +276,13 @@
   dependencies:
     "@babel/helper-plugin-utils" "^7.0.0"
 
+"@babel/plugin-syntax-typescript@^7.2.0":
+  version "7.3.3"
+  resolved "https://registry.yarnpkg.com/@babel/plugin-syntax-typescript/-/plugin-syntax-typescript-7.3.3.tgz#a7cc3f66119a9f7ebe2de5383cce193473d65991"
+  integrity sha512-dGwbSMA1YhVS8+31CnPR7LB4pcbrzcV99wQzby4uAfrkZPYZlQ7ImwdpzLqi6Z6IL02b8IAL379CaMwo0x5Lag==
+  dependencies:
+    "@babel/helper-plugin-utils" "^7.0.0"
+
 "@babel/plugin-transform-arrow-functions@^7.2.0":
   version "7.2.0"
   resolved "https://registry.yarnpkg.com/@babel/plugin-transform-arrow-functions/-/plugin-transform-arrow-functions-7.2.0.tgz#9aeafbe4d6ffc6563bf8f8372091628f00779550"
@@ -496,6 +503,14 @@
   dependencies:
     "@babel/helper-plugin-utils" "^7.0.0"
 
+"@babel/plugin-transform-typescript@^7.3.2":
+  version "7.4.4"
+  resolved "https://registry.yarnpkg.com/@babel/plugin-transform-typescript/-/plugin-transform-typescript-7.4.4.tgz#93e9c3f2a546e6d3da1e9cc990e30791b807aa9f"
+  integrity sha512-rwDvjaMTx09WC0rXGBRlYSSkEHOKRrecY6hEr3SVIPKII8DVWXtapNAfAyMC0dovuO+zYArcAuKeu3q9DNRfzA==
+  dependencies:
+    "@babel/helper-plugin-utils" "^7.0.0"
+    "@babel/plugin-syntax-typescript" "^7.2.0"
+
 "@babel/plugin-transform-unicode-regex@^7.4.4":
   version "7.4.4"
   resolved "https://registry.yarnpkg.com/@babel/plugin-transform-unicode-regex/-/plugin-transform-unicode-regex-7.4.4.tgz#ab4634bb4f14d36728bf5978322b35587787970f"
@@ -564,6 +579,14 @@
     "@babel/helper-plugin-utils" "^7.0.0"
     "@babel/plugin-transform-flow-strip-types" "^7.0.0"
 
+"@babel/preset-typescript@^7.3.3":
+  version "7.3.3"
+  resolved "https://registry.yarnpkg.com/@babel/preset-typescript/-/preset-typescript-7.3.3.tgz#88669911053fa16b2b276ea2ede2ca603b3f307a"
+  integrity sha512-mzMVuIP4lqtn4du2ynEfdO0+RYcslwrZiJHXu4MGaC1ctJiW2fyaeDrtjJGs7R/KebZ1sgowcIoWf4uRpEfKEg==
+  dependencies:
+    "@babel/helper-plugin-utils" "^7.0.0"
+    "@babel/plugin-transform-typescript" "^7.3.2"
+
 "@babel/runtime@^7.4.4":
   version "7.4.4"
   resolved "https://registry.yarnpkg.com/@babel/runtime/-/runtime-7.4.4.tgz#dc2e34982eb236803aa27a07fea6857af1b9171d"
@@ -791,6 +814,13 @@
   version "3.0.0"
   resolved "https://registry.yarnpkg.com/@types/events/-/events-3.0.0.tgz#2862f3f58a9a7f7c3e78d79f130dd4d71c25c2a7"
 
+"@types/fs-extra@^5.1.0":
+  version "5.1.0"
+  resolved "https://registry.yarnpkg.com/@types/fs-extra/-/fs-extra-5.1.0.tgz#2a325ef97901504a3828718c390d34b8426a10a1"
+  integrity sha512-AInn5+UBFIK9FK5xc9yP5e3TQSPNNgjHByqYcj9g5elVBnDQcQL7PlO1CIRy2gWlbwK7UPYqi7vRvFA44dCmYQ==
+  dependencies:
+    "@types/node" "*"
+
 "@types/glob@^7.1.1":
   version "7.1.1"
   resolved "https://registry.yarnpkg.com/@types/glob/-/glob-7.1.1.tgz#aa59a1c6e3fbc421e07ccd31a944c30eba521575"
@@ -816,6 +846,18 @@
     "@types/istanbul-lib-coverage" "*"
     "@types/istanbul-lib-report" "*"
 
+"@types/jest-diff@*":
+  version "20.0.1"
+  resolved "https://registry.yarnpkg.com/@types/jest-diff/-/jest-diff-20.0.1.tgz#35cc15b9c4f30a18ef21852e255fdb02f6d59b89"
+  integrity sha512-yALhelO3i0hqZwhjtcr6dYyaLoCHbAMshwtj6cGxTvHZAKXHsYGdff6E8EPw3xLKY0ELUTQ69Q1rQiJENnccMA==
+
+"@types/jest@^24.0.12":
+  version "24.0.12"
+  resolved "https://registry.yarnpkg.com/@types/jest/-/jest-24.0.12.tgz#0553dd0a5ac744e7dc4e8700da6d3baedbde3e8f"
+  integrity sha512-60sjqMhat7i7XntZckcSGV8iREJyXXI6yFHZkSZvCPUeOnEJ/VP1rU/WpEWQ56mvoh8NhC+sfKAuJRTyGtCOow==
+  dependencies:
+    "@types/jest-diff" "*"
+
 "@types/minimatch@*":
   version "3.0.3"
   resolved "https://registry.yarnpkg.com/@types/minimatch/-/minimatch-3.0.3.tgz#3dca0e3f33b200fc7d1139c0cd96c1268cadfd9d"
@@ -4983,6 +5025,11 @@ typeable-promisify@^2.0.1:
   dependencies:
     any-promise "^1.3.0"
 
+typescript@^3.4.5:
+  version "3.4.5"
+  resolved "https://registry.yarnpkg.com/typescript/-/typescript-3.4.5.tgz#2d2618d10bb566572b8d7aad5180d84257d70a99"
+  integrity sha512-YycBxUb49UUhdNMU5aJ7z5Ej2XGmaIBL0x34vZ82fn3hGvD+bgrMrVDpatgz2f7YxUMJxMkbWxJZeAvDxVe7Vw==
+
 typewise-core@^1.2, typewise-core@^1.2.0:
   version "1.2.0"
   resolved "https://registry.yarnpkg.com/typewise-core/-/typewise-core-1.2.0.tgz#97eb91805c7f55d2f941748fa50d315d991ef195"