mirror of
https://github.com/arthur-pbty/portfolio2023.git
synced 2026-06-10 19:04:26 +02:00
modified
This commit is contained in:
Tutur33
-3
@@ -1,3 +0,0 @@
|
||||
language: node_js
|
||||
node_js:
|
||||
- "0.10"
|
||||
-21
@@ -1,21 +0,0 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2014 Daniel Bugl
|
||||
|
||||
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:
|
||||
|
||||
The above copyright notice and this permission notice shall be included in all
|
||||
copies or substantial portions of the Software.
|
||||
|
||||
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.
|
||||
-86
@@ -1,86 +0,0 @@
|
||||
# node-emoji
|
||||
|
||||
[](https://www.npmjs.com/package/node-emoji) [](https://www.npmjs.com/package/node-emoji) [](https://travis-ci.org/omnidan/node-emoji) [](https://david-dm.org/omnidan/node-emoji) [](https://paypal.me/DanielBugl/9)
|
||||
|
||||
_simple emoji support for node.js projects_
|
||||
|
||||
|
||||
|
||||
**Help wanted:** We are looking for volunteers to maintain this project, if you are interested, feel free to contact me at [me@omnidan.net](mailto:me@omnidan.net)
|
||||
|
||||
## Installation
|
||||
To install `node-emoji`, you need [node.js](http://nodejs.org/) and [npm](https://github.com/npm/npm#super-easy-install). :rocket:
|
||||
|
||||
Once you have that set-up, just run `npm install --save node-emoji` in your project directory. :ship:
|
||||
|
||||
You're now ready to use emoji in your node projects! Awesome! :metal:
|
||||
|
||||
## Usage
|
||||
```javascript
|
||||
var emoji = require('node-emoji')
|
||||
emoji.get('coffee') // returns the emoji code for coffee (displays emoji on terminals that support it)
|
||||
emoji.which(emoji.get('coffee')) // returns the string "coffee"
|
||||
emoji.get(':fast_forward:') // `.get` also supports github flavored markdown emoji (http://www.emoji-cheat-sheet.com/)
|
||||
emoji.emojify('I :heart: :coffee:!') // replaces all :emoji: with the actual emoji, in this case: returns "I ❤️ ☕️!"
|
||||
emoji.random() // returns a random emoji + key, e.g. `{ emoji: '❤️', key: 'heart' }`
|
||||
emoji.search('cof') // returns an array of objects with matching emoji's. `[{ emoji: '☕️', key: 'coffee' }, { emoji: ⚰', key: 'coffin'}]`
|
||||
emoji.unemojify('I ❤️ 🍕') // replaces the actual emoji with :emoji:, in this case: returns "I :heart: :pizza:"
|
||||
emoji.find('🍕') // Find the `pizza` emoji, and returns `({ emoji: '🍕', key: 'pizza' })`;
|
||||
emoji.find('pizza') // Find the `pizza` emoji, and returns `({ emoji: '🍕', key: 'pizza' })`;
|
||||
emoji.hasEmoji('🍕') // Validate if this library knows an emoji like `🍕`
|
||||
emoji.hasEmoji('pizza') // Validate if this library knowns a emoji with the name `pizza`
|
||||
emoji.strip('⚠️ 〰️ 〰️ low disk space') // Strips the string from emoji's, in this case returns: "low disk space".
|
||||
emoji.replace('⚠️ 〰️ 〰️ low disk space', (emoji) => `${emoji.key}:`) // Replace emoji's by callback method: "warning: low disk space"
|
||||
```
|
||||
|
||||
## Options
|
||||
|
||||
### onMissing
|
||||
`emoji.emojify(str, onMissing)`
|
||||
|
||||
As second argument, `emojify` takes an handler to parse unknown emojis. Provide a function to add your own handler:
|
||||
|
||||
```js
|
||||
var onMissing = function (name) {
|
||||
return name;
|
||||
});
|
||||
|
||||
var emojified = emoji.emojify('I :unknown_emoji: :star: :another_one:', onMissing);
|
||||
// emojified: I unknown_emoji ⭐️ another_one
|
||||
```
|
||||
|
||||
### format
|
||||
`emoji.emojify(str, onMissing, format)`
|
||||
|
||||
As third argument, `emojify` takes an handler to wrap parsed emojis. Provide a function to place emojis in custom elements, and to apply your custom styling:
|
||||
|
||||
```js
|
||||
var format = function (code, name) {
|
||||
return '<img alt="' + code + '" src="' + name + '.png" />';
|
||||
});
|
||||
|
||||
var emojified = emoji.emojify('I :unknown_emoji: :star: :another_one:', null, format);
|
||||
// emojified: I <img alt="❤️" src="heart.png" /> <img alt="☕️" src="coffee.png" />
|
||||
```
|
||||
|
||||
## Adding new emoji
|
||||
Emoji come from js-emoji (Thanks a lot :thumbsup:). You can get a JSON file with all emoji here: https://raw.githubusercontent.com/omnidan/node-emoji/master/lib/emoji.json
|
||||
|
||||
To update the list or add custom emoji, clone this repository and put them into `lib/emojifile.js`.
|
||||
Then run `npm run-script emojiparse` in the project directory or `node emojiparse` in the lib directory.
|
||||
This should generate the new emoji.json file and output `Done.`.
|
||||
|
||||
That's all, you now have more emoji you can use! :clap:
|
||||
|
||||
## Support / Donations
|
||||
If you want to support node-emoji development, please consider donating (it helps me keeping my projects active and alive!):
|
||||
|
||||
* Paypal: [](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=YBMS9EKTNPZHJ)
|
||||
* Bitcoin: [1J5eKsrAcPPLv5gPxSjSUkXnbJpkhndFgA](bitcoin:1J5eKsrAcPPLv5gPxSjSUkXnbJpkhndFgA)
|
||||
|
||||
## Special Thanks
|
||||
|
||||
... to Dan Perkins (@Aesth3tical) for sponsoring this project via [GitHub Sponsors](https://github.com/sponsors/omnidan)!
|
||||
|
||||
## License
|
||||
[](https://app.fossa.io/projects/git%2Bgithub.com%2Fomnidan%2Fnode-emoji?ref=badge_large)
|
||||
-1
@@ -1 +0,0 @@
|
||||
module.exports = require('./lib/emoji');
|
||||
-42
@@ -1,42 +0,0 @@
|
||||
{
|
||||
"name": "node-emoji",
|
||||
"version": "1.11.0",
|
||||
"description": "simple emoji support for node.js projects",
|
||||
"author": "Daniel Bugl <daniel.bugl@touchlay.com>",
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/omnidan/node-emoji.git"
|
||||
},
|
||||
"keywords": [
|
||||
"emoji",
|
||||
"simple",
|
||||
"emoticons",
|
||||
"emoticon",
|
||||
"emojis",
|
||||
"smiley",
|
||||
"smileys",
|
||||
"smilies",
|
||||
"ideogram",
|
||||
"ideograms"
|
||||
],
|
||||
"bugs": {
|
||||
"url": "https://github.com/omnidan/node-emoji/issues"
|
||||
},
|
||||
"dependencies": {
|
||||
"lodash": "^4.17.21"
|
||||
},
|
||||
"devDependencies": {
|
||||
"istanbul": "^0.4.5",
|
||||
"mocha": "^9.0.3",
|
||||
"should": "^13.2.3"
|
||||
},
|
||||
"scripts": {
|
||||
"coverage": "./node_modules/.bin/istanbul cover _mocha test",
|
||||
"emojiparse": "node lib/emojiparse.js",
|
||||
"test": "./node_modules/.bin/mocha --require should --bail --reporter spec test/*",
|
||||
"watch": "./node_modules/.bin/mocha --require should --bail --reporter spec test/* --watch",
|
||||
"prepublish": "npm run test"
|
||||
},
|
||||
"main": "index.js",
|
||||
"license": "MIT"
|
||||
}
|
||||
Reference in New Issue
Block a user