simple plugin system for schnack

.gitignore

@@ -2,6 +2,7 @@ node_modules/*
 yarn.lock
 *.db
 config.json
+schnack.json
 npm-debug.log
 *.sublime-*
 .DS_Store

LICENSE

@@ -1,6 +1,6 @@
 The Lil License v1
 
-Copyright (c) 2018  Gregor Aisch, Moritz Klack & g-div
+Copyright (c) 2021  Gregor Aisch, Moritz Klack & g-div
 
 Permission is hereby granted by the authors of this software, to any person,
 to use the software for any purpose, free of charge, including the rights to

README.md

@@ -2,52 +2,56 @@
 
 [Schnack](https://dict.leo.org/englisch-deutsch/schnack) is a simple Disqus-like drop-in commenting system written in JavaScript.
 
-* [Documentation](https://schnack.cool/)
-* [Say hello to Schnack.js](https://www.vis4.net/blog/2017/10/hello-schnack/)
-* Follow [@schnackjs](https://twitter.com/schnackjs) on Twitter
+-   [Documentation](https://schnack.cool/)
+-   [Say hello to Schnack.js](https://www.vis4.net/blog/2017/10/hello-schnack/)
+-   Follow [@schnackjs](https://twitter.com/schnackjs) on Twitter
 
 ## What the schnack?
 
 Features:
-- Tiny! It takes only ~**8 KB!!!** to embed Schnack.
-- **Open source** and **self-hosted**.
-- Ad-free and Tracking-free. Schnack will **not disturb your users**.
-- It's simpy to moderate, with a **minimal** and **slick UI** to allow/reject comments or trust/block users.
-- **[webpush protocol](https://tools.ietf.org/html/draft-ietf-webpush-protocol-12) to notify the site owner** about new comments awaiting for moderation.
-- **Third party providers for authentication** like Github, Twitter, Google and Facebook. Users are not required to register a new account on your system and you don't need to manage a user management system.
+
+-   Tiny! It takes only ~**8 KB!!!** to embed Schnack.
+-   **Open source** and **self-hosted**.
+-   Ad-free and Tracking-free. Schnack will **not disturb your users**.
+-   It's simpy to moderate, with a **minimal** and **slick UI** to allow/reject comments or trust/block users.
+-   **[webpush protocol](https://tools.ietf.org/html/draft-ietf-webpush-protocol-12) to notify the site owner** about new comments awaiting for moderation.
+-   **Third party providers for authentication** like Github, Twitter, Google and Facebook. Users are not required to register a new account on your system and you don't need to manage a user management system.
 
 ### Quickstart
 
-This is the fastest way to setup *schnack*.
+*Note: If you are updating Schnack from a 0.x version check out the separate [upgrade instructions](docs/migrating-to-schnack-1.md).*
+
+This is the fastest way to setup _schnack_.
 
 **Requirements**:
-- Node.js (>= v6)
-- npm (>= v5)
 
-Clone or download schnack:
+-   Node.js (>= v8)
+-   npm (>= v5)
 
-```bash
-git clone https://github.com/schn4ck/schnack
-```
+Create a new folder for schnack and change into it:
 
-Go to the schnack directory:
 ```bash
+mkdir schnack
 cd schnack
+npm init schnack
 ```
 
-Install dependencies:
+if there is no `schnack.json` in this folder, the init script copied over the default config and ask you if you want to configure your server interactively.
+
+alternatively you can just edit the config file according to [configuration](https://schnack.cool/#configuration) section:
+
 ```bash
-npm install
+vim schnack.json                 # or open with any editor of your choice
 ```
 
-Copy and edit the config file according to [configuration](https://schnack.cool/#configuration) section:
+Finally, run `npm init schnack` again to finish installation:
 
 ```bash
-cp config.tpl.json config.json
-vim config.json                 # or open with any editor of your choice
+npm init schnack
 ```
 
 Run the server:
+
 ```bash
 npm start
 ```
@@ -56,13 +60,14 @@ Embed in your HTML page:
 
 ```html
 <div class="comments-go-here"></div>
-<script src="https://comments.example.com/embed.js"
+<script
+    src="https://comments.example.com/embed.js"
     data-schnack-slug="post-slug"
-    data-schnack-target=".comments-go-here">
-</script>
+    data-schnack-target=".comments-go-here"
+></script>
 ```
 
-**or** initialize *schnack* programmatically:
+**or** initialize _schnack_ programmatically:
 
 ```html
 <div class="comments-go-here"></div>
@@ -79,15 +84,50 @@ Embed in your HTML page:
 
 You will find further information on the [schnack page](https://schnack.cool/).
 
-### Configuration
+### Plugins
 
-**Notify Providers:**
+Authentication and notification providers can be added via plugins.
 
-* pushover
-* webpush
-* slack
-* rss
-* sendmail
+```sh
+npm install @schnack/plugin-auth-github  @schnack/plugin-auth-google @schnack/plugin-notify-slack
+```
+
+To enable the plugins you need to add them to the `plugins` section of your `schnack.json`:
+
+```js
+{
+    // ...
+    "plugins": {
+        "auth-github": {
+            "client_id": "xxxxx",
+            "client_secret": "xxxxx"
+        },
+        "auth-google": {
+            "client_id": "xxxxx",
+            "client_secret": "xxxxx"
+        },
+        "notify-slack": {
+            "webhook_url": "xxxxx"
+        }
+    }
+}
+```
+
+if you want to write your own plugins you need to install them and specify their package name in the `schnack.json`. Otherwise Schnack would try to load as from `@schnack/plugin-my-plugin`.
+
+```js
+{
+    // ...
+    "plugins": {
+        "my-plugin": {
+            "pkg": "my-schnack-plugin",
+            // ...
+        }
+    }
+}
+```
+
+Feel free to open a PR on [schnack-plugins](https://github.com/schn4ck/schnack-plugins) with your plugin if you want to add it to the "official" repository.
 
 ### Who is behind Schnack?
 
@@ -97,17 +137,18 @@ Schnack is [yet another](https://github.com/gka/canvid/) happy collaboration bet
 
 Schnack will never track who is using it, so we don't know! If you are a Schnack user, [let us know](https://twitter.com/schnackjs) and we'll add your website here. So far Schnack is being used on:
 
-* https://schnack.cool (scroll all the day down)
-* https://vis4.net/blog
-* https://blog.datawrapper.de
-* https://blog.webkid.io
+-   https://schnack.cool (scroll all the day down)
+-   https://vis4.net/blog
+-   https://blog.datawrapper.de
+-   https://blog.webkid.io
 
 ### Related projects
 
 This is not a new idea, so there are a few projects that are doing almost the same thing:
 
-* [CoralProject Talk](https://github.com/coralproject/talk) - Node + MongoDB + Redis
-* [Discourse](https://github.com/discourse/discourse) - Ruby on Rails + PostgreSQL + Redis
-* [Commento](https://github.com/adtac/commento) - Go + Node
-* [Isso](https://github.com/posativ/isso/) - Python + SQLite3
-* [Mouthful](https://mouthful.dizzy.zone) – Go + Preact
+-   [CoralProject Talk](https://github.com/coralproject/talk) - Node + MongoDB + Redis
+-   [Discourse](https://github.com/discourse/discourse) - Ruby on Rails + PostgreSQL + Redis
+-   [Commento](https://github.com/adtac/commento) - Go + Node
+-   [Isso](https://github.com/posativ/isso/) - Python + SQLite3
+-   [Mouthful](https://mouthful.dizzy.zone) – Go + Preact
+

create-schnack/LICENSE

@@ -0,0 +1,20 @@
+The Lil License v1
+
+Copyright (c) 2019  Gregor Aisch, Moritz Klack & g-div
+
+Permission is hereby granted by the authors of this software, to any person,
+to use the software for any purpose, free of charge, including the rights to
+run, read, copy, change, distribute and sell it, and including usage rights to
+any patents the authors may hold on it, subject to the following conditions:
+
+This license, or a link to its text, must be included with all copies of the
+software and any derivative works.
+
+Any modification to the software submitted to the authors may be incorporated
+into the software under the terms of this license.
+
+The software is provided "as is", without warranty of any kind, including but
+not limited to the warranties of title, fitness, merchantability and non-
+infringement. The authors have no obligation to provide support or updates for
+the software, and may not be held liable for any damages, claims or other
+liability arising from its use.

create-schnack/index.js

@@ -0,0 +1,53 @@
+#! /usr/bin/env node
+/* eslint no-console: "off" */
+const fs = require('fs');
+const path = require('path');
+const { spawn } = require('child_process');
+const setup = require('./setup');
+const { white, green } = require('chalk');
+
+const CWD = process.env.INIT_CWD || process.cwd();
+let tag = process.argv.find(arg => arg.includes('--tag')) || '--tag=latest';
+tag = tag.split('=')[1];
+
+async function main() {
+    const configPath = path.join(CWD, 'schnack.json');
+
+    if (!fs.existsSync(configPath)) {
+        await setup();
+    }
+
+    const { plugins, schnack_host } = require(configPath);
+
+    // create package.json file if it doesn't exist
+    if (!fs.existsSync(path.join(CWD, 'package.json'))) {
+        console.log(`[init] Initialize ${green('package.json')} file.`);
+        const pkg = {
+            name: schnack_host.replace(/https?:\/\//, ''),
+            version: '1.0.0',
+            private: true,
+            scripts: {
+                start: 'schnack'
+            }
+        };
+        fs.writeFileSync(path.join(CWD, 'package.json'), JSON.stringify(pkg, null, 4), {
+            encoding: 'utf-8'
+        });
+    }
+
+    const packages = Object.keys(plugins || {})
+        .filter(id => id !== 'notify-webpush')
+        .map(id => `${plugins[id].pkg || `@schnack/plugin-${id}`}@latest`);
+
+    console.log('[npm] Start package installation.');
+    const npm = spawn('npm', ['install', '-SE', '--production', `schnack@${tag}`].concat(packages));
+
+    npm.stdout.on('data', data => process.stdout.write(data));
+    npm.stderr.on('data', data => process.stderr.write(data));
+
+    npm.on('close', () => {
+        console.log(`\nrun ${white('npm start')} to start your Schnack server.`);
+    });
+}
+
+main();