start readme, add check command, apply complete except for enhancements

CONTRIBUTING.md

@@ -23,7 +23,8 @@ following them shows respect to the developer/s spending their free time on it,
 
 > mobile clients cannot currently be modded.
 
-**know your way around notion/electron/js/css and have some code to contribute?** great! read below to for recommendations on how to create a helpful pull request and what happens with your code afterwards.
+**know your way around notion/electron/js/css and have some code to contribute?** great! read below to for recommendations
+on how to create a helpful pull request and what happens with your code afterwards.
 
 ## testing
 
@@ -41,28 +42,37 @@ using yarn? globally link via `yarn link` (the output of `yarn global bin` must
 
 the downloaded folder is now directly linked to the `notion-enhancer` command.
 
-no written tests are included with the enhancer: i don't have the experience/skill with them yet to use them effectively. if you can add some for your code, though, go ahead!
+no written tests are included with the enhancer: i don't have the experience/skill with them yet to use them effectively.
+if you can add some for your code, though, go ahead!
 
 ## conventions
 
-the enhancer can be categorised as a **core** with extended by included **modules**.
+the enhancer can be categorised as a **core** extended by included **modules**.
+the core can be further split into the **installer** and the **modloader**.
+modules are either **extensions** or **themes**.
 
 each module is separately versioned, following the [semver](https://semver.org/) scheme.
 depending on the content and scale of a contribution, it may constitute an update on its own or may be merged into a larger update.
 
-to keep a consistent code style it is preferred to name variables with `snake_case` and functions/methods with `camelCase`.
+to keep a consistent code but informative style it is preferred to name variables with
+`snake_case`, functions/methods with `camelCase`, and classes with `PascalCase`.
 
 for information on how to create a theme or module, check the [docs](README.md).
 
 ## review
 
-core devs (at the moment: me) will manually look through each pull request and communicate with contributors before merging to make sure it is a) safe, b) functional and c) bug-free.
+active core devs will manually look through each pull request and communicate with contributors before merging to
+make sure it is a) safe, b) functional and c) bug-free.
 
-**a)** system details (e.g. IP, clipboard) + notion user data are considered private unless directly shared by the user. none of this should be accessed or transmitted to an external server.
+**a)** system details (e.g. IP, clipboard) + notion user data are considered private unless directly shared by the user.
+none of this should be accessed or transmitted to an external server.
 
-**b)** is there a better way to do this? can extra dependencies be removed or replaced by newer web technologies? how can this be made as user-friendly as possible?
+**b)** is there a better way to do this? can extra dependencies be removed or replaced by newer web technologies?
+how can this be made as user-friendly as possible?
 
-**c)** where possible, code should be tested on a variety of platforms in a variety of situations so it can be confirmed that it won't break anything for the user and is robust enough to handle use by both power-users and non-tech-savvy users.
+**c)** where possible, code should be tested on a variety of platforms in a variety of situations so it can be
+confirmed that it won't break anything for the user and is robust enough to handle use by both
+power-users and non-tech-savvy users.
 
 ## translating
 

README.md

@@ -7,11 +7,71 @@ for support, contact me on discord `dragonwocky#8449` or open an issue here in t
 want to contribute? check the the [contribution guidelines](CONTRIBUTING.md).
 
 <!--
-
 what?
 why?
 how?
 support?
 extension?
+-->
 
