feat: Parameterize binary and library

- Add MIT as license option

BREAKING CHANGE:

- Ask for path to deploy when running binary
- Move dotenv call from library to binary
- Use IPFS_DEPLOY prefix in env variables and change their names
- Change deploy() signature to take credentials & domain as parameters

Author: agentofuser

LICENSE.md

@@ -102,3 +102,25 @@ SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
 OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
 OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+
+---
+
+# The MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -4,9 +4,9 @@
 
 > Pin directory locally, send hash to pinning service, and update dnslink.
 
-## 🚨 WARNING: This is alpha software and very much in "quick hack that works for me" status. Use with caution.
+## 🚨 WARNING: This is alpha software and very much in "works for me" status. APIs and CLI options will change. Use with caution, but please do, give feedback, and consider contributing :)
 
-The goal of @agentofuser/ipfs-deploy is to make it as easy as possible to
+The goal of `@agentofuser/ipfs-deploy` is to make it as easy as possible to
 deploy a static website to IPFS.
 
 ## Table of Contents
@@ -45,62 +45,125 @@ add it to the README.
 
 ## Install
 
-```
+### As a library:
+
+```bash
 npm install --save-dev @agentofuser/ipfs-deploy
 ```
 
+### As an executable:
+
+```bash
+npm install -g @agentofuser/ipfs-deploy
+```
+
+You might want to alias that in your terminal. I added this to my `~/.bashrc`:
+
+```bash
+alias ipd='ipfs-deploy public'
+```
+
+### No install:
+
+You can run it directly with [npx](https://www.npmjs.com/package/npx 'npx')
+without needing to install anything:
+
+```bash
+npx ipfs-deploy _site
+```
+
+Just remember to have the credentials properly set up as instructed below.
+
 ## Usage
 
+### As an executable:
+
 I won't go over how to set up Pinata and Cloudflare right now, but you can read
 up on that over at:
 
-https://www.cloudflare.com/distributed-web-gateway/
+https://www.cloudflare.com/distributed-web-gateway
 
 and:
 
 https://pinata.cloud/documentation#GettingStarted
 
 (Infura doesn't require creating an account.)
 
-Then copy over `.env.sample` to `.env` and fill out your credentials:
+After setting up your Cloudflare and Pinata accounts, in your website's
+repository root, create or edit the file `.env` with your domain and
+credentials:
 
 ```
-PINATA_API_KEY=
-PINATA_SECRET_API_KEY=
-SITE_DOMAIN=
-CF_API_KEY=
-CF_API_EMAIL=
+IPFS_DEPLOY_SITE_DOMAIN=
+IPFS_DEPLOY_PINATA__API_KEY=
+IPFS_DEPLOY_PINATA__SECRET_API_KEY=
+IPFS_DEPLOY_CLOUDFLARE__API_EMAIL=
+IPFS_DEPLOY_CLOUDFLARE__API_KEY=
 ```
 
-(**Don't** commit it!)
+(**Don't** commit it to source control unless you know what you're doing.)
 
 ```
 $ echo '.env' >> .gitignore
 ```
 
-Put this somewhere in a `deploy.js` file:
+Assuming your website's production build is at the `public` subdirectory
+(that's what Gatsby and Hugo use; Jekyll and Hakyll use `_site`), run this at
+the project's root:
 
-```javascript
-const ipfsDeploy = require(@agentofuser/ipfs-deploy)
-ipfsDeploy()
+```bash
+ipfs-daemon public
 ```
 
-Add a deploy command to your `package.json`:
+To see more details about command line usage, run:
+
+```bash
+ipfs-deploy --help
+```
+
+You can optionally add a deploy command to your `package.json`:
 
 ```javascript
 //  ⋮
   "scripts": {
 //  ⋮
-    "deploy": "node ./ipfs-deploy.js",
+    "deploy": "npx ipfs-daemon public",
 //  ⋮
   }
 //  ⋮
 ```
 
-And when you have built your website into `./public/`, run:
+Then to run it, execute:
 
+```bash
+npm run deploy
 ```
