Split library & cli (yarn workspaces) 🎉

Author: vladimyr

.eslintrc.js

@@ -1,4 +1,5 @@
 module.exports = {
+  root: true,
   extends: 'semistandard',
   rules: {
     'prefer-const': 'error',

.gitignore

@@ -1,5 +1,6 @@
 node_modules
 lib
+*.log
 .tmp_*~
 *#
 .#*

.travis.yml

@@ -1,8 +1,8 @@
 language: node_js
 
 script:
-  - yarn run lint
-  - yarn test
+  - yarn workspaces run lint
+  - yarn workspaces run test
 
 node_js:
   - 8

Changelog.md CHANGELOG.mdChangelog.md renamed to CHANGELOG.md

@@ -9,7 +9,7 @@ Based on gravatar specs - <https://en.gravatar.com/site/implement/hash/> and <ht
 
 ### Runtime
 
-- Node `>= 0.8`
+- Node `>=8`
 
 ### Development/Tests
 
@@ -107,7 +107,7 @@ const profile2 = gravatar.profileUrl(email, {
 `gravatar` includes a simple command line interface. To use it, install globally:
 
 ```sh
-npm i -g gravatar
+npm i -g gravatar-cli
 
 gravatar -h
 gravatar somebody@example.com
@@ -117,13 +117,12 @@ gravatar avatar somebody@example.com
 
 gravatar profile -h
 gravatar profile somebody@example.com
-
 ```
 
 ## Running tests
 
 ```sh
-$ npm test
+$ yarn workspaces run test
 ```
 
 ## To-Do

Readme.md README.mdReadme.md renamed to README.md

@@ -1,57 +1,25 @@
 {
+  "private": true,
   "name": "gravatar",
-  "description": "Gravatar Node.js library",
-  "keywords": [
-    "gravatar",
-    "avatar"
-  ],
-  "version": "1.8.0",
-  "author": "Emerson Macedo <emerleite@gmail.com>",
-  "repository": {
-    "type": "git",
-    "url": "git://github.com/emerleite/node-gravatar.git"
-  },
-  "homepage": "https://github.com/emerleite/node-gravatar",
-  "files": [
-    "lib"
-  ],
-  "dependencies": {
-    "normalize-url": "^4.3.0",
-    "yargs": "^13.2.4"
-  },
+  "dependencies": {},
   "devDependencies": {
     "@babel/core": "^7.4.5",
     "@babel/plugin-proposal-object-rest-spread": "^7.4.4",
     "@babel/preset-env": "^7.4.5",
-    "email-validator": "^2.0.4",
     "eslint": "^5.16.0",
     "eslint-config-semistandard": "^13.0.0",
     "eslint-config-standard": "^12.0.0",
     "eslint-plugin-import": "^2.17.3",
     "eslint-plugin-node": "^9.1.0",
     "eslint-plugin-promise": "^4.1.1",
     "eslint-plugin-standard": "^4.0.0",
-    "mocha": "6.1.4",
-    "nixt": "^0.5.1",
     "rollup": "^1.15.2",
     "rollup-plugin-babel": "^4.3.2",
     "rollup-plugin-commonjs": "^10.0.0",
-    "rollup-plugin-node-resolve": "^5.0.1",
-    "should": "13.2.3"
-  },
-  "main": "lib/gravatar.js",
-  "module": "lib/gravatar.esm.js",
-  "scripts": {
-    "lint": "eslint .",
-    "build": "rollup -c rollup.config.js",
-    "pretest": "yarn run build",
-    "test": "mocha -R spec"
-  },
-  "license": "MIT",
-  "engines": {
-    "node": ">=0.8.0"
+    "rollup-plugin-node-resolve": "^5.0.1"
   },
-  "bin": {
-    "gravatar": "cli.js"
-  }
+  "workspaces": [
+    "packages/gravatar",
+    "packages/gravatar-cli"
+  ]
 }

package.json

@@ -0,0 +1,22 @@
+# License
+
+(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.

packages/gravatar-cli/LICENSE.md

@@ -2,8 +2,8 @@
 
 'use strict';
 
-const gravatar = require('./lib/gravatar');
 const emailValidator = require('email-validator');
+const gravatar = require('gravatar');
 const pkg = require('./package.json');
 
 const options = {
@@ -24,13 +24,13 @@ const options = {
 };
 
 const profileOptions = {
-  format: {
-    alias: 'f',
+  f: {
+    alias: 'format',
     describe: 'format of the requested profile url',
     choices: ['json', 'xml', 'qr', 'php', 'vcf']
   },
-  callback: {
-    alias: 'c',
+  c: {
+    alias: 'callback',
     describe: 'name of a callback function when using json profile url eg. doSomething'
   }
 };
@@ -40,7 +40,10 @@ const footer = `Useful Links:
   - https://en.gravatar.com/site/implement/profiles/
   - ${pkg.homepage}`;
 
-const getOptions = argv => pick(argv, [...Object.keys(options), ...Object.keys(profileOptions)]);
+const getOptions = argv => pick(argv, [
+  ...Object.values(options).map(({ alias }) => alias),
+  ...Object.values(profileOptions).map(({ alias }) => alias)
+]);
 
 const setUsage = function (yargs) {
   return yargs

cli.js packages/gravatar-cli/cli.jscli.js renamed to packages/gravatar-cli/cli.js

@@ -0,0 +1,40 @@
+{
+  "name": "gravatar-cli",
+  "description": "Gravatar Node.js CLI",
+  "keywords": [
+    "gravatar",
+    "avatar",
+    "cli"
+  ],
+  "version": "1.8.0",
+  "author": "Emerson Macedo <emerleite@gmail.com>",
+  "repository": {
+    "type": "git",
+    "url": "git://github.com/emerleite/node-gravatar.git"
+  },
+  "homepage": "https://github.com/emerleite/node-gravatar",
+  "files": [
+    "cli.js"
+  ],
+  "dependencies": {
+    "gravatar": "^1.8.0"
+  },
+  "devDependencies": {
+    "email-validator": "^2.0.4",
+    "eslint": "^5.16.0",
+    "mocha": "6.1.4",
+    "nixt": "^0.5.1",
+    "should": "13.2.3"
+  },
+  "scripts": {
+    "lint": "eslint .",
+    "test": "mocha -R spec"
+  },
+  "license": "MIT",
+  "engines": {
+    "node": ">=8"
+  },
+  "bin": {
+    "gravatar": "cli.js"
+  }
+}

packages/gravatar-cli/package.json

@@ -0,0 +1,41 @@
+'use strict';
+
+/* eslint-env mocha */
+
+require('should');
+const nixt = require('nixt');
+
+describe('gravatar CLI', function () {
+  describe('general: ', function () {
+    it('accepts an email argument with options and writes gravatar URL to STDOUT', function (done) {
+      nixt()
+        .run('./cli.js zeke@sikelianos.com -p https -s 500 -d retro')
+        .stdout('Gravatar (avatar):\nhttps://gravatar.com/avatar/8f344b1c4bdcfc28bd848e97e94c3523?size=500&default=retro')
+        .end(done);
+    });
+    it('outputs usage if -h arg is present', function (done) {
+      nixt()
+        .run('./cli.js -h')
+        .stdout(/Usage/)
+        .end(done);
+    });
+  });
+
+  describe('avatar command: ', function () {
+    it('accepts an email argument with options and writes gravatar URL to STDOUT', function (done) {
+      nixt()
+        .run('./cli.js avatar zeke@sikelianos.com -p https -s 500 -d retro')
+        .stdout('Gravatar (avatar):\nhttps://gravatar.com/avatar/8f344b1c4bdcfc28bd848e97e94c3523?size=500&default=retro')
+        .end(done);
+    });
+  });
+
+  describe('profile command: ', function () {
+    it('accepts an email argument with options and writes gravatar profile URL to STDOUT', function (done) {
+      nixt()
+        .run('./cli.js profile zeke@sikelianos.com -p https -c doSomething')
+        .stdout('Gravatar (profile):\nhttps://gravatar.com/8f344b1c4bdcfc28bd848e97e94c3523.json?callback=doSomething')
+        .end(done);
+    });
+  });
+});