Merge pull request #46 from ofuton/develop

Release 1.1.1 🎉

.eslintrc.json

@@ -1,6 +1,8 @@
 {
     "env": {
-        "browser": true
+        "es6": true,
+        "browser": true,
+        "webextensions": true
     },
     "extends": [
         "eslint:recommended",
@@ -10,4 +12,4 @@
     "rules": {
         "prettier/prettier": "error"
     }
-}
+}

.gitignore

@@ -2,5 +2,5 @@
 node_modules/
 dist/
 *.zip
-src/js/templates/*.js
+src/js/templates/*.pjs
 .DS_Store

README.md

@@ -0,0 +1,45 @@
+# maimodorun
+
+Maimodorun is a chrome extension to recover unsaved texts on Rich Text Editor(RTE) for kintone.
+
+![maimodorun branding logo](./figs/branding_images/branding_logo_for_README_440x180.png)
+
+## Features
+
+1. Automaticaly store texts on RTE.
+1. Recover stored text into the original RTE.
+
+## How to recover the stored text
+
+- To click the icon in RTE toolbar.
+- To select the text to recover in the popup page.
+
+## Demo
+
+![Demo image](./figs/maimodorun-demo.gif)
+
+## Supported Pages [6/6]
+
+- [x] threads
+- [x] thread replies
+- [x] people
+- [x] people replies
+- [x] messages
+- [x] app record comments
+
+## License
+
+This software is released under the MIT License. See [LICENSE](./LICENSE)
+
+## Disclaimer
+
+This OSS is my own personal work and does not have any relationship with Cybozu Inc. or any other organization which I belong to.
+
+## Authors
+
+1. [Keisuke Emi](https://github.com/emiksk)
+1. [Ryota Konno](https://github.com/rkonno)
+1. Rei Asano
+1. Haruka Kunihiro
+1. Yumi Saijo
+1. Shogo Ninomiya

gulpfile.js

@@ -41,7 +41,8 @@ gulp.task('js', () => {
             filename: '[name].js'
         },
         resolve: {
-            extensions: [ '.js' ],
+            // .pjs files are created from pug templates.
+            extensions: [ '.js', '.pjs' ],
             modules: [ scripts, 'node_modules' ]
         },
     };
@@ -110,7 +111,7 @@ gulp.task('manifest', () => {
 
 gulp.task('clean:templates', () => {
     const del = require('del');
-    return del('./src/js/templates/*.js', { force:true });
+    return del('./src/js/templates/*.pjs', { force:true });
 });
 
 gulp.task('clean:dist', () => {

package.json

@@ -1,6 +1,6 @@
 {
   "name": "maimodorun",
-  "version": "1.1.0",
+  "version": "1.1.1",
   "description": "Maimodorun is a chrome extension to recover unsaved texts on Rich Text Editor(RTE) for kintone.",
   "main": "./dist/js/maimodorun.js",
   "devDependencies": {
@@ -33,8 +33,8 @@
   },
   "scripts": {
     "test": "echo \"Error: no test specified\" && exit 1",
-    "eslint": "./node_modules/.bin/eslint ./src/scripts/*.js",
-    "eslint:fix": "./node_modules/.bin/eslint --fix ./src/scripts/*.js",
+    "eslint": "./node_modules/.bin/eslint ./src/js/**/*.js",
+    "eslint:fix": "./node_modules/.bin/eslint --fix ./src/js/**/*.js",
     "gulp:watch": "./node_modules/.bin/gulp watch",
     "gulp:build": "./node_modules/.bin/gulp build",
     "gulp:clean": "./node_modules/.bin/gulp clean:all",

scripts/pug-compile-client.js

@@ -17,7 +17,7 @@ const compileRecoveryButton = () => {
             module: true,
             compileDebug: false
         });
-    fs.writeFileSync('./src/js/templates/recovery-button.js', recoveryButtonTemplate);
+    fs.writeFileSync('./src/js/templates/recovery-button.pjs', recoveryButtonTemplate);
 };
 
 const compileAutoSavedSign = () => {
@@ -28,7 +28,7 @@ const compileAutoSavedSign = () => {
             module: true,
             compileDebug: false
         });
