fix(intro): update intro page, update packages, travis, add pm-boot-e…

…xtension
nkrusch · Apr 29, 2018 · 47824dc · 47824dc
1 parent 8035aee
commit 47824dc
Show file tree

Hide file tree

Showing 20 changed files with 942 additions and 460 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -1,31 +1,29 @@
 language: node_js
 node_js:
-  - "stable"
+  - "8.11.1"
 cache:
   directories:
   - node_modules
-script: 
+script:
   - npm run docs
 before_deploy:
   - npm run build
 deploy:
-  - edge:
-      branch: v1.8.47
-    provider: pages
+  - provider: pages
     skip_cleanup: true
     github_token: $github_token
     local_dir: docs
     on:
       branch: master
-  - edge:
-      branch: v1.8.47
-    provider: releases
+  - provider: releases
     skip_cleanup: true
     api_key: $github_token
     file: release.zip
     on:
       tags: true
-after_deploy:
-  - if [ ! -z  "$TRAVIS_TAG" ]; then npx cws-upload $cws_client_id $cws_client_secret $cws_token ./release.zip hcnjemngcihnhncobgdgkkfkhmleapah; fi
 after_success:
-  - npm run report-coverage
+  - npm run report-coverage
+after_deploy:
+  - if [ ! -z  "$TRAVIS_TAG" ]; then
+      npx cws-upload $cws_client_id $cws_client_secret $cws_token ./release.zip $extension_id;
+    fi
diff --git a/assets/img/prompt.png b/assets/img/prompt.png
diff --git a/config/gulp.config.json b/config/gulp.config.json
@@ -10,6 +10,7 @@
   "scss": "./src/**/*.scss",
   "icons": [
     "./assets/img//**/*.png",
+    "./assets/img/**/*.gif",
     "./assets/img/**/*.svg"
   ],
   "locales": "./assets/locales/",
@@ -20,6 +21,6 @@
   ],
   "background": "./src/background/**/*.js",
   "content": "./src/crawler/**/*.js",
-  "setup": "./src/ui/setup.js",
-  "process": "./src/ui/process.js"
+  "setup": "./src/setup/setup.js",
+  "process": "./src/process/process.js"
 }
