@beauraines/bacon-ipsum-cli 0.1.0

package/.github/dependabot.yml

@@ -0,0 +1,21 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: "npm" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "weekly"
+      day: "friday"
+    commit-message:
+      prefix: fix
+      prefix-development: chore
+      include: scope
+    groups:
+        dev-dependencies:
+          dependency-type: "development"
+          patterns:
+            - "*"

package/.github/workflows/main.yml

@@ -0,0 +1,27 @@
+name: Node.js CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [18.x,20.x]
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm ci
+      - run: npm run build --if-present
+      - run: npm test

package/.github/workflows/publish.yml

@@ -0,0 +1,54 @@
+name: 'Publish to NPM'
+
+on:
+  workflow_run:
+    workflows: ['Node.js CI']
+    types: [completed]
+    branches: [master,main]
+
+jobs:
+  publish-new-version:
+    runs-on: ubuntu-latest
+    if: ${{ github.event.workflow_run.conclusion == 'success' }}
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          fetch-depth: '0'
+      - name: git setup
+        run: |
+          git config --local user.email "41898282+github-actions[bot]@users.noreply.github.com"
+          git config --local user.name "github-actions[bot]"
+      - name: setup node
+        uses: actions/setup-node@v3
+        with:
+          node-version: 16.x
+          registry-url: 'https://registry.npmjs.org'
+      - name: npm install
+        run: npm ci
+
+      - name: Should release
+        id: should_release
+        continue-on-error: true
+        run: npm run should-release -- -v
+
+      - name: No release
+        if: steps.should_release.outcome != 'success'
+        run: echo "No release required. Skipping publishing."
+
+      - name: Version bump
+        if: steps.should_release.outcome == 'success'
+        run: npm run release
+
+      - name: Publish to NPM
+        if: steps.should_release.outcome == 'success'
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Push commits to GitHub
+        if: steps.should_release.outcome == 'success'
+        uses: ad-m/github-push-action@master
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          branch: ${{ github.ref }}
+          tags: true

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Beau Raines
+
+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.

package/TODO.md

@@ -0,0 +1,7 @@
+# TODO
+
+- [ ] Move API call to module for testing
+- [ ] Add other options
+- [ ] Add debug
+- [ ] Add unit tests
+- [ ] Add completion command

package/cli.js

@@ -0,0 +1,64 @@
+#!/usr/bin/env node
+
+const fetch = require('node-fetch');
+const yargs = require('yargs');
+const copyPaste = require('copy-paste');
+
+const apiUrl = 'https://baconipsum.com/api/';
+
+// Define command-line options using yargs
+const argv = yargs
+  .scriptName('bacon')
+  .option('type', {
+    alias: 't',
+    describe: 'Type of meat',
+    default: 'all-meat',
+    choices: ['all-meat', 'meat-and-filler'],
+  })
+  .option('paras', {
+    alias: 'p',
+    describe: 'Number of paragraphs',
+    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('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'
+  // })
+  .help()
+  .argv;
+  
+// Build the API URL with the specified options
+// TODO support additional parameters
+const apiUrlWithParams = `${apiUrl}?type=${argv.type}&paras=${argv.paras}`;
+
+// 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'));
+
+    // 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));

package/cli.test.js

@@ -0,0 +1,24 @@
+const { describe, expect, it } = require('jest');
+
+describe('utilities', () => {
+  it('should return multiple paragraphs', () => {
+    const paragraphs = 2;
+    // Make API call, capture output
+    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)
+  });
+
+  it.skip('should return an empty array without input', () => {
+  });
+
+  it.skip('should return the undefined if there is no data property', () => {
+    const input = { some: 'random', object: { with: ['nested', 'array'] } };
+    const output = mapData(input);
+    expect(output).to.be.undefined;
+  });
+
+  it.skip('should return the data property if passed an object with data', () => {
+  });
+});

package/eslint.config.mjs

@@ -0,0 +1,21 @@
+import globals from "globals";
+import pluginJs from "@eslint/js";
+import jest from "eslint-plugin-jest";
+
+export default [
+  { files: ["**/*.js"], languageOptions: { sourceType: "commonjs" } },
+  { languageOptions: { globals: globals.browser } },
+  pluginJs.configs.recommended,
+  {
+    plugins: {
+      jest: jest
+    },
+    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"
+    }
+  }
+];

package/package.json

@@ -0,0 +1,33 @@
+{
+  "name": "@beauraines/bacon-ipsum-cli",
+  "version": "0.1.0",
+  "description": "CLI for Bacon Ipsum text",
+  "main": "cli.js",
+  "bin": {
+    "bacon-ipsum": "cli.js"
+  },
+  "scripts": {
+    "test": "jest --passWithNoTests",
+    "lint": "eslint . ./**/*.js ./**/*.mjs",
+    "lint:fix": "eslint . ./**/*.js ./**/*.mjs --fix",
+    "release": "standard-version",
+    "should-release": "should-release"
+  },
+  "author": "Beau Raines",
+  "license": "ISC",
+  "dependencies": {
+    "chalk": "^4.1.2",
+    "copy-paste": "^1.5.3",
+    "node-fetch": "^2.6.7",
+    "yargs": "^17.7.2"
+  },
+  "devDependencies": {
+    "@eslint/js": "^9.3.0",
+    "eslint": "^9.3.0",
+    "globals": "^15.3.0",
+    "eslint-plugin-jest": "^28.5.0",
+    "jest": "^29.7.0",
+    "should-release": "^1.2.0",
+    "standard-version": "^9.5.0"
+  }
+}