You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Update the REAMDE.md in /tools, adding the missing task description
for the `clean.coverage` task and correct the
misspelling for the `server.prod` and `server.start` task.
Copy file name to clipboardExpand all lines: tools/README.md
+7-2
Original file line number
Diff line number
Diff line change
@@ -20,6 +20,10 @@ The subfolders provide further folders to distinguish between files which are pr
20
20
21
21
The configuration of the seed contains of a basic configuration provided by `/config/seed.config.ts` file. You can add your own custom configuration within the `/config/project.config.ts` file, which extends the seed configuration.
22
22
23
+
## Environment Configuration
24
+
25
+
The environment configuration files in `/tools/env` provide a way for you to set and override configuration settings based on a given environment. The `/tools/env/base.ts` configuration is set up in all environments (dev|test|staging|prod), whereas the `/tools/env/dev.ts` is specific to the dev environment, as is `/tools/env/prod.ts` specific to the prod environment.
26
+
23
27
## Manual Typings
24
28
25
29
The `manual_typings` folder contains of manual TypeScript typings provided by the seed (`/manual_typings/seed`) and project specific TypeScript typings (`/manual_typings/project`). As for the project specific typings there is a sample provided (`/manual_typings/project/sample.package.d.ts`) to help you get started.
@@ -47,6 +51,7 @@ The seed provides the following tasks:
47
51
|`build.js.tools.ts`| Transpiles the TypeScript files located in `/tools`|
48
52
|`check.versions.ts`| Checks if the required Node and NPM (as defined in `/config/seed.config.ts`) are installed |
49
53
|`clean.all.ts`| Cleans all files within the `/dist` directory |
54
+
|`clean.coverage.ts`| Cleans all files within the `/coverage` directory |
50
55
|`clean.dev.ts`| Cleans all files within the `/dist/dev` directory |
51
56
|`clean.prod.ts`| Cleans all files within the `/dist/prod` directory |
52
57
|`clean.tools.ts`| Cleans all JavaScript files (which got transpiled from the TypeScript files) within the `/tools` directory |
@@ -57,8 +62,8 @@ The seed provides the following tasks:
57
62
|`karma.start.ts`| Starts the unit tests using `karma`|
58
63
|`serve.coverage.ts`| Serves the unit test coverage report using an `express` server |
59
64
|`serve.docs.ts`| Serves the application documentation using an `express` server |
60
-
|`serve.prod.ts`| Serves the files from `/dist/prod` using an `express` server |
61
-
|`serve.start.ts`| Serves the files from `/dist/dev` using an `express` server |
65
+
|`server.prod.ts`| Serves the files from `/dist/prod` using an `express` server |
66
+
|`server.start.ts`| Serves the files from `/dist/dev` using an `express` server |
62
67
|`tslint.ts`| Lints the TypeScript files using `codelyzer`|
63
68
|`watch.dev.ts`| Watches for code changes and rebuilds the files in `/dist/dev`|
64
69
|`watch.e2e.ts`| Watches for code changes and rebuilds the files in `/dist/e2e`|
0 commit comments