diff --git a/.github/lock.yml b/.github/lock.yml new file mode 100644 index 000000000..7ae89fc21 --- /dev/null +++ b/.github/lock.yml @@ -0,0 +1,28 @@ +# Configuration for lock-threads - https://github.com/dessant/lock-threads + +# Number of days of inactivity before a closed issue or pull request is locked +daysUntilLock: 365 + +# Issues and pull requests with these labels will not be locked. Set to `[]` to disable +exemptLabels: [] + +# Label to add before locking, such as `outdated`. Set to `false` to disable +lockLabel: false + +# Comment to post before locking. Set to `false` to disable +lockComment: > + This thread has been automatically locked since there has not been + any recent activity after it was closed. Please open a new issue for + related bugs. + +# Limit to only `issues` or `pulls` +# only: issues + +# Optionally, specify configuration settings just for `issues` or `pulls` +issues: + exemptLabels: + - help-wanted + lockLabel: outdated + +pulls: + daysUntilLock: 180 diff --git a/CHANGELOG.md b/CHANGELOG.md index 3ff8b8bf7..9602031f6 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,22 @@ All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines. + +# [3.0.0](https://github.com/verdaccio/verdaccio/compare/v3.0.0-beta.12...v3.0.0) (2018-05-30) + + +### Bug Fixes + +* favicon refers to .png while only .ico exists [#681](https://github.com/verdaccio/verdaccio/issues/681) ([11e6f9f](https://github.com/verdaccio/verdaccio/commit/11e6f9f)) +* web-ui css were not being minimized ([3168a76](https://github.com/verdaccio/verdaccio/commit/3168a76)) + + +### Features + +* new verdaccio skin to webui ([b8b2612](https://github.com/verdaccio/verdaccio/commit/b8b2612)) + + + # [3.0.0-beta.12](https://github.com/verdaccio/verdaccio/compare/v3.0.0-beta.11...v3.0.0-beta.12) (2018-05-23) diff --git a/README.md b/README.md index 2000814d4..ae6e035a0 100644 --- a/README.md +++ b/README.md @@ -1,34 +1,52 @@ -

- -### A lightweight private npm proxy registry +
+ + + +
+
+

3.0.0 Released 🎉

+
+
+

+ Verdaccio is lightweight private npm proxy registry. +

+ npm version + CircleCI Status + Coverage Status + npm Downloads + npm Downloads +
+
+

