Merge pull request #188 from angular/master

Create a new pull request by comparing changes across two branches. If you need to, you can

Author: GulajavaMinistudio

CONTRIBUTING.md

@@ -18,15 +18,19 @@ Help us keep Angular open and inclusive. Please read and follow our [Code of Con
 
 ## <a name="question"></a> Got a Question or Problem?
 
-Please, do not open issues for the general support questions as we want to keep GitHub issues for bug reports and feature requests. You've got much better chances of getting your question answered on [StackOverflow](https://stackoverflow.com/questions/tagged/angular-devkit) where the questions should be tagged with tag `angular-devkit`.
+Please, do not open issues for the general support questions as we want to keep GitHub issues for
+bug reports and feature requests. You've got much better chances of getting your question answered
+on [StackOverflow](https://stackoverflow.com/questions/tagged/angular-devkit) where the questions
+should be tagged with tag `angular-cli` or `angular-devkit`.
 
 StackOverflow is a much better place to ask questions since:
 
 - there are thousands of people willing to help on StackOverflow
 - questions and answers stay available for public viewing so your question / answer might help someone else
 - StackOverflow's voting system assures that the best answers are prominently visible.
 
-To save your and our time we will be systematically closing all the issues that are requests for general support and redirecting people to StackOverflow.
+To save your and our time we will be systematically closing all the issues that are requests for
+general support and redirecting people to StackOverflow.
 
 If you would like to chat about the question in real-time, you can reach out via [our gitter channel][gitter].
 
@@ -180,41 +184,65 @@ If the commit reverts a previous commit, it should begin with `revert: `, follow
 ### Type
 Must be one of the following:
 
-* **build**: Changes that affect the build system or external dependencies
-* **ci**: Changes to our CI configuration files and scripts
-* **docs**: Documentation only changes
-* **feat**: A new feature
-* **fix**: A bug fix
-* **perf**: A code change that improves performance
-* **refactor**: A code change that neither fixes a bug nor adds a feature
-* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc)
-* **test**: Adding missing tests or correcting existing tests
+* **build**: Changes that affect the build system or external dependencies. [2]
+* **ci**: Changes to our CI configuration files and scripts. [2]
+* **docs**: Documentation only changes. 
+* **feat**: A new feature. [1]
+* **fix**: A bug fix. [1]
+* **refactor**: A code change that neither fixes a bug nor adds a feature 
+* **release**: A release commit. Must only include version changes. [2]
+* **revert**: A git commit revert. The description must include the original commit message. [2]
+* **style**: Changes that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc). 
+* **test**: Adding missing tests or correcting existing tests. 
+
+
+<sup>[1] This type MUST have a scope. See the next section for more information.</sup><br/>
+<sup>[2] This type MUST NOT have a scope. It only applies to general scripts and tooling.</sup>
 
 ### Scope
 The scope should be the name of the npm package affected as perceived by the person reading changelog generated from the commit messages.
 
 The following is the list of supported scopes:
 
-* **@angular-devkit/core**
+* **@angular/cli**
+* **@angular/pwa**
+* **@angular-devkit/architect**
+* **@angular-devkit/architect-cli**
+* **@angular-devkit/build-angular**
+* **@angular-devkit/build-ng-packagr**
 * **@angular-devkit/build-optimizer**
+* **@angular-devkit/build-webpack**
+* **@angular-devkit/core**
 * **@angular-devkit/schematics**
 * **@angular-devkit/schematics-cli**
+* **@ngtools/webpack**
 * **@schematics/angular**
 * **@schematics/schematics**
+* **@schematics/update**
 
-There are currently a few exceptions to the "use package name" rule:
-
-* **packaging**: used for changes that change the npm package layout in all of our packages, e.g. public path changes, package.json changes done to all packages, d.ts file/format changes, changes to bundles, etc.
-* **changelog**: used for updating the release notes in CHANGELOG.md
-* none/empty string: useful for `style`, `test` and `refactor` changes that are done across all packages (e.g. `style: add missing semicolons`)
 
 ### Subject
 The subject contains succinct description of the change:
 
 * use the imperative, present tense: "change" not "changed" nor "changes"
 * don't capitalize first letter
+* be concise and direct
 * no dot (.) at the end
 
