├── .gitignore ├── .travis.yml ├── LICENSE ├── README.md ├── bin.js ├── index.js └── package.json /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules/ 2 | coverage/ 3 | tmp/ 4 | dist/ 5 | npm-debug.log* 6 | .DS_Store 7 | .nyc_output 8 | -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | node_js: 2 | - "4" 3 | - "5" 4 | - "6" 5 | - "7" 6 | sudo: false 7 | language: node_js 8 | script: "npm run test" 9 | # after_success: "npm i -g codecov && npm run coverage && codecov" 10 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # choo-scaffold 2 | [![npm version][2]][3] [![build status][4]][5] 3 | [![downloads][8]][9] [![js-standard-style][10]][11] 4 | 5 | Scaffold out files for a [Choo](https://choo.io) project. Useful to speed up 6 | creating applications. 7 | 8 | ## Usage 9 | ```sh 10 | $ npx choo-scaffold 11 | ``` 12 | 13 | ## API 14 | ```txt 15 | $ choo-scaffold [options] 16 | 17 | Commands: 18 | 19 | store generate a new store 20 | view generate a new view 21 | component generate a new component 22 | 23 | Options: 24 | 25 | -h, --help print usage 26 | -v, --version print version 27 | -q, --quiet don't output any logs 28 | 29 | Examples: 30 | 31 | Create a new store 32 | $ choo-scaffold store todos 33 | 34 | Create a new view 35 | $ choo-scaffold view 404 36 | 37 | Create a new component 38 | $ choo-scaffold component button 39 | 40 | Running into trouble? Feel free to file an issue: 41 | https://github.com/choojs/choo-scaffold/issues/new 42 | 43 | Do you enjoy using this software? Become a backer: 44 | https://opencollective.com/choo 45 | ``` 46 | 47 | ## See Also 48 | 49 | - [create-choo-app](https://github.com/choojs/create-choo-app) - create choo apps from scratch 50 | - [create-choo-electron](https://github.com/choojs/create-choo-electron) - create choo electron apps from scratch 51 | - [choo-cli](https://github.com/trainyard/choo-cli) - creates choo apps from templates on github 52 | 53 | ## License 54 | [Apache-2.0](./LICENSE) 55 | 56 | [0]: https://img.shields.io/badge/stability-experimental-orange.svg?style=flat-square 57 | [1]: https://nodejs.org/api/documentation.html#documentation_stability_index 58 | [2]: https://img.shields.io/npm/v/choo-scaffold.svg?style=flat-square 59 | [3]: https://npmjs.org/package/choo-scaffold 60 | [4]: https://img.shields.io/travis/choojs/choo-scaffold/master.svg?style=flat-square 61 | [5]: https://travis-ci.org/choojs/choo-scaffold 62 | [6]: https://img.shields.io/codecov/c/github/choojs/choo-scaffold/master.svg?style=flat-square 63 | [7]: https://codecov.io/github/choojs/choo-scaffold 64 | [8]: http://img.shields.io/npm/dm/choo-scaffold.svg?style=flat-square 65 | [9]: https://npmjs.org/package/choo-scaffold 66 | [10]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg?style=flat-square 67 | [11]: https://github.com/feross/standard 68 | -------------------------------------------------------------------------------- /bin.js: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | 3 | var ansi = require('ansi-escape-sequences') 4 | var inquirer = require('inquirer') 5 | var minimist = require('minimist') 6 | var path = require('path') 7 | var fs = require('fs') 8 | 9 | var lib = require('./') 10 | 11 | var USAGE = ` 12 | $ ${clr('choo-scaffold', 'bold')} ${clr('', 'green')} [options] 13 | 14 | Commands: 15 | 16 | store generate a new store 17 | view generate a new view 18 | component generate a new component 19 | 20 | Options: 21 | 22 | -h, --help print usage 23 | -v, --version print version 24 | -q, --quiet don't output any logs 25 | 26 | Examples: 27 | 28 | Create a new store 29 | ${clr('$ choo-scaffold store todos', 'cyan')} 30 | 31 | Create a new view 32 | ${clr('$ choo-scaffold view 404', 'cyan')} 33 | 34 | Create a new component 35 | ${clr('$ choo-scaffold component button', 'cyan')} 36 | 37 | Running into trouble? Feel free to file an issue: 38 | ${clr('https://github.com/choojs/choo-scaffold/issues/new', 'cyan')} 39 | 40 | Do you enjoy using this software? Become a backer: 41 | ${clr('https://opencollective.com/choo', 'cyan')} 42 | `.replace(/\n$/, '').replace(/^\n/, '') 43 | 44 | var NODIR = ` 45 | Please specify a valid command: 46 | ${clr('$ choo-scaffold', 'cyan')} ${clr('', 'green')} 47 | 48 | For example: 49 | ${clr('$ choo-scaffold store', 'cyan')} ${clr('todos', 'green')} 50 | 51 | Run ${clr('choo-scaffold --help', 'cyan')} to see all options. 52 | `.replace(/\n$/, '').replace(/^\n/, '') 53 | 54 | var argv = minimist(process.argv.slice(2), { 55 | alias: { 56 | help: 'h', 57 | quiet: 'q', 58 | version: 'v' 59 | }, 60 | boolean: [ 61 | 'help', 62 | 'quiet', 63 | 'version' 64 | ] 65 | }) 66 | 67 | ;(function main (argv) { 68 | var cmd = argv._[0] 69 | var arg = argv._[1] 70 | 71 | if (argv.help) { 72 | console.log(USAGE) 73 | } else if (argv.version) { 74 | console.log(require('./package.json').version) 75 | } else if (cmd === 'store') { 76 | createStore(arg) 77 | } else if (cmd === 'view') { 78 | createView(arg) 79 | } else if (cmd === 'component') { 80 | createComponent(arg) 81 | } else if (!cmd) { 82 | select(function (cmd) { 83 | if (cmd === 'store') { 84 | createStore() 85 | } else if (cmd === 'view') { 86 | createView() 87 | } else if (cmd === 'component') { 88 | createComponent() 89 | } else { 90 | console.log(NODIR) 91 | process.exit(1) 92 | } 93 | }) 94 | } else { 95 | console.log(NODIR) 96 | process.exit(1) 97 | } 98 | })(argv) 99 | 100 | function select (done) { 101 | inquirer.prompt([{ 102 | type: 'list', 103 | name: 'input', 104 | message: 'Choose a scaffold type:', 105 | choices: [ 106 | 'store', 107 | 'view', 108 | 'component' 109 | ] 110 | }]).then(function (answers) { 111 | var answer = answers.input 112 | done(answer) 113 | }) 114 | } 115 | 116 | function createStore (name) { 117 | if (name) { 118 | create(name) 119 | } else { 120 | inquirer.prompt([{ 121 | type: 'input', 122 | name: 'input', 123 | message: "What's the store's name?", 124 | validate: (answer) => answer.length >= 1 125 | }]).then(function (answers) { 126 | var answer = answers.input 127 | create(answer) 128 | }) 129 | } 130 | 131 | function create (answer) { 132 | var filename = path.join(process.cwd(), 'stores', answer + '.js') 133 | write(filename, lib.store) 134 | } 135 | } 136 | 137 | function createView (name) { 138 | if (name) { 139 | create(name) 140 | } else { 141 | inquirer.prompt([{ 142 | type: 'input', 143 | name: 'input', 144 | message: "What's the view's name?", 145 | validate: (answer) => answer.length >= 1 146 | }]).then(function (answers) { 147 | var answer = answers.input 148 | create(answer) 149 | }) 150 | } 151 | 152 | function create (answer) { 153 | var filename = path.join(process.cwd(), 'views', answer + '.js') 154 | write(filename, lib.view) 155 | } 156 | } 157 | 158 | function createComponent (name) { 159 | if (name) { 160 | create(name) 161 | } else { 162 | inquirer.prompt([{ 163 | type: 'input', 164 | name: 'input', 165 | message: "What's the component's name?", 166 | validate: (answer) => answer.length >= 1 167 | }]).then(function (answers) { 168 | var answer = answers.input 169 | create(answer) 170 | }) 171 | } 172 | 173 | function create (answer) { 174 | var filename = path.join(process.cwd(), 'components', answer + '.js') 175 | write(filename, lib.component) 176 | } 177 | } 178 | 179 | function write (filename, writer) { 180 | fs.access(filename, function (err) { 181 | var relative = path.relative(process.cwd(), filename) 182 | if (!err) { 183 | console.log(clr(`The file ${relative} already exists.`, 'red')) 184 | process.exit(1) 185 | } 186 | writer(filename, function (err) { 187 | if (err) { 188 | console.log(clr('Aborting. The following error occured:', 'red')) 189 | console.log(' ' + clr(err.message, 'red') + '\n') 190 | process.exit(1) 191 | } else { 192 | console.log(`${clr('Created', 'magenta')} ${relative}`) 193 | } 194 | }) 195 | }) 196 | } 197 | 198 | function clr (text, color) { 199 | return process.stdout.isTTY ? ansi.format(text, color) : text 200 | } 201 | -------------------------------------------------------------------------------- /index.js: -------------------------------------------------------------------------------- 1 | var dedent = require('dedent') 2 | var mkdirp = require('mkdirp') 3 | var path = require('path') 4 | var fs = require('fs') 5 | 6 | exports.store = function (filename, cb) { 7 | var name = path.parse(filename).name 8 | var file = dedent` 9 | module.exports = store 10 | 11 | store.storeName = '${name}' 12 | function store (state, emitter) { 13 | emitter.on('DOMContentLoaded', function () { 14 | }) 15 | } 16 | ` 17 | var dir = path.dirname(filename) 18 | mkdirp(dir, function (err) { 19 | if (err) return cb(err) 20 | write(filename, file, cb) 21 | }) 22 | } 23 | 24 | exports.view = function (filename, cb) { 25 | var file = dedent` 26 | var html = require('choo/html') 27 | 28 | module.exports = view 29 | 30 | function view (state, emit) { 31 | return html\` 32 | 33 | 34 | \` 35 | } 36 | ` 37 | var dir = path.dirname(filename) 38 | mkdirp(dir, function (err) { 39 | if (err) return cb(err) 40 | write(filename, file, cb) 41 | }) 42 | } 43 | 44 | exports.component = function (filename, cb) { 45 | var name = path 46 | .parse(filename).name 47 | .split('-') 48 | .map(word => word[0].toUpperCase() + word.slice(1)) 49 | .join('') 50 | 51 | var file = dedent` 52 | var Component = require('choo/component') 53 | var html = require('choo/html') 54 | 55 | class ${name} extends Component { 56 | constructor (id, state, emit) { 57 | super(id) 58 | this.local = state.components[id] = {} 59 | } 60 | 61 | createElement () { 62 | return html\` 63 |
64 |
65 | \` 66 | } 67 | 68 | update () { 69 | return true 70 | } 71 | } 72 | 73 | module.exports = ${name} 74 | ` 75 | var dir = path.dirname(filename) 76 | mkdirp(dir, function (err) { 77 | if (err) return cb(err) 78 | write(filename, file, cb) 79 | }) 80 | } 81 | 82 | function write (filename, file, cb) { 83 | fs.writeFile(filename, file, function (err) { 84 | if (err) return cb(new Error('Could not write file ' + filename)) 85 | cb() 86 | }) 87 | } 88 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "choo-scaffold", 3 | "description": "Scaffold out Choo files", 4 | "repository": "choojs/choo-scaffold", 5 | "version": "1.2.0", 6 | "bin": { 7 | "choo-scaffold": "./bin.js" 8 | }, 9 | "scripts": { 10 | "deps": "dependency-check . && dependency-check . --extra --no-dev", 11 | "start": "node .", 12 | "test": "standard && npm run deps" 13 | }, 14 | "dependencies": { 15 | "ansi-escape-sequences": "^4.0.0", 16 | "dedent": "^0.7.0", 17 | "inquirer": "^3.3.0", 18 | "minimist": "^1.2.0", 19 | "mkdirp": "^0.5.1" 20 | }, 21 | "devDependencies": { 22 | "dependency-check": "^2.9.1", 23 | "standard": "^10.0.3", 24 | "tape": "^4.8.0" 25 | }, 26 | "keywords": [ 27 | "choo", 28 | "choojs", 29 | "scaffold", 30 | "generate", 31 | "create" 32 | ], 33 | "license": "Apache-2.0" 34 | } 35 | --------------------------------------------------------------------------------