transliteration - npm Package Compare versions

Comparing version 2.0.3 to 2.0.4

package.json

 {
   "name": "transliteration",
-  "version": "2.0.3",
+  "version": "2.0.4",
   "description": "Unicode to ACSII transliteration / slugify module for node.js, browser, Web Worker, ReactNative and CLI.",
@@ -5,0 +5,0 @@ "main": "dist/node/src/node/index.js",

README.md

@@ -11,3 +11,3 @@ # Transliteration
 
-Universal unicode -> latin transliteration / slugify module. Works with all major languages and on all platforms.
+Universal Unicode ➡ Latin transliteration / slugify module. Works with all major languages and on all platforms.
 
@@ -22,5 +22,5 @@ ## Demo
 
-Node.js, in the browser, Web Worker, ReactNative and CLI
+Other platforms including Node.js, Web Worker, ReactNative and CLI
 
-## Installation
+## Install
 
@@ -46,7 +46,12 @@ ### Node.js / React Native
 <!-- UMD build -->
-<script async defer src="https://cdn.jsdelivr.net/npm/transliteration@2.0.3/dist/browser/bundle.umd.min.js"></script>
+<script async defer src="https://cdn.jsdelivr.net/npm/transliteration@2.0.4/dist/browser/bundle.umd.min.js"></script>
+<script>
+  console.log(transl('你好'));
+</script>
+```
+
+```html
 <!-- ESM build -->
-<script async defer src="https://cdn.jsdelivr.net/npm/transliteration@2.0.3/dist/browser/bundle.esm.min.js" type="module"></script>
 <script type="module">
-  import { transl } from './bundle.esm.min.js';
+  import { transl } from 'https://cdn.jsdelivr.net/npm/transliteration@2.0.4/dist/browser/bundle.esm.min.js';
   console.log(transl('你好'));
@@ -80,3 +85,3 @@ </script>
 
-Transliterates the string `str` and return the result. Characters which this module doesn't recognise will be defaulted to the placeholder from the `unknown` argument in the configuration option, defaults to `[?]`.
+Transliterates the string `str` and return the result. Characters which this module doesn't recognise will be defaulted to the placeholder from the `unknown` argument in the configuration option, defaults to `''`.
 
@@ -117,25 +122,25 @@ __Options:__ (optional)
 
-### transliterate.config([optionsObj])
+### transliterate.config([optionsObj], [reset = false])
 
-Bind options globally so any following calls will be using `optoinsObj` by default. If `optionsObj` argument is omitted, it will return current default option object.
+Bind options object globally so any following calls will be using `optoinsObj` as default. If `optionsObj` is omitted, it will return current default options object.
 
 ```javascript
-transliterate.config({ replace: [['你好', 'Hello']] });
-transliterate('你好, world!'); // Result: 'Hello, world!'. This equals transliterate('你好, world!', { replace: [['你好', 'Hello']] });
-```
-
-__Examples:__
-
-```javascript
 import { transliterate as tr } from 'transliteration';
-tr('你好，世界'); // Ni Hao , Shi Jie
-tr('Γεια σας, τον κόσμο'); // Geia sas, ton kosmo
-tr('안녕하세요, 세계'); // annyeonghaseyo, segye
-tr('你好，世界', { replace: {你: 'You'}, ignore: ['好'] }) // You 好, Shi Jie
-tr('你好，世界', { replace: [['你', 'You']], ignore: ['好'] }) // You 好, Shi Jie (option in array form)
-// or use configurations
+tr('你好，世界');
+// Ni Hao , Shi Jie
+tr('Γεια σας, τον κόσμο');
+// Geia sas, ton kosmo
+tr('안녕하세요, 세계');
+// annyeonghaseyo, segye
+tr('你好，世界', { replace: {你: 'You'}, ignore: ['好'] });
+// You 好, Shi Jie
+tr('你好，世界', { replace: [['你', 'You']], ignore: ['好'] });
+ // You 好, Shi Jie (option in array form)
 tr.config({ replace: [['你', 'You']], ignore: ['好'] });
 tr('你好，世界') // You 好, Shi Jie
-// get configurations
 console.log(tr.config());
+// { replace: [['你', 'You']], ignore: ['好'] }
+tr.config(undefined, true);
+console.log(tr.config());
+// {}
 ```
@@ -145,3 +150,3 @@
 
-Converts Unicode string to slugs. So it can be safely used in URL or file name.
+Convert Unicode `str` into a slug string for making sure it is safe to be used in an URL as a file name.
 
@@ -202,25 +207,19 @@ __Options:__ (optional)
 
-If `options` is not provided, it will use the above default values.
+### slugify.config([optionsObj], [reset = false])
 
-### slugify.config([optionsObj])
-
 Bind options globally so any following calls will be using `optoinsObj` by default. If `optionsObj` argument is omitted, it will return current default option object.
 
 ```javascript
-slugify.config({ replace: [['你好', 'Hello']] });
-slugify('你好, world!'); // Result: 'hello-world'. This equals slugify('你好, world!', { replace: [['你好', 'Hello']] });
-```
+import { slugify } from 'transliteration';
+slugify('你好，世界');
+// ni-hao-shi-jie
+slugify('你好，世界', { lowercase: false, separator: '_' });
+// Ni_Hao_Shi_Jie
+slugify('你好，世界', { replace: {你好: 'Hello', 世界: 'world'}, separator: '_' });
+// hello_world
+slugify('你好，世界', { replace: [['你好', 'Hello'], ['世界', 'world']], separator: '_' }); // replace option in array form)
+// hello_world
+slugify('你好，世界', { ignore: ['你好'] });
+// 你好shi-jie
 
-__Example:__
-
-### Node.js / webpack
-
-```javascript
-import { slugify } from 'transliteration';
-slugify('你好，世界'); // ni-hao-shi-jie
-slugify('你好，世界', { lowercase: false, separator: '_' }); // Ni_Hao_Shi_Jie
-slugify('你好，世界', { replace: {你好: 'Hello', 世界: 'world'}, separator: '_' }); // hello_world
-slugify('你好，世界', { replace: [['你好', 'Hello'], ['世界', 'world']], separator: '_' }); // hello_world (option in array form)
-slugify('你好，世界', { ignore: ['你好'] }); // 你好shi-jie
-// or use configurations
 slugify.config({ lowercase: false, separator: '_' });
@@ -230,2 +229,11 @@ slugify('你好，世界'); // Ni_Hao_Shi_Jie
 console.log(slugify.config());
+slugify.config({ replace: [['你好', 'Hello']] });
+slugify('你好, world!'); // This equals slugify('你好, world!', { replace: [['你好', 'Hello']] });
+// hello-world
+console.log(slugify.config());
+// { replace: [['你好', 'Hello']] }
+slugify.config(undefined, true);
+console.log(slugify.config());
+// {}
+
 ```
@@ -280,3 +288,2 @@
 
-
 ## Change log
@@ -286,7 +293,9 @@
 
-* **CDN files path changes**
-* The entire module has been refactored in Typescript, with a big performance improvement as well as a reduced package size.
+* **CDN files path changed**
+* The entire module had been` refactored in Typescript, with big performance improvements as well as a reduced package size.
 * Better code quality. 100% unit tested.
-* `bower` support was dropped. Please use CDN or together with a js bundler like `webpack` or `rollup`.
-* As according to RFC 3986, more characters(`/a-zA-Z0-9-_.~/`) are kept as result for `slugify`
+* `bower` support was dropped. Please use CDN or `webpack`/`rollup`.
+* As according to RFC 3986, more characters(`/a-zA-Z0-9-_.~/`) are kept as result for `slugify`, and it is configurable.
+* Added `uppercase` as an option for `slugify`, if is set to `true` then the generated slug will be converted to uppercase letters.
+* Unknown characters will be transliterated as empty string by default, instead of a meaningless `[?]`.
 
@@ -304,5 +313,2 @@ ### 1.6.6
 * Code had been entirely refactored since version 1.0.0. Be careful when you plan to upgrade from v0.1.x or v0.2.x to v1.0.x
-
-__Changes:__
-
 * The `options` parameter of `transliterate` now is an `Object` (In 0.1.x it's a string `unknown`).
@@ -322,3 +328,3 @@ * Added `transliterate.config` and `slugify.config`.
 
-* __Thai:__ Currently it is not working. If you know how to make it work, please contact me.
+* __Thai:__ Currently it is not working. If you know how to fix it, please comment on [this](https://github.com/dzcpy/transliteration/issues/67) issue.
 
@@ -325,0 +331,0 @@ * __Cylic:__ Cylic characters are overlapped between a few languages. The result might be inaccurate in some specific languages, for example Bulgarian.

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

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

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

326

increased by1.88%

Worsened metrics

Total package byte prevSize

1394607

decreased by-6.99%

Lines of code

3660

decreased by-2.81%

Number of low quality alerts

2

increased by100%

No dependency changes