├── .editorconfig ├── .gitattributes ├── .github └── workflows │ └── main.yml ├── .gitignore ├── .npmrc ├── cli.js ├── license ├── package.json ├── readme.md └── test.js /.editorconfig: -------------------------------------------------------------------------------- 1 | root = true 2 | 3 | [*] 4 | indent_style = tab 5 | end_of_line = lf 6 | charset = utf-8 7 | trim_trailing_whitespace = true 8 | insert_final_newline = true 9 | 10 | [*.yml] 11 | indent_style = space 12 | indent_size = 2 13 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | * text=auto eol=lf 2 | -------------------------------------------------------------------------------- /.github/workflows/main.yml: -------------------------------------------------------------------------------- 1 | name: CI 2 | on: 3 | - push 4 | - pull_request 5 | jobs: 6 | test: 7 | name: Node.js ${{ matrix.node-version }} 8 | runs-on: ubuntu-latest 9 | strategy: 10 | fail-fast: false 11 | matrix: 12 | node-version: 13 | - 20 14 | - 18 15 | steps: 16 | - uses: actions/checkout@v4 17 | - uses: actions/setup-node@v4 18 | with: 19 | node-version: ${{ matrix.node-version }} 20 | - run: npm install 21 | - run: npm test 22 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | node_modules 2 | yarn.lock 3 | -------------------------------------------------------------------------------- /.npmrc: -------------------------------------------------------------------------------- 1 | package-lock=false 2 | -------------------------------------------------------------------------------- /cli.js: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env node 2 | import meow from 'meow'; 3 | import superheroes, {randomSuperhero} from 'superheroes'; 4 | 5 | const cli = meow(` 6 | Examples 7 | $ superheroes 8 | Spider-Ham 9 | 10 | $ superheroes --all 11 | 3-D Man 12 | A-Bomb 13 | ... 14 | 15 | Options 16 | --all Get all names instead of a random name 17 | `, { 18 | importMeta: import.meta, 19 | }); 20 | 21 | console.log(cli.flags.all ? superheroes.join('\n') : randomSuperhero()); 22 | -------------------------------------------------------------------------------- /license: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) Sindre Sorhus (https://sindresorhus.com) 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: 6 | 7 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. 8 | 9 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. 10 | -------------------------------------------------------------------------------- /package.json: -------------------------------------------------------------------------------- 1 | { 2 | "name": "superheroes-cli", 3 | "version": "2.0.0", 4 | "description": "Get superhero names on the command-line", 5 | "license": "MIT", 6 | "repository": "sindresorhus/superheroes-cli", 7 | "funding": "https://github.com/sponsors/sindresorhus", 8 | "author": { 9 | "name": "Sindre Sorhus", 10 | "email": "sindresorhus@gmail.com", 11 | "url": "https://sindresorhus.com" 12 | }, 13 | "type": "module", 14 | "bin": { 15 | "superheroes": "./cli.js" 16 | }, 17 | "engines": { 18 | "node": ">=18.20" 19 | }, 20 | "scripts": { 21 | "test": "xo && ava" 22 | }, 23 | "files": [ 24 | "cli.js" 25 | ], 26 | "keywords": [ 27 | "cli-app", 28 | "cli", 29 | "word", 30 | "words", 31 | "list", 32 | "array", 33 | "random", 34 | "superheroes", 35 | "superhero", 36 | "heroes", 37 | "hero", 38 | "marvel", 39 | "dc", 40 | "comics" 41 | ], 42 | "dependencies": { 43 | "meow": "^13.2.0", 44 | "superheroes": "^4.0.0" 45 | }, 46 | "devDependencies": { 47 | "ava": "^6.1.2", 48 | "execa": "^8.0.1", 49 | "xo": "^0.58.0" 50 | } 51 | } 52 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | # superheroes-cli 2 | 3 | > Get superhero names 4 | 5 | ## Install 6 | 7 | ```sh 8 | npm install --global superheroes-cli 9 | ``` 10 | 11 | ## Usage 12 | 13 | ``` 14 | $ superheroes --help 15 | 16 | Examples 17 | $ superheroes 18 | Spider-Ham 19 | 20 | $ superheroes --all 21 | 3-D Man 22 | A-Bomb 23 | ... 24 | 25 | Options 26 | --all Get all names instead of a random name 27 | ``` 28 | 29 | ## Related 30 | 31 | - [superheroes](https://github.com/sindresorhus/superheroes) - API for this package 32 | - [supervillains-cli](https://github.com/sindresorhus/supervillains-cli) - Get supervillain names 33 | -------------------------------------------------------------------------------- /test.js: -------------------------------------------------------------------------------- 1 | import {execa} from 'execa'; 2 | import test from 'ava'; 3 | 4 | test('main', async t => { 5 | const {stdout} = await execa('./cli.js'); 6 | t.true(stdout.length > 0); 7 | }); 8 | --------------------------------------------------------------------------------