-$ npm run deploy
+
+### As a library:
+
+````javascript
+const deploy = require('ipfs-deploy')
+
+;(async () => {
+  try {
+    deploy({
+      updateDns: true,
+      open: false, // opens browser after deploying
+      publicDirPath: 'public',
+      remote: {
+        siteDomain: 'example.com',
+        cloudflare: {
+          apiEmail,
+          apiKey,
+        },
+        pinata: {
+          apiKey,
+          secretApiKey,
+        },
+      },
+    })
+  } catch (e) {}
+})()
 ```
 
 ## Contributing
@@ -118,6 +181,8 @@ specification.
 
 ## License
 
-[BlueOak-1.0.0 OR BSD-2-Clause-Patent © Agent of User](./LICENSE.md)
+[BlueOak-1.0.0 OR BSD-2-Clause-Patent OR MIT © Agent of User](./LICENSE.md)
 
-(These are the most permissive possible ever.)
+(The first two are the most permissive possible ever, more than MIT, which
+doesn't have a patent waiver. Use whichever satisfies your lawyer better.)
+````

bin/ipfs-deploy.js

@@ -3,6 +3,8 @@ const chalk = require('chalk')
 
 const deploy = require('../index')
 
+require('dotenv').config()
+
 const argv = require('yargs')
   .scriptName('ipfs-deploy')
   .usage(
@@ -15,6 +17,7 @@ const argv = require('yargs')
           default: './public/',
           describe: 'The path to deploy',
         })
+        .env('IPFS_DEPLOY')
         .options({
           D: {
             type: 'boolean',
@@ -84,6 +87,17 @@ function main() {
     // pinners: argv.p, TODO
     // pinRemotely: !argv.P, TODO
     publicDirPath: argv.path,
+    remote: {
+      siteDomain: argv.siteDomain,
+      cloudflare: {
+        apiKey: argv.cloudflare.apiKey,
+        apiEmail: argv.cloudflare.apiEmail,
+      },
+      pinata: {
+        apiKey: argv.pinata.apiKey,
+        secretApiKey: argv.pinata.secretApiKey,
+      },
+    },
   })
 }
 

index.js

@@ -8,27 +8,22 @@ const ora = require('ora')
 const chalk = require('chalk')
 const openUrl = require('open')
 
-require('dotenv').config()
-
-async function doUpdateDns(hash) {
-  const key = process.env.CF_API_KEY
-  const email = process.env.CF_API_EMAIL
-  const domain = process.env.SITE_DOMAIN
-
+async function doUpdateDns({ siteDomain, cloudflare }, hash) {
   const spinner = ora()
 
-  if (!key || !email || !domain || !hash) {
+  const { apiEmail, apiKey } = cloudflare
+  if (!apiKey || !apiEmail || !siteDomain || !hash) {
     throw new Error('Missing information for doUpdateDns()')
   }
 
   const api = {
-    key,
-    email,
+    email: apiEmail,
+    key: apiKey,
   }
 
   const opts = {
-    record: domain,
-    zone: domain,
+    record: siteDomain,
+    zone: siteDomain,
     link: `/ipfs/${hash}`,
   }
 
@@ -44,7 +39,7 @@ async function doUpdateDns(hash) {
     spinner.info(`${chalk.whiteBright(content)}.`)
     spinner.succeed('🌐 Your website is deployed now.')
   } catch (err) {
-    console.log(err)
+    console.error(err)
     process.exit(1)
   }
 }
@@ -55,6 +50,17 @@ async function deploy({
   // pinners = ['pinata', 'infura'], TODO
   // pinRemotely = true, TODO
   publicDirPath = 'public',
+  remote = {
+    siteDomain,
+    cloudflare: {
+      apiEmail,
+      apiKey,
+    },
+    pinata: {
+      apiKey,
+      secretApiKey,
+    },
+  },
 } = {}) {
   const ipfsBinAbsPath =
     which.sync('ipfs', { nothrow: true }) ||
@@ -104,16 +110,16 @@ async function deploy({
             const pinataOptions = {
               host_nodes: publicMultiaddresses,
               pinataMetadata: {
-                name: process.env.SITE_DOMAIN,
+                name: remote.siteDomain,
                 keyvalues: {
                   gitCommitHash: 'TODO',
                 },
               },
             }
 
             const pinata = pinataSDK(
-              process.env.PINATA_API_KEY,
-              process.env.PINATA_SECRET_API_KEY
+              remote.pinata.apiKey,
+              remote.pinata.secretApiKey
             )
 
             spinner.info(
@@ -151,9 +157,9 @@ async function deploy({
                   `📋 Hash ${chalk.green(hash)} copied to clipboard.`
                 )
 
-                if (updateDns) doUpdateDns(hash)
+                if (updateDns) doUpdateDns(remote, hash)
 
-                if (open) openUrl(`https://${process.env.SITE_DOMAIN}`)
+                if (open) openUrl(`https://${remote.siteDomain}`)
               })
               .catch(err5 => {
                 throw err5

package-lock.json

@@ -56,7 +56,7 @@
     "lint-staged": "^8.1.5",
     "ndb": "^1.0.44",
     "prettier": "^1.16.4",
-    "semantic-git-commit-cli": "^3.2.1",
+    "semantic-git-commit-cli": "^3.2.2",
     "semantic-release": "^15.13.8",
     "semantic-release-cli": "^4.1.1"
   },