first commit
francesco
4 years ago
commit
ef5c7f3bf3
@ -0,0 +1,22 @@
|
||||
# Read Me First
|
||||
The following was discovered as part of building this project:
|
||||
|
||||
* The original package name 'org.gcube.app.springbootangular-demo' is invalid and this project uses 'org.gcube.app.springbootangulardemo' instead.
|
||||
|
||||
# Getting Started
|
||||
|
||||
### Reference Documentation
|
||||
For further reference, please consider the following sections:
|
||||
|
||||
* [Official Apache Maven documentation](https://maven.apache.org/guides/index.html)
|
||||
* [Spring Boot Maven Plugin Reference Guide](https://docs.spring.io/spring-boot/docs/2.2.5.RELEASE/maven-plugin/)
|
||||
* [Spring Web](https://docs.spring.io/spring-boot/docs/2.2.5.RELEASE/reference/htmlsingle/#boot-features-developing-web-applications)
|
||||
* [Spring Boot DevTools](https://docs.spring.io/spring-boot/docs/2.2.5.RELEASE/reference/htmlsingle/#using-boot-devtools)
|
||||
|
||||
### Guides
|
||||
The following guides illustrate how to use some features concretely:
|
||||
|
||||
* [Building a RESTful Web Service](https://spring.io/guides/gs/rest-service/)
|
||||
* [Serving Web Content with Spring MVC](https://spring.io/guides/gs/serving-web-content/)
|
||||
* [Building REST services with Spring](https://spring.io/guides/tutorials/bookmarks/)
|
||||
|
||||
@ -0,0 +1,310 @@
|
||||
#!/bin/sh
|
||||
# ----------------------------------------------------------------------------
|
||||
# Licensed to the Apache Software Foundation (ASF) under one
|
||||
# or more contributor license agreements. See the NOTICE file
|
||||
# distributed with this work for additional information
|
||||
# regarding copyright ownership. The ASF licenses this file
|
||||
# to you 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
|
||||
#
|
||||
# https://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.
|
||||
# ----------------------------------------------------------------------------
|
||||
|
||||
# ----------------------------------------------------------------------------
|
||||
# Maven Start Up Batch script
|
||||
#
|
||||
# Required ENV vars:
|
||||
# ------------------
|
||||
# JAVA_HOME - location of a JDK home dir
|
||||
#
|
||||
# Optional ENV vars
|
||||
# -----------------
|
||||
# M2_HOME - location of maven2's installed home dir
|
||||
# MAVEN_OPTS - parameters passed to the Java VM when running Maven
|
||||
# e.g. to debug Maven itself, use
|
||||
# set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000
|
||||
# MAVEN_SKIP_RC - flag to disable loading of mavenrc files
|
||||
# ----------------------------------------------------------------------------
|
||||
|
||||
if [ -z "$MAVEN_SKIP_RC" ] ; then
|
||||
|
||||
if [ -f /etc/mavenrc ] ; then
|
||||
. /etc/mavenrc
|
||||
fi
|
||||
|
||||
if [ -f "$HOME/.mavenrc" ] ; then
|
||||
. "$HOME/.mavenrc"
|
||||
fi
|
||||
|
||||
fi
|
||||
|
||||
# OS specific support. $var _must_ be set to either true or false.
|
||||
cygwin=false;
|
||||
darwin=false;
|
||||
mingw=false
|
||||
case "`uname`" in
|
||||
CYGWIN*) cygwin=true ;;
|
||||
MINGW*) mingw=true;;
|
||||
Darwin*) darwin=true
|
||||
# Use /usr/libexec/java_home if available, otherwise fall back to /Library/Java/Home
|
||||
# See https://developer.apple.com/library/mac/qa/qa1170/_index.html
|
||||
if [ -z "$JAVA_HOME" ]; then
|
||||
if [ -x "/usr/libexec/java_home" ]; then
|
||||
export JAVA_HOME="`/usr/libexec/java_home`"
|
||||
else
|
||||
export JAVA_HOME="/Library/Java/Home"
|
||||
fi
|
||||
fi
|
||||
;;
|
||||
esac
|
||||
|
||||
if [ -z "$JAVA_HOME" ] ; then
|
||||
if [ -r /etc/gentoo-release ] ; then
|
||||
JAVA_HOME=`java-config --jre-home`
|
||||
fi
|
||||
fi
|
||||
|
||||
if [ -z "$M2_HOME" ] ; then
|
||||
## resolve links - $0 may be a link to maven's home
|
||||
PRG="$0"
|
||||
|
||||
# need this for relative symlinks
|
||||
while [ -h "$PRG" ] ; do
|
||||
ls=`ls -ld "$PRG"`
|
||||
link=`expr "$ls" : '.*-> \(.*\)$'`
|
||||
if expr "$link" : '/.*' > /dev/null; then
|
||||
PRG="$link"
|
||||
else
|
||||
PRG="`dirname "$PRG"`/$link"
|
||||
fi
|
||||
done
|
||||
|
||||
saveddir=`pwd`
|
||||
|
||||
M2_HOME=`dirname "$PRG"`/..
|
||||
|
||||
# make it fully qualified
|
||||
M2_HOME=`cd "$M2_HOME" && pwd`
|
||||
|
||||
cd "$saveddir"
|
||||
# echo Using m2 at $M2_HOME
|
||||
fi
|
||||
|
||||
# For Cygwin, ensure paths are in UNIX format before anything is touched
|
||||
if $cygwin ; then
|
||||
[ -n "$M2_HOME" ] &&
|
||||
M2_HOME=`cygpath --unix "$M2_HOME"`
|
||||
[ -n "$JAVA_HOME" ] &&
|
||||
JAVA_HOME=`cygpath --unix "$JAVA_HOME"`
|
||||
[ -n "$CLASSPATH" ] &&
|
||||
CLASSPATH=`cygpath --path --unix "$CLASSPATH"`
|
||||
fi
|
||||
|
||||
# For Mingw, ensure paths are in UNIX format before anything is touched
|
||||
if $mingw ; then
|
||||
[ -n "$M2_HOME" ] &&
|
||||
M2_HOME="`(cd "$M2_HOME"; pwd)`"
|
||||
[ -n "$JAVA_HOME" ] &&
|
||||
JAVA_HOME="`(cd "$JAVA_HOME"; pwd)`"
|
||||
fi
|
||||
|
||||
if [ -z "$JAVA_HOME" ]; then
|
||||
javaExecutable="`which javac`"
|
||||
if [ -n "$javaExecutable" ] && ! [ "`expr \"$javaExecutable\" : '\([^ ]*\)'`" = "no" ]; then
|
||||
# readlink(1) is not available as standard on Solaris 10.
|
||||
readLink=`which readlink`
|
||||
if [ ! `expr "$readLink" : '\([^ ]*\)'` = "no" ]; then
|
||||
if $darwin ; then
|
||||
javaHome="`dirname \"$javaExecutable\"`"
|
||||
javaExecutable="`cd \"$javaHome\" && pwd -P`/javac"
|
||||
else
|
||||
javaExecutable="`readlink -f \"$javaExecutable\"`"
|
||||
fi
|
||||
javaHome="`dirname \"$javaExecutable\"`"
|
||||
javaHome=`expr "$javaHome" : '\(.*\)/bin'`
|
||||
JAVA_HOME="$javaHome"
|
||||
export JAVA_HOME
|
||||
fi
|
||||
fi
|
||||
fi
|
||||
|
||||
if [ -z "$JAVACMD" ] ; then
|
||||
if [ -n "$JAVA_HOME" ] ; then
|
||||
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
|
||||
# IBM's JDK on AIX uses strange locations for the executables
|
||||
JAVACMD="$JAVA_HOME/jre/sh/java"
|
||||
else
|
||||
JAVACMD="$JAVA_HOME/bin/java"
|
||||
fi
|
||||
else
|
||||
JAVACMD="`which java`"
|
||||
fi
|
||||
fi
|
||||
|
||||
if [ ! -x "$JAVACMD" ] ; then
|
||||
echo "Error: JAVA_HOME is not defined correctly." >&2
|
||||
echo " We cannot execute $JAVACMD" >&2
|
||||
exit 1
|
||||
fi
|
||||
|
||||
if [ -z "$JAVA_HOME" ] ; then
|
||||
echo "Warning: JAVA_HOME environment variable is not set."
|
||||
fi
|
||||
|
||||
CLASSWORLDS_LAUNCHER=org.codehaus.plexus.classworlds.launcher.Launcher
|
||||
|
||||
# traverses directory structure from process work directory to filesystem root
|
||||
# first directory with .mvn subdirectory is considered project base directory
|
||||
find_maven_basedir() {
|
||||
|
||||
if [ -z "$1" ]
|
||||
then
|
||||
echo "Path not specified to find_maven_basedir"
|
||||
return 1
|
||||
fi
|
||||
|
||||
basedir="$1"
|
||||
wdir="$1"
|
||||
while [ "$wdir" != '/' ] ; do
|
||||
if [ -d "$wdir"/.mvn ] ; then
|
||||
basedir=$wdir
|
||||
break
|
||||
fi
|
||||
# workaround for JBEAP-8937 (on Solaris 10/Sparc)
|
||||
if [ -d "${wdir}" ]; then
|
||||
wdir=`cd "$wdir/.."; pwd`
|
||||
fi
|
||||
# end of workaround
|
||||
done
|
||||
echo "${basedir}"
|
||||
}
|
||||
|
||||
# concatenates all lines of a file
|
||||
concat_lines() {
|
||||
if [ -f "$1" ]; then
|
||||
echo "$(tr -s '\n' ' ' < "$1")"
|
||||
fi
|
||||
}
|
||||
|
||||
BASE_DIR=`find_maven_basedir "$(pwd)"`
|
||||
if [ -z "$BASE_DIR" ]; then
|
||||
exit 1;
|
||||
fi
|
||||
|
||||
##########################################################################################
|
||||
# Extension to allow automatically downloading the maven-wrapper.jar from Maven-central
|
||||
# This allows using the maven wrapper in projects that prohibit checking in binary data.
|
||||
##########################################################################################
|
||||
if [ -r "$BASE_DIR/.mvn/wrapper/maven-wrapper.jar" ]; then
|
||||
if [ "$MVNW_VERBOSE" = true ]; then
|
||||
echo "Found .mvn/wrapper/maven-wrapper.jar"
|
||||
fi
|
||||
else
|
||||
if [ "$MVNW_VERBOSE" = true ]; then
|
||||
echo "Couldn't find .mvn/wrapper/maven-wrapper.jar, downloading it ..."
|
||||
fi
|
||||
if [ -n "$MVNW_REPOURL" ]; then
|
||||
jarUrl="$MVNW_REPOURL/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar"
|
||||
else
|
||||
jarUrl="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar"
|
||||
fi
|
||||
while IFS="=" read key value; do
|
||||
case "$key" in (wrapperUrl) jarUrl="$value"; break ;;
|
||||
esac
|
||||
done < "$BASE_DIR/.mvn/wrapper/maven-wrapper.properties"
|
||||
if [ "$MVNW_VERBOSE" = true ]; then
|
||||
echo "Downloading from: $jarUrl"
|
||||
fi
|
||||
wrapperJarPath="$BASE_DIR/.mvn/wrapper/maven-wrapper.jar"
|
||||
if $cygwin; then
|
||||
wrapperJarPath=`cygpath --path --windows "$wrapperJarPath"`
|
||||
fi
|
||||
|
||||
if command -v wget > /dev/null; then
|
||||
if [ "$MVNW_VERBOSE" = true ]; then
|
||||
echo "Found wget ... using wget"
|
||||
fi
|
||||
if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then
|
||||
wget "$jarUrl" -O "$wrapperJarPath"
|
||||
else
|
||||
wget --http-user=$MVNW_USERNAME --http-password=$MVNW_PASSWORD "$jarUrl" -O "$wrapperJarPath"
|
||||
fi
|
||||
elif command -v curl > /dev/null; then
|
||||
if [ "$MVNW_VERBOSE" = true ]; then
|
||||
echo "Found curl ... using curl"
|
||||
fi
|
||||
if [ -z "$MVNW_USERNAME" ] || [ -z "$MVNW_PASSWORD" ]; then
|
||||
curl -o "$wrapperJarPath" "$jarUrl" -f
|
||||
else
|
||||
curl --user $MVNW_USERNAME:$MVNW_PASSWORD -o "$wrapperJarPath" "$jarUrl" -f
|
||||
fi
|
||||
|
||||
else
|
||||
if [ "$MVNW_VERBOSE" = true ]; then
|
||||
echo "Falling back to using Java to download"
|
||||
fi
|
||||
javaClass="$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.java"
|
||||
# For Cygwin, switch paths to Windows format before running javac
|
||||
if $cygwin; then
|
||||
javaClass=`cygpath --path --windows "$javaClass"`
|
||||
fi
|
||||
if [ -e "$javaClass" ]; then
|
||||
if [ ! -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then
|
||||
if [ "$MVNW_VERBOSE" = true ]; then
|
||||
echo " - Compiling MavenWrapperDownloader.java ..."
|
||||
fi
|
||||
# Compiling the Java class
|
||||
("$JAVA_HOME/bin/javac" "$javaClass")
|
||||
fi
|
||||
if [ -e "$BASE_DIR/.mvn/wrapper/MavenWrapperDownloader.class" ]; then
|
||||
# Running the downloader
|
||||
if [ "$MVNW_VERBOSE" = true ]; then
|
||||
echo " - Running MavenWrapperDownloader.java ..."
|
||||
fi
|
||||
("$JAVA_HOME/bin/java" -cp .mvn/wrapper MavenWrapperDownloader "$MAVEN_PROJECTBASEDIR")
|
||||
fi
|
||||
fi
|
||||
fi
|
||||
fi
|
||||
##########################################################################################
|
||||
# End of extension
|
||||
##########################################################################################
|
||||
|
||||
export MAVEN_PROJECTBASEDIR=${MAVEN_BASEDIR:-"$BASE_DIR"}
|
||||
if [ "$MVNW_VERBOSE" = true ]; then
|
||||
echo $MAVEN_PROJECTBASEDIR
|
||||
fi
|
||||
MAVEN_OPTS="$(concat_lines "$MAVEN_PROJECTBASEDIR/.mvn/jvm.config") $MAVEN_OPTS"
|
||||
|
||||
# For Cygwin, switch paths to Windows format before running java
|
||||
if $cygwin; then
|
||||
[ -n "$M2_HOME" ] &&
|
||||
M2_HOME=`cygpath --path --windows "$M2_HOME"`
|
||||
[ -n "$JAVA_HOME" ] &&
|
||||
JAVA_HOME=`cygpath --path --windows "$JAVA_HOME"`
|
||||
[ -n "$CLASSPATH" ] &&
|
||||
CLASSPATH=`cygpath --path --windows "$CLASSPATH"`
|
||||
[ -n "$MAVEN_PROJECTBASEDIR" ] &&
|
||||
MAVEN_PROJECTBASEDIR=`cygpath --path --windows "$MAVEN_PROJECTBASEDIR"`
|
||||
fi
|
||||
|
||||
# Provide a "standardized" way to retrieve the CLI args that will
|
||||
# work with both Windows and non-Windows executions.
|
||||
MAVEN_CMD_LINE_ARGS="$MAVEN_CONFIG $@"
|
||||
export MAVEN_CMD_LINE_ARGS
|
||||
|
||||
WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain
|
||||
|
||||
exec "$JAVACMD" \
|
||||
$MAVEN_OPTS \
|
||||
-classpath "$MAVEN_PROJECTBASEDIR/.mvn/wrapper/maven-wrapper.jar" \
|
||||
"-Dmaven.home=${M2_HOME}" "-Dmaven.multiModuleProjectDirectory=${MAVEN_PROJECTBASEDIR}" \
|
||||
${WRAPPER_LAUNCHER} $MAVEN_CONFIG "$@"
|
||||
@ -0,0 +1,182 @@
|
||||
@REM ----------------------------------------------------------------------------
|
||||
@REM Licensed to the Apache Software Foundation (ASF) under one
|
||||
@REM or more contributor license agreements. See the NOTICE file
|
||||
@REM distributed with this work for additional information
|
||||
@REM regarding copyright ownership. The ASF licenses this file
|
||||
@REM to you under the Apache License, Version 2.0 (the
|
||||
@REM "License"); you may not use this file except in compliance
|
||||
@REM with the License. You may obtain a copy of the License at
|
||||
@REM
|
||||
@REM https://www.apache.org/licenses/LICENSE-2.0
|
||||
@REM
|
||||
@REM Unless required by applicable law or agreed to in writing,
|
||||
@REM software distributed under the License is distributed on an
|
||||
@REM "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
|
||||
@REM KIND, either express or implied. See the License for the
|
||||
@REM specific language governing permissions and limitations
|
||||
@REM under the License.
|
||||
@REM ----------------------------------------------------------------------------
|
||||
|
||||
@REM ----------------------------------------------------------------------------
|
||||
@REM Maven Start Up Batch script
|
||||
@REM
|
||||
@REM Required ENV vars:
|
||||
@REM JAVA_HOME - location of a JDK home dir
|
||||
@REM
|
||||
@REM Optional ENV vars
|
||||
@REM M2_HOME - location of maven2's installed home dir
|
||||
@REM MAVEN_BATCH_ECHO - set to 'on' to enable the echoing of the batch commands
|
||||
@REM MAVEN_BATCH_PAUSE - set to 'on' to wait for a keystroke before ending
|
||||
@REM MAVEN_OPTS - parameters passed to the Java VM when running Maven
|
||||
@REM e.g. to debug Maven itself, use
|
||||
@REM set MAVEN_OPTS=-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=y,address=8000
|
||||
@REM MAVEN_SKIP_RC - flag to disable loading of mavenrc files
|
||||
@REM ----------------------------------------------------------------------------
|
||||
|
||||
@REM Begin all REM lines with '@' in case MAVEN_BATCH_ECHO is 'on'
|
||||
@echo off
|
||||
@REM set title of command window
|
||||
title %0
|
||||
@REM enable echoing by setting MAVEN_BATCH_ECHO to 'on'
|
||||
@if "%MAVEN_BATCH_ECHO%" == "on" echo %MAVEN_BATCH_ECHO%
|
||||
|
||||
@REM set %HOME% to equivalent of $HOME
|
||||
if "%HOME%" == "" (set "HOME=%HOMEDRIVE%%HOMEPATH%")
|
||||
|
||||
@REM Execute a user defined script before this one
|
||||
if not "%MAVEN_SKIP_RC%" == "" goto skipRcPre
|
||||
@REM check for pre script, once with legacy .bat ending and once with .cmd ending
|
||||
if exist "%HOME%\mavenrc_pre.bat" call "%HOME%\mavenrc_pre.bat"
|
||||
if exist "%HOME%\mavenrc_pre.cmd" call "%HOME%\mavenrc_pre.cmd"
|
||||
:skipRcPre
|
||||
|
||||
@setlocal
|
||||
|
||||
set ERROR_CODE=0
|
||||
|
||||
@REM To isolate internal variables from possible post scripts, we use another setlocal
|
||||
@setlocal
|
||||
|
||||
@REM ==== START VALIDATION ====
|
||||
if not "%JAVA_HOME%" == "" goto OkJHome
|
||||
|
||||
echo.
|
||||
echo Error: JAVA_HOME not found in your environment. >&2
|
||||
echo Please set the JAVA_HOME variable in your environment to match the >&2
|
||||
echo location of your Java installation. >&2
|
||||
echo.
|
||||
goto error
|
||||
|
||||
:OkJHome
|
||||
if exist "%JAVA_HOME%\bin\java.exe" goto init
|
||||
|
||||
echo.
|
||||
echo Error: JAVA_HOME is set to an invalid directory. >&2
|
||||
echo JAVA_HOME = "%JAVA_HOME%" >&2
|
||||
echo Please set the JAVA_HOME variable in your environment to match the >&2
|
||||
echo location of your Java installation. >&2
|
||||
echo.
|
||||
goto error
|
||||
|
||||
@REM ==== END VALIDATION ====
|
||||
|
||||
:init
|
||||
|
||||
@REM Find the project base dir, i.e. the directory that contains the folder ".mvn".
|
||||
@REM Fallback to current working directory if not found.
|
||||
|
||||
set MAVEN_PROJECTBASEDIR=%MAVEN_BASEDIR%
|
||||
IF NOT "%MAVEN_PROJECTBASEDIR%"=="" goto endDetectBaseDir
|
||||
|
||||
set EXEC_DIR=%CD%
|
||||
set WDIR=%EXEC_DIR%
|
||||
:findBaseDir
|
||||
IF EXIST "%WDIR%"\.mvn goto baseDirFound
|
||||
cd ..
|
||||
IF "%WDIR%"=="%CD%" goto baseDirNotFound
|
||||
set WDIR=%CD%
|
||||
goto findBaseDir
|
||||
|
||||
:baseDirFound
|
||||
set MAVEN_PROJECTBASEDIR=%WDIR%
|
||||
cd "%EXEC_DIR%"
|
||||
goto endDetectBaseDir
|
||||
|
||||
:baseDirNotFound
|
||||
set MAVEN_PROJECTBASEDIR=%EXEC_DIR%
|
||||
cd "%EXEC_DIR%"
|
||||
|
||||
:endDetectBaseDir
|
||||
|
||||
IF NOT EXIST "%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config" goto endReadAdditionalConfig
|
||||
|
||||
@setlocal EnableExtensions EnableDelayedExpansion
|
||||
for /F "usebackq delims=" %%a in ("%MAVEN_PROJECTBASEDIR%\.mvn\jvm.config") do set JVM_CONFIG_MAVEN_PROPS=!JVM_CONFIG_MAVEN_PROPS! %%a
|
||||
@endlocal & set JVM_CONFIG_MAVEN_PROPS=%JVM_CONFIG_MAVEN_PROPS%
|
||||
|
||||
:endReadAdditionalConfig
|
||||
|
||||
SET MAVEN_JAVA_EXE="%JAVA_HOME%\bin\java.exe"
|
||||
set WRAPPER_JAR="%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.jar"
|
||||
set WRAPPER_LAUNCHER=org.apache.maven.wrapper.MavenWrapperMain
|
||||
|
||||
set DOWNLOAD_URL="https://repo.maven.apache.org/maven2/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar"
|
||||
|
||||
FOR /F "tokens=1,2 delims==" %%A IN ("%MAVEN_PROJECTBASEDIR%\.mvn\wrapper\maven-wrapper.properties") DO (
|
||||
IF "%%A"=="wrapperUrl" SET DOWNLOAD_URL=%%B
|
||||
)
|
||||
|
||||
@REM Extension to allow automatically downloading the maven-wrapper.jar from Maven-central
|
||||
@REM This allows using the maven wrapper in projects that prohibit checking in binary data.
|
||||
if exist %WRAPPER_JAR% (
|
||||
if "%MVNW_VERBOSE%" == "true" (
|
||||
echo Found %WRAPPER_JAR%
|
||||
)
|
||||
) else (
|
||||
if not "%MVNW_REPOURL%" == "" (
|
||||
SET DOWNLOAD_URL="%MVNW_REPOURL%/io/takari/maven-wrapper/0.5.6/maven-wrapper-0.5.6.jar"
|
||||
)
|
||||
if "%MVNW_VERBOSE%" == "true" (
|
||||
echo Couldn't find %WRAPPER_JAR%, downloading it ...
|
||||
echo Downloading from: %DOWNLOAD_URL%
|
||||
)
|
||||
|
||||
powershell -Command "&{"^
|
||||
"$webclient = new-object System.Net.WebClient;"^
|
||||
"if (-not ([string]::IsNullOrEmpty('%MVNW_USERNAME%') -and [string]::IsNullOrEmpty('%MVNW_PASSWORD%'))) {"^
|
||||
"$webclient.Credentials = new-object System.Net.NetworkCredential('%MVNW_USERNAME%', '%MVNW_PASSWORD%');"^
|
||||
"}"^
|
||||
"[Net.ServicePointManager]::SecurityProtocol = [Net.SecurityProtocolType]::Tls12; $webclient.DownloadFile('%DOWNLOAD_URL%', '%WRAPPER_JAR%')"^
|
||||
"}"
|
||||
if "%MVNW_VERBOSE%" == "true" (
|
||||
echo Finished downloading %WRAPPER_JAR%
|
||||
)
|
||||
)
|
||||
@REM End of extension
|
||||
|
||||
@REM Provide a "standardized" way to retrieve the CLI args that will
|
||||
@REM work with both Windows and non-Windows executions.
|
||||
set MAVEN_CMD_LINE_ARGS=%*
|
||||
|
||||
%MAVEN_JAVA_EXE% %JVM_CONFIG_MAVEN_PROPS% %MAVEN_OPTS% %MAVEN_DEBUG_OPTS% -classpath %WRAPPER_JAR% "-Dmaven.multiModuleProjectDirectory=%MAVEN_PROJECTBASEDIR%" %WRAPPER_LAUNCHER% %MAVEN_CONFIG% %*
|
||||
if ERRORLEVEL 1 goto error
|
||||
goto end
|
||||
|
||||
:error
|
||||
set ERROR_CODE=1
|
||||
|
||||
:end
|
||||
@endlocal & set ERROR_CODE=%ERROR_CODE%
|
||||
|
||||
if not "%MAVEN_SKIP_RC%" == "" goto skipRcPost
|
||||
@REM check for post script, once with legacy .bat ending and once with .cmd ending
|
||||
if exist "%HOME%\mavenrc_post.bat" call "%HOME%\mavenrc_post.bat"
|
||||
if exist "%HOME%\mavenrc_post.cmd" call "%HOME%\mavenrc_post.cmd"
|
||||
:skipRcPost
|
||||
|
||||
@REM pause the script if MAVEN_BATCH_PAUSE is set to 'on'
|
||||
if "%MAVEN_BATCH_PAUSE%" == "on" pause
|
||||
|
||||
if "%MAVEN_TERMINATE_CMD%" == "on" exit %ERROR_CODE%
|
||||
|
||||
exit /B %ERROR_CODE%
|
||||
@ -0,0 +1,109 @@
|
||||
<?xml version="1.0" encoding="UTF-8" ?>
|
||||
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
|
||||
<modelVersion>4.0.0</modelVersion>
|
||||
<parent>
|
||||
<groupId>org.springframework.boot</groupId>
|
||||
<artifactId>spring-boot-starter-parent</artifactId>
|
||||
<version>2.2.5.RELEASE</version>
|
||||
<relativePath /> <!-- lookup parent from repository -->
|
||||
</parent>
|
||||
<groupId>org.gcube.app</groupId>
|
||||
<artifactId>springboot-angular-app-demo</artifactId>
|
||||
<version>0.0.1-SNAPSHOT</version>
|
||||
<name>springboot-angular-app-demo</name>
|
||||
<description>Demo project for Spring Boot</description>
|
||||
|
||||
<properties>
|
||||
<java.version>1.8</java.version>
|
||||
<angular.app.name>ng-app</angular.app.name>
|
||||
<node.version>v13.9.0</node.version>
|
||||
<npm.version>6.13.7</npm.version>
|
||||
<frontend-maven-plugin.version>1.9.1</frontend-maven-plugin.version>
|
||||
</properties>
|
||||
|
||||
<dependencies>
|
||||
<dependency>
|
||||
<groupId>org.springframework.boot</groupId>
|
||||
<artifactId>spring-boot-starter-web</artifactId>
|
||||
</dependency>
|
||||
|
||||
<!-- <dependency>
|
||||
<groupId>org.springframework.boot</groupId>
|
||||
<artifactId>spring-boot-starter-thymeleaf</artifactId>
|
||||
</dependency> -->
|
||||
|
||||
<dependency>
|
||||
<groupId>org.springframework.boot</groupId>
|
||||
<artifactId>spring-boot-devtools</artifactId>
|
||||
<scope>runtime</scope>
|
||||
<optional>true</optional>
|
||||
</dependency>
|
||||
<dependency>
|
||||
<groupId>org.springframework.boot</groupId>
|
||||
<artifactId>spring-boot-starter-test</artifactId>
|
||||
<scope>test</scope>
|
||||
<exclusions>
|
||||
<exclusion>
|
||||
<groupId>org.junit.vintage</groupId>
|
||||
<artifactId>junit-vintage-engine</artifactId>
|
||||
</exclusion>
|
||||
</exclusions>
|
||||
</dependency>
|
||||
</dependencies>
|
||||
|
||||
<build>
|
||||
<plugins>
|
||||
<plugin>
|
||||
<groupId>org.springframework.boot</groupId>
|
||||
<artifactId>spring-boot-maven-plugin</artifactId>
|
||||
</plugin>
|
||||
|
||||
<!--to build an Angular 9 project through Maven -->
|
||||
<plugin>
|
||||
<groupId>com.github.eirslett</groupId>
|
||||
<artifactId>frontend-maven-plugin</artifactId>
|
||||
<version>${frontend-maven-plugin.version}</version>
|
||||
<configuration>
|
||||
<nodeVersion>${node.version}</nodeVersion>
|
||||
<npmVersion>${npm.version}</npmVersion>
|
||||
<workingDirectory>${project.basedir}/src/main/${angular.app.name}</workingDirectory>
|
||||
</configuration>
|
||||
<executions>
|
||||
<execution>
|
||||
<id>install node and npm</id>
|
||||
<goals>
|
||||
<goal>install-node-and-npm</goal>
|
||||
</goals>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>npm install</id>
|
||||
<goals>
|
||||
<goal>npm</goal>
|
||||
</goals>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>npm run build</id>
|
||||
<goals>
|
||||
<goal>npm</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<arguments>run build</arguments>
|
||||
</configuration>
|
||||
</execution>
|
||||
<execution>
|
||||
<id>prod</id>
|
||||
<goals>
|
||||
<goal>npm</goal>
|
||||
</goals>
|
||||
<configuration>
|
||||
<arguments>run-script build</arguments>
|
||||
</configuration>
|
||||
<phase>generate-resources</phase>
|
||||
</execution>
|
||||
</executions>
|
||||
</plugin>
|
||||
|
||||
</plugins>
|
||||
</build>
|
||||
|
||||
</project>
|
||||
@ -0,0 +1,14 @@
|
||||
package org.gcube.app.springbootangulardemo;
|
||||
|
||||
import org.springframework.boot.SpringApplication;
|
||||
import org.springframework.boot.autoconfigure.SpringBootApplication;
|
||||
|
||||
@SpringBootApplication
|
||||
public class SpringbootAngularAppDemoApplication {
|
||||
|
||||
public static void main(String[] args) {
|
||||
SpringApplication.run(SpringbootAngularAppDemoApplication.class, args);
|
||||
System.out.println(SpringbootAngularAppDemoApplication.class.getSimpleName()+ " called");
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,20 @@
|
||||
package org.gcube.app.springbootangulardemo.controller;
|
||||
|
||||
import org.springframework.stereotype.Controller;
|
||||
import org.springframework.ui.Model;
|
||||
import org.springframework.web.bind.annotation.RequestMapping;
|
||||
import org.springframework.web.bind.annotation.RequestParam;
|
||||
|
||||
@Controller
|
||||
public class GreetingController {
|
||||
|
||||
//This return the templates/greeting.html
|
||||
@RequestMapping("/greeting")
|
||||
public String greeting(@RequestParam(name="name", required=false, defaultValue="World") final String name,
|
||||
final Model model) {
|
||||
|
||||
//This return the greeting.html
|
||||
model.addAttribute("name", name);
|
||||
return "greeting";
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,23 @@
|
||||
package org.gcube.app.springbootangulardemo.controller;
|
||||
|
||||
import java.util.concurrent.atomic.AtomicLong;
|
||||
|
||||
import org.gcube.app.springbootangulardemo.dto.Greeting;
|
||||
import org.springframework.web.bind.annotation.RequestMapping;
|
||||
import org.springframework.web.bind.annotation.RequestParam;
|
||||
import org.springframework.web.bind.annotation.RestController;
|
||||
|
||||
@RestController
|
||||
public class GreetingRestController {
|
||||
|
||||
String template = "Hello, %s!";
|
||||
AtomicLong counter = new AtomicLong();
|
||||
|
||||
//Return the class Greeting
|
||||
@RequestMapping("/greeting-obj")
|
||||
public Greeting greeting(@RequestParam(value = "name", defaultValue = "World") String name) {
|
||||
|
||||
return new Greeting(counter.incrementAndGet(), String.format(template, name));
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,13 @@
|
||||
package org.gcube.app.springbootangulardemo.controller;
|
||||
|
||||
import org.springframework.web.bind.annotation.RequestMapping;
|
||||
import org.springframework.web.bind.annotation.RestController;
|
||||
|
||||
@RestController
|
||||
public class HomeController {
|
||||
|
||||
@RequestMapping("/")
|
||||
public String home(){
|
||||
return "Hello, I'm the REST "+HomeController.class.getSimpleName();
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,43 @@
|
||||
package org.gcube.app.springbootangulardemo.dto;
|
||||
|
||||
import java.util.Objects;
|
||||
|
||||
|
||||
public class Greeting {
|
||||
|
||||
|
||||
private final long id;
|
||||
private final String content;
|
||||
|
||||
public Greeting(final long id, final String content) {
|
||||
this.id = id;
|
||||
this.content = content;
|
||||
}
|
||||
|
||||
public long getId() {
|
||||
return this.id;
|
||||
}
|
||||
|
||||
public String getContent() {
|
||||
return this.content;
|
||||
}
|
||||
|
||||
@Override
|
||||
public boolean equals(final Object o) {
|
||||
if (o == this)
|
||||
return true;
|
||||
if (!(o instanceof Greeting)) {
|
||||
return false;
|
||||
}
|
||||
final Greeting greeting = (Greeting) o;
|
||||
return id == greeting.id && Objects.equals(content, greeting.content);
|
||||
}
|
||||
|
||||
@Override
|
||||
public String toString() {
|
||||
return "{" +
|
||||
" id='" + getId() + "'" +
|
||||
", content='" + getContent() + "'" +
|
||||
"}";
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,16 @@
|
||||
package org.gcube.app.springbootangulardemo.servlet;
|
||||
|
||||
import org.gcube.app.springbootangulardemo.SpringbootAngularAppDemoApplication;
|
||||
import org.springframework.boot.builder.SpringApplicationBuilder;
|
||||
import org.springframework.boot.web.servlet.support.SpringBootServletInitializer;
|
||||
|
||||
public class ServletInitializer extends SpringBootServletInitializer {
|
||||
|
||||
@Override
|
||||
protected SpringApplicationBuilder configure(SpringApplicationBuilder application) {
|
||||
System.out.println(this.getClass().getSimpleName()+ " configure called");
|
||||
return application.sources(SpringbootAngularAppDemoApplication.class);
|
||||
|
||||
}
|
||||
|
||||
}
|
||||
@ -0,0 +1,13 @@
|
||||
# Editor configuration, see https://editorconfig.org
|
||||
root = true
|
||||
|
||||
[*]
|
||||
charset = utf-8
|
||||
indent_style = space
|
||||
indent_size = 2
|
||||
insert_final_newline = true
|
||||
trim_trailing_whitespace = true
|
||||
|
||||
[*.md]
|
||||
max_line_length = off
|
||||
trim_trailing_whitespace = false
|
||||
@ -0,0 +1,46 @@
|
||||
# See http://help.github.com/ignore-files/ for more about ignoring files.
|
||||
|
||||
# compiled output
|
||||
/dist
|
||||
/tmp
|
||||
/out-tsc
|
||||
# Only exists if Bazel was run
|
||||
/bazel-out
|
||||
|
||||
# dependencies
|
||||
/node_modules
|
||||
|
||||
# profiling files
|
||||
chrome-profiler-events*.json
|
||||
speed-measure-plugin*.json
|
||||
|
||||
# IDEs and editors
|
||||
/.idea
|
||||
.project
|
||||
.classpath
|
||||
.c9/
|
||||
*.launch
|
||||
.settings/
|
||||
*.sublime-workspace
|
||||
|
||||
# IDE - VSCode
|
||||
.vscode/*
|
||||
!.vscode/settings.json
|
||||
!.vscode/tasks.json
|
||||
!.vscode/launch.json
|
||||
!.vscode/extensions.json
|
||||
.history/*
|
||||
|
||||
# misc
|
||||
/.sass-cache
|
||||
/connect.lock
|
||||
/coverage
|
||||
/libpeerconnection.log
|
||||
npm-debug.log
|
||||
yarn-error.log
|
||||
testem.log
|
||||
/typings
|
||||
|
||||
# System Files
|
||||
.DS_Store
|
||||
Thumbs.db
|
||||
@ -0,0 +1,27 @@
|
||||
# NgApp
|
||||
|
||||
This project was generated with [Angular CLI](https://github.com/angular/angular-cli) version 9.0.4.
|
||||
|
||||
## Development server
|
||||
|
||||
Run `ng serve` for a dev server. Navigate to `http://localhost:4200/`. The app will automatically reload if you change any of the source files.
|
||||
|
||||
## Code scaffolding
|
||||
|
||||
Run `ng generate component component-name` to generate a new component. You can also use `ng generate directive|pipe|service|class|guard|interface|enum|module`.
|
||||
|
||||
## Build
|
||||
|
||||
Run `ng build` to build the project. The build artifacts will be stored in the `dist/` directory. Use the `--prod` flag for a production build.
|
||||
|
||||
## Running unit tests
|
||||
|
||||
Run `ng test` to execute the unit tests via [Karma](https://karma-runner.github.io).
|
||||
|
||||
## Running end-to-end tests
|
||||
|
||||
Run `ng e2e` to execute the end-to-end tests via [Protractor](http://www.protractortest.org/).
|
||||
|
||||
## Further help
|
||||
|
||||
To get more help on the Angular CLI use `ng help` or go check out the [Angular CLI README](https://github.com/angular/angular-cli/blob/master/README.md).
|
||||
@ -0,0 +1,124 @@
|
||||
{
|
||||
"$schema": "./node_modules/@angular/cli/lib/config/schema.json",
|
||||
"version": 1,
|
||||
"newProjectRoot": "projects",
|
||||
"projects": {
|
||||
"ng-app": {
|
||||
"projectType": "application",
|
||||
"schematics": {},
|
||||
"root": "",
|
||||
"sourceRoot": "src",
|
||||
"prefix": "app",
|
||||
"architect": {
|
||||
"build": {
|
||||
"builder": "@angular-devkit/build-angular:browser",
|
||||
"options": {
|
||||
"outputPath": "dist/ng-app",
|
||||
"index": "src/index.html",
|
||||
"main": "src/main.ts",
|
||||
"polyfills": "src/polyfills.ts",
|
||||
"tsConfig": "tsconfig.app.json",
|
||||
"aot": true,
|
||||
"assets": [
|
||||
"src/favicon.ico",
|
||||
"src/assets"
|
||||
],
|
||||
"styles": [
|
||||
"src/styles.css"
|
||||
],
|
||||
"scripts": []
|
||||
},
|
||||
"configurations": {
|
||||
"production": {
|
||||
"fileReplacements": [
|
||||
{
|
||||
"replace": "src/environments/environment.ts",
|
||||
"with": "src/environments/environment.prod.ts"
|
||||
}
|
||||
],
|
||||
"optimization": true,
|
||||
"outputHashing": "all",
|
||||
"sourceMap": false,
|
||||
"extractCss": true,
|
||||
"namedChunks": false,
|
||||
"extractLicenses": true,
|
||||
"vendorChunk": false,
|
||||
"buildOptimizer": true,
|
||||
"budgets": [
|
||||
{
|
||||
"type": "initial",
|
||||
"maximumWarning": "2mb",
|
||||
"maximumError": "5mb"
|
||||
},
|
||||
{
|
||||
"type": "anyComponentStyle",
|
||||
"maximumWarning": "6kb",
|
||||
"maximumError": "10kb"
|
||||
}
|
||||
]
|
||||
}
|
||||
}
|
||||
},
|
||||
"serve": {
|
||||
"builder": "@angular-devkit/build-angular:dev-server",
|
||||
"options": {
|
||||
"browserTarget": "ng-app:build"
|
||||
},
|
||||
"configurations": {
|
||||
"production": {
|
||||
"browserTarget": "ng-app:build:production"
|
||||
}
|
||||
}
|
||||
},
|
||||
"extract-i18n": {
|
||||
"builder": "@angular-devkit/build-angular:extract-i18n",
|
||||
"options": {
|
||||
"browserTarget": "ng-app:build"
|
||||
}
|
||||
},
|
||||
"test": {
|
||||
"builder": "@angular-devkit/build-angular:karma",
|
||||
"options": {
|
||||
"main": "src/test.ts",
|
||||
"polyfills": "src/polyfills.ts",
|
||||
"tsConfig": "tsconfig.spec.json",
|
||||
"karmaConfig": "karma.conf.js",
|
||||
"assets": [
|
||||
"src/favicon.ico",
|
||||
"src/assets"
|
||||
],
|
||||
"styles": [
|
||||
"src/styles.css"
|
||||
],
|
||||
"scripts": []
|
||||
}
|
||||
},
|
||||
"lint": {
|
||||
"builder": "@angular-devkit/build-angular:tslint",
|
||||
"options": {
|
||||
"tsConfig": [
|
||||
"tsconfig.app.json",
|
||||
"tsconfig.spec.json",
|
||||
"e2e/tsconfig.json"
|
||||
],
|
||||
"exclude": [
|
||||
"**/node_modules/**"
|
||||
]
|
||||
}
|
||||
},
|
||||
"e2e": {
|
||||
"builder": "@angular-devkit/build-angular:protractor",
|
||||
"options": {
|
||||
"protractorConfig": "e2e/protractor.conf.js",
|
||||
"devServerTarget": "ng-app:serve"
|
||||
},
|
||||
"configurations": {
|
||||
"production": {
|
||||
"devServerTarget": "ng-app:serve:production"
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
}},
|
||||
"defaultProject": "ng-app"
|
||||
}
|
||||
@ -0,0 +1,12 @@
|
||||
# This file is used by the build system to adjust CSS and JS output to support the specified browsers below.
|
||||
# For additional information regarding the format and rule options, please see:
|
||||
# https://github.com/browserslist/browserslist#queries
|
||||
|
||||
# You can see what browsers were selected by your queries by running:
|
||||
# npx browserslist
|
||||
|
||||
> 0.5%
|
||||
last 2 versions
|
||||
Firefox ESR
|
||||
not dead
|
||||
not IE 9-11 # For IE 9-11 support, remove 'not'.
|
||||
@ -0,0 +1,32 @@
|
||||
// @ts-check
|
||||
// Protractor configuration file, see link for more information
|
||||
// https://github.com/angular/protractor/blob/master/lib/config.ts
|
||||
|
||||
const { SpecReporter } = require('jasmine-spec-reporter');
|
||||
|
||||
/**
|
||||
* @type { import("protractor").Config }
|
||||
*/
|
||||
exports.config = {
|
||||
allScriptsTimeout: 11000,
|
||||
specs: [
|
||||
'./src/**/*.e2e-spec.ts'
|
||||
],
|
||||
capabilities: {
|
||||
browserName: 'chrome'
|
||||
},
|
||||
directConnect: true,
|
||||
baseUrl: 'http://localhost:4200/',
|
||||
framework: 'jasmine',
|
||||
jasmineNodeOpts: {
|
||||
showColors: true,
|
||||
defaultTimeoutInterval: 30000,
|
||||
print: function() {}
|
||||
},
|
||||
onPrepare() {
|
||||
require('ts-node').register({
|
||||
project: require('path').join(__dirname, './tsconfig.json')
|
||||
});
|
||||
jasmine.getEnv().addReporter(new SpecReporter({ spec: { displayStacktrace: true } }));
|
||||
}
|
||||
};
|
||||
@ -0,0 +1,23 @@
|
||||
import { AppPage } from './app.po';
|
||||
import { browser, logging } from 'protractor';
|
||||
|
||||
describe('workspace-project App', () => {
|
||||
let page: AppPage;
|
||||
|
||||
beforeEach(() => {
|
||||
page = new AppPage();
|
||||
});
|
||||
|
||||
it('should display welcome message', () => {
|
||||
page.navigateTo();
|
||||
expect(page.getTitleText()).toEqual('ng-app app is running!');
|
||||
});
|
||||
|
||||
afterEach(async () => {
|
||||
// Assert that there are no errors emitted from the browser
|
||||
const logs = await browser.manage().logs().get(logging.Type.BROWSER);
|
||||
expect(logs).not.toContain(jasmine.objectContaining({
|
||||
level: logging.Level.SEVERE,
|
||||
} as logging.Entry));
|
||||
});
|
||||
});
|
||||
@ -0,0 +1,11 @@
|
||||
import { browser, by, element } from 'protractor';
|
||||
|
||||
export class AppPage {
|
||||
navigateTo(): Promise<unknown> {
|
||||
return browser.get(browser.baseUrl) as Promise<unknown>;
|
||||
}
|
||||
|
||||
getTitleText(): Promise<string> {
|
||||
return element(by.css('app-root .content span')).getText() as Promise<string>;
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,13 @@
|
||||
{
|
||||
"extends": "../tsconfig.json",
|
||||
"compilerOptions": {
|
||||
"outDir": "../out-tsc/e2e",
|
||||
"module": "commonjs",
|
||||
"target": "es5",
|
||||
"types": [
|
||||
"jasmine",
|
||||
"jasminewd2",
|
||||
"node"
|
||||
]
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,32 @@
|
||||
// Karma configuration file, see link for more information
|
||||
// https://karma-runner.github.io/1.0/config/configuration-file.html
|
||||
|
||||
module.exports = function (config) {
|
||||
config.set({
|
||||
basePath: '',
|
||||
frameworks: ['jasmine', '@angular-devkit/build-angular'],
|
||||
plugins: [
|
||||
require('karma-jasmine'),
|
||||
require('karma-chrome-launcher'),
|
||||
require('karma-jasmine-html-reporter'),
|
||||
require('karma-coverage-istanbul-reporter'),
|
||||
require('@angular-devkit/build-angular/plugins/karma')
|
||||
],
|
||||
client: {
|
||||
clearContext: false // leave Jasmine Spec Runner output visible in browser
|
||||
},
|
||||
coverageIstanbulReporter: {
|
||||
dir: require('path').join(__dirname, './coverage/ng-app'),
|
||||
reports: ['html', 'lcovonly', 'text-summary'],
|
||||
fixWebpackSourcePaths: true
|
||||
},
|
||||
reporters: ['progress', 'kjhtml'],
|
||||
port: 9876,
|
||||
colors: true,
|
||||
logLevel: config.LOG_INFO,
|
||||
autoWatch: true,
|
||||
browsers: ['Chrome'],
|
||||
singleRun: false,
|
||||
restartOnFileChange: true
|
||||
});
|
||||
};
|
||||
Binary file not shown.
@ -0,0 +1,15 @@
|
||||
{
|
||||
"licenses": {
|
||||
"spdx": [
|
||||
"CC-BY-3.0"
|
||||
],
|
||||
"blueOak": "bronze"
|
||||
},
|
||||
"corrections": true,
|
||||
"packages": {
|
||||
"config-chain": "1.1.12",
|
||||
"cyclist": "0.2.2",
|
||||
"json-schema": "0.2.3",
|
||||
"qrcode-terminal": "0.12.0"
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,77 @@
|
||||
Alex K. Wolfe <alexkwolfe@gmail.com>
|
||||
Andrew Bradley <cspotcode@gmail.com>
|
||||
Andrew Lunny <alunny@gmail.com>
|
||||
Arlo Breault <arlolra@gmail.com>
|
||||
Ashley Williams <ashley@npmjs.com> <ashley666ashley@gmail.com>
|
||||
Ashley Williams <ashley@npmjs.com> <ashley@bocoup.com>
|
||||
Benjamin Coe <bencoe@gmail.com>
|
||||
Benjamin Coe <bencoe@gmail.com> <ben@npmjs.com>
|
||||
Brian White <mscdex@mscdex.net> <mscdex@gmail.com>
|
||||
Cedric Nelson <cedric.nelson@gmail.com>
|
||||
Charlie Robbins <charlie.robbins@gmail.com>
|
||||
Claudia Hernández <cghr1990@gmail.com>
|
||||
Dalmais Maxence <root@ip-10-195-202-5.ec2.internal>
|
||||
Danila Gerasimov <danila.gerasimov@gmail.com>
|
||||
Dave Galbraith <dave@jut.io>
|
||||
David Beitey <david@davidjb.com>
|
||||
David Rousselie <guido.dassori@gmail.com>
|
||||
Domenic Denicola <domenic@domenicdenicola.com>
|
||||
Einar Otto Stangvik <einaros@gmail.com>
|
||||
Emma Ramirez <ramirez.emma.g@gmail.com>
|
||||
Erik Wienhold <git@ewie.name>
|
||||
Evan Lucas <evan@btc.com> <evan.lucas@hattiesburgclinic.com>
|
||||
Evan Lucas <evan@btc.com> <evanlucas@me.com>
|
||||
Faiq Raza <faiqrazarizvi@gmail.com>
|
||||
Forbes Lindesay <forbes@lindesay.co.uk>
|
||||
Forrest L Norvell <ogd@aoaioxxysz.net> <forrest@npmjs.com>
|
||||
Forrest L Norvell <ogd@aoaioxxysz.net> <othiym23@gmail.com>
|
||||
Gabriel Barros <descartavel1@gmail.com>
|
||||
Geoff Flarity <geoff.flarity@gmail.com> <gflarity@raptvm-x02.(none)>
|
||||
Gregers Gram Rygg <gregers.gram.rygg@finn.no>
|
||||
Ifeanyi Oraelosi <ifeanyioraelosi@gmail.com>
|
||||
isaacs <i@izs.me> <i@foohack.com>
|
||||
isaacs <i@izs.me> <nope@not.real>
|
||||
isaacs <i@izs.me> <isaacs@npmjs.com>
|
||||
Jake Verbaten <raynos2@gmail.com>
|
||||
James Sanders <jimmyjazz14@gmail.com>
|
||||
James Treworgy <jamietre@gmail.com>
|
||||
Jason Smith <jhs@iriscouch.com>
|
||||
Jed Fox <git@twopointzero.us>
|
||||
Jonas Weber <github@jonasw.de>
|
||||
Joshua Bennett <legodudejb@gmail.com>
|
||||
Joshua Bennett <legodudejb@gmail.com> <legodude17@users.noreply.github.com>
|
||||
Julien Meddah <julien.meddah@deveryware.com>
|
||||
Kat Marchán <kzm@zkat.tech> <kzm@sykosomatic.org>
|
||||
Kevin Lorenz <mail@kevinlorenz.com>
|
||||
Kris Windham <kriswindham@gmail.com>
|
||||
Leonardo Rojas <leonardo.rojas@shopify.com>
|
||||
Lin Clark <lin.w.clark@gmail.com>
|
||||
Luke Arduini <luke.arduini@gmail.com> <luke.arduini@me.com>
|
||||
Maciej Małecki <me@mmalecki.com> <maciej.malecki@notimplemented.org>
|
||||
Martin Ek <mail@ekmartin.com>
|
||||
Max Goodman <c@chromakode.com>
|
||||
Maxim Bogushevich <boga1@mail.ru>
|
||||
Maximilian Antoni <mail@maxantoni.de> <maximilian.antoni@juliusbaer.com>
|
||||
Michael Hayes <michael@hayes.io> <mhayes@newrelic.com>
|
||||
Misha Kaletsky <misha.kaletsky@gmail.com>
|
||||
Nicolas Morel <marsup@gmail.com>
|
||||
Olivier Melcher <olivier.melcher@gmail.com>
|
||||
Ra'Shaun Stovall <rashaunstovall@gmail.com>
|
||||
Rebecca Turner <me@re-becca.org> <rebecca@npmjs.com>
|
||||
Rebecca Turner <me@re-becca.org> <turner@mikomi.org>
|
||||
Ryan Emery <seebees@gmail.com>
|
||||
Sam Mikes <smikes@cubane.com>
|
||||
Sreenivas Alapati <sreenivas9alapati@gmail.com>
|
||||
Stephanie Snopek <stephaniesnopek@gmail.com>
|
||||
Takaya Kobayashi <jigsaw@live.jp>
|
||||
Ted Yavuzkurt <hello@TedY.io> <davidteoman@gmail.com>
|
||||
Thomas Reggi <thomas@reggi.com>
|
||||
Timo Weiß <timoweiss@Timo-MBP.local>
|
||||
Tony <zearin@gonk.net>
|
||||
Trent Mick <trentm@gmail.com> <trent.mick@joyent.com>
|
||||
Visnu Pitiyanuvath <visnupx@gmail.com>
|
||||
Will Elwood <w.elwood08@gmail.com>
|
||||
Wout Mertens <Wout.Mertens@gmail.com>
|
||||
Yeonghoon Park <sola92@gmail.com>
|
||||
Zeke Sikelianos <zeke@sikelianos.com>
|
||||
Zoujie Wzj <zoujie.wzj@alibaba-inc.com>
|
||||
@ -0,0 +1,28 @@
|
||||
*.swp
|
||||
.*.swp
|
||||
netlify.toml
|
||||
npm-debug.log
|
||||
/.github
|
||||
/test
|
||||
node_modules/marked
|
||||
node_modules/marked-man
|
||||
node_modules/tap
|
||||
tap-snapshots
|
||||
node_modules/.bin
|
||||
node_modules/npm-registry-mock
|
||||
/npmrc
|
||||
/release/
|
||||
|
||||
# don't need these in the npm package.
|
||||
html/*.png
|
||||
|
||||
# don't ignore .npmignore files
|
||||
# these are used in some tests.
|
||||
!.npmignore
|
||||
|
||||
/npm-*.tgz
|
||||
|
||||
*.pyc
|
||||
|
||||
|
||||
.nyc_output
|
||||
@ -0,0 +1,22 @@
|
||||
# need to declare the language as well as the matrix below
|
||||
language: node_js
|
||||
|
||||
os:
|
||||
- windows
|
||||
|
||||
node_js:
|
||||
- 12
|
||||
- 10
|
||||
- 8
|
||||
- 6
|
||||
|
||||
env: "DEPLOY_VERSION=testing"
|
||||
|
||||
notifications:
|
||||
slack: npm-inc:kRqQjto7YbINqHPb1X6nS3g8
|
||||
|
||||
install:
|
||||
- "node . install"
|
||||
|
||||
script:
|
||||
- "node . run tap -- \"test/tap/*.js\" -t600 -Rclassic -c"
|
||||
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,192 @@
|
||||
# npm CLI Contributor Roles and Responsibilities
|
||||
|
||||
## Table of Contents
|
||||
|
||||
* [Introduction](#introduction)
|
||||
* [Code Structure](#code-structure)
|
||||
* [Running Tests](#running-tests)
|
||||
* [Debugging](#debugging)
|
||||
* [Coverage](#coverage)
|
||||
* [Benchmarking](#benchmarking)
|
||||
* [Types of Contributions](#types-of-contributions)
|
||||
* [Contributing an Issue?](#contributing-an-issue)
|
||||
* [Contributing a Question?](#contributing-a-question)
|
||||
* [Contributing a Bug Fix?](#contributing-a-bug-fix)
|
||||
* [Contributing a Feature?](#contributing-a-bug-feature)
|
||||
* [Development Dependencies](#development-dependencies)
|
||||
* [Dependencies](#dependencies)
|
||||
|
||||
## Introduction
|
||||
|
||||
Welcome to the npm CLI Contributor Guide! This document outlines the npm CLI repository's process for community interaction and contribution. This includes the issue tracker, pull requests, wiki pages, and, to a certain extent, outside communication in the context of the npm CLI. This is an entry point for anyone wishing to contribute their time and effort to making npm a better tool for the JavaScript community!
|
||||
|
||||
All interactions in the npm repository are covered by the [npm Code of Conduct](https://www.npmjs.com/policies/conduct)
|
||||
|
||||
|
||||
## Code Structure
|
||||
```
|
||||
/
|
||||
├── bin/
|
||||
│ │ # Directory for executable files. It's very rare that you
|
||||
│ │ # will need to update a file in this directory.
|
||||
│ │
|
||||
│ ├── npm # npm-cli entrypoint for bourne shell
|
||||
│ ├── npm-cli.js # npm-cli entrypoint for node
|
||||
│ ├── npm.cmd # npm-cli entrypoint for windows
|
||||
│ ├── npx # npx entrypoint for bourne shell
|
||||
│ ├── npx-cli.js # npx entrypoint for node
|
||||
│ └── npx.cmd # npx entrypoint for windows
|
||||
│
|
||||
├── docs/ 📖
|
||||
│ │ # Directory that contains the documentation website for
|
||||
│ │ # the npm-cli. You can run this website locally, and have
|
||||
│ │ # offline docs! 🔥📖🤓
|
||||
│ │
|
||||
│ ├── content/ # Markdown files for site content
|
||||
│ ├── src/ # Source files for the website; gatsby related
|
||||
│ └── package.json # Site manifest; scripts and dependencies
|
||||
│
|
||||
├── lib/ 📦
|
||||
│ # All the Good Bits(tm) of the CLI project live here
|
||||
│
|
||||
├── node_modules/ 🔋
|
||||
│ # Vendored dependencies for the CLI project (See the
|
||||
│ # dependencies section below for more details).
|
||||
│
|
||||
├── scripts/ 📜
|
||||
│ # We've created some helper scripts for working with the
|
||||
│ # CLI project, specifically around managing our vendored
|
||||
│ # dependencies, merging in pull-requests, and publishing
|
||||
│ # releases.
|
||||
│
|
||||
├── test/ 🧪
|
||||
│ # All the tests for the CLI live in this folder. We've
|
||||
│ # got a lot of tests 🤓🧪🩺
|
||||
│
|
||||
├── CONTRIBUTING.md # This file! 🎉
|
||||
└── package.json # The projects main manifest file 📃
|
||||
```
|
||||
|
||||
## Running Tests
|
||||
|
||||
```
|
||||
# Make sure you install the dependencies first before running tests.
|
||||
$ npm install
|
||||
|
||||
# Run tests for the CLI (it could take awhile).
|
||||
$ npm run test
|
||||
```
|
||||
|
||||
## Debugging
|
||||
|
||||
It can be tricky to track down issues in the CLI. It's a large code base that has been evolving for over a decade. There is a handy `make` command that will connect the **cloned repository** you have on your machine with the global command, so you can add `console.log` statements or debug any other way you feel most comfortable with.
|
||||
|
||||
```
|
||||
# Clone the repository to start with
|
||||
$ git clone git@github.com:npm/cli.git
|
||||
|
||||
# Change working directories into the repository
|
||||
$ cd cli
|
||||
|
||||
# Make sure you have the latest code (if that's what you're trying to debug)
|
||||
$ git fetch origin latest
|
||||
|
||||
# Connect repository to the global namespace
|
||||
$ make link
|
||||
|
||||
#################
|
||||
# ALTERNATIVELY
|
||||
#################
|
||||
# If ou're working on a feature or bug, you can run the same command on your
|
||||
# working branch and link that code.
|
||||
|
||||
# Create new branch to work from (there are many ways)
|
||||
$ git checkout -b feature/awesome-feature
|
||||
|
||||
# Connect repository to global namespace
|
||||
$ make link
|
||||
```
|
||||
|
||||
## Coverage
|
||||
|
||||
We try and make sure that each new feature or bug fix has tests to go along with them in order to keep code coverages consistent and increasing. We are actively striving for 100% code coverage!
|
||||
|
||||
```
|
||||
# You can run the following command to find out coverage
|
||||
$ npm run test-coverage
|
||||
```
|
||||
|
||||
## Benchmarking
|
||||
|
||||
We often want to know if the bug we've fixed for the feature we've added has any sort of performance impact. We've created a [benchmark suite](https://github.com/npm/benchmarks) to run against the CLI project from pull-requests. If you would like to know if there are any performance impacts to the work you're contributing, simply do the following:
|
||||
|
||||
1. Make a pull-request against this repository
|
||||
2. Add the following comment to the pull-request: "`test this please ✅`"
|
||||
|
||||
This will trigger the [benmark suite](https://github.com/npm/benchmarks) to run against your pull-request, and when it's finished running it will post a comment on your pull-request just like bellow. You'll be able to see the results from the suite inline in your pull-request.
|
||||
|
||||
> You'll notice that the bot-user will also add a 🚀 reaction to your comment to
|
||||
let you know that it's sent the request to start the benchmark suite.
|
||||
|
||||
|
||||
|
||||
If you've updated your pull-reuqest and you'd like to run the the benchmark suite again, simple update your original comment, by adding `test this please ✅` again, or simply just adding another emoji to the **end**. _(The trigger is the phrase "test this please ✅" at the beginning of a comment. Updates will trigger as well, so long as the phrase stays at the beginning.)_.
|
||||
|
||||
|
||||
|
||||
## Types of Contributions
|
||||
|
||||
### Contributing an Issue?
|
||||
|
||||
Great!! Is your [new issue](https://github.com/npm/cli/issues/new/choose) a [bug](https://github.com/npm/cli/issues/new?template=bug.md&title=%5BBUG%5D+%3Ctitle%3E), a [feature](https://github.com/npm/cli/issues/new?template=feature.md&title=%5BFEATURE%5D+%3Ctitle%3E), or a [question](https://github.com/npm/cli/issues/new?template=question.md&title=%5BQUESTION%5D+%3Ctitle%3E)?
|
||||
|
||||
### Contributing a Question?
|
||||
|
||||
Huh? 🤔 Got a situation you're not sure about?! Perfect! We've got some resources you can use.
|
||||
|
||||
* Our [documentation site](https://docs.npmjs.com/)
|
||||
* The local docs that come with the CLI project
|
||||
|
||||
> **Example**: `npm help install --viewer browser`
|
||||
|
||||
* The man pages that are built and shipped with the CLI
|
||||
|
||||
> **Example**: `man npm-install` (only on linux/macOS)
|
||||
|
||||
* Search of the [current issues](https://github.com/npm/cli/issues)
|
||||
|
||||
### Contributing a Bug Fix?
|
||||
|
||||
We'd be happy to triage and help! Head over to the issues and [create a new one](https://github.com/npm/cli/issues/new?template=bug.md&title=%5BBUG%5D+%3Ctitle%3E)!
|
||||
|
||||
> We'll need a little bit of information about what happened, rather than "it broke". Such as:
|
||||
* When did/does this bug happen?
|
||||
* Can you reproduce it? _(Can you make it happen more than once.)_
|
||||
* What version of `node`/`npm` are you running on your computer?
|
||||
* What did you expect it to do?
|
||||
* What did it _actually do?
|
||||
* etc...
|
||||
|
||||
### Contributing a Feature?
|
||||
|
||||
Snazzy, we're always up for fancy new things! If the feature is fairly minor, the team can triage it and prioritize it into our backlog. However, if the feature is a little more complex, then it's best to create an [RFC](https://en.wikipedia.org/wiki/Request_for_Comments) in our [RFC repository](https://github.com/npm/rfcs). Exactly how to do that is outlined in that repository. If you're not sure _exactly_ how to implement your idea, or don't want to make a document about your idea, then please create an issue on that repository. We consider these RRFC's, or a "Requesting Request For Comment".
|
||||
|
||||
## Development Dependencies
|
||||
|
||||
You'll need a few things installed in order to update and test the CLI project during development:
|
||||
|
||||
* [node](https://nodejs.org/) v8 or greater
|
||||
|
||||
> We recommend that you have a [node version manager](https://github.com/nvm-sh/nvm) installed if you plan on fixing bugs that might be present in a specific version of node. With a version manager you can easily switch versions of node and test if your changes to the CLI project are working.
|
||||
|
||||
* [git](https://git-scm.com/) v2.11+
|
||||
|
||||
|
||||
## Dependencies
|
||||
|
||||
> Package vendoring is commonly referred to as the case where dependent packages are stored in the same place as your project. That usually means you dependencies are checked into your source management system, such as Git.
|
||||
|
||||
The CLI project vendors it's dependencies in the `node_modules/` folder. Meaning all the dependencies that the CLI project uses are contained withing the project itself. This is represented by the `bundledDependencies` section in the root level `package.json` file. The main reason for this is because the `npm` CLI project is distributed with the NodeJS runtime and needs to work out of the box, which means all dependencies need to be available after the runtime is installed.
|
||||
|
||||
There are a couple scripts created to help manage this process in the `scripts/` folder.
|
||||
|
||||
@ -0,0 +1,235 @@
|
||||
The npm application
|
||||
Copyright (c) npm, Inc. and Contributors
|
||||
Licensed on the terms of The Artistic License 2.0
|
||||
|
||||
Node package dependencies of the npm application
|
||||
Copyright (c) their respective copyright owners
|
||||
Licensed on their respective license terms
|
||||
|
||||
The npm public registry at https://registry.npmjs.org
|
||||
and the npm website at https://www.npmjs.com
|
||||
Operated by npm, Inc.
|
||||
Use governed by terms published on https://www.npmjs.com
|
||||
|
||||
"Node.js"
|
||||
Trademark Joyent, Inc., https://joyent.com
|
||||
Neither npm nor npm, Inc. are affiliated with Joyent, Inc.
|
||||
|
||||
The Node.js application
|
||||
Project of Node Foundation, https://nodejs.org
|
||||
|
||||
The npm Logo
|
||||
Copyright (c) Mathias Pettersson and Brian Hammond
|
||||
|
||||
"Gubblebum Blocky" typeface
|
||||
Copyright (c) Tjarda Koster, https://jelloween.deviantart.com
|
||||
Used with permission
|
||||
|
||||
|
||||
--------
|
||||
|
||||
|
||||
The Artistic License 2.0
|
||||
|
||||
Copyright (c) 2000-2006, The Perl Foundation.
|
||||
|
||||
Everyone is permitted to copy and distribute verbatim copies
|
||||
of this license document, but changing it is not allowed.
|
||||
|
||||
Preamble
|
||||
|
||||
This license establishes the terms under which a given free software
|
||||
Package may be copied, modified, distributed, and/or redistributed.
|
||||
The intent is that the Copyright Holder maintains some artistic
|
||||
control over the development of that Package while still keeping the
|
||||
Package available as open source and free software.
|
||||
|
||||
You are always permitted to make arrangements wholly outside of this
|
||||
license directly with the Copyright Holder of a given Package. If the
|
||||
terms of this license do not permit the full use that you propose to
|
||||
make of the Package, you should contact the Copyright Holder and seek
|
||||
a different licensing arrangement.
|
||||
|
||||
Definitions
|
||||
|
||||
"Copyright Holder" means the individual(s) or organization(s)
|
||||
named in the copyright notice for the entire Package.
|
||||
|
||||
"Contributor" means any party that has contributed code or other
|
||||
material to the Package, in accordance with the Copyright Holder's
|
||||
procedures.
|
||||
|
||||
"You" and "your" means any person who would like to copy,
|
||||
distribute, or modify the Package.
|
||||
|
||||
"Package" means the collection of files distributed by the
|
||||
Copyright Holder, and derivatives of that collection and/or of
|
||||
those files. A given Package may consist of either the Standard
|
||||
Version, or a Modified Version.
|
||||
|
||||
"Distribute" means providing a copy of the Package or making it
|
||||
accessible to anyone else, or in the case of a company or
|
||||
organization, to others outside of your company or organization.
|
||||
|
||||
"Distributor Fee" means any fee that you charge for Distributing
|
||||
this Package or providing support for this Package to another
|
||||
party. It does not mean licensing fees.
|
||||
|
||||
"Standard Version" refers to the Package if it has not been
|
||||
modified, or has been modified only in ways explicitly requested
|
||||
by the Copyright Holder.
|
||||
|
||||
"Modified Version" means the Package, if it has been changed, and
|
||||
such changes were not explicitly requested by the Copyright
|
||||
Holder.
|
||||
|
||||
"Original License" means this Artistic License as Distributed with
|
||||
the Standard Version of the Package, in its current version or as
|
||||
it may be modified by The Perl Foundation in the future.
|
||||
|
||||
"Source" form means the source code, documentation source, and
|
||||
configuration files for the Package.
|
||||
|
||||
"Compiled" form means the compiled bytecode, object code, binary,
|
||||
or any other form resulting from mechanical transformation or
|
||||
translation of the Source form.
|
||||
|
||||
|
||||
Permission for Use and Modification Without Distribution
|
||||
|
||||
(1) You are permitted to use the Standard Version and create and use
|
||||
Modified Versions for any purpose without restriction, provided that
|
||||
you do not Distribute the Modified Version.
|
||||
|
||||
|
||||
Permissions for Redistribution of the Standard Version
|
||||
|
||||
(2) You may Distribute verbatim copies of the Source form of the
|
||||
Standard Version of this Package in any medium without restriction,
|
||||
either gratis or for a Distributor Fee, provided that you duplicate
|
||||
all of the original copyright notices and associated disclaimers. At
|
||||
your discretion, such verbatim copies may or may not include a
|
||||
Compiled form of the Package.
|
||||
|
||||
(3) You may apply any bug fixes, portability changes, and other
|
||||
modifications made available from the Copyright Holder. The resulting
|
||||
Package will still be considered the Standard Version, and as such
|
||||
will be subject to the Original License.
|
||||
|
||||
|
||||
Distribution of Modified Versions of the Package as Source
|
||||
|
||||
(4) You may Distribute your Modified Version as Source (either gratis
|
||||
or for a Distributor Fee, and with or without a Compiled form of the
|
||||
Modified Version) provided that you clearly document how it differs
|
||||
from the Standard Version, including, but not limited to, documenting
|
||||
any non-standard features, executables, or modules, and provided that
|
||||
you do at least ONE of the following:
|
||||
|
||||
(a) make the Modified Version available to the Copyright Holder
|
||||
of the Standard Version, under the Original License, so that the
|
||||
Copyright Holder may include your modifications in the Standard
|
||||
Version.
|
||||
|
||||
(b) ensure that installation of your Modified Version does not
|
||||
prevent the user installing or running the Standard Version. In
|
||||
addition, the Modified Version must bear a name that is different
|
||||
from the name of the Standard Version.
|
||||
|
||||
(c) allow anyone who receives a copy of the Modified Version to
|
||||
make the Source form of the Modified Version available to others
|
||||
under
|
||||
|
||||
(i) the Original License or
|
||||
|
||||
(ii) a license that permits the licensee to freely copy,
|
||||
modify and redistribute the Modified Version using the same
|
||||
licensing terms that apply to the copy that the licensee
|
||||
received, and requires that the Source form of the Modified
|
||||
Version, and of any works derived from it, be made freely
|
||||
available in that license fees are prohibited but Distributor
|
||||
Fees are allowed.
|
||||
|
||||
|
||||
Distribution of Compiled Forms of the Standard Version
|
||||
or Modified Versions without the Source
|
||||
|
||||
(5) You may Distribute Compiled forms of the Standard Version without
|
||||
the Source, provided that you include complete instructions on how to
|
||||
get the Source of the Standard Version. Such instructions must be
|
||||
valid at the time of your distribution. If these instructions, at any
|
||||
time while you are carrying out such distribution, become invalid, you
|
||||
must provide new instructions on demand or cease further distribution.
|
||||
If you provide valid instructions or cease distribution within thirty
|
||||
days after you become aware that the instructions are invalid, then
|
||||
you do not forfeit any of your rights under this license.
|
||||
|
||||
(6) You may Distribute a Modified Version in Compiled form without
|
||||
the Source, provided that you comply with Section 4 with respect to
|
||||
the Source of the Modified Version.
|
||||
|
||||
|
||||
Aggregating or Linking the Package
|
||||
|
||||
(7) You may aggregate the Package (either the Standard Version or
|
||||
Modified Version) with other packages and Distribute the resulting
|
||||
aggregation provided that you do not charge a licensing fee for the
|
||||
Package. Distributor Fees are permitted, and licensing fees for other
|
||||
components in the aggregation are permitted. The terms of this license
|
||||
apply to the use and Distribution of the Standard or Modified Versions
|
||||
as included in the aggregation.
|
||||
|
||||
(8) You are permitted to link Modified and Standard Versions with
|
||||
other works, to embed the Package in a larger work of your own, or to
|
||||
build stand-alone binary or bytecode versions of applications that
|
||||
include the Package, and Distribute the result without restriction,
|
||||
provided the result does not expose a direct interface to the Package.
|
||||
|
||||
|
||||
Items That are Not Considered Part of a Modified Version
|
||||
|
||||
(9) Works (including, but not limited to, modules and scripts) that
|
||||
merely extend or make use of the Package, do not, by themselves, cause
|
||||
the Package to be a Modified Version. In addition, such works are not
|
||||
considered parts of the Package itself, and are not subject to the
|
||||
terms of this license.
|
||||
|
||||
|
||||
General Provisions
|
||||
|
||||
(10) Any use, modification, and distribution of the Standard or
|
||||
Modified Versions is governed by this Artistic License. By using,
|
||||
modifying or distributing the Package, you accept this license. Do not
|
||||
use, modify, or distribute the Package, if you do not accept this
|
||||
license.
|
||||
|
||||
(11) If your Modified Version has been derived from a Modified
|
||||
Version made by someone other than you, you are nevertheless required
|
||||
to ensure that your Modified Version complies with the requirements of
|
||||
this license.
|
||||
|
||||
(12) This license does not grant you the right to use any trademark,
|
||||
service mark, tradename, or logo of the Copyright Holder.
|
||||
|
||||
(13) This license includes the non-exclusive, worldwide,
|
||||
free-of-charge patent license to make, have made, use, offer to sell,
|
||||
sell, import and otherwise transfer the Package with respect to any
|
||||
patent claims licensable by the Copyright Holder that are necessarily
|
||||
infringed by the Package. If you institute patent litigation
|
||||
(including a cross-claim or counterclaim) against any party alleging
|
||||
that the Package constitutes direct or contributory patent
|
||||
infringement, then this Artistic License to you shall terminate on the
|
||||
date that such litigation is filed.
|
||||
|
||||
(14) Disclaimer of Warranty:
|
||||
THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS
|
||||
IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED
|
||||
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR
|
||||
NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL
|
||||
LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL
|
||||
BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL
|
||||
DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF
|
||||
ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
|
||||
|
||||
|
||||
--------
|
||||
@ -0,0 +1,139 @@
|
||||
# vim: set softtabstop=2 shiftwidth=2:
|
||||
SHELL = bash
|
||||
|
||||
PUBLISHTAG = $(shell node scripts/publish-tag.js)
|
||||
BRANCH = $(shell git rev-parse --abbrev-ref HEAD)
|
||||
|
||||
markdowns = $(shell find docs -name '*.md' | grep -v 'index') README.md
|
||||
|
||||
cli_mandocs = $(shell find docs/content/cli-commands -name '*.md' \
|
||||
|sed 's|.md|.1|g' \
|
||||
|sed 's|docs/content/cli-commands/|man/man1/|g' ) \
|
||||
man/man1/npm-README.1 \
|
||||
man/man1/npx.1
|
||||
|
||||
files_mandocs = $(shell find docs/content/configuring-npm -name '*.md' \
|
||||
|sed 's|.md|.5|g' \
|
||||
|sed 's|docs/content/configuring-npm/|man/man5/|g' ) \
|
||||
|
||||
misc_mandocs = $(shell find docs/content/using-npm -name '*.md' \
|
||||
|sed 's|.md|.7|g' \
|
||||
|sed 's|docs/content/using-npm/|man/man7/|g' ) \
|
||||
|
||||
mandocs = $(cli_mandocs) $(files_mandocs) $(misc_mandocs)
|
||||
|
||||
all: docs
|
||||
|
||||
latest:
|
||||
@echo "Installing latest published npm"
|
||||
@echo "Use 'make install' or 'make link' to install the code"
|
||||
@echo "in this folder that you're looking at right now."
|
||||
node bin/npm-cli.js install -g -f npm ${NPMOPTS}
|
||||
|
||||
install: all
|
||||
node bin/npm-cli.js install -g -f ${NPMOPTS} $(shell node bin/npm-cli.js pack | tail -1)
|
||||
|
||||
# backwards compat
|
||||
dev: install
|
||||
|
||||
link: uninstall
|
||||
node bin/npm-cli.js link -f
|
||||
|
||||
clean: markedclean marked-manclean docs-clean
|
||||
rm -rf npmrc
|
||||
node bin/npm-cli.js cache clean --force
|
||||
|
||||
uninstall:
|
||||
node bin/npm-cli.js rm npm -g -f
|
||||
|
||||
mandocs: $(mandocs)
|
||||
|
||||
htmldocs:
|
||||
cd docs && node ../bin/npm-cli.js install && \
|
||||
node ../bin/npm-cli.js run build:static echo>&2 && \
|
||||
rm -rf node_modules .cache public/*js public/*json public/404* public/page-data public/manifest*
|
||||
|
||||
docs: mandocs htmldocs
|
||||
|
||||
markedclean:
|
||||
rm -rf node_modules/marked node_modules/.bin/marked .building_marked
|
||||
|
||||
marked-manclean:
|
||||
rm -rf node_modules/marked-man node_modules/.bin/marked-man .building_marked-man
|
||||
|
||||
docsclean: docs-clean
|
||||
docs-clean:
|
||||
rm -rf \
|
||||
.building_marked \
|
||||
.building_marked-man \
|
||||
man \
|
||||
docs/node_modules \
|
||||
docs/public \
|
||||
docs/.cache
|
||||
|
||||
## build-time tools for the documentation
|
||||
build-doc-tools := node_modules/.bin/marked \
|
||||
node_modules/.bin/marked-man
|
||||
|
||||
# use `npm install marked-man` for this to work.
|
||||
man/man1/npm-README.1: README.md scripts/docs-build.js package.json $(build-doc-tools)
|
||||
@[ -d man/man1 ] || mkdir -p man/man1
|
||||
node scripts/docs-build.js $< $@
|
||||
|
||||
man/man1/%.1: docs/content/cli-commands/%.md scripts/docs-build.js package.json $(build-doc-tools)
|
||||
@[ -d man/man1 ] || mkdir -p man/man1
|
||||
node scripts/docs-build.js $< $@
|
||||
|
||||
man/man1/npx.1: node_modules/libnpx/libnpx.1
|
||||
cat $< | sed s/libnpx/npx/ > $@
|
||||
|
||||
man/man5/npm-json.5: man/man5/package.json.5
|
||||
cp $< $@
|
||||
|
||||
man/man5/npm-global.5: man/man5/folders.5
|
||||
cp $< $@
|
||||
|
||||
man/man5/%.5: docs/content/configuring-npm/%.md scripts/docs-build.js package.json $(build-doc-tools)
|
||||
@[ -d man/man5 ] || mkdir -p man/man5
|
||||
node scripts/docs-build.js $< $@
|
||||
|
||||
man/man7/%.7: docs/content/using-npm/%.md scripts/docs-build.js package.json $(build-doc-tools)
|
||||
@[ -d man/man7 ] || mkdir -p man/man7
|
||||
node scripts/docs-build.js $< $@
|
||||
|
||||
marked: node_modules/.bin/marked
|
||||
|
||||
node_modules/.bin/marked:
|
||||
node bin/npm-cli.js install marked --no-global --no-timing --no-save
|
||||
|
||||
marked-man: node_modules/.bin/marked-man
|
||||
|
||||
node_modules/.bin/marked-man:
|
||||
node bin/npm-cli.js install marked-man --no-global --no-timing --no-save
|
||||
|
||||
test: docs
|
||||
node bin/npm-cli.js test
|
||||
|
||||
tag:
|
||||
node bin/npm-cli.js tag npm@$(PUBLISHTAG) latest
|
||||
|
||||
ls-ok:
|
||||
node . ls >/dev/null
|
||||
|
||||
gitclean:
|
||||
git clean -fd
|
||||
|
||||
publish: gitclean ls-ok link docs-clean docs
|
||||
@git push origin :v$(shell node bin/npm-cli.js --no-timing -v) 2>&1 || true
|
||||
git push origin $(BRANCH) &&\
|
||||
git push origin --tags &&\
|
||||
node bin/npm-cli.js publish --tag=$(PUBLISHTAG)
|
||||
|
||||
release: gitclean ls-ok markedclean marked-manclean docs-clean docs
|
||||
node bin/npm-cli.js prune --production --no-save
|
||||
@bash scripts/release.sh
|
||||
|
||||
sandwich:
|
||||
@[ $$(whoami) = "root" ] && (echo "ok"; echo "ham" > sandwich) || (echo "make it yourself" && exit 13)
|
||||
|
||||
.PHONY: all latest install dev link docs clean uninstall test man docs-clean docclean release ls-ok realclean
|
||||
@ -0,0 +1,161 @@
|
||||
npm(1) -- a JavaScript package manager
|
||||
==============================
|
||||
|
||||
[](https://travis-ci.org/npm/cli)
|
||||
|
||||
## SYNOPSIS
|
||||
|
||||
This is just enough info to get you up and running.
|
||||
|
||||
Much more info will be available via `npm help` once it's installed.
|
||||
|
||||
## IMPORTANT
|
||||
|
||||
**You need node v6 or higher to run this program.**
|
||||
|
||||
To install an old **and unsupported** version of npm that works on node v5
|
||||
and prior, clone the git repo and dig through the old tags and branches.
|
||||
|
||||
**npm is configured to use npm, Inc.'s public registry at
|
||||
<https://registry.npmjs.org> by default.** Use of the npm public registry
|
||||
is subject to terms of use available at <https://www.npmjs.com/policies/terms>.
|
||||
|
||||
You can configure npm to use any compatible registry you
|
||||
like, and even run your own registry. Check out the [doc on
|
||||
registries](https://docs.npmjs.com/misc/registry).
|
||||
|
||||
## Super Easy Install
|
||||
|
||||
npm is bundled with [node](https://nodejs.org/en/download/).
|
||||
|
||||
### Windows Computers
|
||||
|
||||
[Get the MSI](https://nodejs.org/en/download/). npm is in it.
|
||||
|
||||
### Apple Macintosh Computers
|
||||
|
||||
[Get the pkg](https://nodejs.org/en/download/). npm is in it.
|
||||
|
||||
### Other Sorts of Unices
|
||||
|
||||
Run `make install`. npm will be installed with node.
|
||||
|
||||
If you want a more fancy pants install (a different version, customized
|
||||
paths, etc.) then read on.
|
||||
|
||||
## Fancy Install (Unix)
|
||||
|
||||
There's a pretty robust install script at
|
||||
<https://www.npmjs.com/install.sh>. You can download that and run it.
|
||||
|
||||
Here's an example using curl:
|
||||
|
||||
```sh
|
||||
curl -L https://www.npmjs.com/install.sh | sh
|
||||
```
|
||||
|
||||
### Slightly Fancier
|
||||
|
||||
You can set any npm configuration params with that script:
|
||||
|
||||
```sh
|
||||
npm_config_prefix=/some/path sh install.sh
|
||||
```
|
||||
|
||||
Or, you can run it in uber-debuggery mode:
|
||||
|
||||
```sh
|
||||
npm_debug=1 sh install.sh
|
||||
```
|
||||
|
||||
### Even Fancier
|
||||
|
||||
Get the code with git. Use `make` to build the docs and do other stuff.
|
||||
If you plan on hacking on npm, `make link` is your friend.
|
||||
|
||||
If you've got the npm source code, you can also semi-permanently set
|
||||
arbitrary config keys using the `./configure --key=val ...`, and then
|
||||
run npm commands by doing `node bin/npm-cli.js <command> <args>`. (This is helpful
|
||||
for testing, or running stuff without actually installing npm itself.)
|
||||
|
||||
## Windows Install or Upgrade
|
||||
|
||||
Many improvements for Windows users have been made in npm 3 - you will have a better
|
||||
experience if you run a recent version of npm. To upgrade, either use [Microsoft's
|
||||
upgrade tool](https://github.com/felixrieseberg/npm-windows-upgrade),
|
||||
[download a new version of Node](https://nodejs.org/en/download/),
|
||||
or follow the Windows upgrade instructions in the
|
||||
[Installing/upgrading npm](https://npm.community/t/installing-upgrading-npm/251/2) post.
|
||||
|
||||
If that's not fancy enough for you, then you can fetch the code with
|
||||
git, and mess with it directly.
|
||||
|
||||
## Installing on Cygwin
|
||||
|
||||
No.
|
||||
|
||||
## Uninstalling
|
||||
|
||||
So sad to see you go.
|
||||
|
||||
```sh
|
||||
sudo npm uninstall npm -g
|
||||
```
|
||||
Or, if that fails,
|
||||
|
||||
```sh
|
||||
sudo make uninstall
|
||||
```
|
||||
|
||||
## More Severe Uninstalling
|
||||
|
||||
Usually, the above instructions are sufficient. That will remove
|
||||
npm, but leave behind anything you've installed.
|
||||
|
||||
If you would like to remove all the packages that you have installed,
|
||||
then you can use the `npm ls` command to find them, and then `npm rm` to
|
||||
remove them.
|
||||
|
||||
To remove cruft left behind by npm 0.x, you can use the included
|
||||
`clean-old.sh` script file. You can run it conveniently like this:
|
||||
|
||||
```sh
|
||||
npm explore npm -g -- sh scripts/clean-old.sh
|
||||
```
|
||||
|
||||
npm uses two configuration files, one for per-user configs, and another
|
||||
for global (every-user) configs. You can view them by doing:
|
||||
|
||||
```sh
|
||||
npm config get userconfig # defaults to ~/.npmrc
|
||||
npm config get globalconfig # defaults to /usr/local/etc/npmrc
|
||||
```
|
||||
|
||||
Uninstalling npm does not remove configuration files by default. You
|
||||
must remove them yourself manually if you want them gone. Note that
|
||||
this means that future npm installs will not remember the settings that
|
||||
you have chosen.
|
||||
|
||||
## More Docs
|
||||
|
||||
Check out the [docs](https://docs.npmjs.com/).
|
||||
|
||||
You can use the `npm help` command to read any of them.
|
||||
|
||||
If you're a developer, and you want to use npm to publish your program,
|
||||
you should [read this](https://docs.npmjs.com/misc/developers).
|
||||
|
||||
## BUGS
|
||||
|
||||
When you find issues, please report them:
|
||||
|
||||
* web:
|
||||
<https://npm.community/c/bugs>
|
||||
|
||||
Be sure to include *all* of the output from the npm command that didn't work
|
||||
as expected. The `npm-debug.log` file is also helpful to provide.
|
||||
|
||||
## SEE ALSO
|
||||
|
||||
* npm(1)
|
||||
* npm-help(1)
|
||||
@ -0,0 +1,6 @@
|
||||
#!/usr/bin/env sh
|
||||
if [ "x$npm_config_node_gyp" = "x" ]; then
|
||||
node "`dirname "$0"`/../../node_modules/node-gyp/bin/node-gyp.js" "$@"
|
||||
else
|
||||
"$npm_config_node_gyp" "$@"
|
||||
fi
|
||||
@ -0,0 +1,5 @@
|
||||
if not defined npm_config_node_gyp (
|
||||
node "%~dp0\..\..\node_modules\node-gyp\bin\node-gyp.js" %*
|
||||
) else (
|
||||
node "%npm_config_node_gyp%" %*
|
||||
)
|
||||
@ -0,0 +1,37 @@
|
||||
#!/bin/sh
|
||||
(set -o igncr) 2>/dev/null && set -o igncr; # cygwin encoding fix
|
||||
|
||||
basedir=`dirname "$0"`
|
||||
|
||||
case `uname` in
|
||||
*CYGWIN*) basedir=`cygpath -w "$basedir"`;;
|
||||
esac
|
||||
|
||||
NODE_EXE="$basedir/node.exe"
|
||||
if ! [ -x "$NODE_EXE" ]; then
|
||||
NODE_EXE="$basedir/node"
|
||||
fi
|
||||
if ! [ -x "$NODE_EXE" ]; then
|
||||
NODE_EXE=node
|
||||
fi
|
||||
|
||||
NPM_CLI_JS="$basedir/node_modules/npm/bin/npm-cli.js"
|
||||
|
||||
case `uname` in
|
||||
*MINGW*)
|
||||
NPM_PREFIX=`"$NODE_EXE" "$NPM_CLI_JS" prefix -g`
|
||||
NPM_PREFIX_NPM_CLI_JS="$NPM_PREFIX/node_modules/npm/bin/npm-cli.js"
|
||||
if [ -f "$NPM_PREFIX_NPM_CLI_JS" ]; then
|
||||
NPM_CLI_JS="$NPM_PREFIX_NPM_CLI_JS"
|
||||
fi
|
||||
;;
|
||||
*CYGWIN*)
|
||||
NPM_PREFIX=`"$NODE_EXE" "$NPM_CLI_JS" prefix -g`
|
||||
NPM_PREFIX_NPM_CLI_JS="$NPM_PREFIX/node_modules/npm/bin/npm-cli.js"
|
||||
if [ -f "$NPM_PREFIX_NPM_CLI_JS" ]; then
|
||||
NPM_CLI_JS="$NPM_PREFIX_NPM_CLI_JS"
|
||||
fi
|
||||
;;
|
||||
esac
|
||||
|
||||
"$NODE_EXE" "$NPM_CLI_JS" "$@"
|
||||
@ -0,0 +1,153 @@
|
||||
#!/usr/bin/env node
|
||||
;(function () { // wrapper in case we're in module_context mode
|
||||
// windows: running "npm blah" in this folder will invoke WSH, not node.
|
||||
/* global WScript */
|
||||
if (typeof WScript !== 'undefined') {
|
||||
WScript.echo(
|
||||
'npm does not work when run\n' +
|
||||
'with the Windows Scripting Host\n\n' +
|
||||
"'cd' to a different directory,\n" +
|
||||
"or type 'npm.cmd <args>',\n" +
|
||||
"or type 'node npm <args>'."
|
||||
)
|
||||
WScript.quit(1)
|
||||
return
|
||||
}
|
||||
|
||||
process.title = 'npm'
|
||||
|
||||
var unsupported = require('../lib/utils/unsupported.js')
|
||||
unsupported.checkForBrokenNode()
|
||||
|
||||
var log = require('npmlog')
|
||||
log.pause() // will be unpaused when config is loaded.
|
||||
log.info('it worked if it ends with', 'ok')
|
||||
|
||||
unsupported.checkForUnsupportedNode()
|
||||
|
||||
var npm = require('../lib/npm.js')
|
||||
var npmconf = require('../lib/config/core.js')
|
||||
var errorHandler = require('../lib/utils/error-handler.js')
|
||||
|
||||
var configDefs = npmconf.defs
|
||||
var shorthands = configDefs.shorthands
|
||||
var types = configDefs.types
|
||||
var nopt = require('nopt')
|
||||
|
||||
// if npm is called as "npmg" or "npm_g", then
|
||||
// run in global mode.
|
||||
if (process.argv[1][process.argv[1].length - 1] === 'g') {
|
||||
process.argv.splice(1, 1, 'npm', '-g')
|
||||
}
|
||||
|
||||
log.verbose('cli', process.argv)
|
||||
|
||||
var conf = nopt(types, shorthands)
|
||||
npm.argv = conf.argv.remain
|
||||
if (npm.deref(npm.argv[0])) npm.command = npm.argv.shift()
|
||||
else conf.usage = true
|
||||
|
||||
if (conf.version) {
|
||||
console.log(npm.version)
|
||||
return errorHandler.exit(0)
|
||||
}
|
||||
|
||||
if (conf.versions) {
|
||||
npm.command = 'version'
|
||||
conf.usage = false
|
||||
npm.argv = []
|
||||
}
|
||||
|
||||
log.info('using', 'npm@%s', npm.version)
|
||||
log.info('using', 'node@%s', process.version)
|
||||
|
||||
process.on('uncaughtException', errorHandler)
|
||||
process.on('unhandledRejection', errorHandler)
|
||||
|
||||
if (conf.usage && npm.command !== 'help') {
|
||||
npm.argv.unshift(npm.command)
|
||||
npm.command = 'help'
|
||||
}
|
||||
|
||||
var isGlobalNpmUpdate = conf.global && ['install', 'update'].includes(npm.command) && npm.argv.includes('npm')
|
||||
|
||||
// now actually fire up npm and run the command.
|
||||
// this is how to use npm programmatically:
|
||||
conf._exit = true
|
||||
npm.load(conf, function (er) {
|
||||
if (er) return errorHandler(er)
|
||||
if (
|
||||
!isGlobalNpmUpdate &&
|
||||
npm.config.get('update-notifier') &&
|
||||
!unsupported.checkVersion(process.version).unsupported
|
||||
) {
|
||||
const pkg = require('../package.json')
|
||||
let notifier = require('update-notifier')({pkg})
|
||||
const isCI = require('ci-info').isCI
|
||||
if (
|
||||
notifier.update &&
|
||||
notifier.update.latest !== pkg.version &&
|
||||
!isCI
|
||||
) {
|
||||
const color = require('ansicolors')
|
||||
const useColor = npm.config.get('color')
|
||||
const useUnicode = npm.config.get('unicode')
|
||||
const old = notifier.update.current
|
||||
const latest = notifier.update.latest
|
||||
let type = notifier.update.type
|
||||
if (useColor) {
|
||||
switch (type) {
|
||||
case 'major':
|
||||
type = color.red(type)
|
||||
break
|
||||
case 'minor':
|
||||
type = color.yellow(type)
|
||||
break
|
||||
case 'patch':
|
||||
type = color.green(type)
|
||||
break
|
||||
}
|
||||
}
|
||||
const changelog = `https://github.com/npm/cli/releases/tag/v${latest}`
|
||||
notifier.notify({
|
||||
message: `New ${type} version of ${pkg.name} available! ${
|
||||
useColor ? color.red(old) : old
|
||||
} ${useUnicode ? '→' : '->'} ${
|
||||
useColor ? color.green(latest) : latest
|
||||
}\n` +
|
||||
`${
|
||||
useColor ? color.yellow('Changelog:') : 'Changelog:'
|
||||
} ${
|
||||
useColor ? color.cyan(changelog) : changelog
|
||||
}\n` +
|
||||
`Run ${
|
||||
useColor
|
||||
? color.green(`npm install -g ${pkg.name}`)
|
||||
: `npm i -g ${pkg.name}`
|
||||
} to update!`
|
||||
})
|
||||
}
|
||||
}
|
||||
npm.commands[npm.command](npm.argv, function (err) {
|
||||
// https://genius.com/Lin-manuel-miranda-your-obedient-servant-lyrics
|
||||
if (
|
||||
!err &&
|
||||
npm.config.get('ham-it-up') &&
|
||||
!npm.config.get('json') &&
|
||||
!npm.config.get('parseable') &&
|
||||
npm.command !== 'completion'
|
||||
) {
|
||||
console.error(
|
||||
`\n ${
|
||||
npm.config.get('unicode') ? '🎵 ' : ''
|
||||
} I Have the Honour to Be Your Obedient Servant,${
|
||||
npm.config.get('unicode') ? '🎵 ' : ''
|
||||
} ~ npm ${
|
||||
npm.config.get('unicode') ? '📜🖋 ' : ''
|
||||
}\n`
|
||||
)
|
||||
}
|
||||
errorHandler.apply(this, arguments)
|
||||
})
|
||||
})
|
||||
})()
|
||||
@ -0,0 +1,19 @@
|
||||
:: Created by npm, please don't edit manually.
|
||||
@ECHO OFF
|
||||
|
||||
SETLOCAL
|
||||
|
||||
SET "NODE_EXE=%~dp0\node.exe"
|
||||
IF NOT EXIST "%NODE_EXE%" (
|
||||
SET "NODE_EXE=node"
|
||||
)
|
||||
|
||||
SET "NPM_CLI_JS=%~dp0\node_modules\npm\bin\npm-cli.js"
|
||||
FOR /F "delims=" %%F IN ('CALL "%NODE_EXE%" "%NPM_CLI_JS%" prefix -g') DO (
|
||||
SET "NPM_PREFIX_NPM_CLI_JS=%%F\node_modules\npm\bin\npm-cli.js"
|
||||
)
|
||||
IF EXIST "%NPM_PREFIX_NPM_CLI_JS%" (
|
||||
SET "NPM_CLI_JS=%NPM_PREFIX_NPM_CLI_JS%"
|
||||
)
|
||||
|
||||
"%NODE_EXE%" "%NPM_CLI_JS%" %*
|
||||
@ -0,0 +1,35 @@
|
||||
#!/bin/sh
|
||||
(set -o igncr) 2>/dev/null && set -o igncr; # cygwin encoding fix
|
||||
|
||||
basedir=`dirname "$0"`
|
||||
|
||||
case `uname` in
|
||||
*CYGWIN*) basedir=`cygpath -w "$basedir"`;;
|
||||
esac
|
||||
|
||||
NODE_EXE="$basedir/node.exe"
|
||||
if ! [ -x "$NODE_EXE" ]; then
|
||||
NODE_EXE=node
|
||||
fi
|
||||
|
||||
NPM_CLI_JS="$basedir/node_modules/npm/bin/npm-cli.js"
|
||||
NPX_CLI_JS="$basedir/node_modules/npm/bin/npx-cli.js"
|
||||
|
||||
case `uname` in
|
||||
*MINGW*)
|
||||
NPM_PREFIX=`"$NODE_EXE" "$NPM_CLI_JS" prefix -g`
|
||||
NPM_PREFIX_NPX_CLI_JS="$NPM_PREFIX/node_modules/npm/bin/npx-cli.js"
|
||||
if [ -f "$NPM_PREFIX_NPX_CLI_JS" ]; then
|
||||
NPX_CLI_JS="$NPM_PREFIX_NPX_CLI_JS"
|
||||
fi
|
||||
;;
|
||||
*CYGWIN*)
|
||||
NPM_PREFIX=`"$NODE_EXE" "$NPM_CLI_JS" prefix -g`
|
||||
NPM_PREFIX_NPX_CLI_JS="$NPM_PREFIX/node_modules/npm/bin/npx-cli.js"
|
||||
if [ -f "$NPM_PREFIX_NPX_CLI_JS" ]; then
|
||||
NPX_CLI_JS="$NPM_PREFIX_NPX_CLI_JS"
|
||||
fi
|
||||
;;
|
||||
esac
|
||||
|
||||
"$NODE_EXE" "$NPX_CLI_JS" "$@"
|
||||
@ -0,0 +1,8 @@
|
||||
#!/usr/bin/env node
|
||||
|
||||
const npx = require('libnpx')
|
||||
const path = require('path')
|
||||
|
||||
const NPM_PATH = path.join(__dirname, 'npm-cli.js')
|
||||
|
||||
npx(npx.parseArgs(process.argv, NPM_PATH))
|
||||
@ -0,0 +1,20 @@
|
||||
:: Created by npm, please don't edit manually.
|
||||
@ECHO OFF
|
||||
|
||||
SETLOCAL
|
||||
|
||||
SET "NODE_EXE=%~dp0\node.exe"
|
||||
IF NOT EXIST "%NODE_EXE%" (
|
||||
SET "NODE_EXE=node"
|
||||
)
|
||||
|
||||
SET "NPM_CLI_JS=%~dp0\node_modules\npm\bin\npm-cli.js"
|
||||
SET "NPX_CLI_JS=%~dp0\node_modules\npm\bin\npx-cli.js"
|
||||
FOR /F "delims=" %%F IN ('CALL "%NODE_EXE%" "%NPM_CLI_JS%" prefix -g') DO (
|
||||
SET "NPM_PREFIX_NPX_CLI_JS=%%F\node_modules\npm\bin\npx-cli.js"
|
||||
)
|
||||
IF EXIST "%NPM_PREFIX_NPX_CLI_JS%" (
|
||||
SET "NPX_CLI_JS=%NPM_PREFIX_NPX_CLI_JS%"
|
||||
)
|
||||
|
||||
"%NODE_EXE%" "%NPX_CLI_JS%" %*
|
||||
@ -0,0 +1,743 @@
|
||||
### v1.4.29 (2015-10-29):
|
||||
|
||||
#### THINGS ARE HAPPENING IN LTS LAND
|
||||
|
||||
In a special one-off release as part of the [strategy to get a version of npm
|
||||
into Node LTS that works with the current
|
||||
registry](https://github.com/nodejs/LTS/issues/37), modify npm to print out
|
||||
this deprecation banner literally every time npm is invoked to do anything:
|
||||
|
||||
```
|
||||
npm WARN deprecated This version of npm lacks support for important features,
|
||||
npm WARN deprecated such as scoped packages, offered by the primary npm
|
||||
npm WARN deprecated registry. Consider upgrading to at least npm@2, if not the
|
||||
npm WARN deprecated latest stable version. To upgrade to npm@2, run:
|
||||
npm WARN deprecated
|
||||
npm WARN deprecated npm -g install npm@latest-2
|
||||
npm WARN deprecated
|
||||
npm WARN deprecated To upgrade to the latest stable version, run:
|
||||
npm WARN deprecated
|
||||
npm WARN deprecated npm -g install npm@latest
|
||||
npm WARN deprecated
|
||||
npm WARN deprecated (Depending on how Node.js was installed on your system, you
|
||||
npm WARN deprecated may need to prefix the preceding commands with `sudo`, or if
|
||||
npm WARN deprecated on Windows, run them from an Administrator prompt.)
|
||||
npm WARN deprecated
|
||||
npm WARN deprecated If you're running the version of npm bundled with
|
||||
npm WARN deprecated Node.js 0.10 LTS, be aware that the next version of 0.10 LTS
|
||||
npm WARN deprecated will be bundled with a version of npm@2, which has some small
|
||||
npm WARN deprecated backwards-incompatible changes made to `npm run-script` and
|
||||
npm WARN deprecated semver behavior.
|
||||
```
|
||||
|
||||
The message basically tells the tale: Node 0.10 will finally be getting
|
||||
`npm@2`, so those of you who haven't upgraded your build systems to deal with
|
||||
its (relatively small) breaking changes should do so now.
|
||||
|
||||
Also, this version doesn't even pretend that it can deal with scoped packages,
|
||||
which, given the confusing behavior of older versions of `npm@1.4`, where it
|
||||
would sometimes try to install packages from GitHub, is a distinct improvement.
|
||||
|
||||
There is no good reason for you as an end user to upgrade to this version of
|
||||
npm yourself.
|
||||
|
||||
* [`709e9b4`](https://github.com/npm/npm/commit/709e9b44f5df9817a1c4babfbf26a2329bd265fb)
|
||||
Print 20-line deprecation banner on all command invocations.
|
||||
([@othiym23](https://github.com/othiym23))
|
||||
* [`0c29d09`](https://github.com/npm/npm/commit/0c29d0906608e8e174bd30a7a245e19795326051)
|
||||
Crash out immediately with an exhortation to upgrade on attempts to use
|
||||
scoped packages. ([@othiym23](https://github.com/othiym23))
|
||||
|
||||
### v1.5.0-alpha-4 (2014-07-18):
|
||||
|
||||
* fall back to `_auth` config as default auth when using default registry
|
||||
([@isaacs](https://github.com/isaacs))
|
||||
* support for 'init.version' for those who don't want to deal with semver 0.0.x
|
||||
oddities ([@rvagg](https://github.com/rvagg))
|
||||
* [`be06213`](https://github.com/npm/npm/commit/be06213415f2d51a50d2c792b4cd0d3412a9a7b1)
|
||||
remove residual support for `win` log level
|
||||
([@aterris](https://github.com/aterris))
|
||||
|
||||
### v1.5.0-alpha-3 (2014-07-17):
|
||||
|
||||
* [`a3a85dd`](https://github.com/npm/npm/commit/a3a85dd004c9245a71ad2f0213bd1a9a90d64cd6)
|
||||
`--save` scoped packages correctly ([@othiym23](https://github.com/othiym23))
|
||||
* [`18a3385`](https://github.com/npm/npm/commit/18a3385bcf8bfb8312239216afbffb7eec759150)
|
||||
`npm-registry-client@3.0.2` ([@othiym23](https://github.com/othiym23))
|
||||
* [`375988b`](https://github.com/npm/npm/commit/375988b9bf5aa5170f06a790d624d31b1eb32c6d)
|
||||
invalid package names are an early error for optional deps
|
||||
([@othiym23](https://github.com/othiym23))
|
||||
* consistently use `node-package-arg` instead of arbitrary package spec
|
||||
splitting ([@othiym23](https://github.com/othiym23))
|
||||
|
||||
### v1.5.0-alpha-2 (2014-07-01):
|
||||
|
||||
* [`54cf625`](https://github.com/npm/npm/commit/54cf62534e3331e3f454e609e44f0b944e819283)
|
||||
fix handling for 301s in `npm-registry-client@3.0.1`
|
||||
([@Raynos](https://github.com/Raynos))
|
||||
* [`e410861`](https://github.com/npm/npm/commit/e410861c69a3799c1874614cb5b87af8124ff98d)
|
||||
don't crash if no username set on `whoami`
|
||||
([@isaacs](https://github.com/isaacs))
|
||||
* [`0353dde`](https://github.com/npm/npm/commit/0353ddeaca8171aa7dbdd8102b7e2eb581a86406)
|
||||
respect `--json` for output ([@isaacs](https://github.com/isaacs))
|
||||
* [`b3d112a`](https://github.com/npm/npm/commit/b3d112ae190b984cc1779b9e6de92218f22380c6)
|
||||
outdated: Don't show headings if there's nothing to output
|
||||
([@isaacs](https://github.com/isaacs))
|
||||
* [`bb4b90c`](https://github.com/npm/npm/commit/bb4b90c80dbf906a1cb26d85bc0625dc2758acc3)
|
||||
outdated: Default to `latest` rather than `*` for unspecified deps
|
||||
([@isaacs](https://github.com/isaacs))
|
||||
|
||||
### v1.5.0-alpha-1 (2014-07-01):
|
||||
|
||||
* [`eef4884`](https://github.com/npm/npm/commit/eef4884d6487ee029813e60a5f9c54e67925d9fa)
|
||||
use the correct piece of the spec for GitHub shortcuts
|
||||
([@othiym23](https://github.com/othiym23))
|
||||
|
||||
### v1.5.0-alpha-0 (2014-07-01):
|
||||
|
||||
* [`7f55057`](https://github.com/npm/npm/commit/7f55057807cfdd9ceaf6331968e666424f48116c)
|
||||
install scoped packages ([#5239](https://github.com/npm/npm/issues/5239))
|
||||
([@othiym23](https://github.com/othiym23))
|
||||
* [`0df7e16`](https://github.com/npm/npm/commit/0df7e16c0232d8f4d036ebf4ec3563215517caac)
|
||||
publish scoped packages ([#5239](https://github.com/npm/npm/issues/5239))
|
||||
([@othiym23](https://github.com/othiym23))
|
||||
* [`0689ba2`](https://github.com/npm/npm/commit/0689ba249b92b4c6279a26804c96af6f92b3a501)
|
||||
support (and save) --scope=@s config
|
||||
([@othiym23](https://github.com/othiym23))
|
||||
* [`f34878f`](https://github.com/npm/npm/commit/f34878fc4cee29901e4daf7bace94be01e25cad7)
|
||||
scope credentials to registry ([@othiym23](https://github.com/othiym23))
|
||||
* [`0ac7ca2`](https://github.com/npm/npm/commit/0ac7ca233f7a69751fe4386af6c4daa3ee9fc0da)
|
||||
capture and store bearer tokens when sent by registry
|
||||
([@othiym23](https://github.com/othiym23))
|
||||
* [`63c3277`](https://github.com/npm/npm/commit/63c3277f089b2c4417e922826bdc313ac854cad6)
|
||||
only delete files that are created by npm
|
||||
([@othiym23](https://github.com/othiym23))
|
||||
* [`4f54043`](https://github.com/npm/npm/commit/4f540437091d1cbca3915cd20c2da83c2a88bb8e)
|
||||
`npm-package-arg@2.0.0` ([@othiym23](https://github.com/othiym23))
|
||||
* [`9e1460e`](https://github.com/npm/npm/commit/9e1460e6ac9433019758481ec031358f4af4cd44)
|
||||
`read-package-json@1.2.3` ([@othiym23](https://github.com/othiym23))
|
||||
* [`719d8ad`](https://github.com/npm/npm/commit/719d8adb9082401f905ff4207ede494661f8a554)
|
||||
`fs-vacuum@1.2.1` ([@othiym23](https://github.com/othiym23))
|
||||
* [`9ef8fe4`](https://github.com/npm/npm/commit/9ef8fe4d6ead3acb3e88c712000e2d3a9480ebec)
|
||||
`async-some@1.0.0` ([@othiym23](https://github.com/othiym23))
|
||||
* [`a964f65`](https://github.com/npm/npm/commit/a964f65ab662107b62a4ca58535ce817e8cca331)
|
||||
`npmconf@2.0.1` ([@othiym23](https://github.com/othiym23))
|
||||
* [`113765b`](https://github.com/npm/npm/commit/113765bfb7d3801917c1d9f124b8b3d942bec89a)
|
||||
`npm-registry-client@3.0.0` ([@othiym23](https://github.com/othiym23))
|
||||
|
||||
### v1.4.28 (2014-09-12):
|
||||
|
||||
* [`f4540b6`](https://github.com/npm/npm/commit/f4540b6537a87e653d7495a9ddcf72949fdd4d14)
|
||||
[#6043](https://github.com/npm/npm/issues/6043) defer rollbacks until just
|
||||
before the CLI exits ([@isaacs](https://github.com/isaacs))
|
||||
* [`1eabfd5`](https://github.com/npm/npm/commit/1eabfd5c03f33c2bd28823714ff02059eeee3899)
|
||||
[#6043](https://github.com/npm/npm/issues/6043) `slide@1.1.6`: wait until all
|
||||
callbacks have finished before proceeding
|
||||
([@othiym23](https://github.com/othiym23))
|
||||
|
||||
### v1.4.27 (2014-09-04):
|
||||
|
||||
* [`4cf3c8f`](https://github.com/npm/npm/commit/4cf3c8fd78c9e2693a5f899f50c28f4823c88e2e)
|
||||
[#6007](https://github.com/npm/npm/issues/6007) request@2.42.0: properly set
|
||||
headers on proxy requests ([@isaacs](https://github.com/isaacs))
|
||||
* [`403cb52`](https://github.com/npm/npm/commit/403cb526be1472bb7545fa8e62d4976382cdbbe5)
|
||||
[#6055](https://github.com/npm/npm/issues/6055) npmconf@1.1.8: restore
|
||||
case-insensitivity of environmental config
|
||||
([@iarna](https://github.com/iarna))
|
||||
|
||||
### v1.4.26 (2014-08-28):
|
||||
|
||||
* [`eceea95`](https://github.com/npm/npm/commit/eceea95c804fa15b18e91c52c0beb08d42a3e77d)
|
||||
`github-url-from-git@1.4.0`: add support for git+https and git+ssh
|
||||
([@stefanbuck](https://github.com/stefanbuck))
|
||||
* [`e561758`](https://github.com/npm/npm/commit/e5617587e7d7ab686192391ce55357dbc7fed0a3)
|
||||
`columnify@1.2.1` ([@othiym23](https://github.com/othiym23))
|
||||
* [`0c4fab3`](https://github.com/npm/npm/commit/0c4fab372ee76eab01dda83b6749429a8564902e)
|
||||
`cmd-shim@2.0.0`: upgrade to graceful-fs 3
|
||||
([@ForbesLindesay](https://github.com/ForbesLindesay))
|
||||
* [`2d69e4d`](https://github.com/npm/npm/commit/2d69e4d95777671958b5e08d3b2f5844109d73e4)
|
||||
`github-url-from-username-repo@1.0.0`: accept slashes in branch names
|
||||
([@robertkowalski](https://github.com/robertkowalski))
|
||||
* [`81f9b2b`](https://github.com/npm/npm/commit/81f9b2bac9d34c223ea093281ba3c495f23f10d1)
|
||||
ensure lifecycle spawn errors caught properly
|
||||
([@isaacs](https://github.com/isaacs))
|
||||
* [`bfaab8c`](https://github.com/npm/npm/commit/bfaab8c6e0942382a96b250634ded22454c36b5a)
|
||||
`npm-registry-client@2.0.7`: properly encode % in passwords
|
||||
([@isaacs](https://github.com/isaacs))
|
||||
* [`91cfb58`](https://github.com/npm/npm/commit/91cfb58dda851377ec604782263519f01fd96ad8)
|
||||
doc: Fix 'npm help index' ([@isaacs](https://github.com/isaacs))
|
||||
|
||||
### v1.4.25 (2014-08-21):
|
||||
|
||||
* [`64c0ec2`](https://github.com/npm/npm/commit/64c0ec241ef5d83761ca8de54acb3c41b079956e)
|
||||
`npm-registry-client@2.0.6`: Print the notification header returned by the
|
||||
registry, and make sure status codes are printed without gratuitous quotes
|
||||
around them.
|
||||
([@othiym23](https://github.com/othiym23))
|
||||
* [`a8ed12b`](https://github.com/npm/npm/commit/a8ed12b) `tar@1.0.1`:
|
||||
Add test for removing an extract target immediately after unpacking.
|
||||
([@isaacs](https://github.com/isaacs))
|
||||
* [`70fd11d`](https://github.com/npm/npm/commit/70fd11d)
|
||||
`lockfile@1.0.0`: Fix incorrect interaction between `wait`, `stale`,
|
||||
and `retries` options. Part 2 of race condition leading to `ENOENT`
|
||||
errors.
|
||||
([@isaacs](https://github.com/isaacs))
|
||||
* [`0072c4d`](https://github.com/npm/npm/commit/0072c4d)
|
||||
`fstream@1.0.2`: Fix a double-finish call which can result in excess
|
||||
FS operations after the `close` event. Part 2 of race condition
|
||||
leading to `ENOENT` errors.
|
||||
([@isaacs](https://github.com/isaacs))
|
||||
|
||||
### v1.4.24 (2014-08-14):
|
||||
|
||||
* [`9344bd9`](https://github.com/npm/npm/commit/9344bd9b2929b5c399a0e0e0b34d45bce7bc24bb)
|
||||
doc: add new changelog ([@othiym23](https://github.com/othiym23))
|
||||
* [`4be76fd`](https://github.com/npm/npm/commit/4be76fd65e895883c337a99f275ccc8c801adda3)
|
||||
doc: update version doc to include `pre-*` increment args
|
||||
([@isaacs](https://github.com/isaacs))
|
||||
* [`e4f2620`](https://github.com/npm/npm/commit/e4f262036080a282ad60e236a9aeebd39fde9fe4)
|
||||
build: add `make tag` to tag current release as `latest`
|
||||
([@isaacs](https://github.com/isaacs))
|
||||
* [`ec2596a`](https://github.com/npm/npm/commit/ec2596a7cb626772780b25b0a94a7e547a812bd5)
|
||||
build: publish with `--tag=v1.4-next` ([@isaacs](https://github.com/isaacs))
|
||||
* [`9ee55f8`](https://github.com/npm/npm/commit/9ee55f892b8b473032a43c59912c5684fd1b39e6)
|
||||
build: add script to output `v1.4-next` publish tag
|
||||
([@isaacs](https://github.com/isaacs))
|
||||
* [`aecb56f`](https://github.com/npm/npm/commit/aecb56f95a84687ea46920a0b98aaa587fee1568)
|
||||
build: remove outdated `docpublish` make target
|
||||
([@isaacs](https://github.com/isaacs))
|
||||
* [`b57a9b7`](https://github.com/npm/npm/commit/b57a9b7ccd13e6b38831ed63595c8ea5763da247)
|
||||
build: remove unpublish step from `make publish`
|
||||
([@isaacs](https://github.com/isaacs))
|
||||
* [`2c6acb9`](https://github.com/npm/npm/commit/2c6acb96c71c16106965d5cd829b67195dd673c7)
|
||||
install: rename `.gitignore` when unpacking foreign tarballs
|
||||
([@isaacs](https://github.com/isaacs))
|
||||
* [`22f3681`](https://github.com/npm/npm/commit/22f3681923e993a47fc1769ba735bfa3dd138082)
|
||||
cache: detect non-gzipped tar files more reliably
|
||||
([@isaacs](https://github.com/isaacs))
|
||||
|
||||
### v1.4.23 (2014-07-31):
|
||||
|
||||
* [`8dd11d1`](https://github.com/npm/npm/commit/8dd11d1) update several
|
||||
dependencies to avoid using `semver`s starting with 0.
|
||||
|
||||
### v1.4.22 (2014-07-31):
|
||||
|
||||
* [`d9a9e84`](https://github.com/npm/npm/commit/d9a9e84) `read-package-json@1.2.4`
|
||||
([@isaacs](https://github.com/isaacs))
|
||||
* [`86f0340`](https://github.com/npm/npm/commit/86f0340)
|
||||
`github-url-from-git@1.2.0` ([@isaacs](https://github.com/isaacs))
|
||||
* [`a94136a`](https://github.com/npm/npm/commit/a94136a) `fstream@0.1.29`
|
||||
([@isaacs](https://github.com/isaacs))
|
||||
* [`bb82d18`](https://github.com/npm/npm/commit/bb82d18) `glob@4.0.5`
|
||||
([@isaacs](https://github.com/isaacs))
|
||||
* [`5b6bcf4`](https://github.com/npm/npm/commit/5b6bcf4) `cmd-shim@1.1.2`
|
||||
([@isaacs](https://github.com/isaacs))
|
||||
* [`c2aa8b3`](https://github.com/npm/npm/commit/c2aa8b3) license: Cleaned up
|
||||
legalese with actual lawyer ([@isaacs](https://github.com/isaacs))
|
||||
* [`63fe0ee`](https://github.com/npm/npm/commit/63fe0ee) `init-package-json@1.0.0`
|
||||
([@isaacs](https://github.com/isaacs))
|
||||
|
||||
### v1.4.21 (2014-07-14):
|
||||
|
||||
* [`88f51aa`](https://github.com/npm/npm/commit/88f51aa27eb9a958d1fa7ec50fee5cfdedd05110)
|
||||
fix handling for 301s in `npm-registry-client@2.0.3`
|
||||
([@Raynos](https://github.com/Raynos))
|
||||
|
||||
### v1.4.20 (2014-07-02):
|
||||
|
||||
* [`0353dde`](https://github.com/npm/npm/commit/0353ddeaca8171aa7dbdd8102b7e2eb581a86406)
|
||||
respect `--json` for output ([@isaacs](https://github.com/isaacs))
|
||||
* [`b3d112a`](https://github.com/npm/npm/commit/b3d112ae190b984cc1779b9e6de92218f22380c6)
|
||||
outdated: Don't show headings if there's nothing to output
|
||||
([@isaacs](https://github.com/isaacs))
|
||||
* [`bb4b90c`](https://github.com/npm/npm/commit/bb4b90c80dbf906a1cb26d85bc0625dc2758acc3)
|
||||
outdated: Default to `latest` rather than `*` for unspecified deps
|
||||
([@isaacs](https://github.com/isaacs))
|
||||
|
||||
### v1.4.19 (2014-07-01):
|
||||
|
||||
* [`f687433`](https://github.com/npm/npm/commit/f687433) relative URLS for
|
||||
working non-root registry URLS ([@othiym23](https://github.com/othiym23))
|
||||
* [`bea190c`](https://github.com/npm/npm/commit/bea190c)
|
||||
[#5591](https://github.com/npm/npm/issues/5591) bump nopt and npmconf
|
||||
([@isaacs](https://github.com/isaacs))
|
||||
|
||||
### v1.4.18 (2014-06-29):
|
||||
|
||||
* Bump glob dependency from 4.0.2 to 4.0.3. It now uses graceful-fs when
|
||||
available, increasing resilience to [various filesystem
|
||||
errors](https://github.com/isaacs/node-graceful-fs#improvements-over-fs-module).
|
||||
([@isaacs](https://github.com/isaacs))
|
||||
|
||||
### v1.4.17 (2014-06-27):
|
||||
|
||||
* replace escape codes with ansicolors
|
||||
([@othiym23](https://github.com/othiym23))
|
||||
* Allow to build all the docs OOTB. ([@GeJ](https://github.com/GeJ))
|
||||
* Use core.longpaths on win32 git - fixes
|
||||
[#5525](https://github.com/npm/npm/issues/5525) ([@bmeck](https://github.com/bmeck))
|
||||
* `npmconf@1.1.2` ([@isaacs](https://github.com/isaacs))
|
||||
* Consolidate color sniffing in config/log loading process
|
||||
([@isaacs](https://github.com/isaacs))
|
||||
* add verbose log when project config file is ignored
|
||||
([@isaacs](https://github.com/isaacs))
|
||||
* npmconf: Float patch to remove 'scope' from config defs
|
||||
([@isaacs](https://github.com/isaacs))
|
||||
* doc: npm-explore can't handle a version
|
||||
([@robertkowalski](https://github.com/robertkowalski))
|
||||
* Add user-friendly errors for ENOSPC and EROFS.
|
||||
([@voodootikigod](https://github.com/voodootikigod))
|
||||
* bump tar and fstream deps ([@isaacs](https://github.com/isaacs))
|
||||
* Run the npm-registry-couchapp tests along with npm tests
|
||||
([@isaacs](https://github.com/isaacs))
|
||||
|
||||
### v1.2.8000 (2014-06-17):
|
||||
|
||||
* Same as v1.4.16, but with the spinner disabled, and a version number that
|
||||
starts with v1.2.
|
||||
|
||||
### v1.4.16 (2014-06-17):
|
||||
|
||||
* `npm-registry-client@2.0.2` ([@isaacs](https://github.com/isaacs))
|
||||
* `fstream@0.1.27` ([@isaacs](https://github.com/isaacs))
|
||||
* `sha@1.2.4` ([@isaacs](https://github.com/isaacs))
|
||||
* `rimraf@2.2.8` ([@isaacs](https://github.com/isaacs))
|
||||
* `npmlog@1.0.1` ([@isaacs](https://github.com/isaacs))
|
||||
* `npm-registry-client@2.0.1` ([@isaacs](https://github.com/isaacs))
|
||||
* removed redundant dependency ([@othiym23](https://github.com/othiym23))
|
||||
* `npmconf@1.0.5` ([@isaacs](https://github.com/isaacs))
|
||||
* Properly handle errors that can occur in the config-loading process
|
||||
([@isaacs](https://github.com/isaacs))
|
||||
|
||||
### v1.4.15 (2014-06-10):
|
||||
|
||||
* cache: atomic de-race-ified package.json writing
|
||||
([@isaacs](https://github.com/isaacs))
|
||||
* `fstream@0.1.26` ([@isaacs](https://github.com/isaacs))
|
||||
* `graceful-fs@3.0.2` ([@isaacs](https://github.com/isaacs))
|
||||
* `osenv@0.1.0` ([@isaacs](https://github.com/isaacs))
|
||||
* Only spin the spinner when we're fetching stuff
|
||||
([@isaacs](https://github.com/isaacs))
|
||||
* Update `osenv@0.1.0` which removes ~/tmp as possible tmp-folder
|
||||
([@robertkowalski](https://github.com/robertkowalski))
|
||||
* `ini@1.2.1` ([@isaacs](https://github.com/isaacs))
|
||||
* `graceful-fs@3` ([@isaacs](https://github.com/isaacs))
|
||||
* Update glob and things depending on glob
|
||||
([@isaacs](https://github.com/isaacs))
|
||||
* github-url-from-username-repo and read-package-json updates
|
||||
([@isaacs](https://github.com/isaacs))
|
||||
* `editor@0.1.0` ([@isaacs](https://github.com/isaacs))
|
||||
* `columnify@1.1.0` ([@isaacs](https://github.com/isaacs))
|
||||
* bump ansi and associated deps ([@isaacs](https://github.com/isaacs))
|
||||
|
||||
### v1.4.14 (2014-06-05):
|
||||
|
||||
* char-spinner: update to not bork windows
|
||||
([@isaacs](https://github.com/isaacs))
|
||||
|
||||
### v1.4.13 (2014-05-23):
|
||||
|
||||
* Fix `npm install` on a tarball.
|
||||
([`ed3abf1`](https://github.com/npm/npm/commit/ed3abf1aa10000f0f687330e976d78d1955557f6),
|
||||
[#5330](https://github.com/npm/npm/issues/5330),
|
||||
[@othiym23](https://github.com/othiym23))
|
||||
* Fix an issue with the spinner on Node 0.8.
|
||||
([`9f00306`](https://github.com/npm/npm/commit/9f003067909440390198c0b8f92560d84da37762),
|
||||
[@isaacs](https://github.com/isaacs))
|
||||
* Re-add `npm.commands.cache.clean` and `npm.commands.cache.read` APIs, and
|
||||
document `npm.commands.cache.*` as npm-cache(3).
|
||||
([`e06799e`](https://github.com/npm/npm/commit/e06799e77e60c1fc51869619083a25e074d368b3),
|
||||
[@isaacs](https://github.com/isaacs))
|
||||
|
||||
### v1.4.12 (2014-05-23):
|
||||
|
||||
* remove normalize-package-data from top level, de-^-ify inflight dep
|
||||
([@isaacs](https://github.com/isaacs))
|
||||
* Always sort saved bundleDependencies ([@isaacs](https://github.com/isaacs))
|
||||
* add inflight to bundledDependencies
|
||||
([@othiym23](https://github.com/othiym23))
|
||||
|
||||
### v1.4.11 (2014-05-22):
|
||||
|
||||
* fix `npm ls` labeling issue
|
||||
* `node-gyp@0.13.1`
|
||||
* default repository to https:// instead of git://
|
||||
* addLocalTarball: Remove extraneous unpack
|
||||
([@isaacs](https://github.com/isaacs))
|
||||
* Massive cache folder refactor ([@othiym23](https://github.com/othiym23) and
|
||||
[@isaacs](https://github.com/isaacs))
|
||||
* Busy Spinner, no http noise ([@isaacs](https://github.com/isaacs))
|
||||
* Per-project .npmrc file support ([@isaacs](https://github.com/isaacs))
|
||||
* `npmconf@1.0.0`, Refactor config/uid/prefix loading process
|
||||
([@isaacs](https://github.com/isaacs))
|
||||
* Allow once-disallowed characters in passwords
|
||||
([@isaacs](https://github.com/isaacs))
|
||||
* Send npm version as 'version' header ([@isaacs](https://github.com/isaacs))
|
||||
* fix cygwin encoding issue (Karsten Tinnefeld)
|
||||
* Allow non-github repositories with `npm repo`
|
||||
([@evanlucas](https://github.com/evanlucas))
|
||||
* Allow peer deps to be satisfied by grandparent
|
||||
* Stop optional deps moving into deps on `update --save`
|
||||
([@timoxley](https://github.com/timoxley))
|
||||
* Ensure only matching deps update with `update --save*`
|
||||
([@timoxley](https://github.com/timoxley))
|
||||
* Add support for `prerelease`, `preminor`, `prepatch` to `npm version`
|
||||
|
||||
### v1.4.10 (2014-05-05):
|
||||
|
||||
* Don't set referer if already set
|
||||
* fetch: Send referer and npm-session headers
|
||||
* `run-script`: Support `--parseable` and `--json`
|
||||
* list runnable scripts ([@evanlucas](https://github.com/evanlucas))
|
||||
* Use marked instead of ronn for html docs
|
||||
|
||||
### v1.4.9 (2014-05-01):
|
||||
|
||||
* Send referer header (with any potentially private stuff redacted)
|
||||
* Fix critical typo bug in previous npm release
|
||||
|
||||
### v1.4.8 (2014-05-01):
|
||||
|
||||
* Check SHA before using files from cache
|
||||
* adduser: allow change of the saved password
|
||||
* Make `npm install` respect `config.unicode`
|
||||
* Fix lifecycle to pass `Infinity` for config env value
|
||||
* Don't return 0 exit code on invalid command
|
||||
* cache: Handle 404s and other HTTP errors as errors
|
||||
* Resolve ~ in path configs to env.HOME
|
||||
* Include npm version in default user-agent conf
|
||||
* npm init: Use ISC as default license, use save-prefix for deps
|
||||
* Many test and doc fixes
|
||||
|
||||
### v1.4.7 (2014-04-15):
|
||||
|
||||
* Add `--save-prefix` option that can be used to override the default of `^`
|
||||
when using `npm install --save` and its counterparts.
|
||||
([`64eefdf`](https://github.com/npm/npm/commit/64eefdfe26bb27db8dc90e3ab5d27a5ef18a4470),
|
||||
[@thlorenz](https://github.com/thlorenz))
|
||||
* Allow `--silent` to silence the echoing of commands that occurs with `npm
|
||||
run`.
|
||||
([`c95cf08`](https://github.com/npm/npm/commit/c95cf086e5b97dbb48ff95a72517b203a8f29eab),
|
||||
[@Raynos](https://github.com/Raynos))
|
||||
* Some speed improvements to the cache, which should improve install times.
|
||||
([`cb94310`](https://github.com/npm/npm/commit/cb94310a6adb18cb7b881eacb8d67171eda8b744),
|
||||
[`3b0870f`](https://github.com/npm/npm/commit/3b0870fb2f40358b3051abdab6be4319d196b99d),
|
||||
[`120f5a9`](https://github.com/npm/npm/commit/120f5a93437bbbea9249801574a2f33e44e81c33),
|
||||
[@isaacs](https://github.com/isaacs))
|
||||
* Improve ability to retry registry requests when a subset of the registry
|
||||
servers are down.
|
||||
([`4a5257d`](https://github.com/npm/npm/commit/4a5257de3870ac3dafa39667379f19f6dcd6093e),
|
||||
https://github.com/npm/npm-registry-client/commit/7686d02cb0b844626d6a401e58c0755ef3bc8432,
|
||||
[@isaacs](https://github.com/isaacs))
|
||||
* Fix marking of peer dependencies as extraneous.
|
||||
([`779b164`](https://github.com/npm/npm/commit/779b1649764607b062c031c7e5c972151b4a1754),
|
||||
https://github.com/npm/read-installed/commit/6680ba6ef235b1ca3273a00b70869798ad662ddc,
|
||||
[@isaacs](https://github.com/isaacs))
|
||||
* Fix npm crashing when doing `npm shrinkwrap` in the presence of a
|
||||
`package.json` with no dependencies.
|
||||
([`a9d9fa5`](https://github.com/npm/npm/commit/a9d9fa5ad3b8c925a589422b7be28d2735f320b0),
|
||||
[@kislyuk](https://github.com/kislyuk))
|
||||
* Fix error when using `npm view` on packages that have no versions or have
|
||||
been unpublished.
|
||||
([`94df2f5`](https://github.com/npm/npm/commit/94df2f56d684b35d1df043660180fc321b743dc8),
|
||||
[@juliangruber](https://github.com/juliangruber);
|
||||
[`2241a09`](https://github.com/npm/npm/commit/2241a09c843669c70633c399ce698cec3add40b3),
|
||||
[@isaacs](https://github.com/isaacs))
|
||||
|
||||
### v1.4.6 (2014-03-19):
|
||||
|
||||
* Fix extraneous package detection to work in more cases.
|
||||
([`f671286`](https://github.com/npm/npm/commit/f671286), npm/read-installed#20,
|
||||
[@LaurentVB](https://github.com/LaurentVB))
|
||||
|
||||
### v1.4.5 (2014-03-18):
|
||||
|
||||
* Sort dependencies in `package.json` when doing `npm install --save` and all
|
||||
its variants.
|
||||
([`6fd6ff7`](https://github.com/npm/npm/commit/6fd6ff7e536ea6acd33037b1878d4eca1f931985),
|
||||
[@domenic](https://github.com/domenic))
|
||||
* Add `--save-exact` option, usable alongside `--save` and its variants, which
|
||||
will write the exact version number into `package.json` instead of the
|
||||
appropriate semver-compatibility range.
|
||||
([`17f07df`](https://github.com/npm/npm/commit/17f07df8ad8e594304c2445bf7489cb53346f2c5),
|
||||
[@timoxley](https://github.com/timoxley))
|
||||
* Accept gzipped content from the registry to speed up downloads and save
|
||||
bandwidth.
|
||||
([`a3762de`](https://github.com/npm/npm/commit/a3762de843b842be8fa0ab57cdcd6b164f145942),
|
||||
npm/npm-registry-client#40, [@fengmk2](https://github.com/fengmk2))
|
||||
* Fix `npm ls`'s `--depth` and `--log` options.
|
||||
([`1d29b17`](https://github.com/npm/npm/commit/1d29b17f5193d52a5c4faa412a95313dcf41ed91),
|
||||
npm/read-installed#13, [@zertosh](https://github.com/zertosh))
|
||||
* Fix "Adding a cache directory to the cache will make the world implode" in
|
||||
certain cases.
|
||||
([`9a4b2c4`](https://github.com/npm/npm/commit/9a4b2c4667c2b1e0054e3d5611ab86acb1760834),
|
||||
domenic/path-is-inside#1, [@pmarques](https://github.com/pmarques))
|
||||
* Fix readmes not being uploaded in certain rare cases.
|
||||
([`527b72c`](https://github.com/npm/npm/commit/527b72cca6c55762b51e592c48a9f28cc7e2ff8b),
|
||||
[@isaacs](https://github.com/isaacs))
|
||||
|
||||
### v1.4.4 (2014-02-20):
|
||||
|
||||
* Add `npm t` as an alias for `npm test` (which is itself an alias for `npm run
|
||||
test`, or even `npm run-script test`). We like making running your tests
|
||||
easy. ([`14e650b`](https://github.com/npm/npm/commit/14e650bce0bfebba10094c961ac104a61417a5de), [@isaacs](https://github.com/isaacs))
|
||||
|
||||
### v1.4.3 (2014-02-16):
|
||||
|
||||
* Add back `npm prune --production`, which was removed in 1.3.24.
|
||||
([`acc4d02`](https://github.com/npm/npm/commit/acc4d023c57d07704b20a0955e4bf10ee91bdc83),
|
||||
[@davglass](https://github.com/davglass))
|
||||
* Default `npm install --save` and its counterparts to use the `^` version
|
||||
specifier, instead of `~`.
|
||||
([`0a3151c`](https://github.com/npm/npm/commit/0a3151c9cbeb50c1c65895685c2eabdc7e2608dc),
|
||||
[@mikolalysenko](https://github.com/mikolalysenko))
|
||||
* Make `npm shrinkwrap` output dependencies in a sorted order, so that diffs
|
||||
between shrinkwrap files should be saner now.
|
||||
([`059b2bf`](https://github.com/npm/npm/commit/059b2bfd06ae775205a37257dca80142596a0113),
|
||||
[@Raynos](https://github.com/Raynos))
|
||||
* Fix `npm dedupe` not correctly respecting dependency constraints.
|
||||
([`86028e9`](https://github.com/npm/npm/commit/86028e9fd8524d5e520ce01ba2ebab5a030103fc),
|
||||
[@rafeca](https://github.com/rafeca))
|
||||
* Fix `npm ls` giving spurious warnings when you used `"latest"` as a version
|
||||
specifier.
|
||||
(https://github.com/npm/read-installed/commit/d2956400e0386931c926e0f30c334840e0938f14,
|
||||
[@bajtos](https://github.com/bajtos))
|
||||
* Fixed a bug where using `npm link` on packages without a `name` value could
|
||||
cause npm to delete itself.
|
||||
([`401a642`](https://github.com/npm/npm/commit/401a64286aa6665a94d1d2f13604f7014c5fce87),
|
||||
[@isaacs](https://github.com/isaacs))
|
||||
* Fixed `npm install ./pkg@1.2.3` to actually install the directory at
|
||||
`pkg@1.2.3`; before it would try to find version `1.2.3` of the package
|
||||
`./pkg` in the npm registry.
|
||||
([`46d8768`](https://github.com/npm/npm/commit/46d876821d1dd94c050d5ebc86444bed12c56739),
|
||||
[@rlidwka](https://github.com/rlidwka); see also
|
||||
[`f851b79`](https://github.com/npm/npm/commit/f851b79a71d9a5f5125aa85877c94faaf91bea5f))
|
||||
* Fix `npm outdated` to respect the `color` configuration option.
|
||||
([`d4f6f3f`](https://github.com/npm/npm/commit/d4f6f3ff83bd14fb60d3ac6392cb8eb6b1c55ce1),
|
||||
[@timoxley](https://github.com/timoxley))
|
||||
* Fix `npm outdated --parseable`.
|
||||
([`9575a23`](https://github.com/npm/npm/commit/9575a23f955ce3e75b509c89504ef0bd707c8cf6),
|
||||
[@yhpark](https://github.com/yhpark))
|
||||
* Fix a lockfile-related errors when using certain Git URLs.
|
||||
([`164b97e`](https://github.com/npm/npm/commit/164b97e6089f64e686db7a9a24016f245effc37f),
|
||||
[@nigelzor](https://github.com/nigelzor))
|
||||
|
||||
### v1.4.2 (2014-02-13):
|
||||
|
||||
* Fixed an issue related to mid-publish GET requests made against the registry.
|
||||
(https://github.com/npm/npm-registry-client/commit/acbec48372bc1816c67c9e7cbf814cf50437ff93,
|
||||
[@isaacs](https://github.com/isaacs))
|
||||
|
||||
### v1.4.1 (2014-02-13):
|
||||
|
||||
* Fix `npm shrinkwrap` forgetting to shrinkwrap dependencies that were also
|
||||
development dependencies.
|
||||
([`9c575c5`](https://github.com/npm/npm/commit/9c575c56efa9b0c8b0d4a17cb9c1de3833004bcd),
|
||||
[@diwu1989](https://github.com/diwu1989))
|
||||
* Fixed publishing of pre-existing packages with uppercase characters in their
|
||||
name.
|
||||
(https://github.com/npm/npm-registry-client/commit/9345d3b6c3d8510dd5c4418f27ee1fce59acebad,
|
||||
[@isaacs](https://github.com/isaacs))
|
||||
|
||||
### v1.4.0 (2014-02-12):
|
||||
|
||||
* Remove `npm publish --force`. See
|
||||
https://github.com/npm/npmjs.org/issues/148.
|
||||
([@isaacs](https://github.com/isaacs),
|
||||
npm/npm-registry-client@2c8dba990de6a59af6545b75cc00a6dc12777c2a)
|
||||
* Other changes to the registry client related to saved configs and couch
|
||||
logins. ([@isaacs](https://github.com/isaacs);
|
||||
npm/npm-registry-client@25e2b019a1588155e5f87d035c27e79963b75951,
|
||||
npm/npm-registry-client@9e41e9101b68036e0f078398785f618575f3cdde,
|
||||
npm/npm-registry-client@2c8dba990de6a59af6545b75cc00a6dc12777c2a)
|
||||
* Show an error to the user when doing `npm update` and the `package.json`
|
||||
specifies a version that does not exist.
|
||||
([@evanlucas](https://github.com/evanlucas),
|
||||
[`027a33a`](https://github.com/npm/npm/commit/027a33a5c594124cc1d82ddec5aee2c18bc8dc32))
|
||||
* Fix some issues with cache ownership in certain installation configurations.
|
||||
([@outcoldman](https://github.com/outcoldman),
|
||||
[`a132690`](https://github.com/npm/npm/commit/a132690a2876cda5dcd1e4ca751f21dfcb11cb9e))
|
||||
* Fix issues where GitHub shorthand dependencies `user/repo` were not always
|
||||
treated the same as full Git URLs.
|
||||
([@robertkowalski](https://github.com/robertkowalski),
|
||||
https://github.com/meryn/normalize-package-data/commit/005d0b637aec1895117fcb4e3b49185eebf9e240)
|
||||
|
||||
### v1.3.26 (2014-02-02):
|
||||
|
||||
* Fixes and updates to publishing code
|
||||
([`735427a`](https://github.com/npm/npm/commit/735427a69ba4fe92aafa2d88f202aaa42920a9e2)
|
||||
and
|
||||
[`c0ac832`](https://github.com/npm/npm/commit/c0ac83224d49aa62e55577f8f27d53bbfd640dc5),
|
||||
[@isaacs](https://github.com/isaacs))
|
||||
* Fix `npm bugs` with no arguments.
|
||||
([`b99d465`](https://github.com/npm/npm/commit/b99d465221ac03bca30976cbf4d62ca80ab34091),
|
||||
[@Hoops](https://github.com/Hoops))
|
||||
|
||||
### v1.3.25 (2014-01-25):
|
||||
|
||||
* Remove gubblebum blocky font from documentation headers.
|
||||
([`6940c9a`](https://github.com/npm/npm/commit/6940c9a100160056dc6be8f54a7ad7fa8ceda7e2),
|
||||
[@isaacs](https://github.com/isaacs))
|
||||
|
||||
### v1.3.24 (2014-01-19):
|
||||
|
||||
* Make the search output prettier, with nice truncated columns, and a `--long`
|
||||
option to create wrapping columns.
|
||||
([`20439b2`](https://github.com/npm/npm/commit/20439b2) and
|
||||
[`3a6942d`](https://github.com/npm/npm/commit/3a6942d),
|
||||
[@timoxley](https://github.com/timoxley))
|
||||
* Support multiple packagenames in `npm docs`.
|
||||
([`823010b`](https://github.com/npm/npm/commit/823010b),
|
||||
[@timoxley](https://github.com/timoxley))
|
||||
* Fix the `npm adduser` bug regarding "Error: default value must be string or
|
||||
number" again. ([`b9b4248`](https://github.com/npm/npm/commit/b9b4248),
|
||||
[@isaacs](https://github.com/isaacs))
|
||||
* Fix `scripts` entries containing whitespaces on Windows.
|
||||
([`80282ed`](https://github.com/npm/npm/commit/80282ed),
|
||||
[@robertkowalski](https://github.com/robertkowalski))
|
||||
* Fix `npm update` for Git URLs that have credentials in them
|
||||
([`93fc364`](https://github.com/npm/npm/commit/93fc364),
|
||||
[@danielsantiago](https://github.com/danielsantiago))
|
||||
* Fix `npm install` overwriting `npm link`-ed dependencies when they are tagged
|
||||
Git dependencies. ([`af9bbd9`](https://github.com/npm/npm/commit/af9bbd9),
|
||||
[@evanlucas](https://github.com/evanlucas))
|
||||
* Remove `npm prune --production` since it buggily removed some dependencies
|
||||
that were necessary for production; see
|
||||
[#4509](https://github.com/npm/npm/issues/4509). Hopefully it can make its
|
||||
triumphant return, one day.
|
||||
([`1101b6a`](https://github.com/npm/npm/commit/1101b6a),
|
||||
[@isaacs](https://github.com/isaacs))
|
||||
|
||||
Dependency updates:
|
||||
* [`909cccf`](https://github.com/npm/npm/commit/909cccf) `read-package-json@1.1.6`
|
||||
* [`a3891b6`](https://github.com/npm/npm/commit/a3891b6) `rimraf@2.2.6`
|
||||
* [`ac6efbc`](https://github.com/npm/npm/commit/ac6efbc) `sha@1.2.3`
|
||||
* [`dd30038`](https://github.com/npm/npm/commit/dd30038) `node-gyp@0.12.2`
|
||||
* [`c8c3ebe`](https://github.com/npm/npm/commit/c8c3ebe) `npm-registry-client@0.3.3`
|
||||
* [`4315286`](https://github.com/npm/npm/commit/4315286) `npmconf@0.1.12`
|
||||
|
||||
### v1.3.23 (2014-01-03):
|
||||
|
||||
* Properly handle installations that contained a certain class of circular
|
||||
dependencies.
|
||||
([`5dc93e8`](https://github.com/npm/npm/commit/5dc93e8c82604c45b6067b1acf1c768e0bfce754),
|
||||
[@substack](https://github.com/substack))
|
||||
|
||||
### v1.3.22 (2013-12-25):
|
||||
|
||||
* Fix a critical bug in `npm adduser` that would manifest in the error message
|
||||
"Error: default value must be string or number."
|
||||
([`fba4bd2`](https://github.com/npm/npm/commit/fba4bd24bc2ab00ccfeda2043aa53af7d75ef7ce),
|
||||
[@isaacs](https://github.com/isaacs))
|
||||
* Allow `npm bugs` in the current directory to open the current package's bugs
|
||||
URL.
|
||||
([`d04cf64`](https://github.com/npm/npm/commit/d04cf6483932c693452f3f778c2fa90f6153a4af),
|
||||
[@evanlucas](https://github.com/evanlucas))
|
||||
* Several fixes to various error messages to include more useful or updated
|
||||
information.
|
||||
([`1e6f2a7`](https://github.com/npm/npm/commit/1e6f2a72ca058335f9f5e7ca22d01e1a8bb0f9f7),
|
||||
[`ff46366`](https://github.com/npm/npm/commit/ff46366bd40ff0ef33c7bac8400bc912c56201d1),
|
||||
[`8b4bb48`](https://github.com/npm/npm/commit/8b4bb4815d80a3612186dc5549d698e7b988eb03);
|
||||
[@rlidwka](https://github.com/rlidwka),
|
||||
[@evanlucas](https://github.com/evanlucas))
|
||||
|
||||
### v1.3.21 (2013-12-17):
|
||||
|
||||
* Fix a critical bug that prevented publishing due to incorrect hash
|
||||
calculation.
|
||||
([`4ca4a2c`](https://github.com/npm/npm-registry-client/commit/4ca4a2c6333144299428be6b572e2691aa59852e),
|
||||
[@dominictarr](https://github.com/dominictarr))
|
||||
|
||||
### v1.3.20 (2013-12-17):
|
||||
|
||||
* Fixes a critical bug in v1.3.19. Thankfully, due to that bug, no one could
|
||||
install npm v1.3.19 :)
|
||||
|
||||
### v1.3.19 (2013-12-16):
|
||||
|
||||
* Adds atomic PUTs for publishing packages, which should result in far fewer
|
||||
requests and less room for replication errors on the server-side.
|
||||
|
||||
### v1.3.18 (2013-12-16):
|
||||
|
||||
* Added an `--ignore-scripts` option, which will prevent `package.json` scripts
|
||||
from being run. Most notably, this will work on `npm install`, so e.g. `npm
|
||||
install --ignore-scripts` will not run preinstall and prepublish scripts.
|
||||
([`d7e67bf`](https://github.com/npm/npm/commit/d7e67bf0d94b085652ec1c87d595afa6f650a8f6),
|
||||
[@sqs](https://github.com/sqs))
|
||||
* Fixed a bug introduced in 1.3.16 that would manifest with certain cache
|
||||
configurations, by causing spurious errors saying "Adding a cache directory
|
||||
to the cache will make the world implode."
|
||||
([`966373f`](https://github.com/npm/npm/commit/966373fad8d741637f9744882bde9f6e94000865),
|
||||
[@domenic](https://github.com/domenic))
|
||||
* Re-fixed the multiple download of URL dependencies, whose fix was reverted in
|
||||
1.3.17.
|
||||
([`a362c3f`](https://github.com/npm/npm/commit/a362c3f1919987419ed8a37c8defa19d2e6697b0),
|
||||
[@spmason](https://github.com/spmason))
|
||||
|
||||
### v1.3.17 (2013-12-11):
|
||||
|
||||
* This release reverts
|
||||
[`644c2ff`](https://github.com/npm/npm/commit/644c2ff3e3d9c93764f7045762477f48864d64a7),
|
||||
which avoided re-downloading URL and shinkwrap dependencies when doing `npm
|
||||
install`. You can see the in-depth reasoning in
|
||||
[`d8c907e`](https://github.com/npm/npm/commit/d8c907edc2019b75cff0f53467e34e0ffd7e5fba);
|
||||
the problem was, that the patch changed the behavior of `npm install -f` to
|
||||
reinstall all dependencies.
|
||||
* A new version of the no-re-downloading fix has been submitted as
|
||||
[#4303](https://github.com/npm/npm/issues/4303) and will hopefully be
|
||||
included in the next release.
|
||||
|
||||
### v1.3.16 (2013-12-11):
|
||||
|
||||
* Git URL dependencies are now updated on `npm install`, fixing a two-year old
|
||||
bug
|
||||
([`5829ecf`](https://github.com/npm/npm/commit/5829ecf032b392d2133bd351f53d3c644961396b),
|
||||
[@robertkowalski](https://github.com/robertkowalski)). Additional progress on
|
||||
reducing the resulting Git-related I/O is tracked as
|
||||
[#4191](https://github.com/npm/npm/issues/4191), but for now, this will be a
|
||||
big improvement.
|
||||
* Added a `--json` mode to `npm outdated` to give a parseable output.
|
||||
([`0b6c9b7`](https://github.com/npm/npm/commit/0b6c9b7c8c5579f4d7d37a0c24d9b7a12ccbe5fe),
|
||||
[@yyx990803](https://github.com/yyx990803))
|
||||
* Made `npm outdated` much prettier and more useful. It now outputs a
|
||||
color-coded and easy-to-read table.
|
||||
([`fd3017f`](https://github.com/npm/npm/commit/fd3017fc3e9d42acf6394a5285122edb4dc16106),
|
||||
[@quimcalpe](https://github.com/quimcalpe))
|
||||
* Added the `--depth` option to `npm outdated`, so that e.g. you can do `npm
|
||||
outdated --depth=0` to show only top-level outdated dependencies.
|
||||
([`1d184ef`](https://github.com/npm/npm/commit/1d184ef3f4b4bc309d38e9128732e3e6fb46d49c),
|
||||
[@yyx990803](https://github.com/yyx990803))
|
||||
* Added a `--no-git-tag-version` option to `npm version`, for doing the usual
|
||||
job of `npm version` minus the Git tagging. This could be useful if you need
|
||||
to increase the version in other related files before actually adding the
|
||||
tag.
|
||||
([`59ca984`](https://github.com/npm/npm/commit/59ca9841ba4f4b2f11b8e72533f385c77ae9f8bd),
|
||||
[@evanlucas](https://github.com/evanlucas))
|
||||
* Made `npm repo` and `npm docs` work without any arguments, adding them to the
|
||||
list of npm commands that work on the package in the current directory when
|
||||
invoked without arguments.
|
||||
([`bf9048e`](https://github.com/npm/npm/commit/bf9048e2fa16d43fbc4b328d162b0a194ca484e8),
|
||||
[@robertkowalski](https://github.com/robertkowalski);
|
||||
[`07600d0`](https://github.com/npm/npm/commit/07600d006c652507cb04ac0dae9780e35073dd67),
|
||||
[@wilmoore](https://github.com/wilmoore)). There are a few other commands we
|
||||
still want to implement this for; see
|
||||
[#4204](https://github.com/npm/npm/issues/4204).
|
||||
* Pass through the `GIT_SSL_NO_VERIFY` environment variable to Git, if it is
|
||||
set; we currently do this with a few other environment variables, but we
|
||||
missed that one.
|
||||
([`c625de9`](https://github.com/npm/npm/commit/c625de91770df24c189c77d2e4bc821f2265efa8),
|
||||
[@arikon](https://github.com/arikon))
|
||||
* Fixed `npm dedupe` on Windows due to incorrect path separators being used
|
||||
([`7677de4`](https://github.com/npm/npm/commit/7677de4583100bc39407093ecc6bc13715bf8161),
|
||||
[@mcolyer](https://github.com/mcolyer)).
|
||||
* Fixed the `npm help` command when multiple words were searched for; it
|
||||
previously gave a `ReferenceError`.
|
||||
([`6a28dd1`](https://github.com/npm/npm/commit/6a28dd147c6957a93db12b1081c6e0da44fe5e3c),
|
||||
[@dereckson](https://github.com/dereckson))
|
||||
* Stopped re-downloading URL and shrinkwrap dependencies, as demonstrated in
|
||||
[#3463](https://github.com/npm/npm/issues/3463)
|
||||
([`644c2ff`](https://github.com/isaacs/npm/commit/644c2ff3e3d9c93764f7045762477f48864d64a7),
|
||||
[@spmason](https://github.com/spmason)). You can use the `--force` option to
|
||||
force re-download and installation of all dependencies.
|
||||
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
File diff suppressed because it is too large
Load Diff
@ -0,0 +1,33 @@
|
||||
#!/usr/bin/env bash
|
||||
|
||||
# set configurations that will be "sticky" on this system,
|
||||
# surviving npm self-updates.
|
||||
|
||||
CONFIGS=()
|
||||
i=0
|
||||
|
||||
# get the location of this file.
|
||||
unset CDPATH
|
||||
CONFFILE=$(cd $(dirname "$0"); pwd -P)/npmrc
|
||||
|
||||
while [ $# -gt 0 ]; do
|
||||
conf="$1"
|
||||
case $conf in
|
||||
--help)
|
||||
echo "./configure --param=value ..."
|
||||
exit 0
|
||||
;;
|
||||
--*)
|
||||
CONFIGS[$i]="${conf:2}"
|
||||
;;
|
||||
*)
|
||||
CONFIGS[$i]="$conf"
|
||||
;;
|
||||
esac
|
||||
let i++
|
||||
shift
|
||||
done
|
||||
|
||||
for c in "${CONFIGS[@]}"; do
|
||||
echo "$c" >> "$CONFFILE"
|
||||
done
|
||||
@ -0,0 +1,22 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2015 gatsbyjs
|
||||
|
||||
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.
|
||||
|
||||
@ -0,0 +1,93 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-access
|
||||
description: Set access level on published packages
|
||||
---
|
||||
|
||||
# npm-access(1)
|
||||
|
||||
## Set access level on published packages
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm access public [<package>]
|
||||
npm access restricted [<package>]
|
||||
|
||||
npm access grant <read-only|read-write> <scope:team> [<package>]
|
||||
npm access revoke <scope:team> [<package>]
|
||||
|
||||
npm access 2fa-required [<package>]
|
||||
npm access 2fa-not-required [<package>]
|
||||
|
||||
npm access ls-packages [<user>|<scope>|<scope:team>]
|
||||
npm access ls-collaborators [<package> [<user>]]
|
||||
npm access edit [<package>]
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
Used to set access controls on private packages.
|
||||
|
||||
For all of the subcommands, `npm access` will perform actions on the packages
|
||||
in the current working directory if no package name is passed to the
|
||||
subcommand.
|
||||
|
||||
* public / restricted:
|
||||
Set a package to be either publicly accessible or restricted.
|
||||
|
||||
* grant / revoke:
|
||||
Add or remove the ability of users and teams to have read-only or read-write
|
||||
access to a package.
|
||||
|
||||
* 2fa-required / 2fa-not-required:
|
||||
Configure whether a package requires that anyone publishing it have two-factor
|
||||
authentication enabled on their account.
|
||||
|
||||
* ls-packages:
|
||||
Show all of the packages a user or a team is able to access, along with the
|
||||
access level, except for read-only public packages (it won't print the whole
|
||||
registry listing)
|
||||
|
||||
* ls-collaborators:
|
||||
Show all of the access privileges for a package. Will only show permissions
|
||||
for packages to which you have at least read access. If `<user>` is passed in,
|
||||
the list is filtered only to teams _that_ user happens to belong to.
|
||||
|
||||
* edit:
|
||||
Set the access privileges for a package at once using `$EDITOR`.
|
||||
|
||||
### Details
|
||||
|
||||
`npm access` always operates directly on the current registry, configurable
|
||||
from the command line using `--registry=<registry url>`.
|
||||
|
||||
Unscoped packages are *always public*.
|
||||
|
||||
Scoped packages *default to restricted*, but you can either publish them as
|
||||
public using `npm publish --access=public`, or set their access as public using
|
||||
`npm access public` after the initial publish.
|
||||
|
||||
You must have privileges to set the access of a package:
|
||||
|
||||
* You are an owner of an unscoped or scoped package.
|
||||
* You are a member of the team that owns a scope.
|
||||
* You have been given read-write privileges for a package, either as a member
|
||||
of a team or directly as an owner.
|
||||
|
||||
If you have two-factor authentication enabled then you'll have to pass in an
|
||||
otp with `--otp` when making access changes.
|
||||
|
||||
If your account is not paid, then attempts to publish scoped packages will fail
|
||||
with an HTTP 402 status code (logically enough), unless you use
|
||||
`--access=public`.
|
||||
|
||||
Management of teams and team memberships is done with the `npm team` command.
|
||||
|
||||
### See Also
|
||||
|
||||
* [`libnpmaccess`](https://npm.im/libnpmaccess)
|
||||
* [npm team](/cli-commands/npm-team)
|
||||
* [npm publish](/cli-commands/npm-publish)
|
||||
* [npm config](/cli-commands/npm-config)
|
||||
* [npm registry](/using-npm/registry)
|
||||
95
src/main/ng-app/node/node_modules/npm/docs/content/cli-commands/npm-adduser.md
generated
vendored
95
src/main/ng-app/node/node_modules/npm/docs/content/cli-commands/npm-adduser.md
generated
vendored
@ -0,0 +1,95 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-adduser
|
||||
description: Set access level on published packages
|
||||
---
|
||||
|
||||
# npm-adduser(1)
|
||||
|
||||
## Add a registry user account
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm adduser [--registry=url] [--scope=@orgname] [--always-auth] [--auth-type=legacy]
|
||||
|
||||
aliases: login, add-user
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
Create or verify a user named `<username>` in the specified registry, and
|
||||
save the credentials to the `.npmrc` file. If no registry is specified,
|
||||
the default registry will be used (see [`config`](/using-npm/config)).
|
||||
|
||||
The username, password, and email are read in from prompts.
|
||||
|
||||
To reset your password, go to <https://www.npmjs.com/forgot>
|
||||
|
||||
To change your email address, go to <https://www.npmjs.com/email-edit>
|
||||
|
||||
You may use this command multiple times with the same user account to
|
||||
authorize on a new machine. When authenticating on a new machine,
|
||||
the username, password and email address must all match with
|
||||
your existing record.
|
||||
|
||||
`npm login` is an alias to `adduser` and behaves exactly the same way.
|
||||
|
||||
### Configuration
|
||||
|
||||
#### registry
|
||||
|
||||
Default: https://registry.npmjs.org/
|
||||
|
||||
The base URL of the npm package registry. If `scope` is also specified,
|
||||
this registry will only be used for packages with that scope. `scope` defaults
|
||||
to the scope of the project directory you're currently in, if any. See [`scope`](/using-npm/scope).
|
||||
|
||||
#### scope
|
||||
|
||||
Default: none
|
||||
|
||||
If specified, the user and login credentials given will be associated
|
||||
with the specified scope. See [`scope`](/using-npm/scope). You can use both at the same time,
|
||||
e.g.
|
||||
|
||||
```bash
|
||||
npm adduser --registry=http://myregistry.example.com --scope=@myco
|
||||
```
|
||||
|
||||
This will set a registry for the given scope and login or create a user for
|
||||
that registry at the same time.
|
||||
|
||||
#### always-auth
|
||||
|
||||
Default: false
|
||||
|
||||
If specified, save configuration indicating that all requests to the given
|
||||
registry should include authorization information. Useful for private
|
||||
registries. Can be used with `--registry` and / or `--scope`, e.g.
|
||||
|
||||
```bash
|
||||
npm adduser --registry=http://private-registry.example.com --always-auth
|
||||
```
|
||||
|
||||
This will ensure that all requests to that registry (including for tarballs)
|
||||
include an authorization header. This setting may be necessary for use with
|
||||
private registries where metadata and package tarballs are stored on hosts with
|
||||
different hostnames. See `always-auth` in [`config`](/using-npm/config) for more details on always-auth. Registry-specific configuration of `always-auth` takes precedence over any global configuration.
|
||||
|
||||
#### auth-type
|
||||
|
||||
* Default: `'legacy'`
|
||||
* Type: `'legacy'`, `'sso'`, `'saml'`, `'oauth'`
|
||||
|
||||
What authentication strategy to use with `adduser`/`login`. Some npm registries
|
||||
(for example, npmE) might support alternative auth strategies besides classic
|
||||
username/password entry in legacy npm.
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm registry](/using-npm/registry)
|
||||
* [npm config](/cli-commands/npm-config)
|
||||
* [npmrc](/configuring-npm/npmrc)
|
||||
* [npm owner](/cli-commands/npm-owner)
|
||||
* [npm whoami](/cli-commands/npm-whoami)
|
||||
@ -0,0 +1,136 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-audit
|
||||
description: Run a security audit
|
||||
---
|
||||
|
||||
# npm-audit(1)
|
||||
|
||||
## Run a security audit
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm audit [--json|--parseable|--audit-level=(low|moderate|high|critical)]
|
||||
npm audit fix [--force|--package-lock-only|--dry-run]
|
||||
|
||||
common options: [--production] [--only=(dev|prod)]
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
Scan your project for vulnerabilities and automatically install any compatible
|
||||
updates to vulnerable dependencies:
|
||||
```bash
|
||||
$ npm audit fix
|
||||
```
|
||||
|
||||
Run `audit fix` without modifying `node_modules`, but still updating the
|
||||
pkglock:
|
||||
```bash
|
||||
$ npm audit fix --package-lock-only
|
||||
```
|
||||
|
||||
Skip updating `devDependencies`:
|
||||
```bash
|
||||
$ npm audit fix --only=prod
|
||||
```
|
||||
|
||||
Have `audit fix` install semver-major updates to toplevel dependencies, not just
|
||||
semver-compatible ones:
|
||||
```bash
|
||||
$ npm audit fix --force
|
||||
```
|
||||
|
||||
Do a dry run to get an idea of what `audit fix` will do, and _also_ output
|
||||
install information in JSON format:
|
||||
```bash
|
||||
$ npm audit fix --dry-run --json
|
||||
```
|
||||
|
||||
Scan your project for vulnerabilities and just show the details, without fixing
|
||||
anything:
|
||||
```bash
|
||||
$ npm audit
|
||||
```
|
||||
|
||||
Get the detailed audit report in JSON format:
|
||||
```bash
|
||||
$ npm audit --json
|
||||
```
|
||||
|
||||
Get the detailed audit report in plain text result, separated by tab characters, allowing for
|
||||
future reuse in scripting or command line post processing, like for example, selecting
|
||||
some of the columns printed:
|
||||
```bash
|
||||
$ npm audit --parseable
|
||||
```
|
||||
|
||||
To parse columns, you can use for example `awk`, and just print some of them:
|
||||
```bash
|
||||
$ npm audit --parseable | awk -F $'\t' '{print $1,$4}'
|
||||
```
|
||||
|
||||
Fail an audit only if the results include a vulnerability with a level of moderate or higher:
|
||||
```bash
|
||||
$ npm audit --audit-level=moderate
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
The audit command submits a description of the dependencies configured in
|
||||
your project to your default registry and asks for a report of known
|
||||
vulnerabilities. The report returned includes instructions on how to act on
|
||||
this information. The command will exit with a 0 exit code if no
|
||||
vulnerabilities were found.
|
||||
|
||||
You can also have npm automatically fix the vulnerabilities by running `npm
|
||||
audit fix`. Note that some vulnerabilities cannot be fixed automatically and
|
||||
will require manual intervention or review. Also note that since `npm audit fix`
|
||||
runs a full-fledged `npm install` under the hood, all configs that apply to the
|
||||
installer will also apply to `npm install` -- so things like `npm audit fix
|
||||
--package-lock-only` will work as expected.
|
||||
|
||||
By default, the audit command will exit with a non-zero code if any vulnerability
|
||||
is found. It may be useful in CI environments to include the `--audit-level` parameter
|
||||
to specify the minimum vulnerability level that will cause the command to fail. This
|
||||
option does not filter the report output, it simply changes the command's failure
|
||||
threshold.
|
||||
|
||||
### Content Submitted
|
||||
|
||||
* npm_version
|
||||
* node_version
|
||||
* platform
|
||||
* node_env
|
||||
* A scrubbed version of your package-lock.json or npm-shrinkwrap.json
|
||||
|
||||
#### Scrubbing
|
||||
|
||||
In order to ensure that potentially sensitive information is not included in
|
||||
the audit data bundle, some dependencies may have their names (and sometimes
|
||||
versions) replaced with opaque non-reversible identifiers. It is done for
|
||||
the following dependency types:
|
||||
|
||||
* Any module referencing a scope that is configured for a non-default
|
||||
registry has its name scrubbed. (That is, a scope you did a `npm login --scope=@ourscope` for.)
|
||||
* All git dependencies have their names and specifiers scrubbed.
|
||||
* All remote tarball dependencies have their names and specifiers scrubbed.
|
||||
* All local directory and tarball dependencies have their names and specifiers scrubbed.
|
||||
|
||||
The non-reversible identifiers are a sha256 of a session-specific UUID and the
|
||||
value being replaced, ensuring a consistent value within the payload that is
|
||||
different between runs.
|
||||
|
||||
### Exit Code
|
||||
|
||||
The `npm audit` command will exit with a 0 exit code if no vulnerabilities were found.
|
||||
|
||||
If vulnerabilities were found the exit code will depend on the `audit-level`
|
||||
configuration setting.
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm install](/cli-commands/npm-install)
|
||||
* [package-locks](/configuring-npm/package-locks)
|
||||
* [config](/using-npm/config)
|
||||
@ -0,0 +1,26 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-bin
|
||||
description: Display npm bin folder
|
||||
---
|
||||
|
||||
# npm-bin(1)
|
||||
|
||||
## Display npm bin folder
|
||||
|
||||
### Synopsis
|
||||
```bash
|
||||
npm bin [-g|--global]
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
Print the folder where npm will install executables.
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm prefix](/cli-commands/npm-prefix)
|
||||
* [npm root](/cli-commands/npm-root)
|
||||
* [npm folders](/configuring-npm/folders)
|
||||
* [npm config](/cli-commands/npm-config)
|
||||
* [npmrc](/configuring-npm/npmrc)
|
||||
@ -0,0 +1,50 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-bugs
|
||||
description: Bugs for a package in a web browser maybe
|
||||
---
|
||||
|
||||
# npm-bugs(1)
|
||||
|
||||
## Bugs for a package in a web browser maybe
|
||||
|
||||
### Synopsis
|
||||
```bash
|
||||
npm bugs [<pkgname>]
|
||||
|
||||
aliases: issues
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
This command tries to guess at the likely location of a package's
|
||||
bug tracker URL, and then tries to open it using the `--browser`
|
||||
config param. If no package name is provided, it will search for
|
||||
a `package.json` in the current folder and use the `name` property.
|
||||
|
||||
### Configuration
|
||||
|
||||
#### browser
|
||||
|
||||
* Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"`
|
||||
* Type: String
|
||||
|
||||
The browser that is called by the `npm bugs` command to open websites.
|
||||
|
||||
#### registry
|
||||
|
||||
* Default: https://registry.npmjs.org/
|
||||
* Type: url
|
||||
|
||||
The base URL of the npm package registry.
|
||||
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm docs](/cli-commands/npm-docs)
|
||||
* [npm view](/cli-commands/npm-view)
|
||||
* [npm publish](/cli-commands/npm-publish)
|
||||
* [npm registry](/using-npm/registry)
|
||||
* [npm config](/cli-commands/npm-config)
|
||||
* [npmrc](/configuring-npm/npmrc)
|
||||
* [package.json](/configuring-npm/package-json)
|
||||
@ -0,0 +1,34 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-build
|
||||
description: Build a package
|
||||
---
|
||||
|
||||
# npm-build(1)
|
||||
|
||||
## Build a package
|
||||
|
||||
### Synopsis
|
||||
```shell
|
||||
npm build [<package-folder>]
|
||||
```
|
||||
|
||||
* `<package-folder>`:
|
||||
A folder containing a `package.json` file in its root.
|
||||
|
||||
### Description
|
||||
|
||||
This is the plumbing command called by `npm link` and `npm install`.
|
||||
|
||||
It should generally be called during installation, but if you need to run it
|
||||
directly, run:
|
||||
```bash
|
||||
npm run-script build
|
||||
```
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm install](/cli-commands/npm-install)
|
||||
* [npm link](/cli-commands/npm-link)
|
||||
* [npm scripts](/using-npm/scripts)
|
||||
* [package.json](/configuring-npm/package-json)
|
||||
@ -0,0 +1,21 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-bundle
|
||||
description: REMOVED
|
||||
---
|
||||
|
||||
# npm-bundle(1)
|
||||
|
||||
## REMOVED
|
||||
|
||||
### Description
|
||||
|
||||
The `npm bundle` command has been removed in 1.0, for the simple reason
|
||||
that it is no longer necessary, as the default behavior is now to
|
||||
install packages into the local space.
|
||||
|
||||
Just use `npm install` now to do what `npm bundle` used to do.
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm install](/cli-commands/npm-install)
|
||||
@ -0,0 +1,91 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-cache
|
||||
description: Manipulates packages cache
|
||||
---
|
||||
|
||||
# npm-cache(1)
|
||||
|
||||
## Manipulates packages cache
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm cache add <tarball file>
|
||||
npm cache add <folder>
|
||||
npm cache add <tarball url>
|
||||
npm cache add <name>@<version>
|
||||
|
||||
npm cache clean [<path>]
|
||||
aliases: npm cache clear, npm cache rm
|
||||
|
||||
npm cache verify
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
Used to add, list, or clean the npm cache folder.
|
||||
|
||||
* add:
|
||||
Add the specified package to the local cache. This command is primarily
|
||||
intended to be used internally by npm, but it can provide a way to
|
||||
add data to the local installation cache explicitly.
|
||||
|
||||
* clean:
|
||||
Delete all data out of the cache folder.
|
||||
|
||||
* verify:
|
||||
Verify the contents of the cache folder, garbage collecting any unneeded data,
|
||||
and verifying the integrity of the cache index and all cached data.
|
||||
|
||||
### Details
|
||||
|
||||
npm stores cache data in an opaque directory within the configured `cache`,
|
||||
named `_cacache`. This directory is a `cacache`-based content-addressable cache
|
||||
that stores all http request data as well as other package-related data. This
|
||||
directory is primarily accessed through `pacote`, the library responsible for
|
||||
all package fetching as of npm@5.
|
||||
|
||||
All data that passes through the cache is fully verified for integrity on both
|
||||
insertion and extraction. Cache corruption will either trigger an error, or
|
||||
signal to `pacote` that the data must be refetched, which it will do
|
||||
automatically. For this reason, it should never be necessary to clear the cache
|
||||
for any reason other than reclaiming disk space, thus why `clean` now requires
|
||||
`--force` to run.
|
||||
|
||||
There is currently no method exposed through npm to inspect or directly manage
|
||||
the contents of this cache. In order to access it, `cacache` must be used
|
||||
directly.
|
||||
|
||||
npm will not remove data by itself: the cache will grow as new packages are
|
||||
installed.
|
||||
|
||||
### A note about the cache's design
|
||||
|
||||
The npm cache is strictly a cache: it should not be relied upon as a persistent
|
||||
and reliable data store for package data. npm makes no guarantee that a
|
||||
previously-cached piece of data will be available later, and will automatically
|
||||
delete corrupted contents. The primary guarantee that the cache makes is that,
|
||||
if it does return data, that data will be exactly the data that was inserted.
|
||||
|
||||
To run an offline verification of existing cache contents, use `npm cache
|
||||
verify`.
|
||||
|
||||
### Configuration
|
||||
|
||||
#### cache
|
||||
|
||||
Default: `~/.npm` on Posix, or `%AppData%/npm-cache` on Windows.
|
||||
|
||||
The root cache folder.
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm folders](/configuring-npm/folders)
|
||||
* [npm config](/cli-commands/npm-config)
|
||||
* [npmrc](/configuring-npm/npmrc)
|
||||
* [npm install](/cli-commands/npm-install)
|
||||
* [npm publish](/cli-commands/npm-publish)
|
||||
* [npm pack](/cli-commands/npm-pack)
|
||||
* https://npm.im/cacache
|
||||
* https://npm.im/pacote
|
||||
@ -0,0 +1,67 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-ci
|
||||
description: Install a project with a clean slate
|
||||
---
|
||||
|
||||
# npm-ci(1)
|
||||
|
||||
## Install a project with a clean slate
|
||||
|
||||
### Synopsis
|
||||
```bash
|
||||
npm ci
|
||||
```
|
||||
|
||||
### Example
|
||||
|
||||
Make sure you have a package-lock and an up-to-date install:
|
||||
|
||||
```bash
|
||||
$ cd ./my/npm/project
|
||||
$ npm install
|
||||
added 154 packages in 10s
|
||||
$ ls | grep package-lock
|
||||
```
|
||||
|
||||
Run `npm ci` in that project
|
||||
|
||||
```bash
|
||||
$ npm ci
|
||||
added 154 packages in 5s
|
||||
```
|
||||
|
||||
Configure Travis to build using `npm ci` instead of `npm install`:
|
||||
|
||||
```bash
|
||||
# .travis.yml
|
||||
install:
|
||||
- npm ci
|
||||
# keep the npm cache around to speed up installs
|
||||
cache:
|
||||
directories:
|
||||
- "$HOME/.npm"
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
This command is similar to [`npm install`](/cli-commands/npm-install), except it's meant to be used in
|
||||
automated environments such as test platforms, continuous integration, and
|
||||
deployment -- or any situation where you want to make sure you're doing a clean
|
||||
install of your dependencies. It can be significantly faster than a regular npm
|
||||
install by skipping certain user-oriented features. It is also more strict than
|
||||
a regular install, which can help catch errors or inconsistencies caused by the
|
||||
incrementally-installed local environments of most npm users.
|
||||
|
||||
In short, the main differences between using `npm install` and `npm ci` are:
|
||||
|
||||
* The project **must** have an existing `package-lock.json` or `npm-shrinkwrap.json`.
|
||||
* If dependencies in the package lock do not match those in `package.json`, `npm ci` will exit with an error, instead of updating the package lock.
|
||||
* `npm ci` can only install entire projects at a time: individual dependencies cannot be added with this command.
|
||||
* If a `node_modules` is already present, it will be automatically removed before `npm ci` begins its install.
|
||||
* It will never write to `package.json` or any of the package-locks: installs are essentially frozen.
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm install](/cli-commands/npm-install)
|
||||
* [package-locks](/configuring-npm/package-locks)
|
||||
42
src/main/ng-app/node/node_modules/npm/docs/content/cli-commands/npm-completion.md
generated
vendored
42
src/main/ng-app/node/node_modules/npm/docs/content/cli-commands/npm-completion.md
generated
vendored
@ -0,0 +1,42 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-completion
|
||||
description: Tab Completion for npm
|
||||
---
|
||||
|
||||
# npm-completion(1)
|
||||
|
||||
## Tab Completion for npm
|
||||
|
||||
### Synopsis
|
||||
```bash
|
||||
source <(npm completion)
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
Enables tab-completion in all npm commands.
|
||||
|
||||
The synopsis above
|
||||
loads the completions into your current shell. Adding it to
|
||||
your ~/.bashrc or ~/.zshrc will make the completions available
|
||||
everywhere:
|
||||
|
||||
```bash
|
||||
npm completion >> ~/.bashrc
|
||||
npm completion >> ~/.zshrc
|
||||
```
|
||||
|
||||
You may of course also pipe the output of `npm completion` to a file
|
||||
such as `/usr/local/etc/bash_completion.d/npm` or
|
||||
`/etc/bash_completion.d/npm` if you have a system that will read
|
||||
that file for you.
|
||||
|
||||
When `COMP_CWORD`, `COMP_LINE`, and `COMP_POINT` are defined in the
|
||||
environment, `npm completion` acts in "plumbing mode", and outputs
|
||||
completions based on the arguments.
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm developers](/using-npm/developers)
|
||||
* [npm](/cli-commands/npm)
|
||||
@ -0,0 +1,85 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-config
|
||||
description: Manage the npm configuration files
|
||||
---
|
||||
|
||||
# npm-config(1)
|
||||
|
||||
## Manage the npm configuration files
|
||||
|
||||
### Synopsis
|
||||
```bash
|
||||
npm config set <key> <value> [-g|--global]
|
||||
npm config get <key>
|
||||
npm config delete <key>
|
||||
npm config list [-l] [--json]
|
||||
npm config edit
|
||||
npm get <key>
|
||||
npm set <key> <value> [-g|--global]
|
||||
|
||||
aliases: c
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
npm gets its config settings from the command line, environment
|
||||
variables, `npmrc` files, and in some cases, the `package.json` file.
|
||||
|
||||
See [npmrc](/configuring-npm/npmrc) for more information about the npmrc files.
|
||||
|
||||
See [config](/using-npm/config) for a more thorough discussion of the mechanisms
|
||||
involved.
|
||||
|
||||
The `npm config` command can be used to update and edit the contents
|
||||
of the user and global npmrc files.
|
||||
|
||||
### Sub-commands
|
||||
|
||||
Config supports the following sub-commands:
|
||||
|
||||
#### set
|
||||
```bash
|
||||
npm config set key value
|
||||
```
|
||||
Sets the config key to the value.
|
||||
|
||||
If value is omitted, then it sets it to "true".
|
||||
|
||||
#### get
|
||||
```bash
|
||||
npm config get key
|
||||
```
|
||||
|
||||
Echo the config value to stdout.
|
||||
|
||||
#### list
|
||||
```bash
|
||||
npm config list
|
||||
```
|
||||
|
||||
Show all the config settings. Use `-l` to also show defaults. Use `--json`
|
||||
to show the settings in json format.
|
||||
|
||||
#### delete
|
||||
```bash
|
||||
npm config delete key
|
||||
```
|
||||
|
||||
Deletes the key from all configuration files.
|
||||
|
||||
#### edit
|
||||
```bash
|
||||
npm config edit
|
||||
```
|
||||
|
||||
Opens the config file in an editor. Use the `--global` flag to edit the
|
||||
global config.
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm folders](/configuring-npm/folders)
|
||||
* [npm config](/cli-commands/npm-config)
|
||||
* [package.json](/configuring-npm/package-json)
|
||||
* [npmrc](/configuring-npm/npmrc)
|
||||
* [npm](/cli-commands/npm)
|
||||
@ -0,0 +1,67 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-dedupe
|
||||
description: Reduce duplication
|
||||
---
|
||||
|
||||
# npm-dedupe(1)
|
||||
|
||||
## Reduce duplication
|
||||
|
||||
### Synopsis
|
||||
```bash
|
||||
npm dedupe
|
||||
npm ddp
|
||||
|
||||
aliases: find-dupes, ddp
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
Searches the local package tree and attempts to simplify the overall
|
||||
structure by moving dependencies further up the tree, where they can
|
||||
be more effectively shared by multiple dependent packages.
|
||||
|
||||
For example, consider this dependency graph:
|
||||
|
||||
```bash
|
||||
a
|
||||
+-- b <-- depends on c@1.0.x
|
||||
| `-- c@1.0.3
|
||||
`-- d <-- depends on c@~1.0.9
|
||||
`-- c@1.0.10
|
||||
```
|
||||
|
||||
In this case, `npm dedupe` will transform the tree to:
|
||||
|
||||
```bash
|
||||
a
|
||||
+-- b
|
||||
+-- d
|
||||
`-- c@1.0.10
|
||||
```
|
||||
|
||||
Because of the hierarchical nature of node's module lookup, b and d
|
||||
will both get their dependency met by the single c package at the root
|
||||
level of the tree.
|
||||
|
||||
The deduplication algorithm walks the tree, moving each dependency as far
|
||||
up in the tree as possible, even if duplicates are not found. This will
|
||||
result in both a flat and deduplicated tree.
|
||||
|
||||
If a suitable version exists at the target location in the tree
|
||||
already, then it will be left untouched, but the other duplicates will
|
||||
be deleted.
|
||||
|
||||
Arguments are ignored. Dedupe always acts on the entire tree.
|
||||
|
||||
Modules
|
||||
|
||||
Note that this operation transforms the dependency tree, but will never
|
||||
result in new modules being installed.
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm ls](/cli-commands/npm-ls)
|
||||
* [npm update](/cli-commands/npm-update)
|
||||
* [npm install](/cli-commands/npm-install)
|
||||
36
src/main/ng-app/node/node_modules/npm/docs/content/cli-commands/npm-deprecate.md
generated
vendored
36
src/main/ng-app/node/node_modules/npm/docs/content/cli-commands/npm-deprecate.md
generated
vendored
@ -0,0 +1,36 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-deprecate
|
||||
description: Deprecate a version of a package
|
||||
---
|
||||
# npm-deprecate(1)
|
||||
|
||||
## Deprecate a version of a package
|
||||
|
||||
### Synopsis
|
||||
```bash
|
||||
npm deprecate <pkg>[@<version>] <message>
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
This command will update the npm registry entry for a package, providing
|
||||
a deprecation warning to all who attempt to install it.
|
||||
|
||||
It works on [version ranges](https://semver.npmjs.com/) as well as specific
|
||||
versions, so you can do something like this:
|
||||
```bash
|
||||
npm deprecate my-thing@"< 0.2.3" "critical bug fixed in v0.2.3"
|
||||
```
|
||||
|
||||
Note that you must be the package owner to deprecate something. See the
|
||||
`owner` and `adduser` help topics.
|
||||
|
||||
To un-deprecate a package, specify an empty string (`""`) for the `message`
|
||||
argument. Note that you must use double quotes with no space between them to
|
||||
format an empty string.
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm publish](/cli-commands/npm-publish)
|
||||
* [npm registry](/using-npm/registry)
|
||||
100
src/main/ng-app/node/node_modules/npm/docs/content/cli-commands/npm-dist-tag.md
generated
vendored
100
src/main/ng-app/node/node_modules/npm/docs/content/cli-commands/npm-dist-tag.md
generated
vendored
@ -0,0 +1,52 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-docs
|
||||
description: Docs for a package in a web browser maybe
|
||||
---
|
||||
|
||||
# npm-docs(1)
|
||||
|
||||
## Docs for a package in a web browser maybe
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm docs [<pkgname> [<pkgname> ...]]
|
||||
npm docs .
|
||||
npm home [<pkgname> [<pkgname> ...]]
|
||||
npm home .
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
This command tries to guess at the likely location of a package's
|
||||
documentation URL, and then tries to open it using the `--browser`
|
||||
config param. You can pass multiple package names at once. If no
|
||||
package name is provided, it will search for a `package.json` in
|
||||
the current folder and use the `name` property.
|
||||
|
||||
### Configuration
|
||||
|
||||
#### browser
|
||||
|
||||
* Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"`
|
||||
* Type: String
|
||||
|
||||
The browser that is called by the `npm docs` command to open websites.
|
||||
|
||||
#### registry
|
||||
|
||||
* Default: https://registry.npmjs.org/
|
||||
* Type: url
|
||||
|
||||
The base URL of the npm package registry.
|
||||
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm view](/cli-commands/npm-view)
|
||||
* [npm publish](/cli-commands/npm-publish)
|
||||
* [npm registry](/using-npm/registry)
|
||||
* [npm config](/cli-commands/npm-config)
|
||||
* [npmrc](/configuring-npm/npmrc)
|
||||
* [package.json](/configuring-npm/package-json)
|
||||
111
src/main/ng-app/node/node_modules/npm/docs/content/cli-commands/npm-doctor.md
generated
vendored
111
src/main/ng-app/node/node_modules/npm/docs/content/cli-commands/npm-doctor.md
generated
vendored
@ -0,0 +1,47 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-edit
|
||||
description: Edit an installed package
|
||||
---
|
||||
|
||||
# npm-edit(1)
|
||||
|
||||
## Edit an installed package
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm edit <pkg>[/<subpkg>...]
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
Selects a (sub)dependency in the current
|
||||
working directory and opens the package folder in the default editor
|
||||
(or whatever you've configured as the npm `editor` config -- see
|
||||
[`npm-config`](npm-config).)
|
||||
|
||||
After it has been edited, the package is rebuilt so as to pick up any
|
||||
changes in compiled packages.
|
||||
|
||||
For instance, you can do `npm install connect` to install connect
|
||||
into your package, and then `npm edit connect` to make a few
|
||||
changes to your locally installed copy.
|
||||
|
||||
### Configuration
|
||||
|
||||
#### editor
|
||||
|
||||
* Default: `EDITOR` environment variable if set, or `"vi"` on Posix,
|
||||
or `"notepad"` on Windows.
|
||||
* Type: path
|
||||
|
||||
The command to run for `npm edit` or `npm config edit`.
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm folders](/configuring-npm/folders)
|
||||
* [npm explore](/cli-commands/npm-explore)
|
||||
* [npm install](/cli-commands/npm-install)
|
||||
* [npm config](/cli-commands/npm-config)
|
||||
* [npmrc](/configuring-npm/npmrc)
|
||||
50
src/main/ng-app/node/node_modules/npm/docs/content/cli-commands/npm-explore.md
generated
vendored
50
src/main/ng-app/node/node_modules/npm/docs/content/cli-commands/npm-explore.md
generated
vendored
@ -0,0 +1,50 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-explore
|
||||
description: Browse an installed package
|
||||
---
|
||||
|
||||
# npm-explore(1)
|
||||
|
||||
## Browse an installed package
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm explore <pkg> [ -- <command>]
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
Spawn a subshell in the directory of the installed package specified.
|
||||
|
||||
If a command is specified, then it is run in the subshell, which then
|
||||
immediately terminates.
|
||||
|
||||
This is particularly handy in the case of git submodules in the
|
||||
`node_modules` folder:
|
||||
|
||||
```bash
|
||||
npm explore some-dependency -- git pull origin master
|
||||
```
|
||||
|
||||
Note that the package is *not* automatically rebuilt afterwards, so be
|
||||
sure to use `npm rebuild <pkg>` if you make any changes.
|
||||
|
||||
### Configuration
|
||||
|
||||
#### shell
|
||||
|
||||
* Default: SHELL environment variable, or "bash" on Posix, or "cmd" on
|
||||
Windows
|
||||
* Type: path
|
||||
|
||||
The shell to run for the `npm explore` command.
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm folders](/configuring-npm/folders)
|
||||
* [npm edit](/cli-commands/npm-edit)
|
||||
* [npm rebuild](/cli-commands/npm-rebuild)
|
||||
* [npm build](/cli-commands/npm-build)
|
||||
* [npm install](/cli-commands/npm-install)
|
||||
@ -0,0 +1,60 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-fund
|
||||
description: Retrieve funding information
|
||||
---
|
||||
|
||||
# npm-fund(1)
|
||||
|
||||
## Retrieve funding information
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm fund [<pkg>]
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
This command retrieves information on how to fund the dependencies of
|
||||
a given project. If no package name is provided, it will list all
|
||||
dependencies that are looking for funding in a tree-structure in which
|
||||
are listed the type of funding and the url to visit. If a package name
|
||||
is provided then it tries to open its funding url using the `--browser`
|
||||
config param.
|
||||
|
||||
The list will avoid duplicated entries and will stack all packages
|
||||
that share the same type/url as a single entry. Given this nature the
|
||||
list is not going to have the same shape of the output from `npm ls`.
|
||||
|
||||
### Configuration
|
||||
|
||||
#### browser
|
||||
|
||||
* Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"`
|
||||
* Type: String
|
||||
|
||||
The browser that is called by the `npm fund` command to open websites.
|
||||
|
||||
#### json
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Show information in JSON format.
|
||||
|
||||
#### unicode
|
||||
|
||||
* Type: Boolean
|
||||
* Default: true
|
||||
|
||||
Whether to represent the tree structure using unicode characters.
|
||||
Set it to `false` in order to use all-ansi output.
|
||||
|
||||
## See Also
|
||||
|
||||
* [npm docs](/cli-commands/npm-docs)
|
||||
* [npm config](/cli-commands/npm-config)
|
||||
* [npm install](/cli-commands/npm-install)
|
||||
* [npm ls](/cli-commands/npm-ls)
|
||||
|
||||
43
src/main/ng-app/node/node_modules/npm/docs/content/cli-commands/npm-help-search.md
generated
vendored
43
src/main/ng-app/node/node_modules/npm/docs/content/cli-commands/npm-help-search.md
generated
vendored
@ -0,0 +1,43 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-help-search
|
||||
description: Search npm help documentation
|
||||
---
|
||||
|
||||
# npm-help-search(1)
|
||||
|
||||
## Search npm help documentation
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm help-search <text>
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
This command will search the npm markdown documentation files for the
|
||||
terms provided, and then list the results, sorted by relevance.
|
||||
|
||||
If only one result is found, then it will show that help topic.
|
||||
|
||||
If the argument to `npm help` is not a known help topic, then it will
|
||||
call `help-search`. It is rarely if ever necessary to call this
|
||||
command directly.
|
||||
|
||||
### Configuration
|
||||
|
||||
#### long
|
||||
|
||||
* Type: Boolean
|
||||
* Default: false
|
||||
|
||||
If true, the "long" flag will cause help-search to output context around
|
||||
where the terms were found in the documentation.
|
||||
|
||||
If false, then help-search will just list out the help topics found.
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm](/cli-commands/npm)
|
||||
* [npm help](/cli-commands/npm-help)
|
||||
@ -0,0 +1,44 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-help
|
||||
description: Get help on npm
|
||||
---
|
||||
|
||||
# npm-help(1)
|
||||
|
||||
## Get help on npm
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm help <term> [<terms..>]
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
If supplied a topic, then show the appropriate documentation page.
|
||||
|
||||
If the topic does not exist, or if multiple terms are provided, then run
|
||||
the `help-search` command to find a match. Note that, if `help-search`
|
||||
finds a single subject, then it will run `help` on that topic, so unique
|
||||
matches are equivalent to specifying a topic name.
|
||||
|
||||
### Configuration
|
||||
|
||||
#### viewer
|
||||
|
||||
* Default: "man" on Posix, "browser" on Windows
|
||||
* Type: path
|
||||
|
||||
The program to use to view help content.
|
||||
|
||||
Set to `"browser"` to view html help content in the default web browser.
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm](/cli-commands/npm)
|
||||
* [npm folders](/configuring-npm/folders)
|
||||
* [npm config](/cli-commands/npm-config)
|
||||
* [npmrc](/configuring-npm/npmrc)
|
||||
* [package.json](/configuring-npm/package-json)
|
||||
* [npm help-search](/cli-commands/npm-help-search)
|
||||
@ -0,0 +1,80 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-hook
|
||||
description: Manage registry hooks
|
||||
---
|
||||
|
||||
# npm-hook(1)
|
||||
|
||||
## Manage registry hooks
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm hook ls [pkg]
|
||||
npm hook add <entity> <url> <secret>
|
||||
npm hook update <id> <url> [secret]
|
||||
npm hook rm <id>
|
||||
```
|
||||
|
||||
### Example
|
||||
|
||||
Add a hook to watch a package for changes:
|
||||
```bash
|
||||
$ npm hook add lodash https://example.com/ my-shared-secret
|
||||
```
|
||||
|
||||
Add a hook to watch packages belonging to the user `substack`:
|
||||
```bash
|
||||
$ npm hook add ~substack https://example.com/ my-shared-secret
|
||||
```
|
||||
|
||||
Add a hook to watch packages in the scope `@npm`
|
||||
```bash
|
||||
$ npm hook add @npm https://example.com/ my-shared-secret
|
||||
```
|
||||
|
||||
List all your active hooks:
|
||||
```bash
|
||||
$ npm hook ls
|
||||
```
|
||||
|
||||
List your active hooks for the `lodash` package:
|
||||
```bash
|
||||
$ npm hook ls lodash
|
||||
```
|
||||
|
||||
Update an existing hook's url:
|
||||
```bash
|
||||
$ npm hook update id-deadbeef https://my-new-website.here/
|
||||
```
|
||||
|
||||
Remove a hook:
|
||||
```bash
|
||||
$ npm hook rm id-deadbeef
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
Allows you to manage [npm hooks](https://blog.npmjs.org/post/145260155635/introducing-hooks-get-notifications-of-npm),
|
||||
including adding, removing, listing, and updating.
|
||||
|
||||
Hooks allow you to configure URL endpoints that will be notified whenever a
|
||||
change happens to any of the supported entity types. Three different types of
|
||||
entities can be watched by hooks: packages, owners, and scopes.
|
||||
|
||||
To create a package hook, simply reference the package name.
|
||||
|
||||
To create an owner hook, prefix the owner name with `~` (as in, `~youruser`).
|
||||
|
||||
To create a scope hook, prefix the scope name with `@` (as in, `@yourscope`).
|
||||
|
||||
The hook `id` used by `update` and `rm` are the IDs listed in `npm hook ls` for
|
||||
that particular hook.
|
||||
|
||||
The shared secret will be sent along to the URL endpoint so you can verify the
|
||||
request came from your own configured hook.
|
||||
|
||||
### See Also
|
||||
|
||||
* ["Introducing Hooks" blog post](https://blog.npmjs.org/post/145260155635/introducing-hooks-get-notifications-of-npm)
|
||||
@ -0,0 +1,74 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-init
|
||||
description: create a package.json file
|
||||
---
|
||||
|
||||
# npm-init(1)
|
||||
|
||||
## create a package.json file
|
||||
|
||||
### Synopsis
|
||||
```bash
|
||||
npm init [--force|-f|--yes|-y|--scope]
|
||||
npm init <@scope> (same as `npx <@scope>/create`)
|
||||
npm init [<@scope>/]<name> (same as `npx [<@scope>/]create-<name>`)
|
||||
```
|
||||
|
||||
### Examples
|
||||
|
||||
Create a new React-based project using [`create-react-app`](https://npm.im/create-react-app):
|
||||
```bash
|
||||
$ npm init react-app ./my-react-app
|
||||
```
|
||||
|
||||
Create a new `esm`-compatible package using [`create-esm`](https://npm.im/create-esm):
|
||||
```bash
|
||||
$ mkdir my-esm-lib && cd my-esm-lib
|
||||
$ npm init esm --yes
|
||||
```
|
||||
|
||||
Generate a plain old package.json using legacy init:
|
||||
```bash
|
||||
$ mkdir my-npm-pkg && cd my-npm-pkg
|
||||
$ git init
|
||||
$ npm init
|
||||
```
|
||||
|
||||
Generate it without having it ask any questions:
|
||||
```bash
|
||||
$ npm init -y
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
`npm init <initializer>` can be used to set up a new or existing npm package.
|
||||
|
||||
`initializer` in this case is an npm package named `create-<initializer>`, which
|
||||
will be installed by [`npx`](https://npm.im/npx), and then have its main bin
|
||||
executed -- presumably creating or updating `package.json` and running any other
|
||||
initialization-related operations.
|
||||
|
||||
The init command is transformed to a corresponding `npx` operation as follows:
|
||||
|
||||
* `npm init foo` -> `npx create-foo`
|
||||
* `npm init @usr/foo` -> `npx @usr/create-foo`
|
||||
* `npm init @usr` -> `npx @usr/create`
|
||||
|
||||
Any additional options will be passed directly to the command, so `npm init foo
|
||||
--hello` will map to `npx create-foo --hello`.
|
||||
|
||||
If the initializer is omitted (by just calling `npm init`), init will fall back
|
||||
to legacy init behavior. It will ask you a bunch of questions, and then write a
|
||||
package.json for you. It will attempt to make reasonable guesses based on
|
||||
existing fields, dependencies, and options selected. It is strictly additive, so
|
||||
it will keep any fields and values that were already set. You can also use
|
||||
`-y`/`--yes` to skip the questionnaire altogether. If you pass `--scope`, it
|
||||
will create a scoped package.
|
||||
|
||||
### See Also
|
||||
|
||||
* <https://github.com/isaacs/init-package-json>
|
||||
* [package.json](/configuring-npm/package-json)
|
||||
* [npm version](/cli-commands/npm-version)
|
||||
* [npm scope](/using-npm/scope)
|
||||
26
src/main/ng-app/node/node_modules/npm/docs/content/cli-commands/npm-install-ci-test.md
generated
vendored
26
src/main/ng-app/node/node_modules/npm/docs/content/cli-commands/npm-install-ci-test.md
generated
vendored
@ -0,0 +1,26 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-install-ci-test
|
||||
description: Install a project with a clean slate and run tests
|
||||
---
|
||||
|
||||
# npm install-ci-test(1)
|
||||
|
||||
## Install a project with a clean slate and run tests
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm install-ci-test
|
||||
|
||||
alias: npm cit
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
This command runs an `npm ci` followed immediately by an `npm test`.
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm ci](/cli-commands/npm-ci)
|
||||
* [npm test](/cli-commands/npm-test)
|
||||
35
src/main/ng-app/node/node_modules/npm/docs/content/cli-commands/npm-install-test.md
generated
vendored
35
src/main/ng-app/node/node_modules/npm/docs/content/cli-commands/npm-install-test.md
generated
vendored
@ -0,0 +1,35 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-install-test
|
||||
description: Install package(s) and run tests
|
||||
---
|
||||
|
||||
# npm install-test(1)
|
||||
|
||||
## Install package(s) and run tests
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm install-test (with no args, in package dir)
|
||||
npm install-test [<@scope>/]<name>
|
||||
npm install-test [<@scope>/]<name>@<tag>
|
||||
npm install-test [<@scope>/]<name>@<version>
|
||||
npm install-test [<@scope>/]<name>@<version range>
|
||||
npm install-test <tarball file>
|
||||
npm install-test <tarball url>
|
||||
npm install-test <folder>
|
||||
|
||||
alias: npm it
|
||||
common options: [--save|--save-dev|--save-optional] [--save-exact] [--dry-run]
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
This command runs an `npm install` followed immediately by an `npm test`. It
|
||||
takes exactly the same arguments as `npm install`.
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm install](/cli-commands/npm-install)
|
||||
* [npm test](/cli-commands/npm-test)
|
||||
519
src/main/ng-app/node/node_modules/npm/docs/content/cli-commands/npm-install.md
generated
vendored
519
src/main/ng-app/node/node_modules/npm/docs/content/cli-commands/npm-install.md
generated
vendored
@ -0,0 +1,519 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-install
|
||||
description: Install a package
|
||||
---
|
||||
|
||||
# npm-install(1)
|
||||
|
||||
## Install a package
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm install (with no args, in package dir)
|
||||
npm install [<@scope>/]<name>
|
||||
npm install [<@scope>/]<name>@<tag>
|
||||
npm install [<@scope>/]<name>@<version>
|
||||
npm install [<@scope>/]<name>@<version range>
|
||||
npm install <alias>@npm:<name>
|
||||
npm install <git-host>:<git-user>/<repo-name>
|
||||
npm install <git repo url>
|
||||
npm install <tarball file>
|
||||
npm install <tarball url>
|
||||
npm install <folder>
|
||||
|
||||
aliases: npm i, npm add
|
||||
common options: [-P|--save-prod|-D|--save-dev|-O|--save-optional] [-E|--save-exact] [-B|--save-bundle] [--no-save] [--dry-run]
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
This command installs a package, and any packages that it depends on. If the
|
||||
package has a package-lock or shrinkwrap file, the installation of dependencies
|
||||
will be driven by that, with an `npm-shrinkwrap.json` taking precedence if both
|
||||
files exist. See [package-lock.json](/configuring-npm/package-lock-json) and [`npm shrinkwrap`](/cli-commands/npm-shrinkwrap).
|
||||
|
||||
A `package` is:
|
||||
|
||||
* a) a folder containing a program described by a [`package.json`](/configuring-npm/package-json) file
|
||||
* b) a gzipped tarball containing (a)
|
||||
* c) a url that resolves to (b)
|
||||
* d) a `<name>@<version>` that is published on the registry (see [`registry`](/using-npm/registry)) with (c)
|
||||
* e) a `<name>@<tag>` (see [`npm dist-tag`](/cli-commands/npm-dist-tag)) that points to (d)
|
||||
* f) a `<name>` that has a "latest" tag satisfying (e)
|
||||
* g) a `<git remote url>` that resolves to (a)
|
||||
|
||||
Even if you never publish your package, you can still get a lot of
|
||||
benefits of using npm if you just want to write a node program (a), and
|
||||
perhaps if you also want to be able to easily install it elsewhere
|
||||
after packing it up into a tarball (b).
|
||||
|
||||
|
||||
* `npm install` (in package directory, no arguments):
|
||||
|
||||
Install the dependencies in the local node_modules folder.
|
||||
|
||||
In global mode (ie, with `-g` or `--global` appended to the command),
|
||||
it installs the current package context (ie, the current working
|
||||
directory) as a global package.
|
||||
|
||||
By default, `npm install` will install all modules listed as dependencies
|
||||
in [`package.json`](/configuring-npm/package-json).
|
||||
|
||||
With the `--production` flag (or when the `NODE_ENV` environment variable
|
||||
is set to `production`), npm will not install modules listed in
|
||||
`devDependencies`. To install all modules listed in both `dependencies`
|
||||
and `devDependencies` when `NODE_ENV` environment variable is set to `production`,
|
||||
you can use `--production=false`.
|
||||
|
||||
> NOTE: The `--production` flag has no particular meaning when adding a
|
||||
dependency to a project.
|
||||
|
||||
* `npm install <folder>`:
|
||||
|
||||
Install the package in the directory as a symlink in the current project.
|
||||
Its dependencies will be installed before it's linked. If `<folder>` sits
|
||||
inside the root of your project, its dependencies may be hoisted to the
|
||||
toplevel `node_modules` as they would for other types of dependencies.
|
||||
|
||||
* `npm install <tarball file>`:
|
||||
|
||||
Install a package that is sitting on the filesystem. Note: if you just want
|
||||
to link a dev directory into your npm root, you can do this more easily by
|
||||
using `npm link`.
|
||||
|
||||
Tarball requirements:
|
||||
* The filename *must* use `.tar`, `.tar.gz`, or `.tgz` as
|
||||
the extension.
|
||||
* The package contents should reside in a subfolder inside the tarball (usually it is called `package/`). npm strips one directory layer when installing the package (an equivalent of `tar x --strip-components=1` is run).
|
||||
* The package must contain a `package.json` file with `name` and `version` properties.
|
||||
|
||||
Example:
|
||||
|
||||
npm install ./package.tgz
|
||||
|
||||
* `npm install <tarball url>`:
|
||||
|
||||
Fetch the tarball url, and then install it. In order to distinguish between
|
||||
this and other options, the argument must start with "http://" or "https://"
|
||||
|
||||
Example:
|
||||
|
||||
npm install https://github.com/indexzero/forever/tarball/v0.5.6
|
||||
|
||||
* `npm install [<@scope>/]<name>`:
|
||||
|
||||
Do a `<name>@<tag>` install, where `<tag>` is the "tag" config. (See
|
||||
[`config`](/using-npm/config). The config's default value is `latest`.)
|
||||
|
||||
In most cases, this will install the version of the modules tagged as
|
||||
`latest` on the npm registry.
|
||||
|
||||
Example:
|
||||
|
||||
npm install sax
|
||||
|
||||
* `npm install <alias>@npm:<name>`:
|
||||
|
||||
Install a package under a custom alias. Allows multiple versions of
|
||||
a same-name package side-by-side, more convenient import names for
|
||||
packages with otherwise long ones and using git forks replacements
|
||||
or forked npm packages as replacements. Aliasing works only on your
|
||||
project and does not rename packages in transitive dependencies.
|
||||
Aliases should follow the naming conventions stated in
|
||||
[`validate-npm-package-name`](https://www.npmjs.com/package/validate-npm-package-name#naming-rules).
|
||||
|
||||
Examples:
|
||||
|
||||
npm install my-react@npm:react
|
||||
npm install jquery2@npm:jquery@2
|
||||
npm install jquery3@npm:jquery@3
|
||||
npm install npa@npm:npm-package-arg
|
||||
|
||||
|
||||
`npm install` saves any specified packages into `dependencies` by default.
|
||||
Additionally, you can control where and how they get saved with some
|
||||
additional flags:
|
||||
|
||||
* `-P, --save-prod`: Package will appear in your `dependencies`. This is the
|
||||
default unless `-D` or `-O` are present.
|
||||
|
||||
* `-D, --save-dev`: Package will appear in your `devDependencies`.
|
||||
|
||||
* `-O, --save-optional`: Package will appear in your `optionalDependencies`.
|
||||
|
||||
* `--no-save`: Prevents saving to `dependencies`.
|
||||
|
||||
When using any of the above options to save dependencies to your
|
||||
package.json, there are two additional, optional flags:
|
||||
|
||||
* `-E, --save-exact`: Saved dependencies will be configured with an
|
||||
exact version rather than using npm's default semver range
|
||||
operator.
|
||||
|
||||
* `-B, --save-bundle`: Saved dependencies will also be added to your `bundleDependencies` list.
|
||||
|
||||
Further, if you have an `npm-shrinkwrap.json` or `package-lock.json` then it
|
||||
will be updated as well.
|
||||
|
||||
`<scope>` is optional. The package will be downloaded from the registry
|
||||
associated with the specified scope. If no registry is associated with
|
||||
the given scope the default registry is assumed. See [`scope`](/using-npm/scope).
|
||||
|
||||
Note: if you do not include the @-symbol on your scope name, npm will
|
||||
interpret this as a GitHub repository instead, see below. Scopes names
|
||||
must also be followed by a slash.
|
||||
|
||||
Examples:
|
||||
|
||||
```bash
|
||||
npm install sax
|
||||
npm install githubname/reponame
|
||||
npm install @myorg/privatepackage
|
||||
npm install node-tap --save-dev
|
||||
npm install dtrace-provider --save-optional
|
||||
npm install readable-stream --save-exact
|
||||
npm install ansi-regex --save-bundle
|
||||
```
|
||||
|
||||
**Note**: If there is a file or folder named `<name>` in the current
|
||||
working directory, then it will try to install that, and only try to
|
||||
fetch the package by name if it is not valid.
|
||||
|
||||
* `npm install [<@scope>/]<name>@<tag>`:
|
||||
|
||||
Install the version of the package that is referenced by the specified tag.
|
||||
If the tag does not exist in the registry data for that package, then this
|
||||
will fail.
|
||||
|
||||
Example:
|
||||
|
||||
```bash
|
||||
npm install sax@latest
|
||||
npm install @myorg/mypackage@latest
|
||||
```
|
||||
|
||||
* `npm install [<@scope>/]<name>@<version>`:
|
||||
|
||||
Install the specified version of the package. This will fail if the
|
||||
version has not been published to the registry.
|
||||
|
||||
Example:
|
||||
|
||||
```bash
|
||||
npm install sax@0.1.1
|
||||
npm install @myorg/privatepackage@1.5.0
|
||||
```
|
||||
|
||||
* `npm install [<@scope>/]<name>@<version range>`:
|
||||
|
||||
Install a version of the package matching the specified version range. This
|
||||
will follow the same rules for resolving dependencies described in [`package.json`](/configuring-npm/package-json).
|
||||
|
||||
Note that most version ranges must be put in quotes so that your shell will
|
||||
treat it as a single argument.
|
||||
|
||||
Example:
|
||||
```bash
|
||||
npm install sax@">=0.1.0 <0.2.0"
|
||||
npm install @myorg/privatepackage@">=0.1.0 <0.2.0"
|
||||
```
|
||||
|
||||
* `npm install <git remote url>`:
|
||||
|
||||
Installs the package from the hosted git provider, cloning it with `git`.
|
||||
For a full git remote url, only that URL will be attempted.
|
||||
|
||||
```bash
|
||||
<protocol>://[<user>[:<password>]@]<hostname>[:<port>][:][/]<path>[#<commit-ish> | #semver:<semver>]
|
||||
```
|
||||
|
||||
`<protocol>` is one of `git`, `git+ssh`, `git+http`, `git+https`, or
|
||||
`git+file`.
|
||||
|
||||
If `#<commit-ish>` is provided, it will be used to clone exactly that
|
||||
commit. If the commit-ish has the format `#semver:<semver>`, `<semver>` can
|
||||
be any valid semver range or exact version, and npm will look for any tags
|
||||
or refs matching that range in the remote repository, much as it would for a
|
||||
registry dependency. If neither `#<commit-ish>` or `#semver:<semver>` is
|
||||
specified, then the default branch of the repository is used.
|
||||
|
||||
If the repository makes use of submodules, those submodules will be cloned
|
||||
as well.
|
||||
|
||||
If the package being installed contains a `prepare` script, its
|
||||
`dependencies` and `devDependencies` will be installed, and the prepare
|
||||
script will be run, before the package is packaged and installed.
|
||||
|
||||
The following git environment variables are recognized by npm and will be
|
||||
added to the environment when running git:
|
||||
|
||||
* `GIT_ASKPASS`
|
||||
* `GIT_EXEC_PATH`
|
||||
* `GIT_PROXY_COMMAND`
|
||||
* `GIT_SSH`
|
||||
* `GIT_SSH_COMMAND`
|
||||
* `GIT_SSL_CAINFO`
|
||||
* `GIT_SSL_NO_VERIFY`
|
||||
|
||||
See the git man page for details.
|
||||
|
||||
Examples:
|
||||
|
||||
```bash
|
||||
npm install git+ssh://git@github.com:npm/cli.git#v1.0.27
|
||||
npm install git+ssh://git@github.com:npm/cli#semver:^5.0
|
||||
npm install git+https://isaacs@github.com/npm/cli.git
|
||||
npm install git://github.com/npm/cli.git#v1.0.27
|
||||
GIT_SSH_COMMAND='ssh -i ~/.ssh/custom_ident' npm install git+ssh://git@github.com:npm/cli.git
|
||||
```
|
||||
|
||||
* `npm install <githubname>/<githubrepo>[#<commit-ish>]`:
|
||||
* `npm install github:<githubname>/<githubrepo>[#<commit-ish>]`:
|
||||
|
||||
Install the package at `https://github.com/githubname/githubrepo` by
|
||||
attempting to clone it using `git`.
|
||||
|
||||
If `#<commit-ish>` is provided, it will be used to clone exactly that
|
||||
commit. If the commit-ish has the format `#semver:<semver>`, `<semver>` can
|
||||
be any valid semver range or exact version, and npm will look for any tags
|
||||
or refs matching that range in the remote repository, much as it would for a
|
||||
registry dependency. If neither `#<commit-ish>` or `#semver:<semver>` is
|
||||
specified, then `master` is used.
|
||||
|
||||
As with regular git dependencies, `dependencies` and `devDependencies` will
|
||||
be installed if the package has a `prepare` script, before the package is
|
||||
done installing.
|
||||
|
||||
Examples:
|
||||
|
||||
```bash
|
||||
npm install mygithubuser/myproject
|
||||
npm install github:mygithubuser/myproject
|
||||
```
|
||||
|
||||
* `npm install gist:[<githubname>/]<gistID>[#<commit-ish>|#semver:<semver>]`:
|
||||
|
||||
Install the package at `https://gist.github.com/gistID` by attempting to
|
||||
clone it using `git`. The GitHub username associated with the gist is
|
||||
optional and will not be saved in `package.json`.
|
||||
|
||||
As with regular git dependencies, `dependencies` and `devDependencies` will
|
||||
be installed if the package has a `prepare` script, before the package is
|
||||
done installing.
|
||||
|
||||
Example:
|
||||
|
||||
```bash
|
||||
npm install gist:101a11beef
|
||||
```
|
||||
|
||||
* `npm install bitbucket:<bitbucketname>/<bitbucketrepo>[#<commit-ish>]`:
|
||||
|
||||
Install the package at `https://bitbucket.org/bitbucketname/bitbucketrepo`
|
||||
by attempting to clone it using `git`.
|
||||
|
||||
If `#<commit-ish>` is provided, it will be used to clone exactly that
|
||||
commit. If the commit-ish has the format `#semver:<semver>`, `<semver>` can
|
||||
be any valid semver range or exact version, and npm will look for any tags
|
||||
or refs matching that range in the remote repository, much as it would for a
|
||||
registry dependency. If neither `#<commit-ish>` or `#semver:<semver>` is
|
||||
specified, then `master` is used.
|
||||
|
||||
As with regular git dependencies, `dependencies` and `devDependencies` will
|
||||
be installed if the package has a `prepare` script, before the package is
|
||||
done installing.
|
||||
|
||||
Example:
|
||||
|
||||
```bash
|
||||
npm install bitbucket:mybitbucketuser/myproject
|
||||
```
|
||||
|
||||
* `npm install gitlab:<gitlabname>/<gitlabrepo>[#<commit-ish>]`:
|
||||
|
||||
Install the package at `https://gitlab.com/gitlabname/gitlabrepo`
|
||||
by attempting to clone it using `git`.
|
||||
|
||||
If `#<commit-ish>` is provided, it will be used to clone exactly that
|
||||
commit. If the commit-ish has the format `#semver:<semver>`, `<semver>` can
|
||||
be any valid semver range or exact version, and npm will look for any tags
|
||||
or refs matching that range in the remote repository, much as it would for a
|
||||
registry dependency. If neither `#<commit-ish>` or `#semver:<semver>` is
|
||||
specified, then `master` is used.
|
||||
|
||||
As with regular git dependencies, `dependencies` and `devDependencies` will
|
||||
be installed if the package has a `prepare` script, before the package is
|
||||
done installing.
|
||||
|
||||
Example:
|
||||
|
||||
```bash
|
||||
npm install gitlab:mygitlabuser/myproject
|
||||
npm install gitlab:myusr/myproj#semver:^5.0
|
||||
```
|
||||
|
||||
You may combine multiple arguments, and even multiple types of arguments.
|
||||
For example:
|
||||
|
||||
```bash
|
||||
npm install sax@">=0.1.0 <0.2.0" bench supervisor
|
||||
```
|
||||
|
||||
The `--tag` argument will apply to all of the specified install targets. If a
|
||||
tag with the given name exists, the tagged version is preferred over newer
|
||||
versions.
|
||||
|
||||
The `--dry-run` argument will report in the usual way what the install would
|
||||
have done without actually installing anything.
|
||||
|
||||
The `--package-lock-only` argument will only update the `package-lock.json`,
|
||||
instead of checking `node_modules` and downloading dependencies.
|
||||
|
||||
The `-f` or `--force` argument will force npm to fetch remote resources even if a
|
||||
local copy exists on disk.
|
||||
|
||||
```bash
|
||||
npm install sax --force
|
||||
```
|
||||
|
||||
The `--no-fund` argument will hide the message displayed at the end of each
|
||||
install that acknowledges the number of dependencies looking for funding.
|
||||
See `npm-fund(1)`
|
||||
|
||||
The `-g` or `--global` argument will cause npm to install the package globally
|
||||
rather than locally. See [folders](/configuring-npm/folders).
|
||||
|
||||
The `--global-style` argument will cause npm to install the package into
|
||||
your local `node_modules` folder with the same layout it uses with the
|
||||
global `node_modules` folder. Only your direct dependencies will show in
|
||||
`node_modules` and everything they depend on will be flattened in their
|
||||
`node_modules` folders. This obviously will eliminate some deduping.
|
||||
|
||||
The `--ignore-scripts` argument will cause npm to not execute any
|
||||
scripts defined in the package.json. See [`scripts`](/using-npm/scripts).
|
||||
|
||||
The `--legacy-bundling` argument will cause npm to install the package such
|
||||
that versions of npm prior to 1.4, such as the one included with node 0.8,
|
||||
can install the package. This eliminates all automatic deduping.
|
||||
|
||||
The `--link` argument will cause npm to link global installs into the
|
||||
local space in some cases.
|
||||
|
||||
The `--no-bin-links` argument will prevent npm from creating symlinks for
|
||||
any binaries the package might contain.
|
||||
|
||||
The `--no-optional` argument will prevent optional dependencies from
|
||||
being installed.
|
||||
|
||||
The `--no-shrinkwrap` argument, which will ignore an available
|
||||
package lock or shrinkwrap file and use the package.json instead.
|
||||
|
||||
The `--no-package-lock` argument will prevent npm from creating a
|
||||
`package-lock.json` file. When running with package-lock's disabled npm
|
||||
will not automatically prune your node modules when installing.
|
||||
|
||||
The `--nodedir=/path/to/node/source` argument will allow npm to find the
|
||||
node source code so that npm can compile native modules.
|
||||
|
||||
The `--only={prod[uction]|dev[elopment]}` argument will cause either only
|
||||
`devDependencies` or only non-`devDependencies` to be installed regardless of the `NODE_ENV`.
|
||||
|
||||
The `--no-audit` argument can be used to disable sending of audit reports to
|
||||
the configured registries. See [`npm-audit`](npm-audit) for details on what is sent.
|
||||
|
||||
See [`config`](/using-npm/config). Many of the configuration params have some
|
||||
effect on installation, since that's most of what npm does.
|
||||
|
||||
#### Algorithm
|
||||
|
||||
To install a package, npm uses the following algorithm:
|
||||
```bash
|
||||
load the existing node_modules tree from disk
|
||||
clone the tree
|
||||
fetch the package.json and assorted metadata and add it to the clone
|
||||
walk the clone and add any missing dependencies
|
||||
dependencies will be added as close to the top as is possible
|
||||
without breaking any other modules
|
||||
compare the original tree with the cloned tree and make a list of
|
||||
actions to take to convert one to the other
|
||||
execute all of the actions, deepest first
|
||||
kinds of actions are install, update, remove and move
|
||||
```
|
||||
|
||||
For this `package{dep}` structure: `A{B,C}, B{C}, C{D}`,
|
||||
this algorithm produces:
|
||||
|
||||
```bash
|
||||
A
|
||||
+-- B
|
||||
+-- C
|
||||
+-- D
|
||||
```
|
||||
|
||||
That is, the dependency from B to C is satisfied by the fact that A
|
||||
already caused C to be installed at a higher level. D is still installed
|
||||
at the top level because nothing conflicts with it.
|
||||
|
||||
For `A{B,C}, B{C,D@1}, C{D@2}`, this algorithm produces:
|
||||
|
||||
```bash
|
||||
A
|
||||
+-- B
|
||||
+-- C
|
||||
`-- D@2
|
||||
+-- D@1
|
||||
```
|
||||
|
||||
Because B's D@1 will be installed in the top level, C now has to install D@2
|
||||
privately for itself. This algorithm is deterministic, but different trees may
|
||||
be produced if two dependencies are requested for installation in a different
|
||||
order.
|
||||
|
||||
See [folders](/configuring-npm/folders) for a more detailed description of the specific folder structures that npm creates.
|
||||
|
||||
### Limitations of npm's Install Algorithm
|
||||
|
||||
npm will refuse to install any package with an identical name to the
|
||||
current package. This can be overridden with the `--force` flag, but in
|
||||
most cases can simply be addressed by changing the local package name.
|
||||
|
||||
There are some very rare and pathological edge-cases where a cycle can
|
||||
cause npm to try to install a never-ending tree of packages. Here is
|
||||
the simplest case:
|
||||
|
||||
```bash
|
||||
A -> B -> A' -> B' -> A -> B -> A' -> B' -> A -> ...
|
||||
```
|
||||
|
||||
where `A` is some version of a package, and `A'` is a different version
|
||||
of the same package. Because `B` depends on a different version of `A`
|
||||
than the one that is already in the tree, it must install a separate
|
||||
copy. The same is true of `A'`, which must install `B'`. Because `B'`
|
||||
depends on the original version of `A`, which has been overridden, the
|
||||
cycle falls into infinite regress.
|
||||
|
||||
To avoid this situation, npm flat-out refuses to install any
|
||||
`name@version` that is already present anywhere in the tree of package
|
||||
folder ancestors. A more correct, but more complex, solution would be
|
||||
to symlink the existing version into the new location. If this ever
|
||||
affects a real use-case, it will be investigated.
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm folders](/configuring-npm/folders)
|
||||
* [npm update](/cli-commands/npm-update)
|
||||
* [npm audit](/cli-commands/npm-audit)
|
||||
* [npm fund](/cli-commands/npm-fund)
|
||||
* [npm link](/cli-commands/npm-link)
|
||||
* [npm rebuild](/cli-commands/npm-rebuild)
|
||||
* [npm scripts](/using-npm/scripts)
|
||||
* [npm build](/cli-commands/npm-build)
|
||||
* [npm config](/cli-commands/npm-config)
|
||||
* [npmrc](/configuring-npm/npmrc)
|
||||
* [npm registry](/using-npm/registry)
|
||||
* [npm dist-tag](/cli-commands/npm-dist-tag)
|
||||
* [npm uninstall](/cli-commands/npm-uninstall)
|
||||
* [npm shrinkwrap](/cli-commands/npm-shrinkwrap)
|
||||
* [package.json](/configuring-npm/package-json)
|
||||
@ -0,0 +1,92 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-link
|
||||
description: Symlink a package folder
|
||||
---
|
||||
|
||||
# npm-link(1)
|
||||
|
||||
## Symlink a package folder
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm link (in package dir)
|
||||
npm link [<@scope>/]<pkg>[@<version>]
|
||||
|
||||
alias: npm ln
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
Package linking is a two-step process.
|
||||
|
||||
First, `npm link` in a package folder will create a symlink in the global folder
|
||||
`{prefix}/lib/node_modules/<package>` that links to the package where the `npm
|
||||
link` command was executed. It will also link any bins in the package to `{prefix}/bin/{name}`.
|
||||
Note that `npm link` uses the global prefix (see `npm prefix -g` for its value).
|
||||
|
||||
Next, in some other location, `npm link package-name` will create a
|
||||
symbolic link from globally-installed `package-name` to `node_modules/`
|
||||
of the current folder.
|
||||
|
||||
Note that `package-name` is taken from `package.json`,
|
||||
not from directory name.
|
||||
|
||||
The package name can be optionally prefixed with a scope. See [`scope`](/using-npm/npm-scope).
|
||||
The scope must be preceded by an @-symbol and followed by a slash.
|
||||
|
||||
When creating tarballs for `npm publish`, the linked packages are
|
||||
"snapshotted" to their current state by resolving the symbolic links.
|
||||
|
||||
This is handy for installing your own stuff, so that you can work on it and
|
||||
test it iteratively without having to continually rebuild.
|
||||
|
||||
For example:
|
||||
|
||||
```bash
|
||||
cd ~/projects/node-redis # go into the package directory
|
||||
npm link # creates global link
|
||||
cd ~/projects/node-bloggy # go into some other package directory.
|
||||
npm link redis # link-install the package
|
||||
```
|
||||
|
||||
Now, any changes to ~/projects/node-redis will be reflected in
|
||||
~/projects/node-bloggy/node_modules/node-redis/. Note that the link should
|
||||
be to the package name, not the directory name for that package.
|
||||
|
||||
You may also shortcut the two steps in one. For example, to do the
|
||||
above use-case in a shorter way:
|
||||
|
||||
```bash
|
||||
cd ~/projects/node-bloggy # go into the dir of your main project
|
||||
npm link ../node-redis # link the dir of your dependency
|
||||
```
|
||||
|
||||
The second line is the equivalent of doing:
|
||||
|
||||
```bash
|
||||
(cd ../node-redis; npm link)
|
||||
npm link redis
|
||||
```
|
||||
|
||||
That is, it first creates a global link, and then links the global
|
||||
installation target into your project's `node_modules` folder.
|
||||
|
||||
Note that in this case, you are referring to the directory name, `node-redis`,
|
||||
rather than the package name `redis`.
|
||||
|
||||
If your linked package is scoped (see [`scope`](/using-npm/npm-scope)) your link command must include that scope, e.g.
|
||||
|
||||
```bash
|
||||
npm link @myorg/privatepackage
|
||||
```
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm developers](/using-npm/developers)
|
||||
* [package.json](/configuring-npm/package-json)
|
||||
* [npm- nstall](/cli-commands/npm-install)
|
||||
* [npm folders](/configuring-npm/folders)
|
||||
* [npm config](/cli-commands/npm-config)
|
||||
* [npmrc](/configuring-npm/npmrc)
|
||||
@ -0,0 +1,54 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-logout
|
||||
description: Log out of the registry
|
||||
---
|
||||
|
||||
# npm-logout(1)
|
||||
|
||||
## Log out of the registry
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm logout [--registry=<url>] [--scope=<@scope>]
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
When logged into a registry that supports token-based authentication, tell the
|
||||
server to end this token's session. This will invalidate the token everywhere
|
||||
you're using it, not just for the current environment.
|
||||
|
||||
When logged into a legacy registry that uses username and password authentication, this will
|
||||
clear the credentials in your user configuration. In this case, it will _only_ affect
|
||||
the current environment.
|
||||
|
||||
If `--scope` is provided, this will find the credentials for the registry
|
||||
connected to that scope, if set.
|
||||
|
||||
### Configuration
|
||||
|
||||
#### registry
|
||||
|
||||
Default: https://registry.npmjs.org/
|
||||
|
||||
The base URL of the npm package registry. If `scope` is also specified,
|
||||
it takes precedence.
|
||||
|
||||
#### scope
|
||||
|
||||
Default: The scope of your current project, if any, otherwise none.
|
||||
|
||||
If specified, you will be logged out of the specified scope. See [`scope`](/using-npm/npm-scope).
|
||||
|
||||
```bash
|
||||
npm logout --scope=@myco
|
||||
```
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm adduser](/cli-commands/npm-adduser)
|
||||
* [npm registry](/using-npm/registry)
|
||||
* [npm config](/cli-commands/npm-config)
|
||||
* [npm whoami](/cli-commands/npm-whoami)
|
||||
@ -0,0 +1,129 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-ls
|
||||
description: List installed packages
|
||||
---
|
||||
|
||||
# npm-ls(1)
|
||||
|
||||
## List installed packages
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm ls [[<@scope>/]<pkg> ...]
|
||||
|
||||
aliases: list, la, ll
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
This command will print to stdout all the versions of packages that are
|
||||
installed, as well as their dependencies, in a tree-structure.
|
||||
|
||||
Positional arguments are `name@version-range` identifiers, which will
|
||||
limit the results to only the paths to the packages named. Note that
|
||||
nested packages will *also* show the paths to the specified packages.
|
||||
For example, running `npm ls promzard` in npm's source tree will show:
|
||||
|
||||
```bash
|
||||
npm@@VERSION@ /path/to/npm
|
||||
└─┬ init-package-json@0.0.4
|
||||
└── promzard@0.1.5
|
||||
```
|
||||
|
||||
It will print out extraneous, missing, and invalid packages.
|
||||
|
||||
If a project specifies git urls for dependencies these are shown
|
||||
in parentheses after the name@version to make it easier for users to
|
||||
recognize potential forks of a project.
|
||||
|
||||
The tree shown is the logical dependency tree, based on package
|
||||
dependencies, not the physical layout of your node_modules folder.
|
||||
|
||||
When run as `ll` or `la`, it shows extended information by default.
|
||||
|
||||
### Configuration
|
||||
|
||||
#### json
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Show information in JSON format.
|
||||
|
||||
#### long
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Show extended information.
|
||||
|
||||
#### parseable
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Show parseable output instead of tree view.
|
||||
|
||||
#### global
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
List packages in the global install prefix instead of in the current
|
||||
project.
|
||||
|
||||
#### depth
|
||||
|
||||
* Type: Int
|
||||
|
||||
Max display depth of the dependency tree.
|
||||
|
||||
#### prod / production
|
||||
|
||||
* Type: Boolean
|
||||
* Default: false
|
||||
|
||||
Display only the dependency tree for packages in `dependencies`.
|
||||
|
||||
#### dev / development
|
||||
|
||||
* Type: Boolean
|
||||
* Default: false
|
||||
|
||||
Display only the dependency tree for packages in `devDependencies`.
|
||||
|
||||
#### only
|
||||
|
||||
* Type: String
|
||||
|
||||
When "dev" or "development", is an alias to `dev`.
|
||||
|
||||
When "prod" or "production", is an alias to `production`.
|
||||
|
||||
#### link
|
||||
|
||||
* Type: Boolean
|
||||
* Default: false
|
||||
|
||||
Display only dependencies which are linked
|
||||
|
||||
#### unicode
|
||||
|
||||
* Type: Boolean
|
||||
* Default: true
|
||||
|
||||
Whether to represent the tree structure using unicode characters.
|
||||
Set it to false in order to use all-ansi output.
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm config](/cli-commands/npm-config)
|
||||
* [npmrc](/configuring-npm/npmrc)
|
||||
* [npm folders](/configuring-npm/folders)
|
||||
* [npm install](/cli-commands/npm-install)
|
||||
* [npm link](/cli-commands/npm-link)
|
||||
* [npm prune](/cli-commands/npm-prune)
|
||||
* [npm outdated](/cli-commands/npm-outdated)
|
||||
* [npm update](/cli-commands/npm-update)
|
||||
@ -0,0 +1,65 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-org
|
||||
description: Manage orgs
|
||||
---
|
||||
|
||||
# npm-org(1)
|
||||
|
||||
## Manage orgs
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm org set <orgname> <username> [developer | admin | owner]
|
||||
npm org rm <orgname> <username>
|
||||
npm org ls <orgname> [<username>]
|
||||
```
|
||||
|
||||
### Example
|
||||
|
||||
Add a new developer to an org:
|
||||
|
||||
```bash
|
||||
$ npm org set my-org @mx-smith
|
||||
```
|
||||
|
||||
Add a new admin to an org (or change a developer to an admin):
|
||||
|
||||
```bash
|
||||
$ npm org set my-org @mx-santos admin
|
||||
```
|
||||
|
||||
Remove a user from an org:
|
||||
|
||||
```bash
|
||||
$ npm org rm my-org mx-santos
|
||||
```
|
||||
|
||||
List all users in an org:
|
||||
|
||||
```bash
|
||||
$ npm org ls my-org
|
||||
```
|
||||
|
||||
List all users in JSON format:
|
||||
|
||||
```bash
|
||||
$ npm org ls my-org --json
|
||||
```
|
||||
|
||||
See what role a user has in an org:
|
||||
|
||||
```bash
|
||||
$ npm org ls my-org @mx-santos
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
You can use the `npm org` commands to manage and view users of an organization.
|
||||
It supports adding and removing users, changing their roles, listing them, and
|
||||
finding specific ones and their roles.
|
||||
|
||||
### See Also
|
||||
|
||||
* [Documentation on npm Orgs](https://docs.npmjs.com/orgs/)
|
||||
124
src/main/ng-app/node/node_modules/npm/docs/content/cli-commands/npm-outdated.md
generated
vendored
124
src/main/ng-app/node/node_modules/npm/docs/content/cli-commands/npm-outdated.md
generated
vendored
@ -0,0 +1,124 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-outdated
|
||||
description: Check for outdated packages
|
||||
---
|
||||
|
||||
# npm-outdated(1)
|
||||
|
||||
## Check for outdated packages
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm outdated [[<@scope>/]<pkg> ...]
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
This command will check the registry to see if any (or, specific) installed
|
||||
packages are currently outdated.
|
||||
|
||||
In the output:
|
||||
|
||||
* `wanted` is the maximum version of the package that satisfies the semver
|
||||
range specified in `package.json`. If there's no available semver range (i.e.
|
||||
you're running `npm outdated --global`, or the package isn't included in
|
||||
`package.json`), then `wanted` shows the currently-installed version.
|
||||
* `latest` is the version of the package tagged as latest in the registry.
|
||||
Running `npm publish` with no special configuration will publish the package
|
||||
with a dist-tag of `latest`. This may or may not be the maximum version of
|
||||
the package, or the most-recently published version of the package, depending
|
||||
on how the package's developer manages the latest [dist-tag](npm-dist-tag).
|
||||
* `location` is where in the dependency tree the package is located. Note that
|
||||
`npm outdated` defaults to a depth of 0, so unless you override that, you'll
|
||||
always be seeing only top-level dependencies that are outdated.
|
||||
* `package type` (when using `--long` / `-l`) tells you whether this package is
|
||||
a `dependency` or a `devDependency`. Packages not included in `package.json`
|
||||
are always marked `dependencies`.
|
||||
* `homepage` (when using `--long` / `-l`) is the `homepage` value contained in the package's `package.json`
|
||||
* Red means there's a newer version matching your semver requirements, so you should update now.
|
||||
* Yellow indicates that there's a newer version above your semver requirements (usually new major, or new 0.x minor) so proceed with caution.
|
||||
|
||||
### An example
|
||||
|
||||
```bash
|
||||
$ npm outdated
|
||||
Package Current Wanted Latest Location
|
||||
glob 5.0.15 5.0.15 6.0.1 test-outdated-output
|
||||
nothingness 0.0.3 git git test-outdated-output
|
||||
npm 3.5.1 3.5.2 3.5.1 test-outdated-output
|
||||
local-dev 0.0.3 linked linked test-outdated-output
|
||||
once 1.3.2 1.3.3 1.3.3 test-outdated-output
|
||||
```
|
||||
|
||||
With these `dependencies`:
|
||||
```json
|
||||
{
|
||||
"glob": "^5.0.15",
|
||||
"nothingness": "github:othiym23/nothingness#master",
|
||||
"npm": "^3.5.1",
|
||||
"once": "^1.3.1"
|
||||
}
|
||||
```
|
||||
|
||||
A few things to note:
|
||||
|
||||
* `glob` requires `^5`, which prevents npm from installing `glob@6`, which is
|
||||
outside the semver range.
|
||||
* Git dependencies will always be reinstalled, because of how they're specified.
|
||||
The installed committish might satisfy the dependency specifier (if it's
|
||||
something immutable, like a commit SHA), or it might not, so `npm outdated` and
|
||||
`npm update` have to fetch Git repos to check. This is why currently doing a
|
||||
reinstall of a Git dependency always forces a new clone and install.
|
||||
* `npm@3.5.2` is marked as "wanted", but "latest" is `npm@3.5.1` because npm
|
||||
uses dist-tags to manage its `latest` and `next` release channels. `npm update`
|
||||
will install the _newest_ version, but `npm install npm` (with no semver range)
|
||||
will install whatever's tagged as `latest`.
|
||||
* `once` is just plain out of date. Reinstalling `node_modules` from scratch or
|
||||
running `npm update` will bring it up to spec.
|
||||
|
||||
### Configuration
|
||||
|
||||
#### json
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Show information in JSON format.
|
||||
|
||||
#### long
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Show extended information.
|
||||
|
||||
#### parseable
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Show parseable output instead of tree view.
|
||||
|
||||
#### global
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Check packages in the global install prefix instead of in the current
|
||||
project.
|
||||
|
||||
#### depth
|
||||
|
||||
* Default: 0
|
||||
* Type: Int
|
||||
|
||||
Max depth for checking dependency tree.
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm update](/cli-commands/npm-update)
|
||||
* [npm dist-tag](/cli-commands/npm-dist-tag)
|
||||
* [npm registry](/using-npm/registry)
|
||||
* [npm folders](/configuring-npm/folders)
|
||||
@ -0,0 +1,47 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-owner
|
||||
description: Manage package owners
|
||||
---
|
||||
|
||||
# npm-owner(1)
|
||||
## Manage package owners
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm owner add <user> [<@scope>/]<pkg>
|
||||
npm owner rm <user> [<@scope>/]<pkg>
|
||||
npm owner ls [<@scope>/]<pkg>
|
||||
|
||||
aliases: author
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
Manage ownership of published packages.
|
||||
|
||||
* ls:
|
||||
List all the users who have access to modify a package and push new versions.
|
||||
Handy when you need to know who to bug for help.
|
||||
* add:
|
||||
Add a new user as a maintainer of a package. This user is enabled to modify
|
||||
metadata, publish new versions, and add other owners.
|
||||
* rm:
|
||||
Remove a user from the package owner list. This immediately revokes their
|
||||
privileges.
|
||||
|
||||
Note that there is only one level of access. Either you can modify a package,
|
||||
or you can't. Future versions may contain more fine-grained access levels, but
|
||||
that is not implemented at this time.
|
||||
|
||||
If you have two-factor authentication enabled with `auth-and-writes` then
|
||||
you'll need to include an otp on the command line when changing ownership
|
||||
with `--otp`.
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm publish](/cli-commands/npm-publish)
|
||||
* [npm registry](/using-npm/registry)
|
||||
* [npm adduser](/cli-commands/npm-adduser)
|
||||
* [npm disputes](/using-npm/disputes)
|
||||
@ -0,0 +1,38 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-pack
|
||||
description: Create a tarball from a package
|
||||
---
|
||||
|
||||
# npm-pack(1)
|
||||
|
||||
## Create a tarball from a package
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm pack [[<@scope>/]<pkg>...] [--dry-run]
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
For anything that's installable (that is, a package folder, tarball,
|
||||
tarball url, name@tag, name@version, name, or scoped name), this
|
||||
command will fetch it to the cache, and then copy the tarball to the
|
||||
current working directory as `<name>-<version>.tgz`, and then write
|
||||
the filenames out to stdout.
|
||||
|
||||
If the same package is specified multiple times, then the file will be
|
||||
overwritten the second time.
|
||||
|
||||
If no arguments are supplied, then npm packs the current package folder.
|
||||
|
||||
The `--dry-run` argument will do everything that pack usually does without
|
||||
actually packing anything. Reports on what would have gone into the tarball.
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm cache](/cli-commands/npm-cache)
|
||||
* [npm publish](/cli-commands/npm-publish)
|
||||
* [npm config](/cli-commands/npm-config)
|
||||
* [npmrc](/configuring-npm/npmrc)
|
||||
@ -0,0 +1,33 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-ping
|
||||
description: Ping npm registry
|
||||
---
|
||||
|
||||
# npm-ping(1)
|
||||
|
||||
## Ping npm registry
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm ping [--registry <registry>]
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
Ping the configured or given npm registry and verify authentication.
|
||||
If it works it will output something like:
|
||||
|
||||
```bash
|
||||
Ping success: {*Details about registry*}
|
||||
```
|
||||
otherwise you will get:
|
||||
```bash
|
||||
Ping error: {*Detail about error}
|
||||
```
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm config](/cli-commands/npm-config)
|
||||
* [npmrc](/configuring-npm/npmrc)
|
||||
@ -0,0 +1,32 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-prefix
|
||||
description: Display prefix
|
||||
---
|
||||
|
||||
# npm-prefix(1)
|
||||
|
||||
## Display prefix
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm prefix [-g]
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
Print the local prefix to standard out. This is the closest parent directory
|
||||
to contain a `package.json` file or `node_modules` directory, unless `-g` is
|
||||
also specified.
|
||||
|
||||
If `-g` is specified, this will be the value of the global prefix. See
|
||||
[`npm config`](/cli-commands/npm-config) for more detail.
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm root](/cli-commands/npm-root)
|
||||
* [npm bin](/cli-commands/npm-bin)
|
||||
* [npm folders](/configuring-npm/folders)
|
||||
* [npm config](/cli-commands/npm-config)
|
||||
* [npmrc](/configuring-npm/npmrc)
|
||||
82
src/main/ng-app/node/node_modules/npm/docs/content/cli-commands/npm-profile.md
generated
vendored
82
src/main/ng-app/node/node_modules/npm/docs/content/cli-commands/npm-profile.md
generated
vendored
@ -0,0 +1,82 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-profile
|
||||
description: Change settings on your registry profile
|
||||
---
|
||||
|
||||
# npm-profile(1)
|
||||
## Change settings on your registry profile
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm profile get [--json|--parseable] [<property>]
|
||||
npm profile set [--json|--parseable] <property> <value>
|
||||
npm profile set password
|
||||
npm profile enable-2fa [auth-and-writes|auth-only]
|
||||
npm profile disable-2fa
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
Change your profile information on the registry. This not be available if
|
||||
you're using a non-npmjs registry.
|
||||
|
||||
* `npm profile get [<property>]`:
|
||||
Display all of the properties of your profile, or one or more specific
|
||||
properties. It looks like:
|
||||
|
||||
```bash
|
||||
+-----------------+---------------------------+
|
||||
| name | example |
|
||||
+-----------------+---------------------------+
|
||||
| email | me@example.com (verified) |
|
||||
+-----------------+---------------------------+
|
||||
| two factor auth | auth-and-writes |
|
||||
+-----------------+---------------------------+
|
||||
| fullname | Example User |
|
||||
+-----------------+---------------------------+
|
||||
| homepage | |
|
||||
+-----------------+---------------------------+
|
||||
| freenode | |
|
||||
+-----------------+---------------------------+
|
||||
| twitter | |
|
||||
+-----------------+---------------------------+
|
||||
| github | |
|
||||
+-----------------+---------------------------+
|
||||
| created | 2015-02-26T01:38:35.892Z |
|
||||
+-----------------+---------------------------+
|
||||
| updated | 2017-10-02T21:29:45.922Z |
|
||||
+-----------------+---------------------------+
|
||||
```
|
||||
|
||||
* `npm profile set <property> <value>`:
|
||||
Set the value of a profile property. You can set the following properties this way:
|
||||
email, fullname, homepage, freenode, twitter, github
|
||||
|
||||
* `npm profile set password`:
|
||||
Change your password. This is interactive, you'll be prompted for your
|
||||
current password and a new password. You'll also be prompted for an OTP
|
||||
if you have two-factor authentication enabled.
|
||||
|
||||
* `npm profile enable-2fa [auth-and-writes|auth-only]`:
|
||||
Enables two-factor authentication. Defaults to `auth-and-writes` mode. Modes are:
|
||||
* `auth-only`: Require an OTP when logging in or making changes to your
|
||||
account's authentication. The OTP will be required on both the website
|
||||
and the command line.
|
||||
* `auth-and-writes`: Requires an OTP at all the times `auth-only` does, and also requires one when
|
||||
publishing a module, setting the `latest` dist-tag, or changing access
|
||||
via `npm access` and `npm owner`.
|
||||
|
||||
* `npm profile disable-2fa`:
|
||||
Disables two-factor authentication.
|
||||
|
||||
### Details
|
||||
|
||||
All of the `npm profile` subcommands accept `--json` and `--parseable` and
|
||||
will tailor their output based on those. Some of these commands may not be
|
||||
available on non npmjs.com registries.
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm config](/cli-commands/npm-config)
|
||||
@ -0,0 +1,46 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-prune
|
||||
description: Remove extraneous packages
|
||||
---
|
||||
|
||||
# npm-prune(1)
|
||||
## Remove extraneous packages
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm prune [[<@scope>/]<pkg>...] [--production] [--dry-run] [--json]
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
This command removes "extraneous" packages. If a package name is
|
||||
provided, then only packages matching one of the supplied names are
|
||||
removed.
|
||||
|
||||
Extraneous packages are packages that are not listed on the parent
|
||||
package's dependencies list.
|
||||
|
||||
If the `--production` flag is specified or the `NODE_ENV` environment
|
||||
variable is set to `production`, this command will remove the packages
|
||||
specified in your `devDependencies`. Setting `--no-production` will
|
||||
negate `NODE_ENV` being set to `production`.
|
||||
|
||||
If the `--dry-run` flag is used then no changes will actually be made.
|
||||
|
||||
If the `--json` flag is used then the changes `npm prune` made (or would
|
||||
have made with `--dry-run`) are printed as a JSON object.
|
||||
|
||||
In normal operation with package-locks enabled, extraneous modules are
|
||||
pruned automatically when modules are installed and you'll only need
|
||||
this command with the `--production` flag.
|
||||
|
||||
If you've disabled package-locks then extraneous modules will not be removed
|
||||
and it's up to you to run `npm prune` from time-to-time to remove them.
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm uninstall](/cli-commands/npm-uninstall)
|
||||
* [npm folders](/configuring-npm/folders)
|
||||
* [npm ls](/cli-commands/npm-ls)
|
||||
81
src/main/ng-app/node/node_modules/npm/docs/content/cli-commands/npm-publish.md
generated
vendored
81
src/main/ng-app/node/node_modules/npm/docs/content/cli-commands/npm-publish.md
generated
vendored
@ -0,0 +1,81 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-publish
|
||||
description: Publish a package
|
||||
---
|
||||
|
||||
# npm-publish(1)
|
||||
|
||||
## Publish a package
|
||||
|
||||
### Synopsis
|
||||
```bash
|
||||
npm publish [<tarball>|<folder>] [--tag <tag>] [--access <public|restricted>] [--otp otpcode] [--dry-run]
|
||||
|
||||
Publishes '.' if no argument supplied
|
||||
Sets tag 'latest' if no --tag specified
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
Publishes a package to the registry so that it can be installed by name. All
|
||||
files in the package directory are included if no local `.gitignore` or
|
||||
`.npmignore` file exists. If both files exist and a file is ignored by
|
||||
`.gitignore` but not by `.npmignore` then it will be included. See
|
||||
[`developers`](/using-npm/developers) for full details on what's included in the published package, as well as details on how the package is built.
|
||||
|
||||
By default npm will publish to the public registry. This can be overridden by
|
||||
specifying a different default registry or using a [`scope`](/using-npm/npm-scope) in the name (see [`package.json`](/configuring-npm/package-json)).
|
||||
|
||||
* `<folder>`:
|
||||
A folder containing a package.json file
|
||||
|
||||
* `<tarball>`:
|
||||
A url or file path to a gzipped tar archive containing a single folder
|
||||
with a package.json file inside.
|
||||
|
||||
* `[--tag <tag>]`
|
||||
Registers the published package with the given tag, such that `npm install
|
||||
<name>@<tag>` will install this version. By default, `npm publish` updates
|
||||
and `npm install` installs the `latest` tag. See [`npm-dist-tag`](npm-dist-tag) for
|
||||
details about tags.
|
||||
|
||||
* `[--access <public|restricted>]`
|
||||
Tells the registry whether this package should be published as public or
|
||||
restricted. Only applies to scoped packages, which default to `restricted`.
|
||||
If you don't have a paid account, you must publish with `--access public`
|
||||
to publish scoped packages.
|
||||
|
||||
* `[--otp <otpcode>]`
|
||||
If you have two-factor authentication enabled in `auth-and-writes` mode
|
||||
then you can provide a code from your authenticator with this. If you
|
||||
don't include this and you're running from a TTY then you'll be prompted.
|
||||
|
||||
* `[--dry-run]`
|
||||
As of `npm@6`, does everything publish would do except actually publishing
|
||||
to the registry. Reports the details of what would have been published.
|
||||
|
||||
Fails if the package name and version combination already exists in
|
||||
the specified registry.
|
||||
|
||||
Once a package is published with a given name and version, that
|
||||
specific name and version combination can never be used again, even if
|
||||
it is removed with [`npm unpublish`](/cli-commands/npm-unpublish).
|
||||
|
||||
As of `npm@5`, both a sha1sum and an integrity field with a sha512sum of the
|
||||
tarball will be submitted to the registry during publication. Subsequent
|
||||
installs will use the strongest supported algorithm to verify downloads.
|
||||
|
||||
Similar to `--dry-run` see [`npm pack`](/cli-commands/npm-pack), which figures out the files to be
|
||||
included and packs them into a tarball to be uploaded to the registry.
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm registry](/using-npm/registry)
|
||||
* [npm scope](/using-npm/scope)
|
||||
* [npm adduser](/cli-commands/npm-adduser)
|
||||
* [npm owner](/cli-commands/npm-owner)
|
||||
* [npm deprecate](/cli-commands/npm-deprecate)
|
||||
* [npm dist-tag](/cli-commands/npm-dist-tag)
|
||||
* [npm pack](/cli-commands/npm-pack)
|
||||
* [npm profile](/cli-commands/npm-profile)
|
||||
26
src/main/ng-app/node/node_modules/npm/docs/content/cli-commands/npm-rebuild.md
generated
vendored
26
src/main/ng-app/node/node_modules/npm/docs/content/cli-commands/npm-rebuild.md
generated
vendored
@ -0,0 +1,26 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-rebuild
|
||||
description: Rebuild a package
|
||||
---
|
||||
|
||||
# npm-rebuild(1)
|
||||
|
||||
## Rebuild a package
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm rebuild [[<@scope>/<name>]...]
|
||||
|
||||
alias: npm rb
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
This command runs the `npm build` command on the matched folders. This is useful when you install a new version of node, and must recompile all your C++ addons with the new binary.
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm build](/cli-commands/npm-build)
|
||||
* [npm install](/cli-commands/npm-install)
|
||||
@ -0,0 +1,36 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-repo
|
||||
description: Open package repository page in the browser
|
||||
---
|
||||
|
||||
# npm-repo(1)
|
||||
|
||||
## Open package repository page in the browser
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm repo [<pkg>]
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
This command tries to guess at the likely location of a package's
|
||||
repository URL, and then tries to open it using the `--browser`
|
||||
config param. If no package name is provided, it will search for
|
||||
a `package.json` in the current folder and use the `name` property.
|
||||
|
||||
### Configuration
|
||||
|
||||
#### browser
|
||||
|
||||
* Default: OS X: `"open"`, Windows: `"start"`, Others: `"xdg-open"`
|
||||
* Type: String
|
||||
|
||||
The browser that is called by the `npm repo` command to open websites.
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm docs](/cli-commands/npm-docs)
|
||||
* [npm config](/cli-commands/npm-config)
|
||||
49
src/main/ng-app/node/node_modules/npm/docs/content/cli-commands/npm-restart.md
generated
vendored
49
src/main/ng-app/node/node_modules/npm/docs/content/cli-commands/npm-restart.md
generated
vendored
@ -0,0 +1,49 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-restart
|
||||
description: Restart a package
|
||||
---
|
||||
|
||||
# npm-restart(1)
|
||||
|
||||
## Restart a package
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm restart [-- <args>]
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
This restarts a package.
|
||||
|
||||
This runs a package's "stop", "restart", and "start" scripts, and associated
|
||||
pre- and post- scripts, in the order given below:
|
||||
|
||||
1. prerestart
|
||||
2. prestop
|
||||
3. stop
|
||||
4. poststop
|
||||
5. restart
|
||||
6. prestart
|
||||
7. start
|
||||
8. poststart
|
||||
9. postrestart
|
||||
|
||||
### Note
|
||||
|
||||
Note that the "restart" script is run **in addition to** the "stop"
|
||||
and "start" scripts, not instead of them.
|
||||
|
||||
This is the behavior as of `npm` major version 2. A change in this
|
||||
behavior will be accompanied by an increase in major version number
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm run-script](/cli-commands/npm-run-script)
|
||||
* [npm scripts](/using-npm/scripts)
|
||||
* [npm test](/cli-commands/npm-test)
|
||||
* [npm start](/cli-commands/npm-start)
|
||||
* [npm stop](/cli-commands/npm-stop)
|
||||
* [npm restart](/cli-commands/npm-restart)
|
||||
@ -0,0 +1,26 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-root
|
||||
description: Display npm root
|
||||
---
|
||||
|
||||
# npm-root(1)
|
||||
|
||||
## Display npm root
|
||||
|
||||
### Synopsis
|
||||
```bash
|
||||
npm root [-g]
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
Print the effective `node_modules` folder to standard out.
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm prefix](/cli-commands/npm-prefix)
|
||||
* [npm bin](/cli-commands/npm-bin)
|
||||
* [npm folders](/configuring-npm/folders)
|
||||
* [npm config](/cli-commands/npm-config)
|
||||
* [npmrc](/configuring-npm/npmrc)
|
||||
97
src/main/ng-app/node/node_modules/npm/docs/content/cli-commands/npm-run-script.md
generated
vendored
97
src/main/ng-app/node/node_modules/npm/docs/content/cli-commands/npm-run-script.md
generated
vendored
@ -0,0 +1,97 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-run-script
|
||||
description: Run arbitrary package scripts
|
||||
---
|
||||
|
||||
# npm-run-script(1)
|
||||
|
||||
## Run arbitrary package scripts
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm run-script <command> [--silent] [-- <args>...]
|
||||
|
||||
alias: npm run
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
This runs an arbitrary command from a package's `"scripts"` object. If no
|
||||
`"command"` is provided, it will list the available scripts. `run[-script]` is
|
||||
used by the test, start, restart, and stop commands, but can be called
|
||||
directly, as well. When the scripts in the package are printed out, they're
|
||||
separated into lifecycle (test, start, restart) and directly-run scripts.
|
||||
|
||||
As of [`npm@2.0.0`](https://blog.npmjs.org/post/98131109725/npm-2-0-0), you can
|
||||
use custom arguments when executing scripts. The special option `--` is used by
|
||||
[getopt](https://goo.gl/KxMmtG) to delimit the end of the options. npm will pass
|
||||
all the arguments after the `--` directly to your script:
|
||||
|
||||
```bash
|
||||
npm run test -- --grep="pattern"
|
||||
```
|
||||
|
||||
The arguments will only be passed to the script specified after ```npm run```
|
||||
and not to any pre or post script.
|
||||
|
||||
The `env` script is a special built-in command that can be used to list
|
||||
environment variables that will be available to the script at runtime. If an
|
||||
"env" command is defined in your package, it will take precedence over the
|
||||
built-in.
|
||||
|
||||
In addition to the shell's pre-existing `PATH`, `npm run` adds
|
||||
`node_modules/.bin` to the `PATH` provided to scripts. Any binaries provided by
|
||||
locally-installed dependencies can be used without the `node_modules/.bin`
|
||||
prefix. For example, if there is a `devDependency` on `tap` in your package,
|
||||
you should write:
|
||||
|
||||
```bash
|
||||
"scripts": {"test": "tap test/\*.js"}
|
||||
```
|
||||
|
||||
instead of
|
||||
|
||||
```bash
|
||||
"scripts": {"test": "node_modules/.bin/tap test/\*.js"}
|
||||
```
|
||||
|
||||
to run your tests.
|
||||
|
||||
The actual shell your script is run within is platform dependent. By default,
|
||||
on Unix-like systems it is the `/bin/sh` command, on Windows it is the `cmd.exe`.
|
||||
The actual shell referred to by `/bin/sh` also depends on the system.
|
||||
As of [`npm@5.1.0`](https://github.com/npm/npm/releases/tag/v5.1.0) you can
|
||||
customize the shell with the `script-shell` configuration.
|
||||
|
||||
Scripts are run from the root of the module, regardless of what your current
|
||||
working directory is when you call `npm run`. If you want your script to
|
||||
use different behavior based on what subdirectory you're in, you can use the
|
||||
`INIT_CWD` environment variable, which holds the full path you were in when
|
||||
you ran `npm run`.
|
||||
|
||||
`npm run` sets the `NODE` environment variable to the `node` executable with
|
||||
which `npm` is executed. Also, if the `--scripts-prepend-node-path` is passed,
|
||||
the directory within which `node` resides is added to the
|
||||
`PATH`. If `--scripts-prepend-node-path=auto` is passed (which has been the
|
||||
default in `npm` v3), this is only performed when that `node` executable is
|
||||
not found in the `PATH`.
|
||||
|
||||
If you try to run a script without having a `node_modules` directory and it fails,
|
||||
you will be given a warning to run `npm install`, just in case you've forgotten.
|
||||
|
||||
You can use the `--silent` flag to prevent showing `npm ERR!` output on error.
|
||||
|
||||
You can use the `--if-present` flag to avoid exiting with a non-zero exit code
|
||||
when the script is undefined. This lets you run potentially undefined scripts
|
||||
without breaking the execution chain.
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm scripts](/using-npm/scripts)
|
||||
* [npm test](/cli-commands/npm-test)
|
||||
* [npm start](/cli-commands/npm-start)
|
||||
* [npm restart](/cli-commands/npm-restart)
|
||||
* [npm stop](/cli-commands/npm-stop)
|
||||
* [npm config](/cli-commands/npm-config)
|
||||
114
src/main/ng-app/node/node_modules/npm/docs/content/cli-commands/npm-search.md
generated
vendored
114
src/main/ng-app/node/node_modules/npm/docs/content/cli-commands/npm-search.md
generated
vendored
@ -0,0 +1,114 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-search
|
||||
description: Search for packages
|
||||
---
|
||||
|
||||
# npm-search(1)
|
||||
|
||||
## Search for packages
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm search [-l|--long] [--json] [--parseable] [--no-description] [search terms ...]
|
||||
|
||||
aliases: s, se, find
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
Search the registry for packages matching the search terms. `npm search`
|
||||
performs a linear, incremental, lexically-ordered search through package
|
||||
metadata for all files in the registry. If color is enabled, it will further
|
||||
highlight the matches in the results.
|
||||
|
||||
Additionally, using the `--searchopts` and `--searchexclude` options paired with
|
||||
more search terms will respectively include and exclude further patterns. The
|
||||
main difference between `--searchopts` and the standard search terms is that the
|
||||
former does not highlight results in the output and can be used for more
|
||||
fine-grained filtering. Additionally, both of these can be added to `.npmrc` for
|
||||
default search filtering behavior.
|
||||
|
||||
Search also allows targeting of maintainers in search results, by prefixing
|
||||
their npm username with `=`.
|
||||
|
||||
If a term starts with `/`, then it's interpreted as a regular expression and
|
||||
supports standard JavaScript RegExp syntax. A trailing `/` will be ignored in
|
||||
this case. (Note that many regular expression characters must be escaped or
|
||||
quoted in most shells.)
|
||||
|
||||
### A Note on caching
|
||||
|
||||
### Configuration
|
||||
|
||||
#### description
|
||||
|
||||
* Default: true
|
||||
* Type: Boolean
|
||||
|
||||
Used as `--no-description`, disables search matching in package descriptions and
|
||||
suppresses display of that field in results.
|
||||
|
||||
#### json
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Output search results as a JSON array.
|
||||
|
||||
#### parseable
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Output search results as lines with tab-separated columns.
|
||||
|
||||
#### long
|
||||
|
||||
* Default: false
|
||||
* Type: Boolean
|
||||
|
||||
Display full package descriptions and other long text across multiple
|
||||
lines. When disabled (default) search results are truncated to fit
|
||||
neatly on a single line. Modules with extremely long names will
|
||||
fall on multiple lines.
|
||||
|
||||
#### searchopts
|
||||
|
||||
* Default: ""
|
||||
* Type: String
|
||||
|
||||
Space-separated options that are always passed to search.
|
||||
|
||||
#### searchexclude
|
||||
|
||||
* Default: ""
|
||||
* Type: String
|
||||
|
||||
Space-separated options that limit the results from search.
|
||||
|
||||
#### searchstaleness
|
||||
|
||||
* Default: 900 (15 minutes)
|
||||
* Type: Number
|
||||
|
||||
The age of the cache, in seconds, before another registry request is made.
|
||||
|
||||
#### registry
|
||||
|
||||
* Default: https://registry.npmjs.org/
|
||||
* Type: url
|
||||
|
||||
Search the specified registry for modules. If you have configured npm to point
|
||||
to a different default registry, such as your internal private module
|
||||
repository, `npm search` will default to that registry when searching. Pass a
|
||||
different registry url such as the default above in order to override this
|
||||
setting.
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm registry](/using-npm/registry)
|
||||
* [npm config](/cli-commands/npm-config)
|
||||
* [npmrc](/configuring-npm/npmrc)
|
||||
* [npm view](/cli-commands/npm-view)
|
||||
34
src/main/ng-app/node/node_modules/npm/docs/content/cli-commands/npm-shrinkwrap.md
generated
vendored
34
src/main/ng-app/node/node_modules/npm/docs/content/cli-commands/npm-shrinkwrap.md
generated
vendored
@ -0,0 +1,34 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-shrinkwrap
|
||||
description: Lock down dependency versions for publication
|
||||
---
|
||||
|
||||
# npm-shrinkwrap(1)
|
||||
|
||||
## Lock down dependency versions for publication
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm shrinkwrap
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
This command repurposes `package-lock.json` into a publishable
|
||||
`npm-shrinkwrap.json` or simply creates a new one. The file created and updated
|
||||
by this command will then take precedence over any other existing or future
|
||||
`package-lock.json` files. For a detailed explanation of the design and purpose
|
||||
of package locks in npm, see [package-locks](/configuring-npm/package-locks).
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm install](/cli-commands/npm-install)
|
||||
* [npm run-script](/cli-commands/npm-run-script)
|
||||
* [npm scripts](/using-npm/scripts)
|
||||
* [package.js](/configuring-npm/package-json)
|
||||
* [package-locks](/configuring-npm/package-locks)
|
||||
* [package-lock.json](/configuring-npm/package-lock-json)
|
||||
* [shrinkwrap.json](/configuring-npm/shrinkwrap-json)
|
||||
* [npm ls](/cli-commands/npm-ls)
|
||||
@ -0,0 +1,31 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-star
|
||||
description: Mark your favorite packages
|
||||
---
|
||||
|
||||
# npm-star(1)
|
||||
|
||||
## Mark your favorite packages
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm star [<pkg>...]
|
||||
npm unstar [<pkg>...]
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
"Starring" a package means that you have some interest in it. It's
|
||||
a vaguely positive way to show that you care.
|
||||
|
||||
"Unstarring" is the same thing, but in reverse.
|
||||
|
||||
It's a boolean thing. Starring repeatedly has no additional effect.
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm view](/cli-commands/npm-view)
|
||||
* [npm whoami](/cli-commands/npm-whoami)
|
||||
* [npm adduser](/cli-commands/npm-adduser)
|
||||
@ -0,0 +1,29 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-stars
|
||||
description: View packages marked as favorites
|
||||
---
|
||||
|
||||
# npm-stars(1)
|
||||
|
||||
## View packages marked as favorites
|
||||
|
||||
### Synopsis
|
||||
```bash
|
||||
npm stars [<user>]
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
If you have starred a lot of neat things and want to find them again
|
||||
quickly this command lets you do just that.
|
||||
|
||||
You may also want to see your friend's favorite packages, in this case
|
||||
you will most certainly enjoy this command.
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm star](/cli-commands/npm-star)
|
||||
* [npm view](/cli-commands/npm-view)
|
||||
* [npm whoami](/cli-commands/npm-whoami)
|
||||
* [npm adduser](/cli-commands/npm-adduser)
|
||||
@ -0,0 +1,32 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-start
|
||||
description: Start a package
|
||||
---
|
||||
|
||||
# npm-start(1)
|
||||
|
||||
## Start a package
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm start [-- <args>]
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
This runs an arbitrary command specified in the package's `"start"` property of
|
||||
its `"scripts"` object. If no `"start"` property is specified on the
|
||||
`"scripts"` object, it will run `node server.js`.
|
||||
|
||||
As of [`npm@2.0.0`](https://blog.npmjs.org/post/98131109725/npm-2-0-0), you can
|
||||
use custom arguments when executing scripts. Refer to [`npm run-script`](/cli-commands/npm-run-script) for more details.
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm run-script](/cli-commands/npm-run-script)
|
||||
* [npm scripts](/using-npm/scripts)
|
||||
* [npm test](/cli-commands/npm-test)
|
||||
* [npm restart](/cli-commands/npm-restart)
|
||||
* [npm stop](/cli-commands/npm-stop)
|
||||
@ -0,0 +1,27 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-stop
|
||||
description: Stop a package
|
||||
---
|
||||
|
||||
# npm-stop(1)
|
||||
|
||||
## Stop a package
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm stop [-- <args>]
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
This runs a package's "stop" script, if one was provided.
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm run-script](/cli-commands/npm-run-script)
|
||||
* [npm scripts](/using-npm/scripts)
|
||||
* [npm test](/cli-commands/npm-test)
|
||||
* [npm start](/cli-commands/npm-start)
|
||||
* [npm restart](/cli-commands/npm-restart)
|
||||
@ -0,0 +1,64 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-team
|
||||
description: Manage organization teams and team memberships
|
||||
---
|
||||
|
||||
# npm-team(1)
|
||||
|
||||
## Manage organization teams and team memberships
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm team create <scope:team>
|
||||
npm team destroy <scope:team>
|
||||
|
||||
npm team add <scope:team> <user>
|
||||
npm team rm <scope:team> <user>
|
||||
|
||||
npm team ls <scope>|<scope:team>
|
||||
|
||||
npm team edit <scope:team>
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
Used to manage teams in organizations, and change team memberships. Does not
|
||||
handle permissions for packages.
|
||||
|
||||
Teams must always be fully qualified with the organization/scope they belong to
|
||||
when operating on them, separated by a colon (`:`). That is, if you have a `wombats` team in a `wisdom` organization, you must always refer to that team as `wisdom:wombats` in these commands.
|
||||
|
||||
* create / destroy:
|
||||
Create a new team, or destroy an existing one. Note: You cannot remove the `developers` team, <a href="https://docs.npmjs.com/about-developers-team" target="_blank">learn more.</a>
|
||||
* add / rm:
|
||||
Add a user to an existing team, or remove a user from a team they belong to.
|
||||
|
||||
* ls:
|
||||
If performed on an organization name, will return a list of existing teams
|
||||
under that organization. If performed on a team, it will instead return a list
|
||||
of all users belonging to that particular team.
|
||||
|
||||
* edit:
|
||||
Edit a current team.
|
||||
|
||||
### Details
|
||||
|
||||
`npm team` always operates directly on the current registry, configurable from
|
||||
the command line using `--registry=<registry url>`.
|
||||
|
||||
In order to create teams and manage team membership, you must be a *team admin*
|
||||
under the given organization. Listing teams and team memberships may be done by
|
||||
any member of the organizations.
|
||||
|
||||
Organization creation and management of team admins and *organization* members
|
||||
is done through the website, not the npm CLI.
|
||||
|
||||
To use teams to manage permissions on packages belonging to your organization,
|
||||
use the `npm access` command to grant or revoke the appropriate permissions.
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm access](/cli-commands/npm-access)
|
||||
* [npm registry](/using-npm/registry)
|
||||
@ -0,0 +1,29 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-test
|
||||
description: Test a package
|
||||
---
|
||||
|
||||
# npm-test(1)
|
||||
|
||||
## Test a package
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm test [-- <args>]
|
||||
|
||||
aliases: t, tst
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
This runs a package's "test" script, if one was provided.
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm run-script](/cli-commands/npm-run-script)
|
||||
* [npm scripts](/using-npm/scripts)
|
||||
* [npm start](/cli-commands/npm-start)
|
||||
* [npm restart](/cli-commands/npm-restart)
|
||||
* [npm stop](/cli-commands/npm-stop)
|
||||
@ -0,0 +1,68 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-token
|
||||
description: Manage your authentication tokens
|
||||
---
|
||||
|
||||
# npm-token(1)
|
||||
|
||||
## Manage your authentication tokens
|
||||
|
||||
### Synopsis
|
||||
```bash
|
||||
npm token list [--json|--parseable]
|
||||
npm token create [--read-only] [--cidr=1.1.1.1/24,2.2.2.2/16]
|
||||
npm token revoke <id|token>
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
This lets you list, create and revoke authentication tokens.
|
||||
|
||||
* `npm token list`:
|
||||
Shows a table of all active authentication tokens. You can request this as
|
||||
JSON with `--json` or tab-separated values with `--parseable`.
|
||||
|
||||
```bash
|
||||
+--------+---------+------------+----------+----------------+
|
||||
| id | token | created | read-only | CIDR whitelist |
|
||||
+--------+---------+------------+----------+----------------+
|
||||
| 7f3134 | 1fa9ba… | 2017-10-02 | yes | |
|
||||
+--------+---------+------------+----------+----------------+
|
||||
| c03241 | af7aef… | 2017-10-02 | no | 192.168.0.1/24 |
|
||||
+--------+---------+------------+----------+----------------+
|
||||
| e0cf92 | 3a436a… | 2017-10-02 | no | |
|
||||
+--------+---------+------------+----------+----------------+
|
||||
| 63eb9d | 74ef35… | 2017-09-28 | no | |
|
||||
+--------+---------+------------+----------+----------------+
|
||||
| 2daaa8 | cbad5f… | 2017-09-26 | no | |
|
||||
+--------+---------+------------+----------+----------------+
|
||||
| 68c2fe | 127e51… | 2017-09-23 | no | |
|
||||
+--------+---------+------------+----------+----------------+
|
||||
| 6334e1 | 1dadd1… | 2017-09-23 | no | |
|
||||
+--------+---------+------------+----------+----------------+
|
||||
```
|
||||
|
||||
* `npm token create [--read-only] [--cidr=<cidr-ranges>]`:
|
||||
Create a new authentication token. It can be `--read-only` or accept a list of
|
||||
[CIDR](https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) ranges to
|
||||
limit use of this token to. This will prompt you for your password, and, if you have
|
||||
two-factor authentication enabled, an otp.
|
||||
|
||||
```bash
|
||||
+----------------+--------------------------------------+
|
||||
| token | a73c9572-f1b9-8983-983d-ba3ac3cc913d |
|
||||
+----------------+--------------------------------------+
|
||||
| cidr_whitelist | |
|
||||
+----------------+--------------------------------------+
|
||||
| readonly | false |
|
||||
+----------------+--------------------------------------+
|
||||
| created | 2017-10-02T07:52:24.838Z |
|
||||
+----------------+--------------------------------------+
|
||||
```
|
||||
|
||||
* `npm token revoke <token|id>`:
|
||||
This removes an authentication token, making it immediately unusable. This can accept
|
||||
both complete tokens (as you get back from `npm token create` and will
|
||||
find in your `.npmrc`) and ids as seen in the `npm token list` output.
|
||||
This will NOT accept the truncated token found in `npm token list` output.
|
||||
64
src/main/ng-app/node/node_modules/npm/docs/content/cli-commands/npm-uninstall.md
generated
vendored
64
src/main/ng-app/node/node_modules/npm/docs/content/cli-commands/npm-uninstall.md
generated
vendored
@ -0,0 +1,64 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-uninstall
|
||||
description: Remove a package
|
||||
---
|
||||
|
||||
# npm-uninstall(1)
|
||||
|
||||
## Remove a package
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm uninstall [<@scope>/]<pkg>[@<version>]... [-S|--save|-D|--save-dev|-O|--save-optional|--no-save]
|
||||
|
||||
aliases: remove, rm, r, un, unlink
|
||||
```
|
||||
|
||||
### Description
|
||||
|
||||
This uninstalls a package, completely removing everything npm installed
|
||||
on its behalf.
|
||||
|
||||
Example:
|
||||
|
||||
```bash
|
||||
npm uninstall sax
|
||||
```
|
||||
|
||||
In global mode (ie, with `-g` or `--global` appended to the command),
|
||||
it uninstalls the current package context as a global package.
|
||||
|
||||
`npm uninstall` takes 3 exclusive, optional flags which save or update
|
||||
the package version in your main package.json:
|
||||
|
||||
* `-S, --save`: Package will be removed from your `dependencies`.
|
||||
|
||||
* `-D, --save-dev`: Package will be removed from your `devDependencies`.
|
||||
|
||||
* `-O, --save-optional`: Package will be removed from your `optionalDependencies`.
|
||||
|
||||
* `--no-save`: Package will not be removed from your `package.json` file.
|
||||
|
||||
Further, if you have an `npm-shrinkwrap.json` then it will be updated as
|
||||
well.
|
||||
|
||||
Scope is optional and follows the usual rules for [`scope`](/using-npm/scope).
|
||||
|
||||
Examples:
|
||||
```bash
|
||||
npm uninstall sax --save
|
||||
npm uninstall @myorg/privatepackage --save
|
||||
npm uninstall node-tap --save-dev
|
||||
npm uninstall dtrace-provider --save-optional
|
||||
npm uninstall lodash --no-save
|
||||
```
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm prune](/cli-commands/npm-prune)
|
||||
* [npm install](/cli-commands/npm-install)
|
||||
* [npm folders](/configuring-npm/folders)
|
||||
* [npm config](/cli-commands/npm-config)
|
||||
* [npmrc](/configuring-npm/npmrc)
|
||||
54
src/main/ng-app/node/node_modules/npm/docs/content/cli-commands/npm-unpublish.md
generated
vendored
54
src/main/ng-app/node/node_modules/npm/docs/content/cli-commands/npm-unpublish.md
generated
vendored
@ -0,0 +1,54 @@
|
||||
---
|
||||
section: cli-commands
|
||||
title: npm-unpublish
|
||||
description: Remove a package from the registry
|
||||
---
|
||||
|
||||
# npm-unpublish(1)
|
||||
|
||||
## Remove a package from the registry
|
||||
|
||||
### Synopsis
|
||||
|
||||
```bash
|
||||
npm unpublish [<@scope>/]<pkg>[@<version>]
|
||||
```
|
||||
|
||||
### Warning
|
||||
|
||||
**It is generally considered bad behavior to remove versions of a library
|
||||
that others are depending on!**
|
||||
|
||||
Consider using the `deprecate` command
|
||||
instead, if your intent is to encourage users to upgrade.
|
||||
|
||||
There is plenty of room on the registry.
|
||||
|
||||
### Description
|
||||
|
||||
This removes a package version from the registry, deleting its
|
||||
entry and removing the tarball.
|
||||
|
||||
If no version is specified, or if all versions are removed then
|
||||
the root package entry is removed from the registry entirely.
|
||||
|
||||
Even if a package version is unpublished, that specific name and
|
||||
version combination can never be reused. In order to publish the
|
||||
package again, a new version number must be used. Additionally,
|
||||
new versions of packages with every version unpublished may not
|
||||
be republished until 24 hours have passed.
|
||||
|
||||
With the default registry (`registry.npmjs.org`), unpublish is
|
||||
only allowed with versions published in the last 72 hours. If you
|
||||
are trying to unpublish a version published longer ago than that,
|
||||
contact support@npmjs.com.
|
||||
|
||||
The scope is optional and follows the usual rules for [`scope`](/using-npm/scope).
|
||||
|
||||
### See Also
|
||||
|
||||
* [npm deprecate](/cli-commands/npm-deprecate)
|
||||
* [npm publish](/cli-commands/npm-publish)
|
||||
* [npm registry](/using-npm/registry)
|
||||
* [npm adduser](/cli-commands/npm-adduser)
|
||||
* [npm owner](/cli-commands/npm-owner)
|
||||
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue