@zkochan/cmd-shim

WebJar for @zkochan/cmd-shim

License	BSD-2-Clause
GroupId	org.webjars.npm
ArtifactId	zkochan__cmd-shim
Last Version	3.1.0
Release Date	Apr 5, 2021
Type	jar
Description	@zkochan/cmd-shim WebJar for @zkochan/cmd-shim
Project URL	https://www.webjars.org
Source Code Management	https://github.com/pnpm/cmd-shim

Download zkochan__cmd-shim

Filename	Size
zkochan__cmd-shim-3.1.0.pom
zkochan__cmd-shim-3.1.0.jar	7 KB
zkochan__cmd-shim-3.1.0-sources.jar	22 bytes
zkochan__cmd-shim-3.1.0-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/zkochan__cmd-shim/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>zkochan__cmd-shim</artifactId>
    <version>3.1.0</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/zkochan__cmd-shim/
implementation 'org.webjars.npm:zkochan__cmd-shim:3.1.0'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/zkochan__cmd-shim/
implementation ("org.webjars.npm:zkochan__cmd-shim:3.1.0")

Apache Buildr

'org.webjars.npm:zkochan__cmd-shim:jar:3.1.0'

Apache Ivy

<dependency org="org.webjars.npm" name="zkochan__cmd-shim" rev="3.1.0">
  <artifact name="zkochan__cmd-shim" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='zkochan__cmd-shim', version='3.1.0')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "zkochan__cmd-shim" % "3.1.0"

Leiningen

[org.webjars.npm/zkochan__cmd-shim "3.1.0"]

Dependencies

compile (3)

Group / Artifact	Type	Version
org.webjars.npm : is-windows	jar	[1.0.0,2)
org.webjars.npm : mkdirp-promise	jar	[5.0.1,6)
org.webjars.npm : mz	jar	[2.5.0,3)

Project Modules

There are no modules declared in this project.

@zkochan/cmd-shim

Used in pnpm for command line application support

The cmd-shim used in pnpm to create executable scripts.

Installation

npm install --save @zkochan/cmd-shim

API

cmdShim(src, to, opts?): Promise<void>

Create a cmd shim at to for the command line program at from. e.g.

const cmdShim = require('@zkochan/cmd-shim')
cmdShim(__dirname + '/cli.js', '/usr/bin/command-name')
  .catch(err => console.error(err))

cmdShim.ifExists(src, to, opts?): Promise<void>

The same as above, but will just continue if the file does not exist.

Arguments:

• opts.preserveSymlinks - Boolean - if true, --preserve-symlinks is added to the options passed to NodeJS.
• opts.nodePath - String - sets the NODE_PATH env variable.
• opts.createCmdFile - Boolean - is true on Windows by default. If true, creates a cmd file.
• opts.createPwshFile - Boolean - is true by default. If true, creates a powershell file.
• opts.progArgs - String - optional arguments that will be prepend to any CLI arguments

const cmdShim = require('@zkochan/cmd-shim')
cmdShim(__dirname + '/cli.js', '/usr/bin/command-name', { preserveSymlinks: true })
  .catch(err => console.error(err))

License

BSD-2-Clause © Zoltan Kochan

pnpm

Fast, disk space efficient package manager

Versions

Version
3.1.0 Apr 5, 2021