react-hyphen - npm Package Compare versions

Comparing version 1.0.1 to 1.1.0

package.json

 {
   "name": "react-hyphen",
-  "version": "1.0.1",
+  "version": "1.1.0",
+  "keywords": [
+    "hyphenate",
+    "hyphenation",
+    "hyphenator",
+    "react"
+  ],
+  "homepage": "https://github.com/sergeysolovev/react-hyphen",
+  "bugs": "https://github.com/sergeysolovev/react-hyphen/issues",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/sergeysolovev/react-hyphen.git"
+  },
   "license": "MIT",
   "files": [
-    "index.js",
-    "languages/*",
-    "README.md"
+    "LICENSE",
+    "README.md",
+    "dist/"
   ],
-  "main": "index.js",
+  "main": "dist/react-hyphen.cjs.js",
   "scripts": {
-    "build": "node scripts/build.js",
-    "clean": "node scripts/clean.js",
+    "prebuild": "yarn clean",
+    "build": "rollup -c",
+    "clean": "rimraf dist",
     "prepublishOnly": "yarn run build",
@@ -18,3 +31,3 @@ "test": "jest"
   "dependencies": {
-    "hyphen": "1.1.1"
+    "hyphenated": "1.1.1"
   },
@@ -27,6 +40,7 @@ "devDependencies": {
     "babel-jest": "24.7.1",
-    "chalk": "2.4.2",
     "enzyme": "3.9.0",
     "enzyme-adapter-react-16": "1.12.1",
-    "fs-extra": "7.0.1",
+    "hyphenated-de": "1.1.1",
+    "hyphenated-en-gb": "1.1.1",
+    "hyphenated-fr": "1.1.1",
     "jest": "24.7.1",
@@ -37,3 +51,4 @@ "react": "16.8.6",
     "rollup": "1.10.1",
-    "rollup-plugin-babel": "4.3.2"
+    "rollup-plugin-babel": "4.3.2",
+    "rollup-plugin-node-resolve": "4.2.3"
   },
@@ -40,0 +55,0 @@ "peerDependencies": {

README.md

 # react-hyphen
 
+[![npm version](https://img.shields.io/npm/v/react-hyphen.svg?style=flat)](https://npmjs.org/package/react-hyphen)
 [![CircleCI](https://circleci.com/gh/sergeysolovev/react-hyphen.svg?style=shield)](https://circleci.com/gh/sergeysolovev/react-hyphen)
+
+Hyphenate text in React components. Based on the
+[hyphenated](https://github.com/sergeysolovev/hyphenated) library.
+
+- **Simple API**: wrap your components with `Hyphenated` to hyphenate all nested
+  elements.
+- **Multiple languages**: use any language from
+  [hyphenated](https://github.com/sergeysolovev/hyphenated#supported-languages).
+
+## Quickstart
+
+Install from the command line:
+
+```shell
+npm install react-hyphen
+```
+
+This installation will include hyphenation patterns for the American English
+language as a dependency.
+
+Wrap your components with `Hyphenated`, so they will be rendered with soft
+hyphens:
+
+```js
+import React from 'react';
+import Hyphenated from 'react-hyphen';
+
+const HyphenatedText = () => (
+  <Hyphenated>
+    From Ambrose Bierce’s <em>Devil’s Dictionary</em>:
+    <section>
+      <p>
+        <strong>Self-evident</strong>, <em>adj.</em> Evident to one’s self and
+        to nobody else.
+      </p>
+    </section>
+  </Hyphenated>
+);
+```
+
+Soft hyphens are invisible but they tell the browser where to put real visible
+hyphens.
+
+## Multilingual text
+
+By default, `Hyphenated` uses hyphenation patterns for the American English
+language. To hyphenate text in another language, import necessary languages from
+[hyphenated](https://github.com/sergeysolovev/hyphenated#supported-languages)
+and pass as a `language` prop:
+
+```js
+import React from 'react';
+import Hyphenated from 'react-hyphen';
+import fr from 'hyphenated-fr';
+import de from 'hyphenated-de';
+
+const MultilingualText = () => (
+  <Hyphenated>
+    It is possible to hyphenate multilingual text.{' '}
+    <Hyphenated language={fr}>
+      Je suis l'itinéraire donné par Pierre, un ami français.
+    </Hyphenated>{' '}
+    <Hyphenated language={de}>
+      Das Universalgenie war nicht nur Schriftsteller, sondern auch
+      Rechtsanwalt.
+    </Hyphenated>{' '}
+    Just wrap it using an appropriate language.
+  </Hyphenated>
+);
+```
+
+The resulting text will include optional hyphens using patterns for American
+English, French and German languages.
+
+## License
+
+MIT

Fixed alerts

No bug tracker

Maintenance

Package does not have a linked bug tracker in package.json.

Found 1 instance in 1 package

No repository

Supply chain risk

Package does not have a linked source code repository. Without this field, a package will have no reference to the location of the source code use to generate the package.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

6497

increased by90.53%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

82

increased by1950%

Number of low supply chain risk alerts

0

decreased by-100%

Worsened metrics

Dev dependency count

17

increased by13.33%

Number of package files

4

decreased by-42.86%

Lines of code

50

decreased by-29.58%

Dependency changes

• + Addedhyphenated@1.1.1

• + Addedhyphenated@1.1.1(transitive)

• + Addedhyphenated-en-us@1.2.0(transitive)

• - Removedhyphen@1.1.1

• - Removedhyphen@1.1.1(transitive)