+### Examples
+Examples of valid commit messages:
+
+* `fix(@angular/cli): prevent the flubber from grassing`
+* `refactor(@schematics/angular): move all JSON classes together`
+
+Examples of invalid commit messages:
+* `fix(@angular/cli): add a new XYZ command`
+
+  This is a feature, not a fix.
+* `ci(@angular/cli): fix publishing workflow`
+
+  The `ci` type cannot have a scope.
+
 ### Body
 Just as in the **subject**, use the imperative, present tense: "change" not "changed" nor "changes".
 The body should include the motivation for the change and contrast this with previous behavior.
@@ -240,7 +268,7 @@ changes to be accepted, the CLA must be signed. It's a quick process, we promise
 [coc]: https://github.com/angular/code-of-conduct/blob/master/CODE_OF_CONDUCT.md
 [commit-message-format]: https://docs.google.com/document/d/1QrDFcIiPjSLDn3EL15IJygNPiHORgU1_OOAqWjiDU5Y/edit#
 [corporate-cla]: http://code.google.com/legal/corporate-cla-v1.0.html
-[dev-doc]: ttps://github.com/angular/angular-cli/blob/master/packages/angular/cli/README.md#development-hints-for-working-on-angular-cli
+[dev-doc]: https://github.com/angular/angular-cli/blob/master/packages/angular/cli/README.md#development-hints-for-working-on-angular-cli
 [GitHub]: https://github.com/angular/angular-cli
 [gitter]: https://gitter.im/angular/angular-cli
 [individual-cla]: http://code.google.com/legal/individual-cla-v1.0.html

README.md

@@ -10,7 +10,7 @@
   Any changes to README.md directly will result in a failure on CI.
 -->
 
-# Angular DevKit
+# Angular CLI
 ### Development tools and libraries specialized for Angular
 
 This is the home of the DevKit and the Angular CLI code. You can find the Angular CLI specific README
@@ -25,24 +25,48 @@ This is the home of the DevKit and the Angular CLI code. You can find the Angula
 
 
 
