@beauraines/bacon-ipsum-cli 0.2.14 → 0.2.16

package/.github/release-please.yml

@@ -0,0 +1,60 @@
+on:
+    push:
+      branches:
+        - main
+  
+  permissions:
+    contents: write
+    pull-requests: write
+  
+  name: release-please
+  
+  jobs:
+    release-please:
+      runs-on: ubuntu-latest
+      steps:
+        - uses: googleapis/release-please-action@v4
+          with:
+            # this assumes that you have created a personal access token
+            # (PAT) and configured it as a GitHub action secret named
+            # `MY_RELEASE_PLEASE_TOKEN` (this secret name is not important).
+            token: ${{ secrets.MY_RELEASE_PLEASE_TOKEN }}
+            # this is a built-in strategy in release-please, see "Action Inputs"
+            # for more options
+            release-type: node
+            permissions:
+              contents: write
+              pull-requests: write
+              
+        # The logic below handles the npm publication:
+        - uses: actions/checkout@v4
+          # these if statements ensure that a publication only occurs when
+          # a new release is created:
+          if: ${{ steps.release.outputs.release_created }}
+        - uses: actions/setup-node@v4
+          with:
+            node-version: 12
+            registry-url: 'https://registry.npmjs.org'
+          if: ${{ steps.release.outputs.release_created }}
+        - run: npm ci
+          if: ${{ steps.release.outputs.release_created }}
+        - run: npm publish
+          env:
+            NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN}}
+          if: ${{ steps.release.outputs.release_created }}
+
+        - uses: actions/checkout@v4
+        - name: tag major and minor versions
+          if: ${{ steps.release.outputs.release_created }}
+          run: |
+            git config user.name github-actions[bot]
+            git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+            git remote add gh-token "https://${{ secrets.GITHUB_TOKEN }}@github.com/googleapis/release-please-action.git"
+            git tag -d v${{ steps.release.outputs.major }} || true
+            git tag -d v${{ steps.release.outputs.major }}.${{ steps.release.outputs.minor }} || true
+            git push origin :v${{ steps.release.outputs.major }} || true
+            git push origin :v${{ steps.release.outputs.major }}.${{ steps.release.outputs.minor }} || true
+            git tag -a v${{ steps.release.outputs.major }} -m "Release v${{ steps.release.outputs.major }}"
+            git tag -a v${{ steps.release.outputs.major }}.${{ steps.release.outputs.minor }} -m "Release v${{ steps.release.outputs.major }}.${{ steps.release.outputs.minor }}"
+            git push origin v${{ steps.release.outputs.major }}
+            git push origin v${{ steps.release.outputs.major }}.${{ steps.release.outputs.minor }}

package/CHANGELOG.md