-    fs.writeFileSync('./src/js/templates/auto-saved-sign.js', autoSavedSignTemplate);
+    fs.writeFileSync('./src/js/templates/auto-saved-sign.pjs', autoSavedSignTemplate);
 };
 
 const compileFailedToSaveSign = () => {
@@ -39,7 +39,7 @@ const compileFailedToSaveSign = () => {
             module: true,
             compileDebug: false
         });
-    fs.writeFileSync('./src/js/templates/failed-to-save-sign.js', failedToSaveSignTemplate);
+    fs.writeFileSync('./src/js/templates/failed-to-save-sign.pjs', failedToSaveSignTemplate);
 };
 
 const compileHistoriesTemplate = () => {
@@ -51,7 +51,7 @@ const compileHistoriesTemplate = () => {
             compileDebug: false
         }
     );
-    fs.writeFileSync('./src/js/templates/histories.js', historiesTemplate);
+    fs.writeFileSync('./src/js/templates/histories.pjs', historiesTemplate);
 };
 
 const compileHistoryEmptyTemplate = () => {
@@ -63,7 +63,7 @@ const compileHistoryEmptyTemplate = () => {
             compileDebug: false
         }
     );
-    fs.writeFileSync('./src/js/templates/history-empty.js', historyEmptyTemplate);
+    fs.writeFileSync('./src/js/templates/history-empty.pjs', historyEmptyTemplate);
 };
 
 const compileClient = () => {

src/js/background/index.js

@@ -1,3 +1,3 @@
 import MessageListener from 'background/message-listener';
 
-new MessageListener().run()
+new MessageListener().run();

src/js/background/message-client.js

@@ -3,43 +3,55 @@ import messages from 'background/messages';
 export default class MessageClient {
     initStorage() {
         return new Promise((resolve, reject) => {
-            chrome.runtime.sendMessage({ type: messages.STORAGE_INIT }, response => {
-                if (response.status === messages.STATUS_OK) {
-                    resolve(response);
-                } else {
-                    reject(new Error(response.status));
-                }
-            });
+            chrome.runtime.sendMessage(
+                { type: messages.STORAGE_INIT },
+                response => {
+                    if (response.status === messages.STATUS_OK) {
+                        resolve(response);
+                    } else {
+                        reject(new Error(response.status));
+                    }
+                },
+            );
         });
     }
 
     getValueFromStorage(key) {
         return new Promise((resolve, reject) => {
-            chrome.runtime.sendMessage({ type: messages.STORAGE_LOAD, url: key }, response => {
-                if (response.status === messages.STATUS_OK) {
-                    resolve(response.value);
-                } else {
-                    reject(new Error(response.status));
-                }
-            });
+            chrome.runtime.sendMessage(
+                { type: messages.STORAGE_LOAD, url: key },
+                response => {
+                    if (response.status === messages.STATUS_OK) {
+                        resolve(response.value);
+                    } else {
+                        reject(new Error(response.status));
+                    }
+                },
+            );
         });
     }
 
     getAllValueFromStorage() {
         return new Promise((resolve, reject) => {
-            chrome.runtime.sendMessage({ type: messages.STORAGE_LOAD_ALL }, response => {
-                if (response.status === messages.STATUS_OK) {
-                    resolve(response.value);
-                } else {
-                    reject(new Error(response.status));
-                }
-            });
+            chrome.runtime.sendMessage(
+                { type: messages.STORAGE_LOAD_ALL },
+                response => {
+                    if (response.status === messages.STATUS_OK) {
+                        resolve(response.value);
+                    } else {
+                        reject(new Error(response.status));
+                    }
+                },
+            );
         });
     }
 
     setValueIntoStorage(payload) {
         return new Promise((resolve, reject) => {
-            const body = Object.assign({ type: messages.STORAGE_STORE }, payload);
+            const body = Object.assign(
+                { type: messages.STORAGE_STORE },
+                payload,
+            );
             chrome.runtime.sendMessage(body, response => {
                 if (response.status === messages.STATUS_OK) {
                     resolve(response.value);
@@ -52,25 +64,31 @@ export default class MessageClient {
 
     removeValueInStorage(key) {
         return new Promise((resolve, reject) => {
-            chrome.runtime.sendMessage({ type: messages.STORAGE_REMOVE, url: key }, response => {
-                if (response.status === messages.STATUS_OK) {
-                    resolve();
-                } else {
-                    reject(new Error(response.status));
-                }
-            });
+            chrome.runtime.sendMessage(
+                { type: messages.STORAGE_REMOVE, url: key },
+                response => {
+                    if (response.status === messages.STATUS_OK) {
+                        resolve();
+                    } else {
+                        reject(new Error(response.status));
+                    }
+                },
+            );
         });
     }
 
     recoveryWithNewTab(key) {
         return new Promise((resolve, reject) => {
-            chrome.runtime.sendMessage({ type: messages.STORAGE_RECOVERY, url: key }, response => {
-                if (response.status === messages.STATUS_OK) {
-                    resolve();
-                } else {
-                    reject(new Error(response.status));
-                }
-            });
+            chrome.runtime.sendMessage(
+                { type: messages.STORAGE_RECOVERY, url: key },
+                response => {
+                    if (response.status === messages.STATUS_OK) {
+                        resolve();
+                    } else {
+                        reject(new Error(response.status));
+                    }
+                },
+            );
         });
     }
 }

src/js/background/message-listener.js

@@ -8,34 +8,36 @@ export default class MessageListener {
     }
 
     run() {
-        chrome.runtime.onMessage.addListener((request, sender, sendResponse) => {
-            switch (request.type) {
-            case messages.STORAGE_INIT:
-                this.initStorage(sendResponse);
-                break;
-            case messages.STORAGE_LOAD:
-                this.loadFromStorage(request, sendResponse);
-                break;
-            case messages.STORAGE_STORE:
-                this.storeRequest(request, sendResponse);
-                break;
-            case messages.STORAGE_LOAD_ALL:
-                this.loadAllFromStorage(request, sendResponse);
-                break;
-            case messages.STORAGE_REMOVE:
-                // FIXME: 削除したら対応するタブに消したことを通知する
-                this.removeFromStorage(request, sendResponse);
-                break;
-            case messages.STORAGE_RECOVERY:
-                this.recoveryWithNewTab(request, sendResponse);
-                break;
-            default:
-                sendResponse({ status: 'Failed' });
-                break;
-            }
+        chrome.runtime.onMessage.addListener(
+            (request, sender, sendResponse) => {
+                switch (request.type) {
+                    case messages.STORAGE_INIT:
+                        this.initStorage(sendResponse);
+                        break;
+                    case messages.STORAGE_LOAD:
+                        this.loadFromStorage(request, sendResponse);
+                        break;
+                    case messages.STORAGE_STORE:
+                        this.storeRequest(request, sendResponse);
+                        break;
+                    case messages.STORAGE_LOAD_ALL:
+                        this.loadAllFromStorage(request, sendResponse);
+                        break;
+                    case messages.STORAGE_REMOVE:
+                        // FIXME: 削除したら対応するタブに消したことを通知する
+                        this.removeFromStorage(request, sendResponse);
+                        break;
+                    case messages.STORAGE_RECOVERY:
+                        this.recoveryWithNewTab(request, sendResponse);
+                        break;
+                    default:
+                        sendResponse({ status: 'Failed' });
+                        break;
+                }
 
-            return true;
-        });
+                return true;
+            },
+        );
     }
 
     async initStorage(sendResponse) {
@@ -53,7 +55,7 @@ export default class MessageListener {
             title: request.title,
             timestamp: request.timestamp,
             coverImageUrl: request.coverImageUrl,
-            contents: request.contents
+            contents: request.contents,
         };
 
         sendResponse(await this.commandStorage.store(value));

src/js/background/messages.js

@@ -6,5 +6,5 @@ export default {
     STORAGE_REMOVE: 'storage.remove',
     STORAGE_RECOVERY: 'storage.recovery',
 
-    STATUS_OK: 'OK'
+    STATUS_OK: 'OK',
 };