@stdlib/process-cwd-cli - npm Package Compare versions

Comparing version 0.1.1 to 0.2.0

NOTICE

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

package.json

 {
   "name": "@stdlib/process-cwd-cli",
-  "version": "0.1.1",
+  "version": "0.2.0",
   "description": "Return the current working directory.",
@@ -29,9 +29,9 @@ "license": "Apache-2.0",
     "@stdlib/cli-ctor": "^0.1.1",
-    "@stdlib/fs-read-file": "^0.1.1",
-    "@stdlib/process-cwd": "0.1.1"
+    "@stdlib/fs-read-file": "^0.2.0",
+    "@stdlib/process-cwd": "0.2.0"
   },
   "devDependencies": {
-    "@stdlib/assert-is-browser": "^0.1.0",
-    "@stdlib/assert-is-windows": "^0.1.0",
-    "@stdlib/process-exec-path": "^0.1.0",
+    "@stdlib/assert-is-browser": "^0.1.1",
+    "@stdlib/assert-is-windows": "^0.1.1",
+    "@stdlib/process-exec-path": "^0.1.1",
     "tape": "git+https://github.com/kgryte/tape.git#fix/globby",
@@ -38,0 +38,0 @@ "istanbul": "^0.4.1",

README.md

@@ -139,3 +139,3 @@ <!--
 
-Copyright &copy; 2016-2023. The Stdlib [Authors][stdlib-authors].
+Copyright &copy; 2016-2024. The Stdlib [Authors][stdlib-authors].
 
@@ -153,4 +153,4 @@ </section>
 
-[test-image]: https://github.com/stdlib-js/process-cwd/actions/workflows/test.yml/badge.svg?branch=v0.1.1
-[test-url]: https://github.com/stdlib-js/process-cwd/actions/workflows/test.yml?query=branch:v0.1.1
+[test-image]: https://github.com/stdlib-js/process-cwd/actions/workflows/test.yml/badge.svg?branch=v0.2.0
+[test-url]: https://github.com/stdlib-js/process-cwd/actions/workflows/test.yml?query=branch:v0.2.0
 
@@ -182,4 +182,7 @@ [coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/process-cwd/main.svg
 [deno-url]: https://github.com/stdlib-js/process-cwd/tree/deno
+[deno-readme]: https://github.com/stdlib-js/process-cwd/blob/deno/README.md
 [umd-url]: https://github.com/stdlib-js/process-cwd/tree/umd
+[umd-readme]: https://github.com/stdlib-js/process-cwd/blob/umd/README.md
 [esm-url]: https://github.com/stdlib-js/process-cwd/tree/esm
+[esm-readme]: https://github.com/stdlib-js/process-cwd/blob/esm/README.md
 [branches-url]: https://github.com/stdlib-js/process-cwd/blob/main/branches.md
@@ -186,0 +189,0 @@

.github/workflows/publish_cli.yml

-#/
-# @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'
-        # Pin action to full length commit SHA corresponding to v4.1.0
-        uses: actions/checkout@8ade135a41bc03ea155e62e844d188df1ea18608
-        with:
-          ref: cli
-
-      # Install Node.js:
-      - name: 'Install Node.js'
-        # Pin action to full length commit SHA corresponding to v3.8.1
-        uses: actions/setup-node@5e21ff4d9bc1a8cf6de233a3057d20ec6b3fb69d
-        with:
-          node-version: 16
-        timeout-minutes: 5
-
-      # Configure git:
-      - name: 'Configure git'
-        run: |
-          git config --local user.email "[e-mail]"
-          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:$[e-mail]/$SLUG.git" --follow-tags
-
-      # Replace GitHub MathJax equations with SVGs:
-      - name: 'Replace GitHub MathJax equations with SVGs'
-        run: |
-          find . -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe 's/```math\n([\s\S]+?)\n```\n\n//g'
-          find . -type f -name '*.md' -print0 | xargs -0 perl -0777 -i -pe 's/<!-- <div class="equation"(.*)(<\/div>\s*-->)/<div class="equation"$1<\/div>/sg'
-
-      # 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'
-        # Pin action to full length commit SHA corresponding to v2.2.2
-        uses: JS-DevTools/npm-publish@fe72237be0920f7a0cafd6a966c9b929c9466e9b
-        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'
-        # Pin action to full length commit SHA corresponding to v2.0.0
-        uses: act10ns/slack@ed1309ab9862e57e9e583e51c7889486b9a00b0f
-        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'
-        # Pin action to full length commit SHA corresponding to v0.11.0
-        uses: styfle/cancel-workflow-action@b173b6ec0100793626c2d9e6b90435061f4fc3e5
-        with:
-          workflow_id: >-
-            benchmark.yml,
-            examples.yml,
-            test.yml,
-            test_coverage.yml,
-            test_install.yml,
-            publish.yml
-          access_token: ${{ github.token }}

CONTRIBUTORS

-# This file is generated by tools/scripts/update_contributors.
-#
-# Contributors listed in alphabetical order.
-
-Ali Salesi <[e-mail]>
-Amit Jimiwal <[e-mail]>
-Athan Reines <[e-mail]>
-Brendan Graetz <[e-mail]>
-Bruno Fenzl <[e-mail]>
-Christopher Dambamuromo <[e-mail]>
-Dan Rose <[e-mail]>
-Dominik Moritz <[e-mail]>
-Dorrin Sotoudeh <[e-mail]>
-Frank Kovacs <[e-mail]>
-Harshita Kalani <[e-mail]>
-James Gelok <[e-mail]>
-Jithin KS <[e-mail]>
-Joey Reed <[e-mail]>
-Jordan Gallivan <[e-mail]>
-Joris Labie <[e-mail]>
-Justin Dennison <[e-mail]>
-Marcus Fantham <[e-mail]>
-Matt Cochrane <[e-mail]>
-Milan Raj <[e-mail]>
-Momtchil Momtchev <[e-mail]>
-Naresh Jagadeesan <[e-mail]>
-Nithin Katta <[e-mail]>
-Ognjen Jevremović <[e-mail]>
-Philipp Burckhardt <[e-mail]>
-Pranav Goswami <[e-mail]>
-Ricky Reusser <[e-mail]>
-Roman Stetsyk <[e-mail]>
-Ryan Seal <[e-mail]>
-Seyyed Parsa Neshaei <[e-mail]>
-Shraddheya Shendre <[e-mail]>
-Stephannie Jiménez Gacha <[e-mail]>
-Yernar Yergaziyev <[e-mail]>
-orimiles5 <[e-mail]>
-rei2hu <[e-mail]>

test/test.cli.js

-/**
-* @license Apache-2.0
-*
-* Copyright (c) 2018 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 proc = require( 'process' );
-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 readFileSync = require( '@stdlib/fs-read-file' ).sync;
-var EXEC_PATH = require( '@stdlib/process-exec-path' );
-
-
-// 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 prints the current working directory', opts, function test( t ) {
-	var cmd = [
-		EXEC_PATH,
-		fpath
-	];
-
-	exec( cmd.join( ' ' ), done );
-
-	function done( error, stdout, stderr ) {
-		var str;
-		if ( error ) {
-			t.fail( error.message );
-		} else {
-			str = stdout.toString();
-			t.strictEqual( str, proc.cwd()+'\n', 'prints path to `stdout`' );
-			t.strictEqual( stderr.toString(), '', 'does not print to `stderr`' );
-		}
-		t.end();
-	}
-});

Fixed alerts

Shell access

Supply chain risk

This module accesses the system shell. Accessing the system shell increases the risk of executing arbitrary code.

Found 1 instance in 1 package

Improved metrics

Number of lines in readme file

198

1.54%

Number of medium supply chain risk alerts

0

-100%

Worsened metrics

Total package byte prevSize

19343

-37.04%

Number of package files

7

-30%

Lines of code

14

-90.6%

Dependency changes

• + Added

  @stdlib/error-tools-fmtprodmsg@0.2.3
  (transitive)

• + Added

  @stdlib/fs-read-file@0.2.3
  (transitive)

• + Added

  @stdlib/process-cwd@0.2.0
  (transitive)

• + Added

  @stdlib/string-base-format-interpolate@0.2.4
  (transitive)

• + Added

  @stdlib/string-base-format-tokenize@0.2.4
  (transitive)

• + Added

  @stdlib/string-format@0.2.3
  (transitive)

• + Added

  @stdlib/types@0.4.3
  (transitive)

• + Added

  @stdlib/utils-define-nonenumerable-read-only-property@0.2.3
  (transitive)

• + Added

  @stdlib/utils-define-property@0.2.5
  (transitive)

• - Removed

  @stdlib/fs-read-file@0.1.1
  (transitive)

• - Removed

  @stdlib/process-cwd@0.1.1
  (transitive)

• Updated

  @stdlib/fs-read-file@^0.2.0

• Updated

  @stdlib/process-cwd@0.2.0