docute-emojify - npm Package Compare versions

Comparing version 0.1.2 to 0.1.3

CHANGELOG.md

@@ -7,2 +7,6 @@ # Change Log
 ## Unreleased
+## [0.1.3] - 2017-03-14
+### Added
+- `emojifyCode` option for transforming aliases inside code blocks.
+
 ## [0.1.2] - 2017-03-11
@@ -21,4 +25,5 @@ ### Fixed
 
-[Unreleased]: https://github.com/hkwu/docute-emojify/compare/v0.1.2...HEAD
+[Unreleased]: https://github.com/hkwu/docute-emojify/compare/v0.1.3...HEAD
+[0.1.3]: https://github.com/hkwu/docute-emojify/compare/v0.1.2...v0.1.3
 [0.1.2]: https://github.com/hkwu/docute-emojify/compare/v0.1.1...v0.1.2
 [0.1.1]: https://github.com/hkwu/docute-emojify/compare/v0.1.0...v0.1.1

package.json

 {
   "name": "docute-emojify",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "Docute plugin for transforming emoji aliases within Markdown.",
@@ -27,3 +27,3 @@ "keywords": [
     "build": "bili --name docute-emojify --module-name docuteEmojify --format umd --compress",
-    "build:emoji": "node utils/update.js && eslint src/emoji.js --fix",
+    "update:emoji": "node utils/update.js && eslint src/emoji.js --fix",
     "lint": "eslint src",
@@ -44,3 +44,6 @@ "lint:fix": "eslint src --fix",
     "got": "^6.7.1"
+  },
+  "peerDependencies": {
+    "docute": "^2.9.0"
   }
 }

README.md

@@ -35,3 +35,3 @@ # docute-emojify
 
-> This is **Markdown** with 💯 emoji support 👌
+> This is **Markdown** with 💯 emoji support 👌
 
@@ -55,3 +55,3 @@ All emoji aliases are scraped from the [gemoji](https://github.com/github/gemoji) repository.
 
-This will replace `:hundo:` with 💯 and `:thunking:` or `:thonk:` with 🤔.
+This will replace `:hundo:` with 💯 and `:thunking:` or `:thonk:` with 🤔.
 
@@ -71,1 +71,28 @@ ### Blacklisting Aliases
 This will make `:100:` and `:+1:` render as typed rather than as an emoji character.
+
+### Emojifying Code
+By default, aliases found in code formatting (i.e. surrounded by matching backticks) are not transformed. This behaviour can be toggled using the `emojifyCode` option.
+
+```js
+docuteEmojify({
+  emojifyCode: true,
+});
+```
+
+We will now see
+
+````markdown
+See emoji code below `:+1:`
+
+```
+:100:
+```
+````
+
+render as
+
+> See emoji code below `👍`
+>
+> ```
+> 💯
+> ```

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Empty package

Supply chain risk

Package does not contain any code. It may be removed, is name squatting, or the result of a faulty package publish.

Found 1 instance in 1 package

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

96

increased by39.13%

Worsened metrics

Total package byte prevSize

5211

decreased by-93.13%

Dependency count

2

increased by100%

Number of package files

4

decreased by-42.86%

Lines of code

0

decreased by-100%

Number of medium supply chain risk alerts

2

increased byInfinity%

No dependency changes