# detect-repo-changelog

> Scans a repository directory, searching for a changelog file

Latest version **1.0.1** (published 2016-09-15) · MIT license · 0 weekly downloads

## Install

```sh
npm install detect-repo-changelog
pnpm add detect-repo-changelog
yarn add detect-repo-changelog
bun add detect-repo-changelog
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2016-09-15 |
| First published | 2016-09-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=4.0.0 |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | IndigoUnited |
| Maintainers | satazor |
| Keywords | has, changelog, detect |

## Links

- npm: https://www.npmjs.com/package/detect-repo-changelog
- Repository: https://github.com/IndigoUnited/node-detect-repo-changelog
- Homepage: https://github.com/IndigoUnited/node-detect-repo-changelog#readme
- Issues: https://github.com/IndigoUnited/node-detect-repo-changelog/issues/
- npm.io page: https://npm.io/package/detect-repo-changelog

## Dependencies (4)

- [pify](https://npm.io/package/pify.md) ^2.3.0
- [lodash.find](https://npm.io/package/lodash.find.md) ^4.6.0
- [is-regular-file](https://npm.io/package/is-regular-file.md) ^1.0.1
- [changelog-filename-regex](https://npm.io/package/changelog-filename-regex.md) ^1.1.0

## Alternatives

- [@gemini-wallet/core](https://npm.io/package/@gemini-wallet/core.md) — 515.6K weekly downloads
- [utility](https://npm.io/package/utility.md) — 416.6K weekly downloads
- [@primno/dpapi](https://npm.io/package/@primno/dpapi.md) — 7.2K weekly downloads
- [pi-readseek](https://npm.io/package/pi-readseek.md) — 3.7K weekly downloads
- [@emilia-protocol/verify](https://npm.io/package/@emilia-protocol/verify.md) — 1.1K weekly downloads

## Recent versions

- 1.0.1 (latest) — 2016-09-15
- 1.0.0 — 2016-09-15

## README

# detect-repo-changelog

[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coverage Status][coveralls-image]][coveralls-url] [![Dependency status][david-dm-image]][david-dm-url] [![Dev Dependency status][david-dm-dev-image]][david-dm-dev-url]

[npm-url]:https://npmjs.org/package/detect-repo-changelog
[downloads-image]:http://img.shields.io/npm/dm/detect-repo-changelog.svg
[npm-image]:http://img.shields.io/npm/v/detect-repo-changelog.svg
[travis-url]:https://travis-ci.org/IndigoUnited/node-detect-repo-changelog
[travis-image]:http://img.shields.io/travis/IndigoUnited/node-detect-repo-changelog/master.svg
[coveralls-url]:https://coveralls.io/r/IndigoUnited/node-detect-repo-changelog
[coveralls-image]:https://img.shields.io/coveralls/IndigoUnited/node-detect-repo-changelog/master.svg
[david-dm-url]:https://david-dm.org/IndigoUnited/node-detect-repo-changelog
[david-dm-image]:https://img.shields.io/david/IndigoUnited/node-detect-repo-changelog.svg
[david-dm-dev-url]:https://david-dm.org/IndigoUnited/node-detect-repo-changelog#info=devDependencies
[david-dm-dev-image]:https://img.shields.io/david/dev/IndigoUnited/node-detect-repo-changelog.svg

Scans a repository directory, searching for a changelog file.

Uses [changelog-filename-regex](https://github.com/shinnn/changelog-filename-regex) to match against a variety of changelog filenames.


## Installation

`$ npm install detect-repo-changelog`


## Usage

`detectRepoChangelog(dir) -> Promise`

```js
const detectRepoChangelog = require('detect-repo-changelog');

detectRepoChangelog('./some-repository-directory')
.then((changelogFile) => {
    if (changelogFile) {
        console.log(`changelog file is ${changelogFile}`);
    } else {
        console.log('no changelog detected');
    }
});
```


## Tests

`$ npm test`   
`$ npm test-cov` to get coverage report


## License

Released under the [MIT License](http://www.opensource.org/licenses/mit-license.php).

---
_Source: https://npm.io/package/detect-repo-changelog · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._