Adds types. Updates the description. Closes #4 issue

OlehDutchenko · Nov 27, 2019 · 2a6813b · 2a6813b
1 parent 78c58ec
commit 2a6813b
Show file tree

Hide file tree

Showing 9 changed files with 26 additions and 167 deletions.
diff --git a/CHANGELOG-RU.md b/CHANGELOG-RU.md
diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/CONTRIBUTING-RU.md b/CONTRIBUTING-RU.md
@@ -12,7 +12,7 @@
 
 Проверьте [баг трекер](https://github.com/dutchenkoOleg/sort-css-media-queries/issues) и [список запросов](https://github.com/dutchenkoOleg/sort-css-media-queries/pulls) на предмет уже созданных тем с их обсуждением. Возможно Вы не первые кто сталкивается с какой-то проблемой или хочет предложить свою реализацию.
 
-Также следует ознакомится с [Историей изменений проекта](./CHANGELOG-RU.md) и [Кодексом поведения](./CODE_OF_CONDUCT-RU.md).
+Также следует ознакомится с ["Релиз ноутами"](https://github.com/dutchenkoOleg/sort-css-media-queries/releases) и [Кодексом поведения](./CODE_OF_CONDUCT-RU.md).
 
 ---
 

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -13,7 +13,7 @@ Contributions welcome!
 Please search [issues](https://github.com/dutchenkoOleg/sort-css-media-queries/issues) and [pull requests](https://github.com/dutchenkoOleg/sort-css-media-queries/pulls) before adding something new to avoid duplicating
 efforts and conversations.
 
-Also, you should read the [Change log](./CHANGELOG.md) and the [Contributor Covenant Code of Conduct](./CODE_OF_CONDUCT.md).
+Also, you should read the [Release notes](https://github.com/dutchenkoOleg/sort-css-media-queries/releases) and the [Contributor Covenant Code of Conduct](./CODE_OF_CONDUCT.md).
 
 ---
 

diff --git a/README-RU.md b/README-RU.md
@@ -1,7 +1,8 @@
 # sort-css-media-queries
 
+[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
+![types](https://img.shields.io/badge/types-TypeScript-blue)
 ![npm](https://img.shields.io/badge/node-6.3.0-yellow.svg)
-![es2015](https://img.shields.io/badge/ECMAScript-2015_(ES6)-blue.svg)
 ![license](https://img.shields.io/badge/License-MIT-orange.svg)
 [![Build Status](https://travis-ci.org/dutchenkoOleg/sort-css-media-queries.svg?branch=master)](https://travis-ci.org/dutchenkoOleg/sort-css-media-queries)
 
@@ -12,7 +13,11 @@
 
 > Пользовательский метод сортировки (mobile-first / desktop-first) для [`css-mqpacker`](https://www.npmjs.com/package/css-mqpacker) или [`pleeease`](https://www.npmjs.com/package/pleeease) (который использует css-mqpacker) или, возможно, для чего-то еще ))
 
-[![JavaScript Style Guide](https://cdn.rawgit.com/standard/standard/master/badge.svg)](https://github.com/standard/standard)
+## Альтернатива `mqpacker`
+
+https://github.com/hail2u/node-css-mqpacker - устарел!  
+Одним из альтернативных плагинов может послужить - [postcss-sort-media-queries](https://github.com/solversgroup/postcss-sort-media-queries)
+
 
 ## Установка
 
@@ -143,7 +148,7 @@ postcss([
 
 ## Информация о проекте
 
-* [История изменений](./CHANGELOG-RU.md)
+* ["Релиз ноуты"](https://github.com/dutchenkoOleg/sort-css-media-queries/releases)
 * [Руководство по содействию проекту](./CONTRIBUTING-RU.md)
 * [Кодекс поведения](./CODE_OF_CONDUCT-RU.md)
 * [Лицензия MIT](./LICENSE)
diff --git a/README.md b/README.md
@@ -1,7 +1,8 @@
 # sort-css-media-queries
 
+[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)
+![types](https://img.shields.io/badge/types-TypeScript-blue)
 ![npm](https://img.shields.io/badge/node-6.3.0-yellow.svg)
-![es2015](https://img.shields.io/badge/ECMAScript-2015_(ES6)-blue.svg)
 ![license](https://img.shields.io/badge/License-MIT-orange.svg)
 [![Build Status](https://travis-ci.org/dutchenkoOleg/sort-css-media-queries.svg?branch=master)](https://travis-ci.org/dutchenkoOleg/sort-css-media-queries)
 
@@ -13,7 +14,11 @@
 
 > The custom `sort` method (mobile-first / desktop-first) for [`css-mqpacker`](https://www.npmjs.com/package/css-mqpacker) or [`pleeease`](https://www.npmjs.com/package/pleeease) (which uses css-mqpacker) or, perhaps, something else ))
 
-[![JavaScript Style Guide](https://cdn.rawgit.com/standard/standard/master/badge.svg)](https://github.com/standard/standard)
+## Alternative to `mqpacker`
+
+https://github.com/hail2u/node-css-mqpacker is deprecated.  
+One of the alternative plugins may be - [postcss-sort-media-queries](https://github.com/solversgroup/postcss-sort-media-queries)
+
 
 ## Installing
 
@@ -137,7 +142,7 @@ The plugin will sort your media-queries according to the desktop-first methodolo
 
 ## Project Info
 
-* [Change log](https://github.com/dutchenkoOleg/sort-css-media-queries/blob/master/CHANGELOG.md)
+* [Release notes](https://github.com/dutchenkoOleg/sort-css-media-queries/releases)
 * [Contributing Guidelines](https://github.com/dutchenkoOleg/sort-css-media-queries/blob/master/CONTRIBUTING.md)
 * [Contributor Covenant Code of Conduct](https://github.com/dutchenkoOleg/sort-css-media-queries/blob/master/CODE_OF_CONDUCT.md)
 * [License MIT](https://github.com/dutchenkoOleg/sort-css-media-queries/blob/master/LICENSE)

diff --git a/index.d.ts b/index.d.ts
@@ -0,0 +1,5 @@
+export = sortCSSmq
+declare function sortCSSmq<T = string>(a: T, b: T): number
+declare namespace sortCSSmq {
+  function desktopFirst<T = string>(a: T, b: T): number
+}
diff --git a/index.js b/index.js
@@ -8,7 +8,7 @@
  *
  * @module sort-css-media-queries
  * @author Oleg Dutchenko <dutchenko.o.wezom@gmail.com>
- * @version 1.4.0
+ * @version 1.5.0
  */
 
 // ----------------------------------------

diff --git a/package.json b/package.json
@@ -1,7 +1,7 @@
 {
   "name": "sort-css-media-queries",
-  "version": "1.4.3",
-  "description": "The custom `sort` method (mobile-first / desktop-first) of CSS media queries for `css-mqpacker` or `pleeease` (which uses css-mqpacker) or, perhaps, something else ))",
+  "version": "1.5.0",
+  "description": "The custom `sort` method (mobile-first / desktop-first) of CSS media queries for `postcss-sort-media-queries`, `css-mqpacker` or `pleeease` (which uses css-mqpacker) or, perhaps, something else ))",
   "main": "index.js",
   "scripts": {
     "test": "npm run standard && npm run jest",
-Original file line number
+Diff line change
@@ Expand Up / @@ -12,7 +12,7 @@ @@
     Проверьте [баг трекер](https://github.com/dutchenkoOleg/sort-css-media-queries/issues) и [список запросов](https://github.com/dutchenkoOleg/sort-css-media-queries/pulls) на предмет уже созданных тем с их обсуждением. Возможно Вы не первые кто сталкивается с какой-то проблемой или хочет предложить свою реализацию.
-    Также следует ознакомится с [Историей изменений проекта](./CHANGELOG-RU.md) и [Кодексом поведения](./CODE_OF_CONDUCT-RU.md).
+    Также следует ознакомится с ["Релиз ноутами"](https://github.com/dutchenkoOleg/sort-css-media-queries/releases) и [Кодексом поведения](./CODE_OF_CONDUCT-RU.md).
     ---
@@ Expand Down @@