@@ -2,6 +2,15 @@
 
 All notable changes to this project will be documented in this file. See [commit-and-tag-version](https://github.com/absolute-version/commit-and-tag-version) for commit guidelines.
 
+## [0.2.16](https://github.com/beauraines/bacon-ipsum-cli/compare/v0.2.15...v0.2.16) (2024-06-24)
+
+## [0.2.15](https://github.com/beauraines/bacon-ipsum-cli/compare/v0.2.14...v0.2.15) (2024-06-24)
+
+
+### Features
+
+* option for output format ([2f30a3f](https://github.com/beauraines/bacon-ipsum-cli/commit/2f30a3f6fa91e7c331f9ec4dfbda9aca2fd2cd00)), closes [#6](https://github.com/beauraines/bacon-ipsum-cli/issues/6)
+
 ## [0.2.14](https://github.com/beauraines/bacon-ipsum-cli/compare/v0.2.13...v0.2.14) (2024-06-22)
 
 ## [0.2.13](https://github.com/beauraines/bacon-ipsum-cli/compare/v0.2.12...v0.2.13) (2024-06-22)

package/TODO.md

@@ -8,6 +8,6 @@
 - [x] Configure linter - 'dont warn for Node globals like console'
 - [x] Swith to ESM and import latest versions of dependencies
 - [x] Add README
-- [ ] Add output format options
+- [x] Add output format options
 - [x] Add clipboard bypass option
-- [ ] change getBacon to async/await and separate data processing
+- [xs] change getBacon to async/await and separate data processing

package/cli.js

@@ -32,12 +32,12 @@ const argv = yargs(process.argv.slice(2))
     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('format',{
+    alias: 'f',
+    describe:'Output format. Defaults to `text`',
+    default: 'text',
+    choices: ['text','json','html']
+  })
   .option('nc',{
     alias: 'nc',
     describe:'Only outputs to console, bypassing the clipboard.',
@@ -53,11 +53,12 @@ debug(apiUrlWithParams)
 
 // Fetch data from the Bacon Ipsum API
 let noClip = argv.nc
+let format = argv.format
 
-let bacon = await getBacon(apiUrlWithParams)
+let bacon = await getBacon(apiUrlWithParams,format)
 debug(bacon)
 let outputOptions = {
-  noClip: noClip
+  noClip
 }
 debug(outputOptions)
-processOutput(bacon, outputOptions);
+await processOutput(bacon, outputOptions);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@beauraines/bacon-ipsum-cli",
-  "version": "0.2.14",
+  "version": "0.2.16",
   "description": "CLI for Bacon Ipsum text",
   "exports": "./cli.js",
   "type": "module",

package/utils.js

@@ -23,11 +23,14 @@ export const buildQueryString = (argv) => {
    * @param {String} apiUrlWithParams The bacon ipsum endpoint including any parameters
    * @returns {Array}
    */
-  export const getBacon = async (apiUrlWithParams) => {
+  export const getBacon = async (apiUrlWithParams,format) => {
+    debug(apiUrlWithParams+`&format=${format}`)
     try {
-      let response = await fetch(apiUrlWithParams)
-      if (response.ok) {
+      let response = await fetch(apiUrlWithParams+`&format=${format}`)
+      if (response.ok && format == 'json') {
         return await response.json()
+      } else if (response.ok && (format == 'text' || format == 'html')) {
+        return await response.text()
       } else {
         throw new Error(response.statusText);
       }
@@ -36,13 +39,13 @@ export const buildQueryString = (argv) => {
     }
   }
 
-  export const processOutput = (data, options) => {
+  export const processOutput = async (data, options) => {
   if (options.noClip) { // noClip is alias for no-clip
     // Display the fetched text in the console
-    console.log(data.join('\n'));
+    console.log(data);
   } else {
     // Copy the text to the clipboard
-    copyPaste.copy(data.join('\n'), () => {
+    await copyPaste.copy(data, () => {
       console.log('Bacon ipsum text copied to the clipboard!');
     });
   }

package/utils.test.js

@@ -9,6 +9,7 @@ const debug = debugClient('utils-tests');
 
 describe('utilities', () => {
 
+  //? What exactly is this testing? I don't think this is good for anything.
   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.
@@ -27,30 +28,44 @@ Tongue venison ham tri-tip.  Pig porchetta bacon, kielbasa pork chop spare ribs
     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')
+    // Format should not be added to the query string, it is passed as an argument to the API call
+    argv['format'] = 'html'
+    expect(buildQueryString(argv)).toBe('paras=5&start-with-lorem=1&type=all-meat')
   });
 
 });
 
 // Skipped because GitHub runner doesn't include xclip
-describe.skip("skip copy to clipboard", () => {
-  test('skip copying to the clipboard',async () => {
+describe("skip copy to clipboard", () => {
+  test.skip('skip copying to the clipboard',async () => {
     let bacon = ["bacon ipsum","turkey"]
     await copyPaste.copy("foo")
-    processOutput(bacon, {noClip: true});
+    await processOutput(bacon, {noClip: true});
     const newClipboardContents = await copyPaste.paste()
     expect(newClipboardContents).not.toBe("foo")
   });
 });
 
 // Skipped because GitHub runner doesn't include xclip
-describe.skip("copy to clipboard", () => {
-  test('processes output to clipboard',async () => {
-    let bacon = ["bacon ipsum","turkey"]
+describe("copy JSON to clipboard", () => {
+  test.skip('processes JSON output to clipboard',async () => {
+    let bacon = ['bacon ipsum','turkey']
+    const noClip = false;
+    await copyPaste.copy("foo")
+    await processOutput(bacon, {noClip});
+    const newClipboardContents = await copyPaste.paste()
+    expect(newClipboardContents).toBe(bacon)
+  });
+});
+
+// Skipped because GitHub runner doesn't include xclip
+describe("copy text to clipboard", () => {
+  test.skip('processes text output to clipboard',async () => {
+    let bacon = "bacon ipsum\nturkey";
     const noClip = undefined;
-    await copyPaste.copy("")
-    processOutput(bacon, {noClip});
+    await copyPaste.copy("foo")
+    await processOutput(bacon, {noClip});
     const newClipboardContents = await copyPaste.paste()
     expect(newClipboardContents).toBe("bacon ipsum\nturkey")
   });
-
 });