Skip to content

Commit

Permalink
docs(*): remove usage of global grunt-cli
Browse files Browse the repository at this point in the history
Previously, the `DEVELOPERS.md` and `CONTRIBUTING.md` files
refered to global `grunt-cli` by default.

This commit ensures the local `grunt-cli` is used by default
and mentiones the possibility to still use the global `grunt-cli`.
  • Loading branch information
frederikprijck authored and Narretz committed Nov 11, 2017
1 parent 181ac0b commit f876ab7
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 29 deletions.
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ Before you submit your pull request consider the following guidelines:
* Run the AngularJS [unit][developers.tests-unit] and [E2E test][developers.tests-e2e] suites, and ensure that all tests
pass. It is generally sufficient to run the tests only on Chrome, as our Travis integration will
run the tests on all supported browsers.
* Run `grunt eslint` to check that you have followed the automatically enforced coding rules
* Run `yarn grunt eslint` to check that you have followed the automatically enforced coding rules
* Commit your changes using a descriptive commit message that follows our
[commit message conventions][developers.commits]. Adherence to the
[commit message conventions][developers.commits] is required, because release notes are
Expand All @@ -141,7 +141,7 @@ Before you submit your pull request consider the following guidelines:
* Before creating the Pull Request, package and run all tests a last time:

```shell
grunt test
yarn grunt test
```

* Push your branch to GitHub:
Expand Down
42 changes: 15 additions & 27 deletions DEVELOPERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,9 @@ machine:
to be installed and included in your
[PATH](http://docs.oracle.com/javase/tutorial/essential/environment/paths.html) variable.

* [Grunt](http://gruntjs.com): We use Grunt as our build system. Install the grunt command-line tool
globally with:

```shell
yarn global add grunt-cli
```
* [Grunt](http://gruntjs.com): We use Grunt as our build system. We're using it as a local dependency,
but you can also add the grunt command-line tool globally (with `yarn global add grunt-cli`), which allows
you to leave out the `yarn` prefix for all our grunt commands.

### Forking AngularJS on Github

Expand Down Expand Up @@ -70,20 +67,11 @@ git remote add upstream "https://github.com/angular/angular.js.git"
yarn install

# Build AngularJS (which will install `bower` dependencies automatically):
grunt package
yarn grunt package
```

**Note:** If you're using Windows, you must use an elevated command prompt (right click, run as
Administrator). This is because `grunt package` creates some symbolic links.

**Note:** If you're using Linux, and `yarn install` fails with the message
'Please try running this command again as root/Administrator.', you may need to globally install
`grunt` and `bower`:

```shell
sudo yarn global add grunt-cli
sudo yarn global add bower
```
Administrator). This is because `yarn grunt package` creates some symbolic links.

The build output is in the `build` directory. It consists of the following files and
directories:
Expand All @@ -105,7 +93,7 @@ HTTP server. For this purpose, we have made available a local web server based o

1. To start the web server, run:
```shell
grunt webserver
yarn grunt webserver
```

2. To access the local server, enter the following URL into your web browser:
Expand All @@ -125,13 +113,13 @@ We write unit and integration tests with Jasmine and execute them with Karma. To
tests once on Chrome run:

```shell
grunt test:unit
yarn grunt test:unit
```

To run the tests on other browsers (Chrome, ChromeCanary, Firefox and Safari are pre-configured) use:

```shell
grunt test:unit --browsers=Chrome,Firefox
yarn grunt test:unit --browsers=Chrome,Firefox
```

**Note:** there should be _no spaces between browsers_. `Chrome, Firefox` is INVALID.
Expand All @@ -143,9 +131,9 @@ For example, to run the whole unit test suite:

```shell
# Browserstack
grunt test:unit --browsers=BS_Chrome,BS_Firefox,BS_Safari,BS_IE_9,BS_IE_10,BS_IE_11,BS_EDGE,BS_iOS_8,BS_iOS_9,BS_iOS_10
yarn grunt test:unit --browsers=BS_Chrome,BS_Firefox,BS_Safari,BS_IE_9,BS_IE_10,BS_IE_11,BS_EDGE,BS_iOS_8,BS_iOS_9,BS_iOS_10
# Saucelabs
grunt test:unit --browsers=BS_Chrome,BS_Firefox,BS_Safari,BS_IE_9,BS_IE_10,BS_IE_11,BS_EDGE,BS_iOS_8,BS_iOS_9,BS_iOS_10
yarn grunt test:unit --browsers=BS_Chrome,BS_Firefox,BS_Safari,BS_IE_9,BS_IE_10,BS_IE_11,BS_EDGE,BS_iOS_8,BS_iOS_9,BS_iOS_10
```

Running these commands requires you to set up [Karma Browserstack][karma-browserstack] or
Expand All @@ -157,7 +145,7 @@ source or test files change. To execute tests in this mode run:
1. To start the Karma server, capture Chrome browser and run unit tests, run:

```shell
grunt autotest
yarn grunt autotest
```

2. To capture more browsers, open this URL in the desired browser (URL might be different if you
Expand All @@ -173,7 +161,7 @@ source or test files change. To execute tests in this mode run:
To learn more about all of the preconfigured Grunt tasks run:

```shell
grunt --help
yarn grunt --help
```


Expand All @@ -182,7 +170,7 @@ grunt --help
AngularJS's end to end tests are run with Protractor. Simply run:

```shell
grunt test:e2e
yarn grunt test:e2e
```

This will start the webserver and run the tests on Chrome.
Expand Down Expand Up @@ -329,7 +317,7 @@ documentation generation tool [Dgeni][dgeni].
The docs can be built from scratch using grunt:

```shell
grunt docs
yarn grunt docs
```

This defers the doc-building task to `gulp`.
Expand All @@ -338,7 +326,7 @@ Note that the docs app is using the local build files to run. This means you mig
the build:

```shell
grunt build
yarn grunt build
```

(This is also necessary if you are making changes to minErrors).
Expand Down

0 comments on commit f876ab7

Please sign in to comment.