Skip to content

Commit 2a83bf3

Browse files
committed
docs: adds a list of all options in lower camel case
and minor stuff
1 parent aac96a9 commit 2a83bf3

File tree

3 files changed

+18
-11
lines changed

3 files changed

+18
-11
lines changed

README.md

Lines changed: 16 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -295,14 +295,26 @@ This can be very useful because it outputs what would happen without doing anyth
295295

296296
## 📁 Configuration File <a name="configuration-file"></a>
297297

298-
To avoid all these command-line cmd options, you can write down your configuration in the `angular.json` file in the `options` attribute of your deploy project's architect. Just change the kebab-case<sup id="configuration-file-mark-1">[1](#configuration-file-def-1)</sup> to lower camel case<sup id="configuration-file-mark-2">[2](#configuration-file-def-2)</sup>.
299-
300-
A list of all avaiable options is available [here](https://github.com/angular-schule/angular-cli-ghpages/blob/master/src/deploy/schema.json).
298+
To avoid all these command-line cmd options, you can write down your configuration in the `angular.json` file in the `options` attribute of your deploy project's architect. Just change the kebab-case to lower camel case. This is the notation of all options in lower camel case:
299+
* baseHref
300+
* configuration
301+
* noBuild
302+
* repo
303+
* message
304+
* branch
305+
* name
306+
* email
307+
* noSilent
308+
* noDotfiles
309+
* cname
310+
* dryRun
311+
312+
A list of all avaiable options is also available [here](https://github.com/angular-schule/angular-cli-ghpages/blob/master/src/deploy/schema.json).
301313

302314
Example:
303315

304316
```sh
305-
ng deploy your-project-name --base-href=https://angular-schule.github.io/angular-cli-ghpages/ --name=angular --email=[email protected]
317+
ng deploy --base-href=https://angular-schule.github.io/angular-cli-ghpages/ --name="Angular Schule Team" --email=[email protected]
306318
```
307319

308320
becomes
@@ -322,11 +334,6 @@ And just run `ng deploy` 😄.
322334

323335
> ℹ️ You can always use the [--dry-run](#dry-run) option to verify if your configuration is right.
324336
325-
---
326-
327-
<a id="configuration-file-def-1">1.</a> In kebab case, all letters are written in lower case and the words are separated by a hyphen or minus sign. "Kebab Case" becomes "kebab-case". [](#configuration-file-mark-1)
328-
329-
<a id="configuration-file-def-2">2.</a> Lower camel case (part of CamelCase) is a naming convention in which a name is formed of multiple words that are joined together as a single word with the first letter of each of the multiple words (except the first one) capitalized within the new word that forms the name. "Lower Camel Case" becomes "lowerCamelCase" [](#configuration-file-mark-2)
330337

331338
## 🏁 Next milestones <a name="milestones"></a>
332339

src/deploy/actions.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import { BuilderContext } from '@angular-devkit/architect';
2-
import { Schema } from './schema';
32
import { json, logging } from '@angular-devkit/core';
43

4+
import { Schema } from './schema';
55

66
export default async function deploy(
77
engine: { run: (dir: string, options: Schema, logger: logging.LoggerApi) => Promise<void> },

src/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,7 @@
5050
"@angular-devkit/core": "^8.3.0",
5151
"@angular-devkit/schematics": "^8.3.0",
5252
"@types/fs-extra": "^8.0.0",
53-
"@types/jest": "^24.0.16",
53+
"@types/jest": "^24.0.18",
5454
"@types/node": "^12.6.9",
5555
"copyfiles": "^2.1.1",
5656
"jest": "^24.8.0",

0 commit comments

Comments
 (0)