yarn init
Create a new package.
Usage
$yarn init <initializer> ...
Examples
Create a new package in the local directory:
yarninit
Create a new private package in the local directory:
Create a new package and store the Yarn release inside:
Create a new private package and defines it as a workspace root:
Details
This command will setup a new package in your local directory.
If the-p,--private
or-w,--workspace
options are set, the package will beprivate by default.
If the-w,--workspace
option is set, the package will be configured to accepta set of workspaces in thepackages/
directory.
If the-i,--install
option is given a value, Yarn will first download it usingyarnsetversion
and only then forward the init call to the newly downloadedbundle. Without arguments, the downloaded bundle will belatest
.
The initial settings of the manifest can be changed by using theinitScope
andinitFields
configuration values. Additionally, Yarn will generate anEditorConfig file whose rules can be altered viainitEditorConfig
, and willinitialize a Git repository in the current directory.
Options
Definition | Description |
---|---|
| Initialize a private package |
| Initialize a workspace root with apackages/ directory |
| Initialize a package with a specific bundle that will be locked in the project |
| Initialize a package with the given name |