{"_id":"@alirezark/slugify","name":"@alirezark/slugify","dist-tags":{"latest":"1.6.5"},"versions":{"1.6.5":{"name":"@alirezark/slugify","version":"1.6.5","description":"Slugifies a String","keywords":["slugify","slug","url","urlify"],"license":"MIT","homepage":"https://github.com/simov/slugify","author":{"name":"Simeon Velichkov","email":"simeonvelichkov@gmail.com","url":"https://simov.github.io"},"repository":{"type":"git","url":"git+https://github.com/simov/slugify.git"},"devDependencies":{"coveralls":"^3.1.0","mocha":"^7.2.0","nyc":"^15.1.0"},"main":"./slugify.js","types":"slugify.d.ts","scripts":{"build":"node bin/build","test:ci":"npx mocha --recursive","test:cov":"npx nyc --reporter=lcov --reporter=text-summary mocha -- --recursive","test":"npm run build && npm run test:ci"},"engines":{"node":">=8.0.0"},"gitHead":"4c927b6fa127673f97302091cfe73073a0a5ab29","bugs":{"url":"https://github.com/simov/slugify/issues"},"_id":"@alirezark/slugify@1.6.5","_nodeVersion":"14.19.1","_npmVersion":"6.14.16","dist":{"integrity":"sha512-MuTQXjXcTRBYHSbf8yUIfuchCFh+3jTvRttpOlx7atrHnjk2TYWeYAEit8dFeXsUNXmB5fGSmeCh/Z2tzNJgAQ==","shasum":"2901d07c55652bce76b9c8b204cfa10cdbb2c1c5","tarball":"https://registry.npmjs.org/@alirezark/slugify/-/slugify-1.6.5.tgz","fileCount":6,"unpackedSize":20440,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIASpwBVD7JyirHW5xbAdRFhW/8SevDPWYmc8LHYziiWrAiBhJb5M8xsXbJLyPFHV1RVku+5zd7gOeBz5jnS4kdm6EA=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjs8BoACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmopvxAAg7jXkuYQcH+9s6uWNOULEIf/k6JzdZw1BzRixZUMZSy5yT1H\r\ni/K0up0qrRJeMV3dF0gvuIMdiK7AzHjcH+mLMxLCM0zBhA8IXJrpWvi4+/KE\r\nCULtmmDRGiFiTrSNBRzQDC/ztnIf6jnWayr7vTQSOFmwVdk6M0itBAtnPTg3\r\nxFVecw9ijN1iHHF+HXtYsqpTh4Fqf87+taIb1t4G9Onr66KjMoJy1EXdNkMY\r\nXZErHKUu0YZBECpVL4StItkamtS0acg4Jagu2VpcoU6ZxGmS/IzBatqSB3u4\r\nBYghx4oAsadwOhoUZAXAxlRsRd73ZOJZfrbNylyuNaxJ3aDLRUni/gtH2w91\r\ngHkzXnUytlvvFu43np4p/1FQvRewxT4MVr/8otjfRIARRceeg+mW7+ZoFpzf\r\nuwKbsL37CcFygZ0+b9QyFYJQ5M9ZXWDZB9EQdfDsMLm+HU4RJAZcvXisYXqU\r\nra8fU0C6JB35bvATM1XBOwxrxYRKK3QdYrCxgk6KexD+3NovhQyfDeyJSznz\r\nKNko2goC3/vWHIz3jK6KLF9fqHsepwk+wN2LNAqWIJMgaALsdv1FkFQwIH1M\r\n6XnQv2FBiZLwBXDqjGp9wCy7QJ8/bRtJCDzJCNcH99q5fuNhbqWGnTupBnCw\r\n5GfwCm06q8yxqvm20wPNYVv77R28+wxW4Ws=\r\n=S0Kq\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"alirezark","email":"Alirezark@gmail.com"},"directories":{},"maintainers":[{"name":"alirezark","email":"Alirezark@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/slugify_1.6.5_1672724584471_0.6677369175311787"},"_hasShrinkwrap":false}},"time":{"created":"2023-01-03T05:43:04.414Z","1.6.5":"2023-01-03T05:43:04.657Z","modified":"2023-01-03T05:43:04.839Z"},"maintainers":[{"name":"alirezark","email":"Alirezark@gmail.com"}],"description":"Slugifies a String","homepage":"https://github.com/simov/slugify","keywords":["slugify","slug","url","urlify"],"repository":{"type":"git","url":"git+https://github.com/simov/slugify.git"},"author":{"name":"Simeon Velichkov","email":"simeonvelichkov@gmail.com","url":"https://simov.github.io"},"bugs":{"url":"https://github.com/simov/slugify/issues"},"license":"MIT","readme":"\n# slugify\n\n[![npm-version]][npm] [![coveralls-status]][coveralls]\n\n```js\nvar slugify = require('slugify')\n\nslugify('some string') // some-string\n\n// if you prefer something other than '-' as separator\nslugify('some string', '_')  // some_string\n```\n\n- Vanilla ES2015 JavaScript\n    - If you need to use Slugify with older browsers, consider using [version 1.4.7](https://github.com/simov/slugify/releases/tag/v1.4.7)\n- No dependencies\n- Coerces foreign symbols to their English equivalent (check out the [charMap][charmap] for more details)\n- Works in the browser (window.slugify) and AMD/CommonJS-flavored module loaders\n\n## Options\n\n```js\nslugify('some string', {\n  replacement: '-',  // replace spaces with replacement character, defaults to `-`\n  remove: undefined, // remove characters that match regex, defaults to `undefined`\n  lower: false,      // convert to lower case, defaults to `false`\n  strict: false,     // strip special characters except replacement, defaults to `false`\n  locale: 'vi',      // language code of the locale to use\n  trim: true         // trim leading and trailing replacement chars, defaults to `true`\n})\n```\n\n## Remove\n\nFor example, to remove `*+~.()'\"!:@` from the result slug, you can use `slugify('..', {remove: /[*+~.()'\"!:@]/g})`.\n\n* If the value of `remove` is a regular expression, it should be a\n  [character class](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions/Character_Classes)\n  and only a character class. It should also use the\n  [global flag](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp/global).\n  (For example: `/[*+~.()'\"!:@]/g`.) Otherwise, the `remove` option might not\n  work as expected.\n* If the value of `remove` is a string, it should be a single character.\n  Otherwise, the `remove` option might not work as expected.\n\n## Locales\n\nThe main `charmap.json` file contains all known characters and their transliteration. All new characters should be added there first. In case you stumble upon a character already set in `charmap.json`, but not transliterated correctly according to your language, then you have to add those characters in `locales.json` to override the already existing transliteration in `charmap.json`, but for your locale only.\n\nYou can get the correct language code of your language from [here](https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes).\n\n## Extend\n\nOut of the box `slugify` comes with support for a handful of Unicode symbols. For example the `☢` (radioactive) symbol is not defined in the [`charMap`][charmap] and therefore it will be stripped by default:\n\n```js\nslugify('unicode ♥ is ☢') // unicode-love-is\n```\n\nHowever you can extend the supported symbols, or override the existing ones with your own:\n\n```js\nslugify.extend({'☢': 'radioactive'})\nslugify('unicode ♥ is ☢') // unicode-love-is-radioactive\n```\n\nKeep in mind that the `extend` method extends/overrides the default `charMap` for the entire process. In case you need a fresh instance of the slugify's `charMap` object you have to clean up the module cache first:\n\n```js\ndelete require.cache[require.resolve('slugify')]\nvar slugify = require('slugify')\n```\n\n## Contribute\n\n1. Add chars to `charmap.json`\n2. Run tests `npm test`\n3. The tests will build the charmap in `index.js` and will sort the `charmap.json`\n4. Commit **all** modified files\n\n---\n\n> Originally this was a vanilla javascript port of [node-slug][node-slug].<br>\n> Note that the original [slug][slug] module has been ported to vanilla javascript too.\n\n\n  [npm-version]: https://img.shields.io/npm/v/slugify.svg?style=flat-square (NPM Package Version)\n  [coveralls-status]: https://img.shields.io/coveralls/simov/slugify.svg?style=flat-square (Test Coverage - Coveralls)\n\n  [npm]: https://www.npmjs.com/package/slugify\n  [coveralls]: https://coveralls.io/r/simov/slugify?branch=master\n\n  [node-slug]: https://github.com/dodo/node-slug\n  [slug]: https://www.npmjs.com/package/slug\n  [unicode]: https://www.npmjs.com/package/unicode\n  [index]: https://github.com/simov/slugify/blob/master/index.js\n  [charmap]: https://github.com/simov/slugify/blob/master/config/charmap.json\n","readmeFilename":"README.md"}