Skip to content

Commit

Permalink
Add tartufo pre-commit hook
Browse files Browse the repository at this point in the history
  • Loading branch information
watermelonpizza committed Jul 13, 2021
1 parent f5994ad commit 1979bd9
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 10 deletions.
5 changes: 5 additions & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
repos:
- repo: https://github.com/godaddy/tartufo
rev: v2.6.0
hooks:
- id: tartufo
35 changes: 25 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,45 +42,45 @@ cf [abstract-log](github.com/eugeneware/abstract-log).
<a name="module_knex-log..open"></a>

### knex-log~open()
**Kind**: inner method of [<code>knex-log</code>](#module_knex-log)
**Kind**: inner method of [<code>knex-log</code>](#module_knex-log)
<a name="module_knex-log..close"></a>

### knex-log~close()
Call this when done.

**Kind**: inner method of [<code>knex-log</code>](#module_knex-log)
**Kind**: inner method of [<code>knex-log</code>](#module_knex-log)
<a name="module_knex-log..append"></a>

### knex-log~append(payload)
**Kind**: inner method of [<code>knex-log</code>](#module_knex-log)
**Kind**: inner method of [<code>knex-log</code>](#module_knex-log)

| Param | Type |
| --- | --- |
| payload | <code>object</code> |
| payload | <code>object</code> |

<a name="module_knex-log..get"></a>

### knex-log~get(offset) ⇒ <code>object</code>
**Kind**: inner method of [<code>knex-log</code>](#module_knex-log)
**Returns**: <code>object</code> - value
**Kind**: inner method of [<code>knex-log</code>](#module_knex-log)
**Returns**: <code>object</code> - value

| Param | Type |
| --- | --- |
| offset | <code>integer</code> |
| offset | <code>integer</code> |

<a name="module_knex-log..createWriteStream"></a>

### knex-log~createWriteStream()
Create a write stream that we can use to append to the log.

**Kind**: inner method of [<code>knex-log</code>](#module_knex-log)
**Kind**: inner method of [<code>knex-log</code>](#module_knex-log)
<a name="module_knex-log..createReadStream"></a>

### knex-log~createReadStream()
- opts.offset.id - The id to read from

**Kind**: inner method of [<code>knex-log</code>](#module_knex-log)
**Params**: <code>object</code> opts
**Kind**: inner method of [<code>knex-log</code>](#module_knex-log)
**Params**: <code>object</code> opts

## Installation

Expand All @@ -89,6 +89,21 @@ This module is installed via npm:
``` bash
$ npm install knex-log
```

## Contributing

### Prerequisites

```
$ pip install pre-commit
```

### Installation

```
$ pre-commit install --install-hooks
```

## License

The BSD License
Expand Down

0 comments on commit 1979bd9

Please sign in to comment.