@stdlib/string-acronym-cli 0.1.0 → 0.3.0

package/NOTICE

@@ -1 +1 @@
-Copyright (c) 2016-2023 The Stdlib Authors.
+Copyright (c) 2016-2024 The Stdlib Authors.

package/README.md

@@ -18,6 +18,17 @@ limitations under the License.
 
 -->
 
+
+<details>
+  <summary>
+    About stdlib...
+  </summary>
+  <p>We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.</p>
+  <p>The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.</p>
+  <p>When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.</p>
+  <p>To join us in bringing numerical computing to the web, get started by checking us out on <a href="https://github.com/stdlib-js/stdlib">GitHub</a>, and please consider <a href="https://opencollective.com/stdlib">financially supporting stdlib</a>. We greatly appreciate your continued support!</p>
+</details>
+
 # acronym
 
 [![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] <!-- [![dependencies][dependencies-image]][dependencies-url] -->
@@ -190,7 +201,7 @@ See [LICENSE][stdlib-license].
 
 ## Copyright
 
-Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 
 </section>
 
@@ -203,8 +214,8 @@ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 [npm-image]: http://img.shields.io/npm/v/@stdlib/string-acronym-cli.svg
 [npm-url]: https://npmjs.org/package/@stdlib/string-acronym-cli
 
-[test-image]: https://github.com/stdlib-js/string-acronym/actions/workflows/test.yml/badge.svg?branch=v0.1.0
-[test-url]: https://github.com/stdlib-js/string-acronym/actions/workflows/test.yml?query=branch:v0.1.0
+[test-image]: https://github.com/stdlib-js/string-acronym/actions/workflows/test.yml/badge.svg?branch=v0.3.0
+[test-url]: https://github.com/stdlib-js/string-acronym/actions/workflows/test.yml?query=branch:v0.3.0
 
 [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/string-acronym/main.svg
 [coverage-url]: https://codecov.io/github/stdlib-js/string-acronym?branch=main
@@ -217,7 +228,7 @@ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 -->
 
 [chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg
-[chat-url]: https://gitter.im/stdlib-js/stdlib/
+[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im
 
 [stdlib]: https://github.com/stdlib-js/stdlib
 
@@ -231,8 +242,11 @@ Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
 [es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules
 
 [deno-url]: https://github.com/stdlib-js/string-acronym/tree/deno
+[deno-readme]: https://github.com/stdlib-js/string-acronym/blob/deno/README.md
 [umd-url]: https://github.com/stdlib-js/string-acronym/tree/umd
+[umd-readme]: https://github.com/stdlib-js/string-acronym/blob/umd/README.md
 [esm-url]: https://github.com/stdlib-js/string-acronym/tree/esm
+[esm-readme]: https://github.com/stdlib-js/string-acronym/blob/esm/README.md
 [branches-url]: https://github.com/stdlib-js/string-acronym/blob/main/branches.md
 
 [stdlib-license]: https://raw.githubusercontent.com/stdlib-js/string-acronym/main/LICENSE

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stdlib/string-acronym-cli",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "description": "Generate an acronym for a given string.",
   "license": "Apache-2.0",
   "author": {
@@ -25,21 +25,21 @@
     "url": "https://github.com/stdlib-js/stdlib/issues"
   },
   "dependencies": {
-    "@stdlib/assert-is-regexp-string": "^0.0.9",
-    "@stdlib/cli-ctor": "^0.0.3",
-    "@stdlib/fs-read-file": "^0.0.8",
-    "@stdlib/process-read-stdin": "^0.0.7",
-    "@stdlib/regexp-eol": "^0.0.7",
-    "@stdlib/streams-node-stdin": "^0.0.7",
-    "@stdlib/string-trim": "^0.0.9",
-    "@stdlib/utils-regexp-from-string": "^0.0.9",
-    "@stdlib/string-acronym": "0.1.0"
+    "@stdlib/assert-is-regexp-string": "^0.2.0",
+    "@stdlib/cli-ctor": "^0.2.0",
+    "@stdlib/fs-read-file": "^0.2.0",
+    "@stdlib/process-read-stdin": "^0.2.0",
+    "@stdlib/regexp-eol": "^0.2.0",
+    "@stdlib/streams-node-stdin": "^0.2.0",
+    "@stdlib/string-trim": "^0.2.0",
+    "@stdlib/utils-regexp-from-string": "^0.2.0",
+    "@stdlib/string-acronym": "0.3.0"
   },
   "devDependencies": {
-    "@stdlib/assert-is-browser": "^0.0.8",
-    "@stdlib/assert-is-windows": "^0.0.7",
-    "@stdlib/process-exec-path": "^0.0.7",
-    "@stdlib/string-replace": "^0.0.11",
+    "@stdlib/assert-is-browser": "^0.2.0",
+    "@stdlib/assert-is-windows": "^0.2.0",
+    "@stdlib/process-exec-path": "^0.2.0",
+    "@stdlib/string-replace": "^0.2.0",
     "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
     "proxyquire": "^2.0.0",
     "istanbul": "^0.4.1",

package/.github/workflows/publish_cli.yml

@@ -1,159 +0,0 @@
-#/
-# @license Apache-2.0
-#
-# Copyright (c) 2023 The Stdlib Authors.
-#
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#    http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-#/
-
-# Workflow name:
-name: publish_cli
-
-# Workflow triggers:
-on:
-  # Allow the workflow to be manually run:
-  workflow_dispatch:
-    # Workflow inputs:
-    inputs:
-      version:
-        description: 'Version Increment'
-        type: choice
-        default: 'none'
-        options:
-          - 'none'
-          - 'major'
-          - 'minor'
-          - 'patch'
-          - 'premajor'
-          - 'preminor'
-          - 'prepatch'
-          - 'prerelease'
-
-# Workflow jobs:
-jobs:
-
-  # Define job to publish package to npm:
-  publish:
-
-    # Define display name:
-    name: 'Publish CLI package to npm'
-
-    # Define the type of virtual host machine on which to run the job:
-    runs-on: ubuntu-latest
-
-    # Define environment variables:
-    env:
-      SLACK_WEBHOOK_URL: ${{ secrets.SLACK_WEBHOOK_URL }}
-      NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
-
-    # Define the sequence of job steps...
-    steps:
-
-      # Checkout cli branch:
-      - name: 'Checkout cli branch'
-        uses: actions/checkout@v3
-        with:
-          ref: cli
-
-      # Install Node.js:
-      - name: 'Install Node.js'
-        uses: actions/setup-node@v3
-        with:
-          node-version: 16
-        timeout-minutes: 5
-
-      # Configure git:
-      - name: 'Configure git'
-        run: |
-          git config --local user.email "noreply@stdlib.io"
-          git config --local user.name "stdlib-bot"
-
-      # Increment package version (if requested):
-      - name: 'Increment package version (if requested)'
-        if: ${{ github.event.inputs.version != 'none' }}
-        run: |
-          # Save NPM_TOKEN to user's .npmrc:
-          echo "//registry.npmjs.org/:_authToken=${NPM_TOKEN}" > ~/.npmrc
-
-          # Increment package version:
-          npm version ${{ github.event.inputs.version }} --no-git-tag-version
-
-          # Define variable for new version:
-          NEW_VERSION=$(node -p "require('./package.json').version")
-
-          # Replace branch in README.md link definitions for badges with the new version:
-          find . -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/branch([=:])[^ ]+/branch\1v${NEW_VERSION}/g"
-
-          # Create a new commit and tag:
-          git add package.json README.md
-          git commit -m "Release v${NEW_VERSION}"
-          git tag -a "v${NEW_VERSION}-cli" -m "Release v${NEW_VERSION}"
-
-          # Push changes to GitHub:
-          SLUG=${{ github.repository }}
-          git push "https://$GITHUB_ACTOR:$GITHUB_TOKEN@github.com/$SLUG.git" --follow-tags
-
-      # Replace GitHub links to individual packages with npm links:
-      - name: 'Replace all GitHub links to individual packages with npm links'
-        run: |
-          find . -type f -name '*.md' -print0 | xargs -0 sed -Ei '/tree\/main/b; s/@stdlib\/([^:]*)\]: https:\/\/github.com\/stdlib-js/@stdlib\/\1\]: https:\/\/www.npmjs.com\/package\/@stdlib/g'
-          SLUG=${{ github.repository }}
-          ESCAPED_SLUG=${SLUG//\//\\\/}
-          REPO=${SLUG#*/}
-          find . -type f -name '*.md' -print0 | xargs -0 sed -Ei "s/https:\/\/github.com\/${ESCAPED_SLUG}\/tree\/main/https:\/\/www.npmjs.com\/package\/@stdlib\/${REPO}/g"
-
-      # Publish package to npm:
-      - name: 'Publish package to npm'
-        uses: JS-DevTools/npm-publish@v1
-        with:
-          token: ${{ secrets.NPM_TOKEN }}
-          access: public
-
-      # Discard any uncommitted changes:
-      - name: 'Discard any uncommitted changes'
-        run: |
-          git reset --hard
-
-      # Send status to Slack channel if job fails:
-      - name: 'Send status to Slack channel in case of failure'
-        uses: act10ns/slack@v1
-        with:
-          status: ${{ job.status }}
-          steps: ${{ toJson(steps) }}
-          channel: '#npm-ci'
-        if: failure()
-
-  # Define job to cancel any running or queued workflow runs...
-  cancel:
-
-    # Define the type of virtual host machine on which to run the job:
-    runs-on: ubuntu-latest
-
-    # Time out the job after 3 minutes:
-    timeout-minutes: 3
-
-    # Define the sequence of job steps...
-    steps:
-
-      # Cancel any running or queued workflow runs:
-      - name: 'Cancel running or queued workflow runs'
-        uses: styfle/cancel-workflow-action@0.11.0
-        with:
-          workflow_id: >-
-            benchmark.yml,
-            examples.yml,
-            test.yml,
-            test_coverage.yml,
-            test_install.yml,
-            publish.yml
-          access_token: ${{ github.token }}

package/CONTRIBUTORS

@@ -1,31 +0,0 @@
-# This file is generated by tools/scripts/update_contributors.
-#
-# Contributors listed in alphabetical order.
-
-Ali Salesi <ali_sal1381@yahoo.com>
-Athan Reines <kgryte@gmail.com>
-Brendan Graetz <bguiz@users.noreply.github.com>
-Bruno Fenzl <brunofenzl@gmail.com>
-Christopher Dambamuromo <chridam@gmail.com>
-Dominik Moritz <domoritz@gmail.com>
-Frank Kovacs <fran70kk@gmail.com>
-James <jdgelok@gmail.com>
-Jithin KS <jithinks112@gmail.com>
-Joey Reed <joeyrreed@gmail.com>
-Jordan-Gallivan <115050475+Jordan-Gallivan@users.noreply.github.com>
-Joris Labie <joris.labie1@gmail.com>
-Justin Dennison <justin1dennison@gmail.com>
-Marcus <mfantham@users.noreply.github.com>
-Matt Cochrane <matthew.cochrane.eng@gmail.com>
-Milan Raj <rajsite@users.noreply.github.com>
-Momtchil Momtchev <momtchil@momtchev.com>
-Ognjen Jevremović <ognjenjevremovic@users.noreply.github.com>
-Philipp Burckhardt <pburckhardt@outlook.com>
-Pranav <85227306+Pranavchiku@users.noreply.github.com>
-Ricky Reusser <rsreusser@gmail.com>
-Ryan Seal <splrk@users.noreply.github.com>
-Seyyed Parsa Neshaei <spneshaei@users.noreply.github.com>
-Shraddheya Shendre <shendreshraddheya@gmail.com>
-Stephannie Jiménez Gacha <steff456@hotmail.com>
-dorrin-sot <59933477+dorrin-sot@users.noreply.github.com>
-rei2hu <rei2hu@users.noreply.github.com>

package/test/fixtures/stdin_error.js.txt

@@ -1,33 +0,0 @@
-/**
-* @license Apache-2.0
-*
-* Copyright (c) 2021 The Stdlib Authors.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-*    http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
-
-var proc = require( 'process' );
-var resolve = require( 'path' ).resolve;
-var proxyquire = require( 'proxyquire' );
-
-var fpath = resolve( __dirname, '..', 'bin', 'cli' );
-
-proc.stdin.isTTY = false;
-
-proxyquire( fpath, {
-	'@stdlib/process-read-stdin': stdin
-});
-
-function stdin( clbk ) {
-	clbk( new Error( 'beep' ) );
-}

package/test/test.cli.js

@@ -1,246 +0,0 @@
-/**
-* @license Apache-2.0
-*
-* Copyright (c) 2021 The Stdlib Authors.
-*
-* Licensed under the Apache License, Version 2.0 (the "License");
-* you may not use this file except in compliance with the License.
-* You may obtain a copy of the License at
-*
-*    http://www.apache.org/licenses/LICENSE-2.0
-*
-* Unless required by applicable law or agreed to in writing, software
-* distributed under the License is distributed on an "AS IS" BASIS,
-* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-* See the License for the specific language governing permissions and
-* limitations under the License.
-*/
-
-'use strict';
-
-// MODULES //
-
-var resolve = require( 'path' ).resolve;
-var exec = require( 'child_process' ).exec;
-var tape = require( 'tape' );
-var IS_BROWSER = require( '@stdlib/assert-is-browser' );
-var IS_WINDOWS = require( '@stdlib/assert-is-windows' );
-var EXEC_PATH = require( '@stdlib/process-exec-path' );
-var replace = require( '@stdlib/string-replace' );
-var readFileSync = require( '@stdlib/fs-read-file' ).sync;
-
-
-// VARIABLES //
-
-var fpath = resolve( __dirname, '..', 'bin', 'cli' );
-var opts = {
-	'skip': IS_BROWSER || IS_WINDOWS
-};
-
-
-// FIXTURES //
-
-var PKG_VERSION = require( './../package.json' ).version;
-
-
-// TESTS //
-
-tape( 'command-line interface', function test( t ) {
-	t.ok( true, __filename );
-	t.end();
-});
-
-tape( 'when invoked with a `--help` flag, the command-line interface prints the help text to `stderr`', opts, function test( t ) {
-	var expected;
-	var cmd;
-
-	expected = readFileSync( resolve( __dirname, '..', 'docs', 'usage.txt' ), {
-		'encoding': 'utf8'
-	});
-	cmd = [
-		EXEC_PATH,
-		fpath,
-		'--help'
-	];
-
-	exec( cmd.join( ' ' ), done );
-
-	function done( error, stdout, stderr ) {
-		if ( error ) {
-			t.fail( error.message );
-		} else {
-			t.strictEqual( stdout.toString(), '', 'does not print to `stdout`' );
-			t.strictEqual( stderr.toString(), expected+'\n', 'expected value' );
-		}
-		t.end();
-	}
-});
-
-tape( 'when invoked with a `-h` flag, the command-line interface prints the help text to `stderr`', opts, function test( t ) {
-	var expected;
-	var cmd;
-
-	expected = readFileSync( resolve( __dirname, '..', 'docs', 'usage.txt' ), {
-		'encoding': 'utf8'
-	});
-	cmd = [
-		EXEC_PATH,
-		fpath,
-		'-h'
-	];
-
-	exec( cmd.join( ' ' ), done );
-
-	function done( error, stdout, stderr ) {
-		if ( error ) {
-			t.fail( error.message );
-		} else {
-			t.strictEqual( stdout.toString(), '', 'does not print to `stdout`' );
-			t.strictEqual( stderr.toString(), expected+'\n', 'expected value' );
-		}
-		t.end();
-	}
-});
-
-tape( 'when invoked with a `--version` flag, the command-line interface prints the version to `stderr`', opts, function test( t ) {
-	var cmd = [
-		EXEC_PATH,
-		fpath,
-		'--version'
-	];
-
-	exec( cmd.join( ' ' ), done );
-
-	function done( error, stdout, stderr ) {
-		if ( error ) {
-			t.fail( error.message );
-		} else {
-			t.strictEqual( stdout.toString(), '', 'does not print to `stdout`' );
-			t.strictEqual( stderr.toString(), PKG_VERSION+'\n', 'expected value' );
-		}
-		t.end();
-	}
-});
-
-tape( 'when invoked with a `-V` flag, the command-line interface prints the version to `stderr`', opts, function test( t ) {
-	var cmd = [
-		EXEC_PATH,
-		fpath,
-		'-V'
-	];
-
-	exec( cmd.join( ' ' ), done );
-
-	function done( error, stdout, stderr ) {
-		if ( error ) {
-			t.fail( error.message );
-		} else {
-			t.strictEqual( stdout.toString(), '', 'does not print to `stdout`' );
-			t.strictEqual( stderr.toString(), PKG_VERSION+'\n', 'expected value' );
-		}
-		t.end();
-	}
-});
-
-tape( 'the command-line interface generates an acronym for a supplied string', opts, function test( t ) {
-	var opts;
-	var cmd;
-
-	cmd = [
-		EXEC_PATH,
-		'-e',
-		'"process.stdin.isTTY = true; process.argv[ 2 ] = \'Test-Driven Development\'; require( \''+fpath+'\' );"'
-	];
-	opts = {};
-
-	exec( cmd.join( ' ' ), opts, done );
-
-	function done( error, stdout, stderr ) {
-		if ( error ) {
-			t.fail( error.message );
-		} else {
-			t.strictEqual( stdout.toString(), 'TDD\n', 'prints expected results to stdout' );
-			t.strictEqual( stderr.toString(), '', 'does not print to `stderr`' );
-		}
-		t.end();
-	}
-});
-
-tape( 'the command-line interface supports specifying a custom delimiter when used as a standard stream (string)', opts, function test( t ) {
-	var cmd = [
-		'printf \'Test-driven Development\tAmerican Statistical Association\'',
-		'|',
-		EXEC_PATH,
-		fpath,
-		'--split \'\t\''
-	];
-
-	exec( cmd.join( ' ' ), done );
-
-	function done( error, stdout, stderr ) {
-		if ( error ) {
-			t.fail( error.message );
-		} else {
-			t.strictEqual( stdout.toString(), 'TDD\nASA\n', 'expected value' );
-			t.strictEqual( stderr.toString(), '', 'does not print to `stderr`' );
-		}
-		t.end();
-	}
-});
-
-tape( 'the command-line interface supports specifying a custom delimiter when used as a standard stream (regexp)', opts, function test( t ) {
-	var cmd = [
-		'printf \'Test-driven Development\tAmerican Statistical Association\'',
-		'|',
-		EXEC_PATH,
-		fpath,
-		'--split=/\\\\t/'
-	];
-
-	exec( cmd.join( ' ' ), done );
-
-	function done( error, stdout, stderr ) {
-		if ( error ) {
-			t.fail( error.message );
-		} else {
-			t.strictEqual( stdout.toString(), 'TDD\nASA\n', 'expected value' );
-			t.strictEqual( stderr.toString(), '', 'does not print to `stderr`' );
-		}
-		t.end();
-	}
-});
-
-tape( 'when used as a standard stream, if an error is encountered when reading from `stdin`, the command-line interface prints an error and sets a non-zero exit code', opts, function test( t ) {
-	var script;
-	var opts;
-	var cmd;
-
-	script = readFileSync( resolve( __dirname, 'fixtures', 'stdin_error.js.txt' ), {
-		'encoding': 'utf8'
-	});
-
-	// Replace single quotes with double quotes:
-	script = replace( script, '\'', '"' );
-
-	cmd = [
-		EXEC_PATH,
-		'-e',
-		'\''+script+'\''
-	];
-
-	opts = {
-		'cwd': __dirname
-	};
-
-	exec( cmd.join( ' ' ), opts, done );
-
-	function done( error, stdout, stderr ) {
-		if ( error ) {
-			t.pass( error.message );
-			t.strictEqual( error.code, 1, 'expected exit code' );
-		}
-		t.strictEqual( stdout.toString(), '', 'does not print to `stdout`' );
-		t.strictEqual( stderr.toString(), 'Error: beep\n', 'expected value' );
-		t.end();
-	}
-});