├── .gitignore ├── .npmignore ├── LICENSE ├── README.md ├── alphabet └── straight.json ├── ascli.js ├── ascli.png ├── example.png ├── package.json └── tests └── test.js /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules/ 2 | npm-debug.log 3 | .idea/ 4 | -------------------------------------------------------------------------------- /.npmignore: -------------------------------------------------------------------------------- 1 | node_modules/ 2 | npm-debug.log 3 | ascli.png 4 | example.png 5 | .idea/ 6 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | 2 | Apache License 3 | Version 2.0, January 2004 4 | http://www.apache.org/licenses/ 5 | 6 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 7 | 8 | 1. Definitions. 9 | 10 | "License" shall mean the terms and conditions for use, reproduction, 11 | and distribution as defined by Sections 1 through 9 of this document. 12 | 13 | "Licensor" shall mean the copyright owner or entity authorized by 14 | the copyright owner that is granting the License. 15 | 16 | "Legal Entity" shall mean the union of the acting entity and all 17 | other entities that control, are controlled by, or are under common 18 | control with that entity. For the purposes of this definition, 19 | "control" means (i) the power, direct or indirect, to cause the 20 | direction or management of such entity, whether by contract or 21 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 22 | outstanding shares, or (iii) beneficial ownership of such entity. 23 | 24 | "You" (or "Your") shall mean an individual or Legal Entity 25 | exercising permissions granted by this License. 26 | 27 | "Source" form shall mean the preferred form for making modifications, 28 | including but not limited to software source code, documentation 29 | source, and configuration files. 30 | 31 | "Object" form shall mean any form resulting from mechanical 32 | transformation or translation of a Source form, including but 33 | not limited to compiled object code, generated documentation, 34 | and conversions to other media types. 35 | 36 | "Work" shall mean the work of authorship, whether in Source or 37 | Object form, made available under the License, as indicated by a 38 | copyright notice that is included in or attached to the work 39 | (an example is provided in the Appendix below). 40 | 41 | "Derivative Works" shall mean any work, whether in Source or Object 42 | form, that is based on (or derived from) the Work and for which the 43 | editorial revisions, annotations, elaborations, or other modifications 44 | represent, as a whole, an original work of authorship. For the purposes 45 | of this License, Derivative Works shall not include works that remain 46 | separable from, or merely link (or bind by name) to the interfaces of, 47 | the Work and Derivative Works thereof. 48 | 49 | "Contribution" shall mean any work of authorship, including 50 | the original version of the Work and any modifications or additions 51 | to that Work or Derivative Works thereof, that is intentionally 52 | submitted to Licensor for inclusion in the Work by the copyright owner 53 | or by an individual or Legal Entity authorized to submit on behalf of 54 | the copyright owner. For the purposes of this definition, "submitted" 55 | means any form of electronic, verbal, or written communication sent 56 | to the Licensor or its representatives, including but not limited to 57 | communication on electronic mailing lists, source code control systems, 58 | and issue tracking systems that are managed by, or on behalf of, the 59 | Licensor for the purpose of discussing and improving the Work, but 60 | excluding communication that is conspicuously marked or otherwise 61 | designated in writing by the copyright owner as "Not a Contribution." 62 | 63 | "Contributor" shall mean Licensor and any individual or Legal Entity 64 | on behalf of whom a Contribution has been received by Licensor and 65 | subsequently incorporated within the Work. 66 | 67 | 2. Grant of Copyright License. Subject to the terms and conditions of 68 | this License, each Contributor hereby grants to You a perpetual, 69 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 70 | copyright license to reproduce, prepare Derivative Works of, 71 | publicly display, publicly perform, sublicense, and distribute the 72 | Work and such Derivative Works in Source or Object form. 73 | 74 | 3. Grant of Patent License. Subject to the terms and conditions of 75 | this License, each Contributor hereby grants to You a perpetual, 76 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 77 | (except as stated in this section) patent license to make, have made, 78 | use, offer to sell, sell, import, and otherwise transfer the Work, 79 | where such license applies only to those patent claims licensable 80 | by such Contributor that are necessarily infringed by their 81 | Contribution(s) alone or by combination of their Contribution(s) 82 | with the Work to which such Contribution(s) was submitted. If You 83 | institute patent litigation against any entity (including a 84 | cross-claim or counterclaim in a lawsuit) alleging that the Work 85 | or a Contribution incorporated within the Work constitutes direct 86 | or contributory patent infringement, then any patent licenses 87 | granted to You under this License for that Work shall terminate 88 | as of the date such litigation is filed. 89 | 90 | 4. Redistribution. You may reproduce and distribute copies of the 91 | Work or Derivative Works thereof in any medium, with or without 92 | modifications, and in Source or Object form, provided that You 93 | meet the following conditions: 94 | 95 | (a) You must give any other recipients of the Work or 96 | Derivative Works a copy of this License; and 97 | 98 | (b) You must cause any modified files to carry prominent notices 99 | stating that You changed the files; and 100 | 101 | (c) You must retain, in the Source form of any Derivative Works 102 | that You distribute, all copyright, patent, trademark, and 103 | attribution notices from the Source form of the Work, 104 | excluding those notices that do not pertain to any part of 105 | the Derivative Works; and 106 | 107 | (d) If the Work includes a "NOTICE" text file as part of its 108 | distribution, then any Derivative Works that You distribute must 109 | include a readable copy of the attribution notices contained 110 | within such NOTICE file, excluding those notices that do not 111 | pertain to any part of the Derivative Works, in at least one 112 | of the following places: within a NOTICE text file distributed 113 | as part of the Derivative Works; within the Source form or 114 | documentation, if provided along with the Derivative Works; or, 115 | within a display generated by the Derivative Works, if and 116 | wherever such third-party notices normally appear. The contents 117 | of the NOTICE file are for informational purposes only and 118 | do not modify the License. You may add Your own attribution 119 | notices within Derivative Works that You distribute, alongside 120 | or as an addendum to the NOTICE text from the Work, provided 121 | that such additional attribution notices cannot be construed 122 | as modifying the License. 123 | 124 | You may add Your own copyright statement to Your modifications and 125 | may provide additional or different license terms and conditions 126 | for use, reproduction, or distribution of Your modifications, or 127 | for any such Derivative Works as a whole, provided Your use, 128 | reproduction, and distribution of the Work otherwise complies with 129 | the conditions stated in this License. 130 | 131 | 5. Submission of Contributions. Unless You explicitly state otherwise, 132 | any Contribution intentionally submitted for inclusion in the Work 133 | by You to the Licensor shall be under the terms and conditions of 134 | this License, without any additional terms or conditions. 135 | Notwithstanding the above, nothing herein shall supersede or modify 136 | the terms of any separate license agreement you may have executed 137 | with Licensor regarding such Contributions. 138 | 139 | 6. Trademarks. This License does not grant permission to use the trade 140 | names, trademarks, service marks, or product names of the Licensor, 141 | except as required for reasonable and customary use in describing the 142 | origin of the Work and reproducing the content of the NOTICE file. 143 | 144 | 7. Disclaimer of Warranty. Unless required by applicable law or 145 | agreed to in writing, Licensor provides the Work (and each 146 | Contributor provides its Contributions) on an "AS IS" BASIS, 147 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 148 | implied, including, without limitation, any warranties or conditions 149 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 150 | PARTICULAR PURPOSE. You are solely responsible for determining the 151 | appropriateness of using or redistributing the Work and assume any 152 | risks associated with Your exercise of permissions under this License. 153 | 154 | 8. Limitation of Liability. In no event and under no legal theory, 155 | whether in tort (including negligence), contract, or otherwise, 156 | unless required by applicable law (such as deliberate and grossly 157 | negligent acts) or agreed to in writing, shall any Contributor be 158 | liable to You for damages, including any direct, indirect, special, 159 | incidental, or consequential damages of any character arising as a 160 | result of this License or out of the use or inability to use the 161 | Work (including but not limited to damages for loss of goodwill, 162 | work stoppage, computer failure or malfunction, or any and all 163 | other commercial damages or losses), even if such Contributor 164 | has been advised of the possibility of such damages. 165 | 166 | 9. Accepting Warranty or Additional Liability. While redistributing 167 | the Work or Derivative Works thereof, You may choose to offer, 168 | and charge a fee for, acceptance of support, warranty, indemnity, 169 | or other liability obligations and/or rights consistent with this 170 | License. However, in accepting such obligations, You may act only 171 | on Your own behalf and on Your sole responsibility, not on behalf 172 | of any other Contributor, and only if You agree to indemnify, 173 | defend, and hold each Contributor harmless for any liability 174 | incurred by, or claims asserted against, such Contributor by reason 175 | of your accepting any such warranty or additional liability. 176 | 177 | END OF TERMS AND CONDITIONS 178 | 179 | APPENDIX: How to apply the Apache License to your work. 180 | 181 | To apply the Apache License to your work, attach the following 182 | boilerplate notice, with the fields enclosed by brackets "[]" 183 | replaced with your own identifying information. (Don't include 184 | the brackets!) The text should be enclosed in the appropriate 185 | comment syntax for the file format. We also recommend that a 186 | file or class name and description of purpose be included on the 187 | same "printed page" as the copyright notice for easier 188 | identification within third-party archives. 189 | 190 | Copyright [yyyy] [name of copyright owner] 191 | 192 | Licensed under the Apache License, Version 2.0 (the "License"); 193 | you may not use this file except in compliance with the License. 194 | You may obtain a copy of the License at 195 | 196 | http://www.apache.org/licenses/LICENSE-2.0 197 | 198 | Unless required by applicable law or agreed to in writing, software 199 | distributed under the License is distributed on an "AS IS" BASIS, 200 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 201 | See the License for the specific language governing permissions and 202 | limitations under the License. 203 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | ![ascli](https://raw.github.com/dcodeIO/ascli/master/ascli.png) 2 | ===== 3 | **Why?** Some of us are not only programmers but also part-time artist. So am I. This is good. However, to limit myself 4 | a bit to a straight look of my CLI apps, I've created ascli based on the thought of not making things too fancy but 5 | still looking good. So, basically, this package is meant to be used by me but if you like my interpretation of 6 | unobtrusiveness and ease-of-use ... You are welcome! 7 | 8 |

