Skip to content
This repository was archived by the owner on Sep 16, 2018. It is now read-only.

Commit fa28dd1

Browse files
committed
update docs
1 parent 9d5dce6 commit fa28dd1

File tree

1 file changed

+13
-8
lines changed

1 file changed

+13
-8
lines changed

README.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ npm install && npm run link
1010

1111
### Test schematic changes against this repositories Angular CLI test-app
1212

13-
Schematic changes will be applied to the test app in the `./test-app` directory
13+
When running locally, schematic changes will be applied to the test app in the `./test-app` directory. The test-app is a bare CLI app and serves no other purpose than for testing schematics changes.
1414

1515
Compile the typescript in watch mode in one shell:
1616

@@ -30,14 +30,14 @@ npm run clean:launch
3030

3131
### Test schematics against a local project
3232

33-
- run `npm run build` to compile the schematic
34-
- in another shell, cd into the repo and run `npm link ../PATH_TO_THIS_PROJECT`
35-
- this will link the projects so that the schematic command runs from you're local filesystem
36-
- in the repo you want to run the schematic against, run `ng g add-jest:add-jest`
33+
- run `npm run build` to compile the schematic in watch mode
34+
- open another shell, cd into the local repo you want to run the schematic against, and run `npm link ../PATH_TO_THIS_PROJECT`
35+
- this will symlink the projects so that the Jest schematic command runs from you're local filesystem
36+
- in the local repo you want to run the schematic against, run `ng g add-jest:add-jest`
3737

3838
### Dev tips
3939

40-
while developing, comment out the following line to avoid npm installing dependencies
40+
For faster developing, find and comment out the following line to avoid npm installing dependencies
4141

4242
```ts
4343
context.addTask(new NodePackageInstallTask());
@@ -67,9 +67,9 @@ npm run build:once
6767

6868
## Testing
6969

70-
### Test changes to local `/test-app` project
70+
### Test local test-app for regressions
7171

72-
Run a series of standard tests to ensure things continue to function as expected in the test-app
72+
Run a series of standard tests to ensure the `./test-app` continues to function normally
7373

7474
```shell
7575
npm run test:app
@@ -103,3 +103,8 @@ npm publish
103103
```
104104

105105
That's it!
106+
107+
## Documentation
108+
109+
- [Schematics README](https://github.com/angular/angular-cli/blob/master/packages/angular_devkit/schematics/README.md)
110+
- [Angular CLI schematic examples](https://github.com/angular/angular-cli/blob/master/packages/schematics/angular/app-shell/index.ts)

0 commit comments

Comments
 (0)