-`verdaccio` is a fork of `sinopia`. It aims to keep backwards compatibility with `sinopia`, while keeping up with npm changes. +
-[![CircleCI](https://circleci.com/gh/verdaccio/verdaccio/tree/master.svg?style=svg)](https://circleci.com/gh/verdaccio/verdaccio/tree/master) -[![Backers on Open Collective](https://opencollective.com/verdaccio/backers/badge.svg)](#backers) [![Sponsors on Open Collective](https://opencollective.com/verdaccio/sponsors/badge.svg)](#sponsors) [![npm version badge](https://img.shields.io/npm/v/verdaccio.svg)](https://www.npmjs.org/package/verdaccio) -[![downloads badge](http://img.shields.io/npm/dm/verdaccio.svg)](https://www.npmjs.org/package/verdaccio) -[![Docker Pulls](https://img.shields.io/docker/pulls/verdaccio/verdaccio.svg)](https://hub.docker.com/r/verdaccio/verdaccio/) -[![Gitter chat](https://badges.gitter.im/verdaccio/questions.png)](https://gitter.im/verdaccio/) -[![Crowdin](https://d322cqt584bo4o.cloudfront.net/verdaccio/localized.svg)](https://crowdin.com/project/verdaccio) -[![dependencies Status](https://david-dm.org/verdaccio/verdaccio/status.svg)](https://david-dm.org/verdaccio/verdaccio) -[![Known Vulnerabilities](https://snyk.io/test/github/verdaccio/verdaccio/badge.svg?targetFile=package.json)](https://snyk.io/test/github/verdaccio/verdaccio?targetFile=package.json) -[![codecov](https://codecov.io/gh/verdaccio/verdaccio/branch/master/graph/badge.svg)](https://codecov.io/gh/verdaccio/verdaccio) +

Install

+ +Install with npm: + +```bash +npm install --global verdaccio +``` + +Install with yarn: + +```bash +yarn global add verdaccio +``` + +Install with pnpm: + +```bash +pnpm i -g verdaccio +``` -

+

Introduction

- -It allows you to have a **local npm private registry with zero configuration**. You don't have to install and replicate an entire database. Verdaccio keeps its own small database and, if a package doesn't exist there, **it asks any other registry** (npmjs.org) for it keeping only those packages you use. - -## Quick Links - -* [Documentation](http://www.verdaccio.org/docs/en/installation.html) -* [Chat](https://gitter.im/verdaccio/questions) -* [Wiki](https://github.com/verdaccio/verdaccio/wiki) - -## Introduction +Verdaccio is a simple, **zero-config-required local private npm registry**. No need for an entire database just to get started! Verdaccio comes out of the box with **its own tiny database**, and the ability to proxy other registries (eg. npmjs.org), caching the downloaded modules along the way. For those looking to extend their storage capabilities, Verdaccio **supports various community-made plugins to hook into services such as Amazon's s3 and Google Cloud Storage**. ### Use private packages @@ -37,7 +55,11 @@ It allows you to have a **local npm private registry with zero configuration**. ### Cache npmjs.org registry If you have more than one server you want to install packages on, you might want to use this to decrease latency - (presumably "slow" npmjs.org will be connected to only once per package/version) and provide limited failover (if npmjs.org is down, we might still find something useful in the cache) or avoid issues like *[How one developer just broke Node, Babel and thousands of projects in 11 lines of JavaScript](https://www.theregister.co.uk/2016/03/23/npm_left_pad_chaos/)*. + (presumably "slow" npmjs.org will be connected to only once per package/version) and provide limited failover (if npmjs.org is down, we might still find something useful in the cache) or avoid issues like *[How one developer just broke Node, Babel and thousands of projects in 11 lines of JavaScript](https://www.theregister.co.uk/2016/03/23/npm_left_pad_chaos/)*, *[Many packages suddenly disappeared](https://github.com/npm/registry/issues/255?source=techstories.org)* or *[Registry returns 404 for a package I have installed before](https://github.com/npm/registry/issues/329)*. + +### Link multiple registries + +If you use multiples registries in your organization and need to fetch packages from multiple sources in one single project you might take advance of the uplinks feature with Verdaccio, chaining multiple regirtries and fetching from one single endpoint. ### Override public packages @@ -46,13 +68,7 @@ It allows you to have a **local npm private registry with zero configuration**. See in detail each of these [use cases](https://github.com/verdaccio/verdaccio/tree/master/docs/use-cases.md). -## Get Started - -Installation and starting (application will create default config in config.yaml you can edit later) - -```bash -npm install --global verdaccio -``` +

Get Started

Run in your terminal @@ -73,22 +89,7 @@ Now you can navigate to [http://localhost:4873/](http://localhost:4873/) where y > Warning: Verdaccio does not currently support PM2's cluster mode, running it with cluster mode may cause unknown behavior. -#### Beta - -⚠️⚠️ **Please, help us to test the version 3.x in order to release a stable version soon. Do never test with your original storage folder, do always a backup** ⚠️⚠️ - -If you are an adventurous developer you can use and install the latest beta version, this is a non stable version, I'd recommend only use for testing purporses. - -```bash -$ npm install -g verdaccio@beta -``` -or using docker - -```bash -$ docker run -it --rm --name verdaccio -p 4873:4873 verdaccio/verdaccio:beta -``` - -## Publishing Private Packages +

Publishing Private Packages

#### Create an user and log in @@ -104,20 +105,21 @@ npm publish --registry http://localhost:4873 This will prompt you for user credentials which will be saved on the `verdaccio` server. -## Docker +

Docker

Below are the most commony needed informations, -every aspect of Docker and verdaccio is [documented separately](http://www.verdaccio.org/docs/en/docker.html) +every aspect of Docker and verdaccio is [documented separately](https://www.verdaccio.org/docs/en/docker.html) -### Prebuilt images -To pull the latest pre-built [docker image](https://hub.docker.com/r/verdaccio/verdaccio/): - -```bash +``` docker pull verdaccio/verdaccio ``` -Since version 2 images for every version are available as [tags](https://hub.docker.com/r/verdaccio/verdaccio/tags/). +Available as [tags](https://hub.docker.com/r/verdaccio/verdaccio/tags/). + +``` +docker pull verdaccio/verdaccio:3.0.0 +``` ### Running verdaccio using Docker @@ -127,17 +129,9 @@ To run the docker container: docker run -it --rm --name verdaccio -p 4873:4873 verdaccio/verdaccio ``` -### Using docker-compose - -1. Get the latest version of [docker-compose](https://github.com/docker/compose). -2. Build and run the container: - -```bash -$ docker-compose up --build -``` Docker examples are available [in this repository](https://github.com/verdaccio/docker-examples). -## Compatibility +

Compatibility

Verdaccio aims to support all features of a standard npm client that make sense to support in private repository. Unfortunately, it isn't always possible. @@ -150,48 +144,36 @@ Verdaccio aims to support all features of a standard npm client that make sense - Unpublishing packages (npm unpublish) - **supported** - Tagging (npm tag) - **supported** -- Deprecation (npm deprecate) - not supported +- Deprecation (npm deprecate) - not supported - *PR-welcome* ### User management - Registering new users (npm adduser {newuser}) - **supported** -- Transferring ownership (npm owner add {user} {pkg}) - not supported, verdaccio uses its own acl management system - +- Transferring ownership (npm owner add {user} {pkg}) - not supported, *PR-welcome* ### Misc stuff - Searching (npm search) - **supported** (cli / browser) -- Starring (npm star, npm unstar) - not supported, doesn't make sense in private registry - Ping (npm ping) - **supported** +- Starring (npm star, npm unstar) - not supported, *PR-welcome* ### Security - npm audit - **supported** -## FAQ / Contact / Troubleshoot - -If you have any issue you can try the following options, do no desist to ask or check our issues database, perhaps someone has asked already what you are looking for. - -* [Roadmap](https://github.com/verdaccio/verdaccio/wiki) -* [Most common questions](https://github.com/verdaccio/verdaccio/issues?utf8=%E2%9C%93&q=is%3Aissue%20label%3Aquestion%20) -* [Reporting a bug](https://github.com/verdaccio/verdaccio/blob/master/CONTRIBUTING.md#reporting-a-bug) -* [Running discussions](https://github.com/verdaccio/verdaccio/issues?q=is%3Aissue+is%3Aopen+label%3Adiscuss) -* [Chat Room](https://gitter.im/verdaccio/) -* [Logos](https://github.com/verdaccio/verdaccio/tree/master/assets) - -## Contributors +

Contributors

This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)]. -## Backers +### Backers Thank you to all our backers! 🙏 [[Become a backer](https://opencollective.com/verdaccio#backer)] -## Sponsors +### Sponsors Support this project by becoming a sponsor. Your logo will show up here with a link to your website. [[Become a sponsor](https://opencollective.com/verdaccio#sponsor)] @@ -206,10 +188,20 @@ Support this project by becoming a sponsor. Your logo will show up here with a l +

FAQ / Contact / Troubleshoot

+ +If you have any issue you can try the following options, do no desist to ask or check our issues database, perhaps someone has asked already what you are looking for. + +* [Roadmap](https://github.com/verdaccio/verdaccio/wiki) +* [Most common questions](https://github.com/verdaccio/verdaccio/issues?utf8=%E2%9C%93&q=is%3Aissue%20label%3Aquestion%20) +* [Reporting a bug](https://github.com/verdaccio/verdaccio/blob/master/CONTRIBUTING.md#reporting-a-bug) +* [Running discussions](https://github.com/verdaccio/verdaccio/issues?q=is%3Aissue+is%3Aopen+label%3Adiscuss) +* [Chat Room](https://gitter.im/verdaccio/) +* [Logos](https://github.com/verdaccio/verdaccio/tree/master/assets) -## License -Verdaccio is [MIT licensed](https://github.com/verdaccio/verdaccio/blob/master/LICENSE). +

License

-The Verdaccio documentation and logos (e.g., .md, .png, .sketch) files in the /wiki and /assets folder) is [Creative Commons licensed](https://github.com/verdaccio/verdaccio/blob/master/LICENSE-docs). +Verdaccio is [MIT licensed](https://github.com/verdaccio/verdaccio/blob/master/LICENSE) +The Verdaccio documentation and logos (e.g., .md, .png, .sketch) files in the /docs and /assets folder) is [Creative Commons licensed](https://github.com/verdaccio/verdaccio/blob/master/LICENSE-docs). diff --git a/assets/gif/verdaccio_big_30.gif b/assets/gif/verdaccio_big_30.gif new file mode 100644 index 000000000..564d78c8b Binary files /dev/null and b/assets/gif/verdaccio_big_30.gif differ diff --git a/package.json b/package.json index bf4d43169..f1923853d 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "verdaccio", - "version": "3.0.0-beta.12", + "version": "3.0.0", "description": "Private npm repository server", "author": { "name": "Alex Kocharin", diff --git a/test/unit/local-storage.spec.js b/test/unit/local-storage.spec.js index 6b15da401..0a6b2a606 100644 --- a/test/unit/local-storage.spec.js +++ b/test/unit/local-storage.spec.js @@ -134,164 +134,168 @@ describe('LocalStorage', () => { }); }); - describe('LocalStorage::addTarball', () => { + describe('LocalStorage::tarball operations', () => { - test('should add a new tarball', (done) => { - const tarballData = JSON.parse(readMetadata('addTarball')); - const stream = storage.addTarball(pkgName, tarballName); + describe('LocalStorage::addTarball', () => { - stream.on('error', function(err) { - expect(err).toBeNull(); - done(); - }); - stream.on('success', function() { - done(); + test('should add a new tarball', (done) => { + const tarballData = JSON.parse(readMetadata('addTarball')); + const stream = storage.addTarball(pkgName, tarballName); + + stream.on('error', function(err) { + expect(err).toBeNull(); + done(); + }); + stream.on('success', function() { + done(); + }); + + stream.end(new Buffer(tarballData.data, 'base64')); + stream.done(); + }); + + test('should add a new second tarball', (done) => { + const tarballData = JSON.parse(readMetadata('addTarball')); + const stream = storage.addTarball(pkgName, tarballName2); + stream.on('error', function(err) { + expect(err).toBeNull(); + done(); + }); + stream.on('success', function() { + done(); + }); + + stream.end(new Buffer(tarballData.data, 'base64')); + stream.done(); + }); + + test('should fails on add a duplicated new tarball ', (done) => { + const tarballData = JSON.parse(readMetadata('addTarball')); + const stream = storage.addTarball(pkgName, tarballName); + stream.on('error', function(err) { + expect(err).not.toBeNull(); + expect(err.statusCode).toEqual(409); + expect(err.message).toMatch(/this package is already present/); + done(); + }); + + stream.on('success', function() { + done(); + }); + + stream.end(new Buffer(tarballData.data, 'base64')); + stream.done(); + }); + + test('should fails on add a new tarball on missing package', (done) => { + const tarballData = JSON.parse(readMetadata('addTarball')); + const stream = storage.addTarball('unexsiting-package', tarballName); + stream.on('error', function(err) { + expect(err).not.toBeNull(); + expect(err.statusCode).toEqual(404); + expect(err.message).toMatch(/no such package available/); + done(); + }); + + stream.on('success', function() { + done(); + }); + + stream.end(new Buffer(tarballData.data, 'base64')); + stream.done(); + }); + + test('should fails on use invalid package name on add a new tarball', (done) => { + const stream = storage.addTarball(pkgName, `${pkgName}-fails-add-tarball-1.0.4.tgz`); + stream.on('error', function(err) { + expect(err).not.toBeNull(); + expect(err.statusCode).toEqual(422); + expect(err.message).toMatch(/refusing to accept zero-length file/); + done(); + }); + + stream.done(); + }); + + test('should fails on abort on add a new tarball', (done) => { + const stream = storage.addTarball('package.json', `${pkgName}-fails-add-tarball-1.0.4.tgz`); + stream.abort(); + stream.on('error', function(err) { + expect(err).not.toBeNull(); + expect(err.statusCode).toEqual(403); + expect(err.message).toMatch(/can't use this filename/); + done(); + }); + + stream.done(); + }); + + describe('LocalStorage::removeTarball', () => { + + test('should remove a tarball', (done) => { + storage.removeTarball(pkgName, tarballName2, 'rev', (err, pkg) => { + expect(err).toBeNull(); + expect(pkg).toBeUndefined(); + done(); + }); + }); + + test('should remove a tarball that does not exist', (done) => { + storage.removeTarball(pkgName, tarballName2, 'rev', (err) => { + expect(err).not.toBeNull(); + expect(err.statusCode).toEqual(404); + expect(err.message).toMatch(/no such file available/); + done(); + }); + }); }); - stream.end(new Buffer(tarballData.data, 'base64')); - stream.done(); }); - test('should add a new second tarball', (done) => { - const tarballData = JSON.parse(readMetadata('addTarball')); - const stream = storage.addTarball(pkgName, tarballName2); - stream.on('error', function(err) { - expect(err).toBeNull(); - done(); - }); - stream.on('success', function() { - done(); + describe('LocalStorage::getTarball', () => { + test('should get a existing tarball', (done) => { + const stream = storage.getTarball(pkgName, tarballName); + stream.on('content-length', function(contentLength) { + expect(contentLength).toBe(279); + done(); + }); + stream.on('open', function() { + done(); + }); }); - stream.end(new Buffer(tarballData.data, 'base64')); - stream.done(); - }); - - test('should fails on add a duplicated new tarball ', (done) => { - const tarballData = JSON.parse(readMetadata('addTarball')); - const stream = storage.addTarball(pkgName, tarballName); - stream.on('error', function(err) { - expect(err).not.toBeNull(); - expect(err.statusCode).toEqual(409); - expect(err.message).toMatch(/this package is already present/); - done(); - }); - - stream.on('success', function() { - done(); - }); - - stream.end(new Buffer(tarballData.data, 'base64')); - stream.done(); - }); - - test('should fails on add a new tarball on missing package', (done) => { - const tarballData = JSON.parse(readMetadata('addTarball')); - const stream = storage.addTarball('unexsiting-package', tarballName); - stream.on('error', function(err) { - expect(err).not.toBeNull(); - expect(err.statusCode).toEqual(404); - expect(err.message).toMatch(/no such package available/); - done(); - }); - - stream.on('success', function() { - done(); - }); - - stream.end(new Buffer(tarballData.data, 'base64')); - stream.done(); - }); - - test('should fails on use invalid package name on add a new tarball', (done) => { - const stream = storage.addTarball(pkgName, `${pkgName}-fails-add-tarball-1.0.4.tgz`); - stream.on('error', function(err) { - expect(err).not.toBeNull(); - expect(err.statusCode).toEqual(422); - expect(err.message).toMatch(/refusing to accept zero-length file/); - done(); - }); - - stream.done(); - }); - - test('should fails on abort on add a new tarball', (done) => { - const stream = storage.addTarball('package.json', `${pkgName}-fails-add-tarball-1.0.4.tgz`); - stream.abort(); - stream.on('error', function(err) { - expect(err).not.toBeNull(); - expect(err.statusCode).toEqual(403); - expect(err.message).toMatch(/can't use this filename/); - done(); - }); - - stream.done(); - }); - }); - - describe('LocalStorage::removeTarball', () => { - - test('should remove a tarball', (done) => { - storage.removeTarball(pkgName, tarballName2, 'rev', (err, pkg) => { - expect(err).toBeNull(); - expect(pkg).toBeUndefined(); - done(); + test('should fails on get a tarball that does not exist', (done) => { + const stream = storage.getTarball('fake', tarballName); + stream.on('error', function(err) { + expect(err).not.toBeNull(); + expect(err.statusCode).toEqual(404); + expect(err.message).toMatch(/no such file available/); + done(); + }); }); }); - test('should remove a tarball that does not exist', (done) => { - storage.removeTarball(pkgName, tarballName2, 'rev', (err) => { - expect(err).not.toBeNull(); - expect(err.statusCode).toEqual(404); - expect(err.message).toMatch(/no such file available/); - done(); + describe('LocalStorage::search', () => { + test('should find a tarball', (done) => { + const stream = storage.search('99999'); + + stream.on('data', function each(pkg) { + expect(pkg.name).toEqual(pkgName); + }); + + stream.on('error', function(err) { + expect(err).not.toBeNull(); + done(); + }); + + stream.on('end', function() { + done(); + }); }); + }); }); - describe('LocalStorage::getTarball', () => { - test('should get a existing tarball', (done) => { - const stream = storage.getTarball(pkgName, tarballName); - stream.on('content-length', function(contentLength) { - expect(contentLength).toBe(279); - done(); - }); - stream.on('open', function() { - done(); - }); - }); - - test('should fails on get a tarball that does not exist', (done) => { - const stream = storage.getTarball('fake', tarballName); - stream.on('error', function(err) { - expect(err).not.toBeNull(); - expect(err.statusCode).toEqual(404); - expect(err.message).toMatch(/no such file available/); - done(); - }); - }); - }); - - describe('LocalStorage::search', () => { - test('should find a tarball', (done) => { - const stream = storage.search('99999'); - - stream.on('data', function each(pkg) { - expect(pkg.name).toEqual(pkgName); - }); - - stream.on('error', function(err) { - expect(err).not.toBeNull(); - done(); - }); - - stream.on('end', function() { - done(); - }); - }); - - }); - describe('LocalStorage::removePackage', () => { test('should remove completely package', (done) => { storage.removePackage(pkgName, (err, data) => {