1 | apeman-need
|
2 | ==========
|
3 |
|
4 |
|
5 | This file is generated by ape-tmpl. Do not update manually.
|
6 | --->
|
7 |
|
8 |
|
9 | <a name="badges"></a>
|
10 |
|
11 | [![Build Status][bd_travis_shield_url]][bd_travis_url]
|
12 | [![Code Climate][bd_codeclimate_shield_url]][bd_codeclimate_url]
|
13 | [![Code Coverage][bd_codeclimate_coverage_shield_url]][bd_codeclimate_url]
|
14 | [![npm Version][bd_npm_shield_url]][bd_npm_url]
|
15 | [![JS Standard][bd_standard_shield_url]][bd_standard_url]
|
16 |
|
17 | [bd_repo_url]: https://github.com/apeman-cmd-labo/apeman-need
|
18 | [bd_travis_url]: http://travis-ci.org/apeman-cmd-labo/apeman-need
|
19 | [bd_travis_shield_url]: http://img.shields.io/travis/apeman-cmd-labo/apeman-need.svg?style=flat
|
20 | [bd_travis_com_url]: http://travis-ci.com/apeman-cmd-labo/apeman-need
|
21 | [bd_travis_com_shield_url]: https://api.travis-ci.com/apeman-cmd-labo/apeman-need.svg?token=
|
22 | [bd_license_url]: https://github.com/apeman-cmd-labo/apeman-need/blob/master/LICENSE
|
23 | [bd_codeclimate_url]: http://codeclimate.com/github/apeman-cmd-labo/apeman-need
|
24 | [bd_codeclimate_shield_url]: http://img.shields.io/codeclimate/github/apeman-cmd-labo/apeman-need.svg?style=flat
|
25 | [bd_codeclimate_coverage_shield_url]: http://img.shields.io/codeclimate/coverage/github/apeman-cmd-labo/apeman-need.svg?style=flat
|
26 | [bd_gemnasium_url]: https://gemnasium.com/apeman-cmd-labo/apeman-need
|
27 | [bd_gemnasium_shield_url]: https://gemnasium.com/apeman-cmd-labo/apeman-need.svg
|
28 | [bd_npm_url]: http://www.npmjs.org/package/apeman-need
|
29 | [bd_npm_shield_url]: http://img.shields.io/npm/v/apeman-need.svg?style=flat
|
30 | [bd_standard_url]: http://standardjs.com/
|
31 | [bd_standard_shield_url]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg
|
32 |
|
33 |
|
34 |
|
35 |
|
36 |
|
37 | <a name="description"></a>
|
38 |
|
39 | Needs checker for apeman.
|
40 |
|
41 |
|
42 |
|
43 |
|
44 |
|
45 | <a name="overview"></a>
|
46 |
|
47 |
|
48 |
|
49 |
|
50 |
|
51 |
|
52 |
|
53 | <a name="sections"></a>
|
54 |
|
55 |
|
56 |
|
57 | <a name="section-doc-guides-01-installation-md"></a>
|
58 | Installation
|
59 | -----
|
60 |
|
61 | Install apeman-need module via [npm][npm_url].
|
62 | ```bash
|
63 | $ npm install apeman-need -g
|
64 | ```
|
65 |
|
66 |
|
67 | [npm_url]: https://www.npmjs.com/
|
68 |
|
69 |
|
70 |
|
71 |
|
72 |
|
73 | <a name="section-doc-guides-02-usage-md"></a>
|
74 | Usage
|
75 | ---------
|
76 |
|
77 | 1. Prepare an Apemanfile.js at your project root.
|
78 | 2. Run the command via CLI.
|
79 |
|
80 | ***Apemanfile.js***
|
81 | ```javascript
|
82 | /** Example of Apemanfile.js */
|
83 |
|
84 | 'use strict'
|
85 |
|
86 | module.exports = {
|
87 | $cwd: __dirname,
|
88 | $pkg: { /* ... */ },
|
89 | $proto: [ /* ... */ ],
|
90 | $aou: { /* ... */ }
|
91 | }
|
92 |
|
93 | ```
|
94 |
|
95 | Then,
|
96 |
|
97 | ```bash
|
98 | $ apeman-need
|
99 | ```
|
100 |
|
101 |
|
102 | ##### CLI Options
|
103 |
|
104 | ```bash
|
105 | $ apeman-need -h
|
106 |
|
107 | Usage: apeman-need [options]
|
108 |
|
109 | Check project needs.
|
110 |
|
111 | Options:
|
112 |
|
113 | -h, --help output usage information
|
114 | -V, --version output the version number
|
115 | -c, --configuration <configuration> Pathname of Apemanfile
|
116 |
|
117 | Examples:
|
118 |
|
119 | $ apeman-need # Check projects needs.
|
120 |
|
121 |
|
122 | ```
|
123 |
|
124 |
|
125 |
|
126 |
|
127 |
|
128 |
|
129 | <a name="section-doc-guides-03-programmatic-a-p-i-md"></a>
|
130 | Programmatic API
|
131 | ---
|
132 |
|
133 | apeman-need also provide programmatic API.
|
134 |
|
135 | Firstly, install the module locally.
|
136 |
|
137 | ```bash
|
138 | $ npm install apeman-need --save-dev
|
139 | ```
|
140 |
|
141 | Then,
|
142 |
|
143 | ```javascript
|
144 | 'use strict'
|
145 |
|
146 | const apemanNeed = require('apeman-need')
|
147 |
|
148 | apemanNeed({}).then(() => {
|
149 | /* ... */
|
150 | })
|
151 |
|
152 | ```
|
153 |
|
154 |
|
155 | ##### Programmatic Options
|
156 |
|
157 | | Key | Description | Default |
|
158 | | --- | ----------- | ------- |
|
159 | | configuration | Pathname of Apemanfile | |
|
160 |
|
161 |
|
162 |
|
163 |
|
164 |
|
165 |
|
166 |
|
167 |
|
168 |
|
169 | <a name="license"></a>
|
170 |
|
171 | License
|
172 | -------
|
173 | This software is released under the [MIT License](https://github.com/apeman-cmd-labo/apeman-need/blob/master/LICENSE).
|
174 |
|
175 |
|
176 |
|
177 |
|
178 |
|
179 | <a name="links"></a>
|
180 |
|
181 | Links
|
182 | ------
|
183 |
|
184 | + [apeman][apeman_url]
|
185 | + [apeman-cmd-labo][apeman_cmd_labo_url]
|
186 |
|
187 | [apeman_url]: http://github.com/apeman-labo/apeman
|
188 | [apeman_cmd_labo_url]: http://github.com/apeman-cmd-labo
|
189 |
|
190 |
|