Moved scripts to tools/; added extract-tf per #170

INTERNALS.md

@@ -1,14 +1,16 @@
 # TabFern internals
 
+NOTE: this document has not yet been fully updated for brunch usage.
+
 ## Project layout
 
  - `/tabfern`: The development tree for TabFern itself
-   * `/tabfern/src`: Main source
+   * `/tabfern/app`: Main source
      - `/tabfern/src/bg`: Background page
-     - `/tabfern/src/view`: Popup
-     - `/tabfern/src/options_custom`: Options page
+     - `/tabfern/src/win`: Popup
+     - `/tabfern/src/settings`: Options page
    * `/tabfern/test`: Jasmine tests of TabFern
- - `/dist`: where build output from the build process will eventually go.
+ - `/tools`: Useful scripts
  - `/webstore`: The latest version of TabFern released to the Chrome Web Store.
    Updated manually by the maintainers.
  - `/doc`: Documentation

package.json

@@ -8,12 +8,12 @@
   },
   "scripts": {
     "build": "npx brunch build",
-    "ff": "sh -c 'npx brunch b ; node ffize.js'",
+    "ff": "sh -c 'npx brunch b ; node tools/ffize.js'",
     "rebuild": "sh -c 'rm -rf public ; npx brunch b ; find public'",
     "debug": "sh -c 'LOGGY_STACKS=1 npx brunch b -d 2>&1 |less -R'",
     "watch": "npx brunch watch",
     "test": "echo \"Error: no test specified\" && exit 1",
-    "zip": "node zip.js"
+    "zip": "node tools/zip.js"
   },
   "repository": {
     "type": "git",

tools/extract-tf.js

@@ -0,0 +1,27 @@
+// extract-tf.js: Extract the TabFern save data from a Chrome/Vivaldi
+// Extension Settings database.
+//
+// See https://github.com/cxw42/TabFern/issues/170#issuecomment-473280320
+// for usage instructions.
+//
+// Prerequisites:
+//      npm install levelup leveldown
+//
+// This code by cxw42 2019, CC-BY-SA 3.0.  Thanks to the sample at
+// https://github.com/Level/levelup/blob/master/README.md and to
+// https://superuser.com/a/1088579/269989 by
+// https://superuser.com/users/219095/daniel-b
+
+var levelup = require('levelup')
+var leveldown = require('leveldown')
+
+// 1) Create our store
+var db = levelup(leveldown('./data'))
+
+// 3) Fetch by key
+db.get('tabfern-data', function (err, value) {
+    if (err) return console.log('Ooops!', err) // likely the key was not found
+
+    // Ta da!
+    console.log(value.toString('utf8')) // since value is a Buffer
+})

zip.js → tools/zip.js

@@ -1,4 +1,4 @@
-// zip.js: ZIP up the brunch-built TabFern.
+// tools/zip.js: ZIP up the brunch-built TabFern.
 // cxw42, 2018.  Modified from the samples at
 // https://github.com/archiverjs/node-archiver and
 // https://github.com/archiverjs/node-archiver/issues/185 .
@@ -7,10 +7,10 @@
 var fs = require('fs');
 var archiver = require('archiver');
 
-var me = require('./package.json');
+var me = require('../package.json');
 
 // create a file to stream archive data to.
-const fn = `${__dirname}/webstore-${me.version}.zip`;
+const fn = `${__dirname}/../webstore-${me.version}.zip`;
 var output = fs.createWriteStream(fn);
 
 var archive = archiver('zip', {