# counsel-filename-format

> enforce filename formatting

Latest version **0.4.1** (published 2017-08-14) · ISC license · 0 weekly downloads

## Install

```sh
npm install counsel-filename-format
pnpm add counsel-filename-format
yarn add counsel-filename-format
bun add counsel-filename-format
```

## Health

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

Positive: no vulnerabilities.

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

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.1 |
| Published | 2017-08-14 |
| First published | 2016-10-07 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | cdaringe |
| Maintainers | cdaringe |

## Links

- npm: https://www.npmjs.com/package/counsel-filename-format
- npm.io page: https://npm.io/package/counsel-filename-format

## Dependencies (3)

- [glob](https://npm.io/package/glob.md) ^7.1.0
- [pify](https://npm.io/package/pify.md) ^2.3.0
- [counsel-rule](https://npm.io/package/counsel-rule.md) ^0.4.1

## Recent versions

- 0.4.1 (latest) — 2017-08-14
- 0.4.0 — 2017-08-14
- 0.3.1-0 — 2017-08-14
- 0.3.0 — 2017-08-08
- 0.2.0 — 2017-08-07
- 0.1.4 — 2017-03-27
- 0.1.1 — 2017-03-23
- 0.0.29 — 2017-01-17
- 0.0.28 — 2017-01-12
- 0.0.26 — 2017-01-09
- 0.0.23 — 2016-12-01
- 0.0.22 — 2016-12-01
- 0.0.21 — 2016-11-17
- 0.0.20 — 2016-11-17
- 0.0.19 — 2016-11-15
- … 4 more at https://npm.io/package/counsel-filename-format/versions

## README

# counsel-filename-format

add's a `counsel.check` task that enforces filename conventions in your project!

## example

- create your rule

```js
'use strict'

const FilenameFormatRule = require('counsel-filename-format')
const kebab = require('lodash.kebabcase')

module.exports = new FilenameFormatRule({
  fileFormatExtensions: 'js',
  fileFormatExclude: ['*IGNORE*', '*docs/**/*.blah'], // <== `glob` matchers!
  fileFormatFunction: kebab // <== enforces all files are kebab-cased.  best case :)
})
```

- run `counsel.check(rules)` (per `counsel` docs)

check will `reject`, and the process will exit w/ code 1 if unhandled.

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