diff --git a/package.json b/package.json
@@ -20,15 +20,15 @@
     "url": "https://github.com/pikkumyy/sitemap-generator.git"
   },
   "devDependencies": {
-    "cws-publish": "^1.0.6",
-    "babel-core": "^6.26.0",
+    "babel-core": "^6.26.3",
     "babel-eslint": "^8.2.3",
     "babel-loader": "^7.1.4",
     "babel-plugin-add-module-exports": "^0.2.1",
     "babel-preset-env": "^1.6.1",
     "chai": "^4.1.2",
     "coveralls": "^3.0.0",
     "cross-env": "^5.1.4",
+    "cws-publish": "^1.0.7",
     "del": "^3.0.0",
     "eslint": "^4.19.1",
     "eslint-loader": "^2.0.0",
@@ -46,11 +46,12 @@
     "gulp-sass": "latest",
     "gulp-zip": "^4.1.0",
     "jsdoc": "^3.5.5",
-    "jsdom": "11.8.0",
+    "jsdom": "11.9.0",
     "jsdom-global": "3.0.2",
     "mocha": "^5.1.1",
     "mocha-lcov-reporter": "^1.3.0",
     "nyc": "^11.7.1",
+    "pm-boot-extension": "^1.0.3",
     "sinon-chrome": "^2.3.1",
     "standard-version": "^4.3.0",
     "webpack-stream": "^4.0.3",

diff --git a/src/background/backgroundApi.js b/src/background/backgroundApi.js
@@ -1,4 +1,4 @@
-import CenteredPopup from './centeredPopup.js';
+import { CenteredPopup } from 'pm-boot-extension';
 import Generator from './generator/generator.js';
 
 let generator;

diff --git a/src/background/centeredPopup.js b/src/background/centeredPopup.js
diff --git a/src/background/events.js b/src/background/events.js
diff --git a/src/background/generator/generator.js b/src/background/generator/generator.js
@@ -1,4 +1,4 @@
-import CenteredPopup from '../centeredPopup';
+import {CenteredPopup} from 'pm-boot-extension';
 import GeneratorUtils from './generatorUtils';
 import WebRequestListener from './webRequests';
 import QueueManager from './queueManager';

diff --git a/src/background/index.js b/src/background/index.js
@@ -1,5 +1,9 @@
 import BackgroundApi from './backgroundApi';
-import BackgroundEvents from './events';
+import {OnInstallHandler} from 'pm-boot-extension';
+
+(() => new OnInstallHandler({
+    action: OnInstallHandler.options.openUri,
+    uri: window.chrome.runtime.getURL('intro.html')
+}))();
 
 (() => new BackgroundApi())();
-(() => new BackgroundEvents())();
diff --git a/src/templates/intro.html → src/intro.html b/src/templates/intro.html → src/intro.html
@@ -12,42 +12,45 @@
 </head>
 
 <body class="intro">
-<img src="icons/128x128.png" alt='icon' style="width:64px;"/>
+<h1>Introduction to Sitemap Generator</h1>
 <br/><br/>
+<div class="preview">
+    <img src="https://raw.githubusercontent.com/pikkumyy/sitemap-generator/docs/preview.gif" alt="preview" />
+</div>
+
 <section class="main-content">
     <div class='focus'>
         <h2> How to use Sitemap Generator</h2>
         <ol>
             <li>
                 <p>
-                    <strong>Click extension icon</strong> in the top right corner on chrome browser</p>
+                    Click extension icon &nbsp;<img src="icons/16x16.png" alt="this"/> &nbsp; in top right
+                    corner of chrome browser</p>
             </li>
             <li>
-                <p>Session configuration window will open. In this window
-                    <strong>set your preferences</strong> then click start.</p>
+                <p>Session configuration window will open.
+                    Set your preferences then click start.</p>
             </li>
             <li>
-                <p>The
-                    <strong>sitemap generator will launch</strong> in a separate window. You may let this window run in
+                <p>Sitemap generator will launch in a separate window. You may let this window run in
                     the background.</p>
             </li>
             <li>
-                <p>When complete
-                    <strong>generated sitemap will open in window</strong> and download.
+                <p>Once the generator is done, sitemap will open in new tab and download.
                 </p>
             </li>
         </ol>
     </div>
 
+
     <h5 id="a-few-words-about-permissions">A few words about permissions</h5>
 
     <p>
-        <img src="icons/prompt.png" alt="permissions" class='perm-image'>
+        <img src="https://raw.githubusercontent.com/pikkumyy/sitemap-generator/docs/prompt.png" alt="permissions" class='perm-image'>
     </p>
 
     <p>When you use use the extension to crawl some domain for the first time you should see permissions prompt. These
-        permissions
-        are required for the sitemap generation to be successful so make sure you choose
+        permissions are required for sitemap generation to be successful so make sure you choose
         <code class="highlighter-rouge">Allow</code>.</p>
 
     <p>What the prompt says:
@@ -60,7 +63,8 @@ <h5 id="a-few-words-about-permissions">A few words about permissions</h5>
         <strong>Manage your downloads</strong>
     </p>
 
-    <p><i>Why it is needed</i> &nbsp; *New Since Chrome 65* there are some issues with Chrome blocking downloading XML file
+    <p><i>Why it is needed</i> &nbsp; *New Since Chrome 65* there are some issues with Chrome blocking downloading XML
+        file
         as potentially dangerous. This permission allows successfully downloading the sitemap.
     </p>
 
@@ -88,7 +92,6 @@ <h5>Sitemap Generator is Open Source!</h5>
     <p>Feel free to review source code or fork your own version on Github:
         <a href="https://github.com/pikkumyy/sitemap-generator" traget="new">https://github.com/pikkumyy/sitemap-generator</a>
     </p>
-
     <br/><br/>
     <div class="alert alert-success">
         Thank you for installing sitemap generator extension! We hope you enjoy it. Please share with your friends and

diff --git a/src/templates/process.html → src/process/process.html b/src/templates/process.html → src/process/process.html
diff --git a/src/ui/process.js → src/process/process.js b/src/ui/process.js → src/process/process.js
diff --git a/src/templates/setup.html → src/setup/setup.html b/src/templates/setup.html → src/setup/setup.html
diff --git a/src/ui/setup.js → src/setup/setup.js b/src/ui/setup.js → src/setup/setup.js