9 | example 10 |

11 | 12 | Installation 13 | ------------ 14 | `npm install ascli` 15 | 16 | Usage 17 | ----- 18 | ```js 19 | var cli = require("ascli")("myAppName"); 20 | cli.banner(ascli.appName.green.bold, "v1.0.0 by Foo Bar "); 21 | cli.log("Hello!"); 22 | cli.info("World!"); 23 | cli.warn("of"); 24 | cli.error("ascli."); 25 | // If it worked: 26 | cli.ok("It worked!", /* optional exit code */ 0); 27 | // If it didn't: 28 | cli.fail("Nope, sorry.", /* optional exit code */ 1); 29 | ``` 30 | 31 | #### Using another alphabet 32 | By default ascli uses a modified version of the **straight** ASCII alphabet. If you don't like it, you are free to 33 | replace it: 34 | 35 | ```js 36 | cli.use("/path/to/my/alphabet.json"); 37 | // or 38 | var myAlphabet = { ... }; 39 | cli.use(myAlphabet); 40 | ``` 41 | 42 | See the `alphabet/` directory for an example. 43 | 44 | #### Using colors 45 | ascli automatically looks up and translates ANSI terminal colors applied to the title string. For that it depends on 46 | [colour.js](https://github.com/dcodeIO/colour.js) which is also exposed as a property of the ascli namespace: 47 | `cli.colour` / `cli.colors`. Also means: You don't need another ANSI terminal colors dependency. 48 | 49 | #### Indentation 50 | `cli.log` etc. indents all console output by one space just because it looks better with the banner. 51 | 52 | Parsing command line arguments 53 | ------------------------------ 54 | [opt.js](https://github.com/dcodeIO/opt.js) will be pre-run on the `cli` namespace and also exposed as `cli.optjs()`. 55 | ```js 56 | cli.node // Node executable 57 | cli.script // Executed script 58 | cli.opt // Options as a hash 59 | cli.argv // Remaining non-option arguments 60 | ``` 61 | 62 | License 63 | ------- 64 | Apache License, Version 2.0 65 | -------------------------------------------------------------------------------- /alphabet/straight.json: -------------------------------------------------------------------------------- 1 | { 2 | "a": [ 3 | " _ ", 4 | "(_|", 5 | " " 6 | ], 7 | "b": [ 8 | "|_ ", 9 | "|_)", 10 | " " 11 | ], 12 | "c": [ 13 | " _", 14 | "( ", 15 | " " 16 | ], 17 | "d": [ 18 | " _|", 19 | "(_|", 20 | " " 21 | ], 22 | "e": [ 23 | " _", 24 | "(-", 25 | " " 26 | ], 27 | "f": [ 28 | "(_", 29 | "| ", 30 | " " 31 | ], 32 | "g": [ 33 | " _ ", 34 | "(_)", 35 | "_/ " 36 | ], 37 | "h": [ 38 | "|_ ", 39 | "| )", 40 | " " 41 | ], 42 | "i": [ 43 | ".", 44 | "|", 45 | " " 46 | ], 47 | "j": [ 48 | ".", 49 | "|", 50 | "'" 51 | ], 52 | "k": [ 53 | "| ", 54 | "|<", 55 | " " 56 | ], 57 | "l": [ 58 | "|", 59 | "|", 60 | " " 61 | ], 62 | "m": [ 63 | " _ ", 64 | "||)", 65 | " " 66 | ], 67 | "n": [ 68 | " _ ", 69 | "| )", 70 | " " 71 | ], 72 | "o": [ 73 | " _ ", 74 | "(_)", 75 | " " 76 | ], 77 | "p": [ 78 | " _ ", 79 | "|_)", 80 | "| " 81 | ], 82 | "q": [ 83 | " _ ", 84 | "(_|", 85 | " |" 86 | ], 87 | "r": [ 88 | " _", 89 | "| ", 90 | " " 91 | ], 92 | "s": [ 93 | " _", 94 | "_)", 95 | " " 96 | ], 97 | "t": [ 98 | "|_", 99 | "|_", 100 | " " 101 | ], 102 | "u": [ 103 | " ", 104 | "|_|", 105 | " " 106 | ], 107 | "v": [ 108 | " ", 109 | "\\/", 110 | " " 111 | ], 112 | "w": [ 113 | " ", 114 | "\\)/", 115 | " " 116 | ], 117 | "x": [ 118 | " ", 119 | ")(", 120 | " " 121 | ], 122 | "y": [ 123 | " ", 124 | "\\/", 125 | "/ " 126 | ], 127 | "z": [ 128 | "_ ", 129 | "/_", 130 | " " 131 | ], 132 | "0": [ 133 | " _ ", 134 | "/ \\", 135 | "\\_/" 136 | ], 137 | "1": [ 138 | " .", 139 | "/|", 140 | " |" 141 | ], 142 | "2": [ 143 | " _ ", 144 | " _)", 145 | "(_ " 146 | ], 147 | "3": [ 148 | "_ ", 149 | "_)", 150 | "_)" 151 | ], 152 | "4": [ 153 | " ", 154 | "|_|", 155 | " |" 156 | ], 157 | "5": [ 158 | " _ ", 159 | "|_ ", 160 | " _)" 161 | ], 162 | "6": [ 163 | " ", 164 | " / ", 165 | "(_)" 166 | ], 167 | "7": [ 168 | "__", 169 | " /", 170 | "/ " 171 | ], 172 | "8": [ 173 | " _ ", 174 | "(_)", 175 | "(_)" 176 | ], 177 | "9": [ 178 | " _ ", 179 | "( )", 180 | " /" 181 | ], 182 | ".": [ 183 | " ", 184 | ".", 185 | " " 186 | ], 187 | ",": [ 188 | " ", 189 | ",", 190 | " " 191 | ], 192 | "-": [ 193 | "_", 194 | " ", 195 | " " 196 | ], 197 | "_": [ 198 | " ", 199 | "__", 200 | " " 201 | ], 202 | "!": [ 203 | "|", 204 | ".", 205 | " " 206 | ], 207 | " ": [ 208 | " ", 209 | " ", 210 | " " 211 | ] 212 | } 213 | -------------------------------------------------------------------------------- /ascli.js: -------------------------------------------------------------------------------- 1 | /* 2 | Copyright 2013 Daniel Wirtz 3 | 4 | Licensed under the Apache License, Version 2.0 (the "License"); 5 | you may not use this file except in compliance with the License. 6 | You may obtain a copy of the License at 7 | 8 | http://www.apache.org/licenses/LICENSE-2.0 9 | 10 | Unless required by applicable law or agreed to in writing, software 11 | distributed under the License is distributed on an "AS IS" BASIS, 12 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | See the License for the specific language governing permissions and 14 | limitations under the License. 15 | */ 16 | 17 | var util = require("util"), 18 | path = require("path"), 19 | colour = require("colour"); 20 | 21 | // Default alphabet 22 | var alphabet = require(path.join(__dirname, "alphabet", "straight.json")); 23 | 24 | module.exports = function(appName) { 25 | ascli.appName = appName; 26 | return ascli; 27 | }; 28 | 29 | module.exports.app = module.exports; // For backward compatibility 30 | 31 | /** 32 | * Builds a banner. 33 | * @param {string=} title App name 34 | * @param {string=} appendix Appendix, e.g. version 35 | * @returns {string} 36 | */ 37 | function ascli(title, appendix) { 38 | title = title || ascli.appName; 39 | appendix = appendix || ""; 40 | var lines = ["", "", ""], c, a, j, ac = ""; 41 | for (var i=0; i} alpha File name or alphabet to use 90 | * @returns {Function} ascli 91 | */ 92 | ascli.use = function(alpha) { 93 | if (typeof alpha === 'string') 94 | alphabet = require(alpha); 95 | else 96 | alphabet = alpha; 97 | return ascli; 98 | }; 99 | 100 | /** 101 | * Prints a final success message. 102 | * @param {string} msg Message text 103 | * @param {number=} code Exit code, defaults not to send it explicitly 104 | */ 105 | ascli.ok = function(msg, code) { 106 | process.stderr.write('\n '+ascli.appName.green.bold+' OK'.white.bold+(msg ? ' '+msg : '')+'\n'); 107 | if (typeof code !== 'undefined') 108 | process.exit(code); 109 | }; 110 | 111 | /** 112 | * Prints a final failure message. 113 | * @param {string} msg Message text 114 | * @param {number=} code Exit code, defaults to not send it explicitly 115 | */ 116 | ascli.fail = function(msg, code) { 117 | process.stderr.write('\n '+ascli.appName.red.bold+' ERROR'.white.bold+(msg ? ' '+msg : '')+'\n'); 118 | if (typeof code !== 'undefined') 119 | process.exit(code); 120 | }; 121 | 122 | /** 123 | * opt.js 124 | * @param {Array.=} argv 125 | * @returns {{node: string, script: string, argv: Array., opt: Object.}} 126 | */ 127 | ascli.optjs = require("optjs"); 128 | 129 | // Pre-run it 130 | var opt = ascli.optjs(); 131 | ascli.node = opt.node; 132 | ascli.script = opt.script; 133 | ascli.argv = opt.argv; 134 | ascli.opt = opt.opt; 135 | 136 | // Expose colour.js 137 | ascli.colour = ascli.colors = colour; 138 | -------------------------------------------------------------------------------- /ascli.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dcodeIO/ascli/5972ea9baf6939fc0f47a3435cedd66bc6f66fe1/ascli.png -------------------------------------------------------------------------------- /example.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/dcodeIO/ascli/5972ea9baf6939fc0f47a3435cedd66bc6f66fe1/example.png -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "ascli", 3 | "description": "A uniform foundation for unobtrusive (ASCII art in) cli apps.", 4 | "version": "1.0.1", 5 | "author": "Daniel Wirtz", 6 | "repository": { 7 | "type": "url", 8 | "url": "https://github.com/dcodeIO/ascli.git" 9 | }, 10 | "bugs": { 11 | "url": "https://github.com/dcodeIO/ascli/issues" 12 | }, 13 | "keywords": [ 14 | "ansi", 15 | "terminal", 16 | "colors", 17 | "ascii" 18 | ], 19 | "main": "./ascli.js", 20 | "dependencies": { 21 | "colour": "~0.7.1", 22 | "optjs": "~3.2.2" 23 | }, 24 | "scripts": { 25 | "test": "node tests/test.js" 26 | }, 27 | "license": "Apache-2.0" 28 | } 29 | -------------------------------------------------------------------------------- /tests/test.js: -------------------------------------------------------------------------------- 1 | var cli = require("../ascli.js")("myapp"); 2 | 3 | cli.banner("staying straight".green.bold, "v1.0.0 through ascli"); 4 | cli.log("Hello world!".white.bold); 5 | cli.log("...of ascli\n"); 6 | cli.log("Command line arguments".white.bold); 7 | cli.log(cli.opt, cli.argv); 8 | cli.banner("abcdefghijklmnopqrstuvwxyz 0123456789"); 9 | cli.ok("yep, that worked."); 10 | cli.fail("nope, that didn't."); 11 | --------------------------------------------------------------------------------