Skip to content

Commit

Permalink
Commits files
Browse files Browse the repository at this point in the history
  • Loading branch information
Maël Nison committed Feb 6, 2019
1 parent 563087e commit e2c2ab6
Show file tree
Hide file tree
Showing 3 changed files with 131 additions and 52 deletions.
74 changes: 74 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,74 @@
# Contributor Covenant Code of Conduct

## Our Pledge

In the interest of fostering an open and welcoming environment, we as
contributors and maintainers pledge to making participation in our project and
our community a harassment-free experience for everyone, regardless of age, body
size, disability, ethnicity, gender identity and expression, level of experience,
nationality, personal appearance, race, religion, or sexual identity and
orientation.

## Our Standards

Examples of behavior that contributes to creating a positive environment
include:

* Using welcoming and inclusive language
* Being respectful of differing viewpoints and experiences
* Gracefully accepting constructive criticism
* Focusing on what is best for the community
* Showing empathy towards other community members

Examples of unacceptable behavior by participants include:

* The use of sexualized language or imagery and unwelcome sexual attention or
advances
* Trolling, insulting/derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or electronic
address, without explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Our Responsibilities

Project maintainers are responsible for clarifying the standards of acceptable
behavior and are expected to take appropriate and fair corrective action in
response to any instances of unacceptable behavior.

Project maintainers have the right and responsibility to remove, edit, or
reject comments, commits, code, wiki edits, issues, and other contributions
that are not aligned to this Code of Conduct, or to ban temporarily or
permanently any contributor for other behaviors that they deem inappropriate,
threatening, offensive, or harmful.

## Scope

This Code of Conduct applies both within project spaces and in public spaces
when an individual is representing the project or its community. Examples of
representing a project or community include using an official project e-mail
address, posting via an official social media account, or acting as an appointed
representative at an online or offline event. Representation of a project may be
further defined and clarified by project maintainers.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported by contacting the project team at [email protected]. All
complaints will be reviewed and investigated and will result in a response that
is deemed necessary and appropriate to the circumstances. The project team is
obligated to maintain confidentiality with regard to the reporter of an incident.
Further details of specific enforcement policies may be posted separately.