->
+## installation
+
+1. install node.js: [windows/macOS](https://nodejs.org/en/download/), [linux/WSL](https://github.com/mklement0/n-install).
+2. install notion-enhancer globally via yarn or npm:
+   `npm i -g notion-enhancer` or `yarn global add notion-enhancer`
+3. ensure no notion processes are running (you may want to check the task manager to make sure), and try running one of these commands:
+
+   ```
+   notion-enhancer v0.8.0-beta
+   https://github.com/dragonwocky/notion-enhancer
+
+   Usage:
+     $ notion-enhancer <command> [options]
+
+   Commands:
+     apply   : add enhancements to the notion app
+     remove  : return notion to its pre-enhanced/pre-modded state
+     check   : check the current state of the notion app
+
+   For more info, run any command with the `--help` flag:
+     $ notion-enhancer apply --help
+     $ notion-enhancer remove --help
+     $ notion-enhancer check --help
+
+   Options:
+     -y, --yes      : skip prompts (may overwrite data)
+     -h, --help     : display usage information
+     -v, --version  : display version number
+   ```
+
+## supported clients
+
+- the [official windows/mac releases](https://notion.so/desktop).
+- the arch linux AUR [notion-app](https://aur.archlinux.org/packages/notion-app/) package.
+- the linux [notion-app](https://github.com/jaredallard/notion-app) installer.
+- the debian [notion-deb-builder](https://github.com/davidbailey00/notion-deb-builder/tree/229f2868e117e81858618783b83babd00c595000).
+
+(it can also be run from the wsl to apply enhancements to the windows app.)
+
+**using a not-yet-supported operating system or notion installation?** ask for
+[platform support](https://github.com/dragonwocky/notion-enhancer/issues/new?assignees=&labels=enhancement&template=platform-support.md&title=).
+
+mobile clients are not supported and due to system limitations/restrictions cannot be.
+
+## faq
+
+**is this against notion's terms of service? can i get in trouble for using it?**
+
+absolutely not! i contacted notion to check, and their response was awesome:
+
+"Thanks for taking the time to share this with us. Userscripts and userstyles are definitely cool ideas and would be helpful for many users! ... I'll also share this with the rest of the team to take to heart for future improvements."
+
+## contributors
+
+this project was started by [@TarasokUA](https://github.com/TarasokUA/) in early 2020.
+a couple months after, they decided they didn't have any motivation to continue work on it and
+the enhancer was picked up by [@dragonwocky](https://github.com/dragonwocky/).
+
+since then, various community members have helped out heaps here on github or in more extended discussions on discord (with code, feedback and testing):
+
+[![](https://contributors-img.web.app/image?repo=dragonwocky/notion-enhancer)](https://github.com/dragonwocky/notion-enhancer/graphs/contributors)

bin.js

@@ -7,40 +7,62 @@
  */
 
 'use strict';
-const meta = require('./package.json'),
+const cli = require('cac')(),
-  cli = require('cac')();
+  { EnhancerError } = require('./pkg/helpers.js');
 
-// '=== title ==='
+// === title ===
-// ' ...information'
+//  ...information
-// ' * warning'
+//  * warning
-// ' > prompt'
+//  > prompt
-// ' -> response'
+//  -- response
-// ' ~~ exit'
+//  ~~ exit
-// '### error ###'
+// ### error ###
 
 cli.option('-y, --yes', ': skip prompts (may overwrite data)');
 
 cli
   .command('apply', ': add enhancements to the notion app')
-  .action((options) => {
+  .action(async (options) => {
-    require('./pkg/apply.js')(options.yes);
+    console.info('=== NOTION ENHANCEMENT LOG ===');
+    await require('./pkg/apply.js')();
+    console.info('=== END OF LOG ===');
   });
 cli
   .command('remove', ': return notion to its pre-enhanced/pre-modded state')
-  .action((options) => {
+  .action(async (options) => {
-    require('./pkg/remove.js')(options.yes);
+    console.info('=== NOTION RESTORATION LOG ===');
+    await require('./pkg/remove.js')(
+      options.yes
+        ? {
+            overwrite_asar: true,
+            delete_data: true,
+          }
+        : {}
+    );
+    console.info('=== END OF LOG ===');
+  });
+cli
+  .command('check', ': check the current state of the notion app')
+  .action(async (options) => {
+    try {
+      console.info((await require('./pkg/check.js')()).msg);
+    } catch (err) {
+      console.error(err instanceof EnhancerError ? err.message : err);
+    }
   });
 
+let helpCalled = false;
 cli.globalCommand.option('-h, --help', ': display usage information');
 cli.globalCommand.helpCallback = (sections) => {
   sections[0].body += '\nhttps://github.com/dragonwocky/notion-enhancer';
+  helpCalled = true;
 };
 cli.showHelpOnExit = true;
 
 cli.globalCommand.option('-v, --version', ': display version number');
-cli.globalCommand.versionNumber = meta.version;
+cli.globalCommand.versionNumber = require('./package.json').version;
 cli.showVersionOnExit = true;
 
 cli.parse();
 
-if (!cli.matchedCommand) cli.outputHelp();
+if (!cli.matchedCommand && !helpCalled) cli.outputHelp();

pkg/apply.js

@@ -1,31 +1,106 @@
 /*
  * notion-enhancer
- * (c) 2020 dragonwocky <thedragonring.bod@gmail.com>
+ * (c) 2020 dragonwocky <thedragonring.bod@gmail.com> (https://dragonwocky.me/)
- * (https://dragonwocky.me/notion-enhancer) under the MIT license
+ * under the MIT license
  */
 
 'use strict';
-const os = require('os'),
+const fs = require('fs-extra'),
-  fs = require('fs-extra'),
   path = require('path'),
-  exec = require('util').promisify(require('child_process').exec),
   helpers = require('./helpers.js'),
-  store = require('./store.js');
+  { version } = require('../package.json');
+
+// === title ===
+//  ...information
+//  * warning
+//  > prompt
+//  -- response
+//  ~~ exit
+// ### error ###
 
 let __notion = helpers.getNotion();
+module.exports = async function ({ overwrite_version } = {}) {
+  try {
+    __notion = await __notion;
+    await fs.ensureDir(helpers.data_folder);
 
-module.exports = async function () {
+    // handle pre-existing installations: app.asar present? version set in data folder? overwrite?
-  const data = store('test', { ok: true });
+    const check_app = require('./check.js')();
-  console.log(data.ok);
+    switch (check_app.code) {
-  data.thing = 7;
+      case 1:
-  console.log(data);
+        console.log(`~~ notion-enhancer v${version} already applied.`);
+        return true;
+      case 2:
+        console.log(` * ${check_app.msg}`);
+        do {
+          process.stdout.write(' > overwrite? [Y/n]: ');
+          overwrite_version = await helpers.readline();
+        } while (
+          overwrite_version &&
+          !['y', 'n'].includes(overwrite_version.toLowerCase())
+        );
+        overwrite_version =
+          !overwrite_version || overwrite_version.toLowerCase() == 'y';
+        if (!overwrite_version) {
+          console.info(' ~~ keeping previous version: exiting.');
+          return false;
+        }
+        console.info(
+          ' -- removing previous enhancements before applying new version.'
+        );
+        await require('./remove.js')({
+          overwrite_asar: true,
+          delete_data: false,
+        });
+    }
+    console.info(' ...unpacking app.asar');
+    const asar_app = path.join(__notion, 'app.asar'),
+      asar_exec = path.join(
+        __dirname,
+        '..',
+        'node_modules',
+        'asar',
+        'bin',
+        'asar.js'
+      );
+    await helpers.exec(
+      `"${asar_exec}" extract "${asar_app}" "${path.join(__notion, 'app')}"`
+    );
+    fs.move(asar_app, path.join(__notion, 'app.asar.bak'));
+
+    // patching launch script target of custom wrappers
+    if (
+      [
+        '/opt/notion-app', // https://aur.archlinux.org/packages/notion-app/
+        '/opt/notion', // https://github.com/jaredallard/notion-app
+      ].includes(__notion)
+    ) {
+      console.info(
+        ' ...patching app launcher (notion-app linux wrappers only).'
+      );
+      for (let bin_path of [
+        `/usr/bin/${__notion.split('/')[2]}`,
+        `${__notion}${__notion.split('/')[2]}`,
+      ]) {
+        const bin_script = await fs.readFile(bin_path, 'utf8');
+        if (bin_script.includes('app.asar')) {
+          await fs.outputFile(
+            bin_path,
+            bin_script.replace('electron app.asar\n', 'electron app\n')
+          );
+        }
+      }
+    }
+
+    // not resolved, nothing depends on it so it's just a "let it do its thing"
+    fs.outputFile(path.join(__notion, 'app', 'ENHANCER_VERSION.txt'), version);
+    fs.outputFile(path.join(helpers.data_folder, 'version.txt'), version);
+
+    console.info(' ~~ success.');
+    return true;
+  } catch (err) {
+    console.error('### ERROR ###');
+    console.error(err);
+    return false;
+  }
 };
-
-// getNotion()
-//   .then(async (__notion) => {
-//     console.log(__notion);
-//     await exec(
-//       `"${__dirname}/node_modules/asar/bin/asar.js" extract "${__notion}/app.asar" "${__notion}/app"`
-//     );
-//   })
-//   .catch((err) => console.log(err.message));

pkg/check.js

@@ -0,0 +1,38 @@
+/*
+ * notion-enhancer
+ * (c) 2020 dragonwocky <thedragonring.bod@gmail.com> (https://dragonwocky.me/)
+ * under the MIT license
+ */
+
+'use strict';
+const fs = require('fs-extra'),
+  path = require('path'),
+  helpers = require('./helpers.js'),
+  { version } = require('../package.json');
+
+// handle pre-existing installations: app.asar modded? with which enhancer version?
+
+let __notion = helpers.getNotion();
+module.exports = async function ({ overwrite_version } = {}) {
+  __notion = await __notion;
+
+  const version_path = path.join(__notion, 'app', 'ENHANCER_VERSION.txt'),
+    installed_version = (await fs.pathExists(version_path))
+      ? await fs.readFile(version_path, 'utf8')
+      : '?.?.?';
+  if (await fs.pathExists(path.join(__notion, 'app.asar'))) {
+    return {
+      msg: `notion-enhancer has not been applied.`,
+      code: 0,
+    };
+  }
+  return installed_version == version
+    ? {
+        msg: `notion-enhancer v${version} applied.`,
+        code: 1,
+      }
+    : {
+        msg: `notion-enhancer v${installed_version} found applied != v${version} package.`,
+        code: 2,
+      };
+};

pkg/helpers.js

@@ -10,13 +10,35 @@ const os = require('os'),
   fs = require('fs-extra'),
   exec = require('util').promisify(require('child_process').exec);
 
-function isWSL() {
+// used to differentiate between informative errors and "enhancer-is-dying" errors.
-  return (
+class EnhancerError extends Error {
-    process.platform == 'linux' &&
+  constructor(message) {
-    os.release().toLowerCase().includes('microsoft')
+    super(message);
-  );
+    this.name = 'EnhancerError';
+  }
 }
 
+// checks if being run on the windows subsystem for linux:
+// used to modify windows notion app.
+const is_wsl =
+    process.platform == 'linux' &&
+    os.release().toLowerCase().includes('microsoft'),
+  data_folder = path.join(os.homedir(), '.notion-enhancer');
+
+// wait for console input, returns keys when enter pressed.
+function readline() {
+  return new Promise((res, rej) => {
+    process.stdin.resume();
+    process.stdin.setEncoding('utf8');
+    process.stdin.on('data', (key) => {
+      if (key === '\u0003') process.exit(); // CTRL+C
+      process.stdin.pause();
+      res(key.trim());
+    });
+  });
+}
+
+// gets possible system notion app filepaths.
 async function getNotion() {
   let folder = '';
   switch (process.platform) {
@@ -27,7 +49,7 @@ async function getNotion() {
       folder = process.env.LOCALAPPDATA + '\\Programs\\Notion\\resources';
       break;
     case 'linux':
-      if (isWSL()) {
+      if (is_wsl) {
         const { stdout } = await exec('cmd.exe /c echo %localappdata%'),
           drive = stdout[0];
         folder = `/mnt/${drive.toLowerCase()}${stdout
@@ -45,29 +67,32 @@ async function getNotion() {
       }
   }
   if (!folder)
-    throw new Error(
+    throw new EnhancerError(
-      ' ~~ platform not supported: exiting. open a request in the github repo:\n' +
+      'platform not supported: open a request in the github repo:\n' +
         'https://github.com/dragonwocky/notion-enhancer/issues/new?assignees=&labels=enhancement&template=platform-support.md'
     );
-  if (!(await fs.pathExists(folder)))
+  // check if actual app files are present.
-    throw new Error(
+  // if app/app.asar are missing but app.asar.bak present it will be moved to app.asar
-      ' ~~ nothing found: exiting. notion install is either corrupted or non-existent.'
+  const app_asar = path.join(folder, 'app.asar');
-    );
+  if (
+    !(
+      (await fs.pathExists(folder)) &&
+      ((await fs.pathExists(app_asar)) ||
+        (await fs.pathExists(path.join(folder, 'app'))))
+    )
+  ) {
+    const asar_bak = path.join(folder, 'app.asar.bak');
+    if (await fs.pathExists(asar_bak)) {
+      await fs.move(asar_bak, app_asar);
+    } else
+      throw new EnhancerError(
+        'nothing found: notion installation is either corrupted or non-existent.'
+      );
+  }
   return folder;
 }
 
-function readline() {
+// attempts to read a JSON file, falls back to empty object.
-  return new Promise((res, rej) => {
-    process.stdin.resume();
-    process.stdin.setEncoding('utf8');
-    process.stdin.on('data', (key) => {
-      if (key === '\u0003') process.exit(); // CTRL+C
-      process.stdin.pause();
-      res(key.trim());
-    });
-  });
-}
-
 function getJSON(from) {
   try {
     return fs.readJsonSync(from);
@@ -77,9 +102,11 @@ function getJSON(from) {
 }
 
 module.exports = {
-  getNotion,
+  EnhancerError,
-  isWSL,
+  is_wsl,
+  data_folder,
   readline,
+  getNotion,
   getJSON,
-  data_folder: path.join(os.homedir(), '.notion-enhancer'),
+  exec,
 };

pkg/remove.js

@@ -5,57 +5,58 @@
  */
 
 'use strict';
-const os = require('os'),
+const fs = require('fs-extra'),
-  fs = require('fs-extra'),
   path = require('path'),
-  exec = require('util').promisify(require('child_process').exec),
+  helpers = require('./helpers.js');
-  { getNotion, readline, data_folder } = require('./helpers.js');
 
-// '=== title ==='
+// === title ===
-// ' ...information'
+//  ...information
-// ' * warning'
+//  * warning
-// ' > prompt'
+//  > prompt
-// ' -> response'
+//  -- response
-// ' ~~ exit'
+//  ~~ exit
-// '### error ###'
+// ### error ###
 
-let __notion = getNotion();
+let __notion = helpers.getNotion();
-
+module.exports = async function ({ overwrite_asar, delete_data } = {}) {
-module.exports = async function (yes) {
-  console.info('=== NOTION RESTORATION LOG ===');
   try {
     const file_operations = [];
     __notion = await __notion;
 
+    // extracted asar: modded
     const app_folder = path.join(__notion, 'app');
     if (await fs.pathExists(app_folder)) {
       console.info(` ...removing folder ${app_folder}`);
       file_operations.push(fs.remove(app_folder));
     } else console.warn(` * ${app_folder} not found: step skipped.`);
 
+    // restoring original asar
     const asar_bak = path.join(__notion, 'app.asar.bak');
     if (await fs.pathExists(asar_bak)) {
       console.info(' ...moving asar.app.bak to app.asar');
 
-      let write = true;
       if (await fs.pathExists(path.join(__notion, 'app.asar'))) {
         console.warn(' * app.asar already exists!');
-        if (!yes) {
+        if (overwrite_asar === undefined) {
           do {
             process.stdout.write(' > overwrite? [Y/n]: ');
-            write = await readline();
+            overwrite_asar = await helpers.readline();
-          } while (write && !['y', 'n'].includes(write.toLowerCase()));
+          } while (
-          write = !write || write.toLowerCase() == 'y';
+            overwrite_asar &&
-        } else write = true;
+            !['y', 'n'].includes(overwrite_asar.toLowerCase())
+          );
+          overwrite_asar =
+            !overwrite_asar || overwrite_asar.toLowerCase() == 'y';
+        }
         console.info(
-          write
+          overwrite_asar
-            ? ' -> overwriting app.asar with app.asar.bak'
+            ? ' -- overwriting app.asar with app.asar.bak'
-            : ' -> removing app.asar.bak'
+            : ' -- removing app.asar.bak'
         );
       }
 
       file_operations.push(
-        write
+        overwrite_asar || overwrite_asar === undefined
           ? fs.move(asar_bak, path.join(__notion, 'app.asar'), {
               overwrite: true,
             })
@@ -63,24 +64,32 @@ module.exports = async function (yes) {
       );
     } else console.warn(` * ${asar_bak} not found: step skipped.`);
 
-    if (await fs.pathExists(data_folder)) {
+    // cleaning data folder: ~/.notion-enhancer
-      console.log(` ...data folder ${data_folder} found.`);
+    if (await fs.pathExists(helpers.data_folder)) {
-      let write = true;
+      console.log(` ...data folder ${helpers.data_folder} found.`);
-      if (!yes) {
+      if (delete_data === undefined) {
         do {
           process.stdout.write(' > delete? [Y/n]: ');
-          write = await readline();
+          delete_data = await helpers.readline();
-        } while (write && !['y', 'n'].includes(write.toLowerCase()));
+        } while (
-        write = !write || write.toLowerCase() == 'y';
+          delete_data &&
-      } else write = true;
+          !['y', 'n'].includes(delete_data.toLowerCase())
+        );
+        delete_data = !delete_data || delete_data.toLowerCase() == 'y';
+      }
       console.info(
-        write ? ` -> deleting ${data_folder}` : ` -> keeping ${data_folder}`
+        delete_data
+          ? ` -- deleting ${helpers.data_folder}`
+          : ` -- keeping ${helpers.data_folder}`
       );
-      if (write) file_operations.push(fs.remove(data_folder));
+      if (delete_data) {
-    } else console.warn(` * ${data_folder} not found: step skipped.`);
+        file_operations.push(fs.remove(helpers.data_folder));
+      } else fs.remove(path.join(helpers.data_folder, 'version.txt'));
+    } else console.warn(` * ${helpers.data_folder} not found: step skipped.`);
 
     await Promise.all(file_operations);
 
+    // patching launch script target of custom wrappers
     if (
       [
         '/opt/notion-app', // https://aur.archlinux.org/packages/notion-app/
@@ -103,9 +112,12 @@ module.exports = async function (yes) {
         }
       }
     }
+
+    console.info(' ~~ success.');
+    return true;
   } catch (err) {
-    console.error(`### ERROR ###\n${err}`);
+    console.error('### ERROR ###');
+    console.error(err);
+    return false;
   }
-  console.info(' ~~ success.');
-  console.info('=== END OF LOG ===');
 };

pkg/store.js

@@ -4,15 +4,15 @@
  * (https://dragonwocky.me/) under the MIT license
  */
 
-// a wrapper for accessing data stored in a JSON file.
+'use strict';
-
 const path = require('path'),
   fs = require('fs-extra'),
   { getJSON, data_folder } = require('./helpers.js');
 
+// a wrapper for accessing data stored in a JSON file.
 module.exports = (namespace, defaults = {}) => {
-  namespace = path.join(data_folder, 'data', namespace + '.json');
+  namespace = path.join(data_folder, namespace + '.json');
-  fs.ensureDirSync(path.join(data_folder, 'data'));
+  fs.ensureDirSync(data_folder);
 
   const getData = () => ({ ...defaults, ...getJSON(namespace) });
   return new Proxy(defaults, {