├── .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 | - 14 14 | - 12 15 | steps: 16 | - uses: actions/checkout@v2 17 | - uses: actions/setup-node@v2 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 slugify from '@sindresorhus/slugify'; 4 | 5 | const cli = meow(` 6 | Usage 7 | $ slugify 8 | 9 | Options 10 | --separator= Word separator [Default: -] 11 | --no-lowercase Don’t make the slug lowercase 12 | --no-decamelize Don’t convert camelCase to separate words 13 | --preserve-leading-underscore If your string starts with an underscore, it will be preserved in the slugified string 14 | 15 | Examples 16 | $ slugify 'Déjà Vu!' 17 | deja-vu 18 | $ slugify 'Unicorns & Rainbows' --separator='_' 19 | unicorns_and_rainbows 20 | `, { 21 | flags: { 22 | separator: { 23 | type: 'string' 24 | }, 25 | lowercase: { 26 | type: 'boolean', 27 | default: true 28 | }, 29 | decamelize: { 30 | type: 'boolean', 31 | default: true 32 | }, 33 | preserveLeadingUnderscore: { 34 | type: 'boolean', 35 | default: false 36 | } 37 | } 38 | }); 39 | 40 | const [text] = cli.input; 41 | 42 | console.log(slugify(text, cli.flags)); 43 | -------------------------------------------------------------------------------- /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": "slugify-cli", 3 | "version": "3.0.0", 4 | "description": "Slugify a string", 5 | "license": "MIT", 6 | "repository": "sindresorhus/slugify-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 | "slugify": "./cli.js" 16 | }, 17 | "engines": { 18 | "node": ">=12" 19 | }, 20 | "scripts": { 21 | "test": "xo && ava" 22 | }, 23 | "files": [ 24 | "cli.js" 25 | ], 26 | "keywords": [ 27 | "cli-app", 28 | "cli", 29 | "string", 30 | "slugify", 31 | "slug", 32 | "url", 33 | "url-safe", 34 | "urlify", 35 | "transliterate", 36 | "transliteration", 37 | "deburr", 38 | "unicode", 39 | "ascii", 40 | "text", 41 | "decamelize", 42 | "pretty", 43 | "clean", 44 | "filename", 45 | "id" 46 | ], 47 | "dependencies": { 48 | "@sindresorhus/slugify": "^2.0.0", 49 | "meow": "^9.0.0" 50 | }, 51 | "devDependencies": { 52 | "ava": "^3.15.0", 53 | "execa": "^5.0.0", 54 | "xo": "^0.38.2" 55 | } 56 | } 57 | -------------------------------------------------------------------------------- /readme.md: -------------------------------------------------------------------------------- 1 | # slugify-cli 2 | 3 | > Slugify a string 4 | 5 | ## Install 6 | 7 | ``` 8 | $ npm install --global slugify-cli 9 | ``` 10 | 11 | ## Usage 12 | 13 | ``` 14 | $ slugify --help 15 | 16 | Usage 17 | $ slugify 18 | 19 | Options 20 | --separator= Word separator [Default: -] 21 | --no-lowercase Don’t make the slug lowercase 22 | --no-decamelize Don’t convert camelCase to separate words 23 | --preserve-leading-underscore If your string starts with an underscore, it will be preserved in the slugified string 24 | 25 | Examples 26 | $ slugify 'Déjà Vu!' 27 | deja-vu 28 | $ slugify 'Unicorns & Rainbows' --separator='_' 29 | unicorns_and_rainbows 30 | ``` 31 | 32 | ## Related 33 | 34 | - [slugify](https://github.com/sindresorhus/slugify) - API for this module 35 | -------------------------------------------------------------------------------- /test.js: -------------------------------------------------------------------------------- 1 | import test from 'ava'; 2 | import execa from 'execa'; 3 | 4 | test('main', async t => { 5 | const {stdout} = await execa('./cli.js', ['Déjà Vu!']); 6 | t.is(stdout, 'deja-vu'); 7 | }); 8 | 9 | test('separator', async t => { 10 | const {stdout} = await execa('./cli.js', ['Unicorns & Rainbows', '--separator=_']); 11 | t.is(stdout, 'unicorns_and_rainbows'); 12 | }); 13 | 14 | test('lowercase', async t => { 15 | const {stdout} = await execa('./cli.js', ['Déjà Vu!', '--no-lowercase']); 16 | t.is(stdout, 'Deja-Vu'); 17 | }); 18 | 19 | test('decamelize', async t => { 20 | const {stdout} = await execa('./cli.js', ['fooBar', '--no-decamelize']); 21 | t.is(stdout, 'foobar'); 22 | }); 23 | 24 | test('preserve-leading-underscore', async t => { 25 | const {stdout} = await execa('./cli.js', ['_foo_bar', '--preserve-leading-underscore']); 26 | t.is(stdout, '_foo-bar'); 27 | }); 28 | --------------------------------------------------------------------------------