-----
-
-This is the home for all the tools and libraries built to assist developers with their Angular applications.
-
 ### Quick Links
 [Gitter](https://gitter.im/angular/angular-cli) | [Contributing](https://github.com/angular/angular-cli/blob/master/CONTRIBUTING.md) | [Angular CLI](http://github.com/angular/angular-cli) | 
 |---|---|---|
 
+----
+
+## The Goal of Angular CLI
+
+The Angular CLI creates, manages, builds and test your Angular projects. It's built on top of the
+Angular DevKit.
 
 ## The Goal of DevKit
 
-Our goal is to provide a large set of libraries that can be used to manage, develop, deploy and
+DevKit's goal is to provide a large set of libraries that can be used to manage, develop, deploy and
 analyze your code.
 
-This is the extension of the Angular CLI Project. Once this set of tools is done, the Angular CLI
-as it is today will become one of many interfaces available to perform those tasks. Everything
-will also be available to third party tools and IDEs.
+# Getting Started - Local Development
+
+## Installation
+To get started locally, follow these instructions:
 
+1. If you haven't done it already, [make a fork of this repo](https://github.com/angular/angular-cli/fork).
+1. Clone to your local computer using `git`.
+1. Make sure that you have Node 10.9 or later installed. See instructions [here](https://nodejs.org/en/download/). The Angular CLI requires Node 8, but development requires Node 10.
+1. Make sure that you have `yarn` installed; see instructions [here](https://yarnpkg.com/lang/en/docs/install/).
+1. Run `yarn` (no arguments) from the root of your clone of this project.
+1. Run `yarn link` to add all custom scripts we use to your global install.
+
+## Creating New Packages
+Adding a package to this repository means running two separate commands:
+
+1. `schematics devkit:package PACKAGE_NAME`. This will update the `.monorepo` file, and create the
+  base files for the new package (package.json, src/index, etc).
+1. `devkit-admin templates`. This will update the README and all other template files that might
+  have changed when adding a new package.
+
+For private packages, you will need to add a `"private": true` key to your package.json manually.
+This will require re-running the template admin script.
+
+# Packages
+
+This is a monorepo which contains many tools and packages:
 
 
 
@@ -54,10 +78,7 @@ will also be available to third party tools and IDEs.
 **Schematics CLI** | [`@angular-devkit/schematics-cli`](https://npmjs.com/package/@angular-devkit/schematics-cli) | [![latest](https://img.shields.io/npm/v/%40angular-devkit%2Fschematics-cli/latest.svg)](https://npmjs.com/package/@angular-devkit/schematics-cli) |  [![snapshot](https://img.shields.io/badge/snapshot--blue.svg)](https://github.com/angular/angular-devkit-schematics-cli-builds)
 
 
-
 ## Packages
-This is a monorepo which contains many packages:
-
 
 
 | Project | Package | Version | Links |

lib/bootstrap-local.js

@@ -26,10 +26,10 @@ if (process.env['CODE_COVERAGE'] || process.argv.indexOf('--code-coverage') !==
 let profiler = null;
 if (process.env['DEVKIT_PROFILING']) {
   try {
-    profiler = require('v8-profiler');
+    profiler = require('v8-profiler-node8');
   } catch (err) {
-    throw new Error(`Could not require 'v8-profiler'. You must install it separetely with` +
-      `'npm install v8-profiler --no-save.\n\nOriginal error:\n\n${err}`);
+    throw new Error(`Could not require 'v8-profiler-node8'. You must install it separetely with` +
+      `'npm install v8-profiler-node8 --no-save.\n\nOriginal error:\n\n${err}`);
   }
 
   profiler.startProfiling();
@@ -119,9 +119,12 @@ if (!__dirname.match(new RegExp(`\\${path.sep}node_modules\\${path.sep}`))) {
 
   Module._resolveFilename = function (request, parent) {
     let resolved = null;
+    let exception;
     try {
       resolved = oldResolve.call(this, request, parent);
-    } catch (_) {}
+    } catch (e) {
+      exception = e;
+    }
 
     if (request in packages) {
       return packages[request].main;
@@ -135,6 +138,12 @@ if (!__dirname.match(new RegExp(`\\${path.sep}node_modules\\${path.sep}`))) {
       if (match) {
         const p = path.join(packages[match].root, request.substr(match.length));
         return oldResolve.call(this, p, parent);
+      } else if (!resolved) {
+        if (exception) {
+          throw exception;
+        } else {
+          return resolved;
+        }
       } else {
         // Because loading `.ts` ends up AFTER `.json` in the require() logic, requiring a file that has both `.json`
         // and `.ts` versions will only get the `.json` content (which wouldn't happen if the .ts was compiled to

package.json

@@ -34,6 +34,7 @@
     "validate": "node ./bin/devkit-admin validate",
     "validate-commits": "./bin/devkit-admin validate-commits",
     "prepush": "node ./bin/devkit-admin hooks/pre-push",
+    "preinstall": "node ./tools/yarn/check-yarn.js",
     "webdriver-update-appveyor": "webdriver-manager update --standalone false --gecko false --versions.chrome 2.37",
     "webdriver-update-circleci": "webdriver-manager update --standalone false --gecko false --versions.chrome $CHROMEDRIVER_VERSION_ARG "
   },

packages/_/benchmark/src/benchmark.ts

@@ -15,11 +15,11 @@ declare const global: {
 const kNanosecondsPerSeconds = 1e9;
 const kBenchmarkIterationMaxCount = 10000;
 const kBenchmarkTimeoutInMsec = 5000;
-const kWarmupIterationCount = 10;
+const kWarmupIterationCount = 100;
 const kTopMetricCount = 5;
 
 
-function _run(fn: () => void, collector: number[]) {
+function _run(fn: (i: number) => void, collector: number[]) {
   const timeout = Date.now();
   // Gather the first 5 seconds runs, or kMaxNumberOfIterations runs whichever comes first
   // (soft timeout).
@@ -28,7 +28,7 @@ function _run(fn: () => void, collector: number[]) {
        i++) {
     // Start time.
     const start = process.hrtime();
-    fn();
+    fn(i);
     // Get the stop difference time.
     const diff = process.hrtime(start);
 
@@ -41,13 +41,15 @@ function _run(fn: () => void, collector: number[]) {
 function _stats(metrics: number[]) {
   metrics.sort((a, b) => a - b);
 
-  const middle = metrics.length / 2;
+  const count = metrics.length;
+  const middle = count / 2;
   const mean = Number.isInteger(middle)
     ? metrics[middle] : ((metrics[middle - 0.5] + metrics[middle + 0.5]) / 2);
   const total = metrics.reduce((acc, curr) => acc + curr, 0);
-  const average = total / metrics.length;
+  const average = total / count;
 
   return {
+    count: count,
     fastest: metrics.slice(0, kTopMetricCount),
     slowest: metrics.reverse().slice(0, kTopMetricCount),
     mean,
@@ -56,12 +58,12 @@ function _stats(metrics: number[]) {
 }
 
 
-export function benchmark(name: string, fn: () => void, base?: () => void) {
+export function benchmark(name: string, fn: (i: number) => void, base?: (i: number) => void) {
   it(name + ' (time in nanoseconds)', (done) => {
     process.nextTick(() => {
       for (let i = 0; i < kWarmupIterationCount; i++) {
         // Warm it up.
-        fn();
+        fn(i);
       }
 
       const reporter = global.benchmarkReporter;

packages/angular/cli/README.md

@@ -226,6 +226,28 @@ Then you can add breakpoints in `dist/@angular` files.
 
 For more informations about Node.js debugging in VS Code, see the related [VS Code Documentation](https://code.visualstudio.com/docs/nodejs/nodejs-debugging).
 
+### CPU Profiling
+
+In order to investigate performance issues, CPU profiling is often usefull.
+
+To capture a CPU profiling, you can:
+1. install the v8-profiler-node8 dependency: `npm install v8-profiler-node8 --no-save`
+1. set the NG_CLI_PROFILING Environment variable to the file name you want:
+    * on Unix systems (Linux & Mac OS X): ̀`export NG_CLI_PROFILING=my-profile`
+    * on Windows: ̀̀`setx NG_CLI_PROFILING my-profile`
+
+Then, just run the ng command on which you want to capture a CPU profile.
+You will then obtain a `my-profile.cpuprofile` file in the folder from wich you ran the ng command.
+
+You can use the Chrome Devtools to process it. To do so:
+1. open `chrome://inspect/#devices` in Chrome
+1. click on "Open dedicated DevTools for Node"
+1. go to the "profiler" tab
+1. click on the "Load" button and select the generated .cpuprofile file
+1. on the left panel, select the associated file
+
+In addition to this one, another, more elaborated way to capture a CPU profile using the Chrome Devtools is detailed in https://github.com/angular/angular-cli/issues/8259#issue-269908550.
+
 ## Documentation
 
 The documentation for the Angular CLI is located in this repo's [wiki](https://github.com/angular/angular-cli/wiki).

packages/angular/cli/commands/update-impl.ts

@@ -54,7 +54,7 @@ export class UpdateCommand extends SchematicCommand<UpdateCommandSchema> {
       collectionName: this.collectionName,
       schematicName: this.schematicName,
       schematicOptions: options['--'],
-      dryRun: options.dryRun,
+      dryRun: !!options.dryRun,
       force: false,
       showNothingDone: false,
     });

packages/angular/cli/commands/update.json

@@ -11,30 +11,6 @@
 
   "type": "object",
   "allOf": [
-    {
-      "properties": {
-        "packages": {
-          "type": "array",
-          "items": {
-            "type": "string"
-          },
-          "description": "The names of package(s) to update",
-          "$default": {
-            "$source": "argv"
-          }
-        },
-        "dryRun": {
-          "type": "boolean",
-          "default": false,
-          "aliases": [
-            "d"
-          ],
-          "description": "Run through without making any changes."
-        }
-      },
-      "required": [
-      ]
-    },
     {
       "$ref": "./definitions.json#/definitions/base"
     }

packages/angular/cli/lib/init.ts

@@ -43,8 +43,19 @@ function _fromPackageJson(cwd?: string) {
 
 // Check if we need to profile this CLI run.
 if (process.env['NG_CLI_PROFILING']) {
-  const profiler = require('v8-profiler'); // tslint:disable-line:no-implicit-dependencies
+  let profiler: {
+    startProfiling: (name?: string, recsamples?: boolean) => void;
+    stopProfiling: (name?: string) => any; // tslint:disable-line:no-any
+  };
+  try {
+    profiler = require('v8-profiler-node8'); // tslint:disable-line:no-implicit-dependencies
+  } catch (err) {
+    throw new Error(`Could not require 'v8-profiler-node8'. You must install it separetely with` +
+      `'npm install v8-profiler-node8 --no-save.\n\nOriginal error:\n\n${err}`);
+  }
+
   profiler.startProfiling();
+
   const exitHandler = (options: { cleanup?: boolean, exit?: boolean }) => {
     if (options.cleanup) {
       const cpuProfile = profiler.stopProfiling();

packages/angular_devkit/build_angular/package.json

@@ -18,7 +18,6 @@
     "copy-webpack-plugin": "4.5.2",
     "file-loader": "2.0.0",
     "glob": "7.1.3",
-    "html-webpack-plugin": "3.2.0",
     "istanbul": "0.4.5",
     "istanbul-instrumenter-loader": "3.0.1",
     "karma-source-map-support": "1.3.0",