# ape-formatting

> Format files

Latest version **2.0.2** (published 2019-03-05) · MIT license · 0 weekly downloads

## Install

```sh
npm install ape-formatting
pnpm add ape-formatting
yarn add ape-formatting
bun add ape-formatting
```

## 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 | 2.0.2 |
| Published | 2019-03-05 |
| First published | 2016-05-15 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=8 |
| Dependencies | 3 |
| Unpacked size | 11.4 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Taka Okunishi |
| Maintainers | okunishinishi |

## Links

- npm: https://www.npmjs.com/package/ape-formatting
- Repository: https://github.com/ape-repo/ape-formatting
- Homepage: https://github.com/ape-repo/ape-formatting#readme
- Issues: https://github.com/ape-repo/ape-formatting/issues
- npm.io page: https://npm.io/package/ape-formatting

## Dependencies (3)

- [aglob](https://npm.io/package/aglob.md) ^3.0.1
- [execcli](https://npm.io/package/execcli.md) ^5.0.6
- [fmtjson](https://npm.io/package/fmtjson.md) ^4.0.3

## Recent versions

- 2.0.2 (latest) — 2019-03-05
- 2.0.1 — 2019-02-24
- 2.0.0 — 2019-02-23
- 1.0.2 — 2016-07-12
- 1.0.1 — 2016-07-12
- 1.0.0 — 2016-05-15

## README

ape-formatting
==========

<!---
This file is generated by ape-tmpl. Do not update manually.
--->

<!-- Badge Start -->
<a name="badges"></a>

[![Build Status][bd_travis_shield_url]][bd_travis_url]
[![Code Climate][bd_codeclimate_shield_url]][bd_codeclimate_url]
[![Code Coverage][bd_codeclimate_coverage_shield_url]][bd_codeclimate_url]
[![npm Version][bd_npm_shield_url]][bd_npm_url]
[![JS Standard][bd_standard_shield_url]][bd_standard_url]

[bd_repo_url]: https://github.com/ape-repo/ape-formatting
[bd_travis_url]: http://travis-ci.org/ape-repo/ape-formatting
[bd_travis_shield_url]: http://img.shields.io/travis/ape-repo/ape-formatting.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/ape-repo/ape-formatting
[bd_travis_com_shield_url]: https://api.travis-ci.com/ape-repo/ape-formatting.svg?token=
[bd_license_url]: https://github.com/ape-repo/ape-formatting/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/ape-repo/ape-formatting
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/ape-repo/ape-formatting.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/ape-repo/ape-formatting.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/ape-repo/ape-formatting
[bd_gemnasium_shield_url]: https://gemnasium.com/ape-repo/ape-formatting.svg
[bd_npm_url]: http://www.npmjs.org/package/ape-formatting
[bd_npm_shield_url]: http://img.shields.io/npm/v/ape-formatting.svg?style=flat
[bd_standard_url]: http://standardjs.com/
[bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

<!-- Badge End -->


<!-- Description Start -->
<a name="description"></a>

Format files

<!-- Description End -->


<!-- Overview Start -->
<a name="overview"></a>



<!-- Overview End -->


<!-- Sections Start -->
<a name="sections"></a>

<!-- Section from "doc/guides/01.Installation.md.hbs" Start -->

<a name="section-doc-guides-01-installation-md"></a>

Installation
-----

```bash
$ npm install ape-formatting --save
```


<!-- Section from "doc/guides/01.Installation.md.hbs" End -->

<!-- Section from "doc/guides/02.Usage.md.hbs" Start -->

<a name="section-doc-guides-02-usage-md"></a>

Usage
---------

```javascript
'use strict'

const apeFormatting = require('ape-formatting')

// Format javascript files
apeFormatting.formatJs('lib/*.js', {
  ignore: 'index.js'
}).then(() => {
  /* ... */
})

// Format json files
apeFormatting.formatJson('lib/*.json', {
  indent: 2,
  sort: true
}).then(() => {
  /* ... */
})

```


<!-- Section from "doc/guides/02.Usage.md.hbs" End -->


<!-- Sections Start -->


<!-- LICENSE Start -->
<a name="license"></a>

License
-------
This software is released under the [MIT License](https://github.com/ape-repo/ape-formatting/blob/master/LICENSE).

<!-- LICENSE End -->


<!-- Links Start -->
<a name="links"></a>

Links
------

+ [standard-format][standard_format_url]

[standard_format_url]: https://github.com/maxogden/standard-format

<!-- Links End -->

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