# apemanfile

> Configuration file handler for apeman framework.

Latest version **8.0.0** (published 2016-07-31) · MIT license · 0 weekly downloads

## Install

```sh
npm install apemanfile
pnpm add apemanfile
yarn add apemanfile
bun add apemanfile
```

## 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 | 8.0.0 |
| Published | 2016-07-31 |
| First published | 2015-07-22 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | >=6 |
| Dependencies | 0 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Taka Okunishi |
| Maintainers | okunishinishi |
| Keywords | apeman, Apemanfile, configuration |

## Links

- npm: https://www.npmjs.com/package/apemanfile
- Repository: https://github.com/apeman-labo/apemanfile
- Homepage: https://github.com/apeman-labo/apemanfile#readme
- Issues: https://github.com/apeman-labo/apemanfile/issues
- npm.io page: https://npm.io/package/apemanfile

## Alternatives

- [jsforce](https://npm.io/package/jsforce.md) — 851.2K weekly downloads
- [react-native-qrcode-svg](https://npm.io/package/react-native-qrcode-svg.md) — 693.5K weekly downloads
- [@salesforce/plugin-data](https://npm.io/package/@salesforce/plugin-data.md) — 394.9K weekly downloads
- [@backstage/plugin-search-common](https://npm.io/package/@backstage/plugin-search-common.md) — 308.5K weekly downloads
- [@chain-registry/types](https://npm.io/package/@chain-registry/types.md) — 38.4K weekly downloads

## Recent versions

- 8.0.0 (latest) — 2016-07-31
- 7.0.3 — 2016-07-11
- 7.0.2 — 2016-07-09
- 7.0.1 — 2016-07-03
- 7.0.0 — 2016-07-02
- 6.0.1 — 2016-05-21
- 6.0.0 — 2016-05-18
- 5.2.1 — 2016-04-27
- 5.2.0 — 2016-04-27
- 5.1.11 — 2016-04-27
- 5.1.10 — 2016-04-19
- 5.1.9 — 2016-03-01
- 5.1.8 — 2016-02-29
- 5.1.7 — 2016-02-29
- 5.1.6 — 2016-02-29
- … 66 more at https://npm.io/package/apemanfile/versions

## README

apemanfile
==========

<!---
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/apeman-labo/apemanfile
[bd_travis_url]: http://travis-ci.org/apeman-labo/apemanfile
[bd_travis_shield_url]: http://img.shields.io/travis/apeman-labo/apemanfile.svg?style=flat
[bd_travis_com_url]: http://travis-ci.com/apeman-labo/apemanfile
[bd_travis_com_shield_url]: https://api.travis-ci.com/apeman-labo/apemanfile.svg?token=
[bd_license_url]: https://github.com/apeman-labo/apemanfile/blob/master/LICENSE
[bd_codeclimate_url]: http://codeclimate.com/github/apeman-labo/apemanfile
[bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/apeman-labo/apemanfile.svg?style=flat
[bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/apeman-labo/apemanfile.svg?style=flat
[bd_gemnasium_url]: https://gemnasium.com/apeman-labo/apemanfile
[bd_gemnasium_shield_url]: https://gemnasium.com/apeman-labo/apemanfile.svg
[bd_npm_url]: http://www.npmjs.org/package/apemanfile
[bd_npm_shield_url]: http://img.shields.io/npm/v/apemanfile.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>

Configuration file handler for apeman framework.

<!-- 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 apemanfile --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
---------

Load an apemanfile for a project.

```javascript
'use strict'

const apemanfile = require('apemanfile')

// Create an apemanfile instance
let configuration = apemanfile('my_project_dir/Apemanfile.js')

// Get property with keypath
let task = configuration.get('$task.build')
/* ... */


```


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

<!-- Section from "doc/guides/03.Spec.md.hbs" Start -->

<a name="section-doc-guides-03-spec-md"></a>

Spec
----

### Properties in Apemanfile.js

| Property | Type | Description |
| --- | --- | --- |
| $api | API interfaces |
| $children | Child projects |
| $ctx | Context values |
| $cwd | Working directory path |
| $defaultCtx | Default context values |
| $name | Name of this apeman file |
| $needs | Needed commands |
| $notes | Description of properties |
| $parent | Parent project |
| $pkg | Package data |
| $proto | Prototype projects |
| $src | Path of loaded file |
| $ui | User interface settings |


<!-- Section from "doc/guides/03.Spec.md.hbs" End -->


<!-- Sections Start -->


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

License
-------
This software is released under the [MIT License](https://github.com/apeman-labo/apemanfile/blob/master/LICENSE).

<!-- LICENSE End -->

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