Merge branch 'release/v1.1.0'

CHANGELOG.md

@@ -0,0 +1,14 @@
+# Changelog
+
+
+## v1.1.0 (2017-02-23) 
+
+### Changes
+
+- Replace npm package `date-util` with [Sugarjs](https://sugarjs.com/) (#1)
+- Refactor plugin
+
+
+## v1.0.0 (2017-02-15)
+
+- First release

README.md

@@ -1,15 +1,19 @@
 ## Zazu-utime
 
-Plugin for [Zazu](http://zazuapp.org/) inspired by this [Chrome extension](https://chrome.google.com/webstore/detail/kpcibgnngaaabebmcabmkocdokepdaki).
+A simple timestamp plugin for [Zazu](http://zazuapp.org/), inspired by this [Chrome extension](https://chrome.google.com/webstore/detail/kpcibgnngaaabebmcabmkocdokepdaki).
 
-## Keywords
-See [date-util](https://www.npmjs.com/package/date-util) for examples.
 
-Added a few custom missing keywords in date-util:
-- today
-- now
-- tomorrow
-- yesterday
+## Usage
+
+Open Zazu and type a timestamp or human-readable date, the plugin will try and translate most of it.
+
+Examples:
+- `now`
+- `today`
+- `1487718000`
+- `the end of next week`
+
+For more examples see https://sugarjs.com/dates/#/Parsing
 
 
 ## Installing
@@ -26,7 +30,7 @@ Add `puyt/zazu-utime` inside of `plugins` block of your  `~/.zazurc.json` file.
 
 ### Variables
 - `timestampUnit`: seconds or milliseconds
-- `outputFormat`: see npm package [date-util](https://www.npmjs.com/package/date-util#date-format)
+- `outputFormat`: see https://sugarjs.com/dates/#/Formatting for all possible options
 
 ~~~ json
 {
@@ -35,7 +39,7 @@ Add `puyt/zazu-utime` inside of `plugins` block of your  `~/.zazurc.json` file.
         "name": "puyt/zazu-utime",
         "variables": {
             "timestampUnit": "milliseconds",
-            "timestampUnit": "yyyy/mm/dd HH:MM:ss"
+            "timestampUnit": "{yyyy}/{MM}/{dd} {HH}:{mm}:{s}"
         }
     }
   ]
@@ -44,13 +48,19 @@ Add `puyt/zazu-utime` inside of `plugins` block of your  `~/.zazurc.json` file.
 
 
 ## Screenshots
-![now](./assets/screenshot_now1.png)
-![now2](./assets/screenshot_now2.png)
-![tomorrow](./assets/screenshot_tomorrow1.png)
-![tomorrow2](./assets/screenshot_tomorrow2.png)
-![friday](./assets/screenshot_friday1.png)
-![friday2](./assets/screenshot_friday2.png)
+![example1](./assets/example1.png)
+![example2](./assets/example2.png)
+![example3](./assets/example3.png)
+![example4](./assets/example4.png)
+
+
+## Acknowledgments
+Most the plugin it's :muscle: is coming from [Sugarjs](https://sugarjs.com/)
+
+
+## See also
+- [`tinytacoteam/zazu`](http://github.com/tinytacoteam/zazu)
 
+## License
 
-## Uses
-- [date-util](https://www.npmjs.com/package/date-util)
+[MIT](LICENSE.md)

package.json

@@ -1,15 +1,12 @@
 {
   "name": "zazu-utime",
-  "version": "1.0.0",
-  "description": "Convert unix timestamps to human readable dates and vice versa.",
+  "version": "1.1.0",
+  "description": "Convert unix timestamps to human-readable dates and vice versa.",
   "keywords": [
     "zazu",
     "timestamp",
     "date"
   ],
   "author": "Puyt",
-  "license": "MIT",
-  "dependencies": {
-    "date-util": "^1.2.1"
-  }
+  "license": "MIT"
 }

src/utime.js

@@ -0,0 +1,69 @@
+// load package date-util
+require('../libs/sugar-date')
+
+module.exports = (pluginContext) => {
+    return {
+        respondsTo: (query) => {
+            return true
+        },
+        search: (query = '', env = {}) => {
+            // check if timestamp given
+            let isTimestamp = !isNaN(parseFloat(query)) && isFinite(query);
+
+            // default settings
+            let outputFormat = env['outputFormat'] || '{full}';
+            let timestampUnit = 'seconds';
+
+            // override timestamp unit
+            if (env['timestampUnit'] && env['timestampUnit'] == 'milliseconds') {
+                timestampUnit = 'milliseconds';
+            }
+
+            // check if string or timestamp is given
+            if (!isTimestamp) {
+                // handle timestamp unit
+                if (timestampUnit == 'seconds') {
+                    // timestamp in seconds
+                    outputFormat = '{X}';
+                } else {
+                    // timestamp in milliseconds
+                    outputFormat = '{x}';
+                }
+            } else {
+                // parse query
+                query = parseFloat(query);
+
+                // convert given timestamp in seconds to milliseconds
+                if (timestampUnit == 'seconds') {
+                    query *= 1000;
+                }
+            }
+
+            // create Sugar Date
+            var sugarDate = Sugar.Date.create(query);
+
+            // check if valid date
+            if (!Sugar.Date.isValid(sugarDate)) {
+                return Promise.reject();
+            }
+
+            // set result value
+            const value = Sugar.Date.format(sugarDate, outputFormat);
+
+            // set result subtitle
+            const subtitle = `Select to copy ` + (isTimestamp ? `the formatted date` : `the timestamp in ${timestampUnit}`) + `.`;
+
+            // return results
+            return new Promise((resolve, reject) => {
+                resolve([
+                    {
+                        icon: 'fa-clock-o',
+                        title: value,
+                        subtitle: subtitle,
+                        value: value,
+                    }
+                ])
+            })
+        }
+    }
+}

zazu.json

@@ -1,21 +1,13 @@
 {
   "name": "zazu-utime",
-  "version": "1.0.0",
-  "description": "Convert unix timestamps to human readable dates and vice versa.",
+  "version": "1.1.0",
+  "description": "Convert unix timestamps to human-readable dates and vice versa.",
   "blocks": {
     "input": [
       {
-        "id": "StringToTimestamp",
+        "id": "utime",
         "type": "RootScript",
-        "script": "src/string.js",
-        "connections": [
-          "Copy"
-        ]
-      },
-      {
-        "id": "TimestampToString",
-        "type": "RootScript",
-        "script": "src/timestamp.js",
+        "script": "src/utime.js",
         "connections": [
           "Copy"
         ]