@beauraines/bacon-ipsum-cli 0.1.4 → 0.2.0

package/CHANGELOG.md

@@ -2,6 +2,32 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+## [0.2.0](https://github.com/beauraines/bacon-ipsum-cli/compare/v0.1.5...v0.2.0) (2024-05-27)
+
+
+### ⚠ BREAKING CHANGES
+
+* does not display returned text to the console anymore. By default it copies to the clipboard.
+If `--no-clip` or `--nc` are passed with the command, output is _only_ output to the console, bypassing the clipboard.
+
+### Features
+
+* adds completion command ([fed1266](https://github.com/beauraines/bacon-ipsum-cli/commit/fed12669bfcb30bf40b3789ad2b2ed76f95b9f47))
+* calls API from utils module ([6c64902](https://github.com/beauraines/bacon-ipsum-cli/commit/6c64902ecdc28f9ac4a15c613239b8020ecf64ec))
+* enables no-clip option ([aff861e](https://github.com/beauraines/bacon-ipsum-cli/commit/aff861e75ca0bc9ddf0320d008faa41fa672312c))
+
+
+### Bug Fixes
+
+* fixes no clip option ([c108a77](https://github.com/beauraines/bacon-ipsum-cli/commit/c108a774c87ec028c13a0aa9bbedee435912b9b7))
+
+### [0.1.5](https://github.com/beauraines/bacon-ipsum-cli/compare/v0.1.4...v0.1.5) (2024-05-27)
+
+
+### Features
+
+* adds support for more options ([#4](https://github.com/beauraines/bacon-ipsum-cli/issues/4)) ([4b9f87e](https://github.com/beauraines/bacon-ipsum-cli/commit/4b9f87e2971868cd15f92ca632571ec7d245aa94))
+
 ### [0.1.4](https://github.com/beauraines/bacon-ipsum-cli/compare/v0.1.3...v0.1.4) (2024-05-27)
 
 

package/README.md

@@ -0,0 +1,24 @@
+# Bacon Ipsum CLI
+
+A CLI for the [Bacon Ipsum API](https://baconipsum.com/json-api/)
+
+
+## Usage
+
+```
+bacon [command]
+
+Commands:
+  bacon completion  generate completion script
+
+Options:
+      --version                    Show version number                 [boolean]
+  -t, --type                       Type of meat
+                  [choices: "all-meat", "meat-and-filler"] [default: "all-meat"]
+  -p, --paras                      Number of paragraphs    [number] [default: 1]
+  -s, --sentences                  Number of sentences. This overrides paragraph
+                                   s.                                   [number]
+  -l, --start-with-lorem, --lorem  Starts the first paragraph with 'Bacon ipsum
+                                   dolor sit amet'                     [boolean]
+      --help                       Show help                           [boolean]
+```

package/TODO.md

@@ -1,10 +1,13 @@
 # TODO
 
-- [ ] Move API call to module for testing
-- [ ] Add other options
-- [ ] Add debug
-- [ ] Add unit tests
-- [ ] Add completion command
+- [x] Move API call to module for testing
+- [x] Add other options
+- [x] Add debug
+- [x] Add unit tests
+- [x] Add completion command
 - [x] Configure linter - 'dont warn for Node globals like console'
-- [ ] Swith to ESM and import latest versions of dependencies
-- [ ] Add README
+- [x] Swith to ESM and import latest versions of dependencies
+- [x] Add README
+- [ ] Add output format options
+- [x] Add clipboard bypass option
+- [ ] change getBacon to async/await and separate data processing

package/cli.js

@@ -1,13 +1,14 @@
 #!/usr/bin/env node
 
-const fetch = require('node-fetch');
-const yargs = require('yargs');
-const copyPaste = require('copy-paste');
+import yargs from "yargs";
+import debugClient from 'debug'
+import { buildQueryString, getBacon } from './utils.js';
 
+const debug = debugClient('bacon-ipsum-cli');
 const apiUrl = 'https://baconipsum.com/api/';
 
 // Define command-line options using yargs
-const argv = yargs
+const argv = yargs(process.argv.slice(2))
   .scriptName('bacon')
   .option('type', {
     alias: 't',
@@ -21,44 +22,37 @@ const argv = yargs
     default: 1,
     type: 'number',
   })
-  // .option('sentences',{
-  //   alias: 's',
-  //   describe: 'Number of sentences. This overrides paragraphs.',
-  //   type: 'number'
-  // })
-  // .option('start-with-lorem',{
-  //   alias: ['l','lorem'],
-  //   describe: 'Starts the first paragraph with ‘Bacon ipsum dolor sit amet’',
-  //   type: 'boolean'
-  // })
+  .option('sentences',{
+    alias: 's',
+    describe: 'Number of sentences. This overrides paragraphs.',
+    type: 'number'
+  })
+  .option('start-with-lorem',{
+    alias: ['l','lorem'],
+    describe: 'Starts the first paragraph with ‘Bacon ipsum dolor sit amet’',
+    type: 'boolean'
+  })
   // .option('format',{
   //   alias: 'f',
   //   describe:'Output format. Defaults to `text`',
   //   default: 'text',
   //   choices: ['text','json','html']
   // })
-  // .option('no-clip',{
-  //   alias: 'nc',
-  //   describe:'Only outputs to console, bypassing the clipboard.',
-  //   type: 'boolean'
-  // })
+  .option('nc',{
+    alias: 'nc',
+    describe:'Only outputs to console, bypassing the clipboard.',
+    type: 'boolean'
+  })
+  .completion()
   .help()
   .argv;
-  
-// Build the API URL with the specified options
-// TODO support additional parameters
-const apiUrlWithParams = `${apiUrl}?type=${argv.type}&paras=${argv.paras}`;
+
+debug(argv)
+const apiUrlWithParams = `${apiUrl}?${buildQueryString(argv)}`
+debug(apiUrlWithParams)
 
 // Fetch data from the Bacon Ipsum API
-fetch(apiUrlWithParams)
-  .then((response) => response.json())
-  .then((data) => {
-    // Display the fetched text in the console
-    console.log(data.join('\n'));
+let noClip = argv.nc
+debug(argv.noClip)
 
-    // Copy the text to the clipboard
-    copyPaste.copy(data.join('\n'), () => {
-      console.log('Text copied to clipboard!');
-    });
-  })
-  .catch((error) => console.error('Error fetching data:', error));
+getBacon(apiUrlWithParams,noClip)

package/eslint.config.mjs

@@ -5,7 +5,7 @@ import jestPlugin from "eslint-plugin-jest";
 export default [
   {
     files: ["**/*.js"],
-    languageOptions: { sourceType: "commonjs", globals: globals.nodeBuiltin}
+    languageOptions: { sourceType: "module", ecmaVersion: "latest", globals: globals.nodeBuiltin}
   },
   { languageOptions: { ...jestPlugin.environments.globals } },
   pluginJs.configs.recommended,

package/package.json

@@ -1,28 +1,38 @@
 {
   "name": "@beauraines/bacon-ipsum-cli",
-  "version": "0.1.4",
+  "version": "0.2.0",
   "description": "CLI for Bacon Ipsum text",
-  "main": "cli.js",
+  "exports": "./cli.js",
+  "type": "module",
   "bin": {
-    "bacon-ipsum": "cli.js"
+    "bacon": "cli.js"
   },
   "scripts": {
-    "test": "jest --passWithNoTests",
+    "test": "NODE_OPTIONS=--experimental-vm-modules npx jest --passWithNoTests --silent",
     "lint": "eslint . ./**/*.js ./**/*.mjs",
     "lint:fix": "eslint . ./**/*.js ./**/*.mjs --fix",
     "release": "standard-version",
     "should-release": "should-release"
   },
-  "author": "Beau Raines",
-  "license": "ISC",
+  "author": "Beau Raines <beau.raines@gmail.com>",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/beauraines/bacon-ipsum-cli.git"
+  },
+  "bugs": {
+    "url": "https://github.com/beauraines/bacon-ipsum-cli/issues"
+  },
+  "license": "MIT",
   "dependencies": {
     "chalk": "^4.1.2",
     "copy-paste": "^1.5.3",
     "node-fetch": "^2.6.7",
+    "query-string": "^9.0.0",
     "yargs": "^17.7.2"
   },
   "devDependencies": {
     "@eslint/js": "^9.3.0",
+    "debug": "^4.3.4",
     "eslint": "^9.3.0",
     "eslint-plugin-jest": "^28.5.0",
     "globals": "^15.3.0",

package/utils.js

@@ -0,0 +1,37 @@
+import copyPaste  from "copy-paste";
+import debugClient from 'debug'
+import fetch from "node-fetch";
+import queryString from "query-string";
+
+const debug = debugClient('bacon-ipsum-cli-utils');
+
+export const buildQueryString = (argv) => {
+    // Build the API URL with the specified options
+    let queryParams = {
+      type: argv.type, 
+      paras: argv.paras, 
+      sentences: argv.sentences,
+      "start-with-lorem" : argv['start-with-lorem'] ? 1 : undefined
+    }
+    const qs = queryString.stringify(queryParams);
+    debug(qs)
+    return qs
+  }
+
+  export const getBacon = (apiUrlWithParams,noClip) => {
+    fetch(apiUrlWithParams)
+      .then((response) => response.json())
+      .then((data) => {
+        if (noClip) { // noClip is alias for no-clip
+          // Display the fetched text in the console
+          console.log(data.join('\n'));
+        } else {
+          // Copy the text to the clipboard
+          copyPaste.copy(data.join('\n'), () => {
+            console.log('Bacon ipsum text copied to the clipboard!');
+          });
+        }
+
+      })
+      .catch((error) => console.error('Error fetching data:', error));
+  }

package/utils.test.js

@@ -0,0 +1,60 @@
+/* eslint-disable jest/no-disabled-tests */
+import { buildQueryString, getBacon } from "./utils.js";
+import copyPaste  from "copy-paste";
+import debugClient from 'debug'
+const debug = debugClient('utils-tests');
+
+
+
+describe('utilities', () => {
+
+  // eslint-disable-next-line no-unused-vars
+  const apiUrl = 'https://baconipsum.com/api/';
+
+  test('should return multiple paragraphs', () => {
+    const paragraphs = 2;
+    const output = `Turkey flank meatball, ham t-bone pancetta ham hock drumstick beef boudin ground round short loin pig buffalo.  Flank pork pork loin chislic spare ribs.  Pork loin tenderloin kevin, bresaola picanha ham hock shoulder shank venison rump.  Shankle short loin fatback venison salami.  Capicola short ribs landjaeger, beef ribs shankle bacon meatloaf sirloin frankfurter venison chicken ham hock burgdoggen chuck.  Burgdoggen tri-tip salami beef shoulder boudin flank andouille pancetta tongue fatback short ribs t-bone.
+Tongue venison ham tri-tip.  Pig porchetta bacon, kielbasa pork chop spare ribs turducken landjaeger brisket.  Capicola chicken pancetta short ribs kevin tenderloin, alcatra fatback beef ribs.  Beef spare ribs sirloin fatback, rump burgdoggen doner ham beef ribs leberkas jowl shankle shank.`;
+    let newLineCount = output.split(/\n/).length
+    expect(newLineCount).toBe(paragraphs)
+  });
+
+  test('build a query string', () => {
+    let argv = {}
+    argv.type = "all-meat"
+    expect(buildQueryString(argv)).toBe('type=all-meat')
+    argv.paras=5
+    expect(buildQueryString(argv)).toBe('paras=5&type=all-meat')
+    argv['start-with-lorem'] = undefined
+    expect(buildQueryString(argv)).toBe('paras=5&type=all-meat')
+    argv['start-with-lorem'] = true
+    expect(buildQueryString(argv)).toBe('paras=5&start-with-lorem=1&type=all-meat')
+  });
+
+  test.skip('skip copying to the clipboard',() => {
+    let argv = {}
+    const noClip = true;
+    const currentClipboardContents = copyPaste.paste()
+    debug(currentClipboardContents)
+
+    const apiUrlWithParams = `${apiUrl}?${buildQueryString(argv)}`
+    getBacon(apiUrlWithParams,noClip)
+    const newClipboardContents = copyPaste.paste()
+    debug(newClipboardContents)
+
+    expect(newClipboardContents).toBe(currentClipboardContents)
+  });
+
+  test.skip('copying to the clipboard',async () => {
+    let argv = {}
+    const noClip = undefined;
+    const currentClipboardContents = copyPaste.paste()
+    debug(currentClipboardContents)
+    const apiUrlWithParams = `${apiUrl}?${buildQueryString(argv)}`
+    getBacon(apiUrlWithParams, noClip)
+    const newClipboardContents = copyPaste.paste()
+    debug(newClipboardContents)
+    expect(newClipboardContents).not.toBe(currentClipboardContents)
+  });
+
+});