@beauraines/bacon-ipsum-cli 0.1.3 → 0.1.5

package/CHANGELOG.md

@@ -2,6 +2,20 @@
 
 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.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)
+
+
+### Bug Fixes
+
+* bad merge in eslint ([7c34b5d](https://github.com/beauraines/bacon-ipsum-cli/commit/7c34b5d24f6d4bcb4445e4a6fc9271a55a7c5d4d))
+
 ### 0.1.3 (2024-05-26)
 
 

package/TODO.md

@@ -1,7 +1,11 @@
 # TODO
 
 - [ ] Move API call to module for testing
-- [ ] Add other options
-- [ ] Add debug
+- [x] Add other options
+- [x] Add debug
 - [ ] Add unit tests
 - [ ] Add completion command
+- [x] Configure linter - 'dont warn for Node globals like console'
+- [x] Swith to ESM and import latest versions of dependencies
+- [ ] Add README
+- [ ] Add output options (format and clipboard)

package/cli.js

@@ -1,13 +1,17 @@
 #!/usr/bin/env node
 
-const fetch = require('node-fetch');
-const yargs = require('yargs');
-const copyPaste = require('copy-paste');
+import fetch from "node-fetch";
+import yargs from "yargs";
+import copyPaste  from "copy-paste";
+import debugClient from 'debug'
+import { buildQueryString } 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,16 +25,16 @@ 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`',
@@ -44,10 +48,10 @@ const argv = yargs
   // })
   .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)

package/eslint.config.mjs

@@ -1,21 +1,20 @@
 import globals from "globals";
 import pluginJs from "@eslint/js";
-import jest from "eslint-plugin-jest";
+import jestPlugin from "eslint-plugin-jest";
 
 export default [
-  { files: ["**/*.js"], languageOptions: { sourceType: "commonjs" } },
-  { languageOptions: { globals: globals.browser } },
+  {
+    files: ["**/*.js"],
+    languageOptions: { sourceType: "module", ecmaVersion: "latest", globals: globals.nodeBuiltin}
+  },
+  { languageOptions: { ...jestPlugin.environments.globals } },
   pluginJs.configs.recommended,
   {
     plugins: {
-      jest: jest
+      jest: jestPlugin
     },
     rules: {
-      "jest/no-disabled-tests": "warn",
-      "jest/no-focused-tests": "error",
-      "jest/no-identical-title": "error",
-      "jest/prefer-to-have-length": "warn",
-      "jest/valid-expect": "error"
+      ...jestPlugin.configs.recommended.rules, // Use recommended rules from eslint-plugin-jest
     }
   }
 ];

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "@beauraines/bacon-ipsum-cli",
-  "version": "0.1.3",
+  "version": "0.1.5",
   "description": "CLI for Bacon Ipsum text",
-  "main": "cli.js",
+  "exports": "./cli.js",
+  "type": "module",
   "bin": {
     "bacon-ipsum": "cli.js"
   },
@@ -19,13 +20,15 @@
     "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",
-    "globals": "^15.3.0",
     "eslint-plugin-jest": "^28.5.0",
+    "globals": "^15.3.0",
     "jest": "^29.7.0",
     "should-release": "^1.2.0",
     "standard-version": "^9.5.0"

package/utils.js

@@ -0,0 +1,16 @@
+import queryString from "query-string";
+import debugClient from 'debug'
+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 : null
+    }
+    const qs = queryString.stringify(queryParams);
+    debug(qs)
+    return qs
+  }