Adding a regression test project "api-extractor-test-01" that builds using a trivial build.js script

Author: pgonzal

build-tests/api-extractor-test-01/api-extractor.json

@@ -0,0 +1,49 @@
+{
+  "$schema": "https://dev.office.com/json-schemas/api-extractor/api-extractor.schema.json",
+  "compiler" : {
+    "configType": "tsconfig",
+    "rootFolder": ".",
+
+    "overrideTsconfig": {
+      "compilerOptions": {
+        "target": "es6",
+        "forceConsistentCasingInFileNames": true,
+        "module": "commonjs",
+        "declaration": true,
+        "sourceMap": true,
+        "experimentalDecorators": true,
+        "strictNullChecks": true,
+        "types": [
+          "node",
+          "jest"
+        ],
+        "lib": [
+          "es5",
+          "scripthost",
+          "es2015.collection",
+          "es2015.promise",
+          "es2015.iterable",
+          "dom"
+        ]
+      },
+      "include": [
+        // TODO: Automatically generate this from the real tsconfig.json
+        "lib/index.d.ts",
+        "typings/tsd.d.ts"
+      ]
+    }
+
+  },
+
+  "apiJsonFile": {
+    "enabled": true
+  },
+
+  "apiReviewFile": {
+    "enabled": true
+  },
+
+  "project": {
+    "entryPointSourceFile": "lib/index.d.ts"
+  }
+}

build-tests/api-extractor-test-01/build.js

@@ -0,0 +1,27 @@
+const fsx = require('fs-extra');
+const child_process = require('child_process');
+const path = require('path');
+const process = require('process');
+
+function executeCommand(command) {
+  console.log('---> ' + command);
+  child_process.execSync(command, { stdio: 'inherit' });
+}
+
+// Clean the old build outputs
+console.log(`==> Starting build.js for ${path.basename(process.cwd())}`);
+fsx.emptyDirSync('dist');
+fsx.emptyDirSync('lib');
+fsx.emptyDirSync('temp');
+
+// Run the TypeScript compiler
+executeCommand('node node_modules/typescript/lib/tsc');
+
+// Run the API Extractor command-line
+if (process.argv.indexOf('--production') >= 0) {
+  executeCommand('node node_modules/@microsoft/api-extractor/lib/start run');
+} else {
+  executeCommand('node node_modules/@microsoft/api-extractor/lib/start run --local');
+}
+
+console.log(`==> Finished build.js for ${path.basename(process.cwd())}`);

build-tests/api-extractor-test-01/package.json

@@ -0,0 +1,17 @@
+{
+  "name": "api-extractor-test-01",
+  "description": "Building this project is a regression test for api-extractor",
+  "version": "1.0.0",
+  "main": "lib/index.js",
+  "typings": "lib/index.d.ts",
+  "scripts": {
+    "build": "node build.js"
+  },
+  "dependencies": {
+    "@microsoft/api-extractor": "4.3.4",
+    "@types/jest": "~20.0.4",
+    "@types/node": "6.0.88",
+    "fs-extra": "~0.26.7",
+    "typescript": "~2.4.1"
+  }
+}

build-tests/api-extractor-test-01/src/ReexportedClass1.ts

@@ -0,0 +1,7 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+/**
+ * This class gets aliased twice before being exported from the package.
+ */
+export { ReexportedClass2 as ReexportedClass1 } from './ReexportedClass2';

build-tests/api-extractor-test-01/src/ReexportedClass2.ts

@@ -0,0 +1,9 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+/**
+ * This class gets aliased twice before being exported from the package.
+ * @public
+ */
+export class ReexportedClass2 {
+}

build-tests/api-extractor-test-01/src/index.ts

@@ -0,0 +1,49 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+/**
+ * Example package docs.
+ */
+declare const packageDescription: void; // tslint:disable-line:no-unused-variable
+
+/**
+ * Test the alias-following logic:  This class gets aliased twice before being
+ * exported from the package.
+ */
+export { ReexportedClass1 as ReexportedClass } from './ReexportedClass1';
+
+/**
+ * A simple, normal definition
+ * @public
+ */
+export interface ISimpleInterface {
+}
+
+/**
+ * Test different kinds of ambient definitions
+ * @public
+ */
+export class AmbientConsumer {
+  // Found via tsconfig.json's "lib" setting, which specifies the built-in "es2015.collection"
+  public builtinDefinition1(): Map<string, string> {
+    return new Map<string, string>();
+  }
+
+  // Found via tsconfig.json's "lib" setting, which specifies the built-in "es2015.promise"
+  public builtinDefinition2(): Promise<void> {
+    return new Promise<void>(() => { /* */ });
+  }
+
+  // Configured via tsconfig.json's "lib" setting, which specifies "@types/jest".
+  // The emitted index.d.ts gets a reference like this:  <reference types="jest" />
+  public definitelyTyped(): jest.Context {
+    return {} as jest.Context;
+  }
+
+  // Found via tsconfig.json's "include" setting point to a *.d.ts file.
+  // This is an old-style Definitely Typed definition, which is the worst possible kind,
+  // because consumers are expected to provide this, with no idea where it came from.
+  public localTypings(): IAmbientInterfaceExample {
+    return {} as IAmbientInterfaceExample;
+  }
+}

build-tests/api-extractor-test-01/tsconfig.json

@@ -0,0 +1,28 @@
+{
+  "compilerOptions": {
+    "target": "es6",
+    "forceConsistentCasingInFileNames": true,
+    "module": "commonjs",
+    "declaration": true,
+    "sourceMap": true,
+    "experimentalDecorators": true,
+    "strictNullChecks": true,
+    "types": [
+      "node",
+      "jest"
+    ],
+    "lib": [
+      "es5",
+      "scripthost",
+      "es2015.collection",
+      "es2015.promise",
+      "es2015.iterable",
+      "dom"
+    ],
+    "outDir": "lib"
+  },
+  "include": [
+    "src/**/*.ts",
+    "typings/tsd.d.ts"
+  ]
+}

build-tests/api-extractor-test-01/typings/tsd.d.ts

@@ -0,0 +1,7 @@
+// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license.
+// See LICENSE in the project root for license information.
+
+// Simulate legacy-style Definitely Typed typings
+interface IAmbientInterfaceExample {
+  member: number;
+}

rush.json

@@ -58,6 +58,14 @@
       "shouldPublish": false
     },
 
+    // "build-tests" folder (alphabetical order)
+    {
+      "packageName": "api-extractor-test-01",
+      "projectFolder": "build-tests/api-extractor-test-01",
+      "reviewCategory": "libraries",
+      "shouldPublish": false
+    },
+
     // "core-build" folder (alphabetical order)
     {
       "packageName": "@microsoft/gulp-core-build",