Skip to content

Commit

Permalink
Adjust options list position
Browse files Browse the repository at this point in the history
  • Loading branch information
vilicvane committed Sep 17, 2021
1 parent d7a926a commit 99d9f8d
Showing 1 changed file with 36 additions and 38 deletions.
74 changes: 36 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,42 @@ npm install --save-dev inplate
inplate [options] [file-pattern]
```

### Options

- `--config`

Config files to `require()`.

- `--update`

Update files.

- `--assert`

Assert that files are up-to-date, otherwise exit with non-zero code.

- `--silent`

Silence listed files and diffs.

- `--template <template-path>`

Path to file template.

- `--data <module-path>`

Module to load default template data.

- `--comment-styles <styles>`

One or more of `#`, `//`, `/*`, `{/*`, `<!--`, comma-separated.

### Arguments

- `[file-pattern]`

Glob pattern for target files, required if `--config` is not specified.

## Example

```bash
Expand Down Expand Up @@ -126,44 +162,6 @@ Take `/*` as an example:
[generated content]
```

## Command line

### Options

- `--config`

Config files to `require()`.

- `--update`

Update files.

- `--assert`

Assert that files are up-to-date, otherwise exit with non-zero code.

- `--silent`

Silence listed files and diffs.

- `--template <template-path>`

Path to file template.

- `--data <module-path>`

Module to load default template data.

- `--comment-styles <styles>`

One or more of `#`, `//`, `/*`, `{/*`, `<!--`, comma-separated.

### Arguments

- `[file-pattern]`

Glob pattern for target files, required if `--config` is not specified.

## Config files

Config file specified with option `--config`.
Expand Down

0 comments on commit 99d9f8d

Please sign in to comment.