Project maintainers who do not follow or enforce the Code of Conduct in good
faith may face temporary or permanent repercussions as determined by other
members of the project's leadership.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
available at [http://contributor-covenant.org/version/1/4][version]

[homepage]: http://contributor-covenant.org
[version]: http://contributor-covenant.org/version/1/4/
26 changes: 26 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
BSD 2-Clause License

For Yarn software

Copyright (c) 2016-present, Yarn Contributors. All rights reserved.

Redistribution and use in source and binary forms, with or without modification,
are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
83 changes: 31 additions & 52 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,55 +1,58 @@
# <img src="./icon.svg" width="32" height="32" align="bottom" /> Yarn - Berry Edition

Yarn is a modern package manager split into various packages. Its novel
architecture allows to do things currently impossible with existing solutions:
Yarn is a modern package manager split into various packages. Its novel architecture allows to do things currently impossible with existing solutions:

- Yarn supports plugins; adding a plugin is as simple as adding it into your repository
- Yarn supports Node by default but isn't limited to it - plugins can add support for other languages
- Yarn supports [workspaces]() natively, and its CLI takes advantage of that
- Yarn uses professional-grade terminal UIs built thanks to a generic React renderer, [berry-ui]()
- Yarn uses a portable shell to execute package scripts, guaranteeing they work the same way on Windows and Linux
- Yarn is first and foremost a Node API that can be used programmatically (through [berry-core]())
- Yarn is first and foremost a Node API that can be used programmatically (via [berry-core](packages/berry-core))
- Yarn is written in TypeScript, and fully typechecked

## Install

Because this repository is about the modern but experimental version of Yarn (aka Yarn v2), the install process is slightly different for the time being.

- First, make sure you are using [the latest Yarn release](https://yarnpkg.com/en/docs/install).
- Then go into your project and run `yarn policies set-version berry-nightly`
- To revert, just remove the local `.yarnrc` file that's been created

## Generic packages

The following packages are generic and can be used in a variety of purposes
(including to implement other package managers, but not only):
The following packages are generic and can be used in a variety of purposes (including to implement other package managers, but not only):

- [berry-core](packages/berry-core) allows any application to manipulate a project programmatically
- [berry-json-proxy](packages/berry-json-proxy) allows to temporarily convert any POD object to an immutable object
- [berry-libzip](packages/berry-libzip) contains zlib+libzip bindings compiled to WebAssembly
- [berry-parsers](packages/berry-parsers) can be used to parse [Syml]() and the language used by [berry-shell]()
- [berry-pnp](packages/berry-pnp) can be used to generate [Plug'n'Play-compatible]() hooks
- [berry-shell](packages/berry-shell) is a portable bash-like shell interpreter
- [berry-ui](packages/berry-ui) is a React renderer targeting terminals
- [berry-zipfs](packages/berry-zipfs) is a `fs` implementation that can read files from zip archives
- [berry-core](packages/berry-core) allows any application to manipulate a project programmatically.
- [berry-json-proxy](packages/berry-json-proxy) allows to temporarily convert any POD object to an immutable object.
- [berry-libzip](packages/berry-libzip) contains zlib+libzip bindings compiled to WebAssembly.
- [berry-parsers](packages/berry-parsers) can be used to parse [Syml]() and the language used by [berry-shell](packages/berry-shell).
- [berry-pnp](packages/berry-pnp) can be used to generate [Plug'n'Play-compatible]() hooks.
- [berry-shell](packages/berry-shell) is a portable bash-like shell interpreter.
- [berry-ui](packages/berry-ui) is a React renderer targeting terminals.
- [berry-zipfs](packages/berry-zipfs) is a `fs` implementation that can read files from zip archives.

## Berry plugins
## Yarn plugins

The following packages are plugins for Berry and can be installed through
`berry add plugin <plugin-name>`. Note that some of them are typically already
shipped with the regular Berry bundles. Such plugins are marked with a star (★).
The following packages are plugins for Berry and can be installed through `berry add plugin <plugin-name>`. Note that some of them are typically already shipped with the regular Yarn bundles. Such plugins are marked with a star (★).

- [plugin-constraints](packages/plugin-constraints) adds various commands for enforcing constraints across workspaces.
- [plugin-constraints](packages/plugin-constraints) adds support for `yarn constraints check` and `yarn constraints fix`.
- [plugin-essentials★](packages/plugin-essentials) adds various commands deemed necessary for a package manager (add, remove, ...).
- [plugin-file★](packages/plugin-file) adds support for using `file:` references as dependencies.
- [plugin-github★](packages/plugin-github) adds support for using Github references as dependencies. [This plugin doesn't use git.](https://stackoverflow.com/a/13636954/880703)
- [plugin-http★](packages/plugin-http) adds support for using straight URL references as dependencies (tgz archives only).
- [plugin-hub](packages/plugin-hub) contains a UI designed to efficiently manage large-scale projects with multiple workspaces
- [plugin-hub](packages/plugin-hub) contains a UI designed to efficiently manage large-scale projects with multiple workspaces.
- [plugin-init★](packages/plugin-init) adds support for the `yarn init` command.
- [plugin-link★](packages/plugin-link) adds support for using `link:` and `portal:` references as dependencies.
- [plugin-npm★](packages/plugin-npm) adds support for using [semver ranges]() as dependencies, resolving them to an NPM-like registry
- [plugin-pnp★](packages/plugin-pnp) adds support for installing Javascript dependencies through the [Plug'n'Play]() specification
- [plugin-npm★](packages/plugin-npm) adds support for using [semver ranges]() as dependencies, resolving them to an NPM-like registry.
- [plugin-pnp★](packages/plugin-pnp) adds support for installing Javascript dependencies through the [Plug'n'Play]() specification.

To create your own plugin, please refer to the [documentation]().

## Berry packages
## Yarn packages

The following packages are meant to be used with Berry, and won't be useful to
other applications:
The following packages are meant to be used by Yarn itself, and probably won't be useful to other applications:

- [berry-builder](packages/berry-builder) contains a CLI tool to package berry and its plugins
- [berry-cli](packages/berry-cli) is a CLI entry point built on top of [berry-core]()
- [berry-builder](packages/berry-builder) contains a CLI tool to package berry and its plugins.
- [berry-cli](packages/berry-cli) is a CLI entry point built on top of [berry-core](packages/berry-core).

## Build your own bundle

Expand All @@ -59,28 +62,4 @@ Clone this repository, then run the following commands:
$> ./packages/berry-cli/bin/berry build:cli
```

Note that no other command is needed! Since the repository contains our
dependencies, you don't need to run any install. Everything works, and
everything is guaranteed to work even ten years from now 🙂

## License (MIT)

> **Copyright © 2019 Yarn contributors**
>
> 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.
Note that no other command is needed! Since the repository contains our dependencies, you don't need to run any install. Everything works, and everything is guaranteed to work even ten years from now.

0 comments on commit e2c2ab6

Please sign in to comment.