diff --git a/CHANGELOG.md b/CHANGELOG.md index 168dafb..c8cecd4 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,152 +2,169 @@ ## [Unreleased] +## [5.0.0] - 2018-12-27 + +### Changed + +- Upgrade `encoding-down` from `~5.0.0` to `^6.0.0` ([#80](https://github.com/Level/packager/issues/80), [#81](https://github.com/Level/packager/issues/81)) ([**@vweevers**](https://github.com/vweevers)) +- Upgrade `levelup` from `^3.0.0` to `^4.0.0` ([#79](https://github.com/Level/packager/issues/79)) ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Upgrade `standard` devDependency from `^11.0.0` to `^12.0.0` ([#74](https://github.com/Level/packager/issues/74)) ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Replace `remark-cli` devDependency with `hallmark` ([#81](https://github.com/Level/packager/issues/81)) ([**@vweevers**](https://github.com/vweevers)) + +### Added + +- Add nyc and coveralls ([#73](https://github.com/Level/packager/issues/73)) ([**@ralphtheninja**](https://github.com/ralphtheninja)) + +### Removed + +- Remove node 9 ([`29fdaf4`](https://github.com/Level/packager/commit/29fdaf4)) ([**@ralphtheninja**](https://github.com/ralphtheninja)) + ## [4.0.1] - 2018-06-23 ### Changed -- Use `var` instead of `let` ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Use `var` instead of `let` ([**@ralphtheninja**](https://github.com/ralphtheninja)) ### Added -- Add `remark` tooling ([**@ralphtheninja**](https://github.com/ralphtheninja)) -- Add `'use strict'` to all abstract tests ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Add `remark` tooling ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Add `'use strict'` to all abstract tests ([**@ralphtheninja**](https://github.com/ralphtheninja)) ### Removed -- Remove `contributors` from `package.json` ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Remove `contributors` from `package.json` ([**@ralphtheninja**](https://github.com/ralphtheninja)) ## [4.0.0] - 2018-06-13 ### Changed -- Rewrite `test.js` to test `level-packager` api ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Rewrite `test.js` to test `level-packager` api ([**@ralphtheninja**](https://github.com/ralphtheninja)) ## [3.1.0] - 2018-05-28 ### Changed -- Split up tests into `abstract/*-test.js` ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Split up tests into `abstract/*-test.js` ([**@ralphtheninja**](https://github.com/ralphtheninja)) ### Removed -- Remove `.jshintrc` ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Remove `.jshintrc` ([**@ralphtheninja**](https://github.com/ralphtheninja)) ## [3.0.0] - 2018-05-23 ### Added -- Add node 10 to Travis ([**@ralphtheninja**](https://github.com/ralphtheninja)) -- Add `UPGRADING.md` ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Add node 10 to Travis ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Add `UPGRADING.md` ([**@ralphtheninja**](https://github.com/ralphtheninja)) ### Changed -- Update `standard` to `^11.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja)) -- Update `encoding-down` to `~5.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja)) -- Update `leveldown` to `^4.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja)) -- Update `levelup` to `^3.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja)) -- Change `License & Copyright` to `License` in README ([**@ralphtheninja**](https://github.com/ralphtheninja)) -- Replace `const` with `var` for IE10 support ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Update `standard` to `^11.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Update `encoding-down` to `~5.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Update `leveldown` to `^4.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Update `levelup` to `^3.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Change `License & Copyright` to `License` in README ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Replace `const` with `var` for IE10 support ([**@ralphtheninja**](https://github.com/ralphtheninja)) ### Removed -- Remove node 4 from Travis ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Remove node 4 from Travis ([**@ralphtheninja**](https://github.com/ralphtheninja)) ## [2.1.1] - 2018-02-13 ### Added -- Travis: add 9 ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Travis: add 9 ([**@ralphtheninja**](https://github.com/ralphtheninja)) ### Changed -- Update `encoding-down` to `~4.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja)) -- Update `leveldown` to `^3.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja)) -- Update copyright year to 2018 ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Update `encoding-down` to `~4.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Update `leveldown` to `^3.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Update copyright year to 2018 ([**@ralphtheninja**](https://github.com/ralphtheninja)) ### Fixed -- Test: clean up `level-test-*` dbs after tests are done ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Test: clean up `level-test-*` dbs after tests are done ([**@ralphtheninja**](https://github.com/ralphtheninja)) ## [2.1.0] - 2017-12-13 ### Added -- Add `standard` for linting ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Add `standard` for linting ([**@ralphtheninja**](https://github.com/ralphtheninja)) ### Changed -- Attach `.errors` from `levelup` to `Level` constructor ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Attach `.errors` from `levelup` to `Level` constructor ([**@ralphtheninja**](https://github.com/ralphtheninja)) ## [2.0.2] - 2017-11-11 ### Changed -- Update `encoding-down` to `~3.0.0` ([**@vweevers**](https://github.com/vweevers)) -- README: update node badge ([**@vweevers**](https://github.com/vweevers)) +- Update `encoding-down` to `~3.0.0` ([**@vweevers**](https://github.com/vweevers)) +- README: update node badge ([**@vweevers**](https://github.com/vweevers)) ### Fixed -- Travis: restore node 4 ([**@vweevers**](https://github.com/vweevers)) +- Travis: restore node 4 ([**@vweevers**](https://github.com/vweevers)) ## [2.0.1] - 2017-10-12 ### Added -- Test that encoding options default to utf8 ([**@ralphtheninja**](https://github.com/ralphtheninja)) -- Test that `.keyEncoding` and `.valueEncoding` are passed to `encoding-down` ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Test that encoding options default to utf8 ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Test that `.keyEncoding` and `.valueEncoding` are passed to `encoding-down` ([**@ralphtheninja**](https://github.com/ralphtheninja)) ### Fixed -- Fix encoding options to `encoding-down` ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Fix encoding options to `encoding-down` ([**@ralphtheninja**](https://github.com/ralphtheninja)) ## [2.0.0] - 2017-10-11 ### Added -- README: add `level` badge ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- README: add `level` badge ([**@ralphtheninja**](https://github.com/ralphtheninja)) ### Changed -- Update `levelup` to `^2.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja)) -- Update `encoding-down` to `~2.3.0` ([**@ralphtheninja**](https://github.com/ralphtheninja)) -- Update `leveldown` to `^2.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja)) -- README: update npm badges to similar badge style ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Update `levelup` to `^2.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Update `encoding-down` to `~2.3.0` ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Update `leveldown` to `^2.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- README: update npm badges to similar badge style ([**@ralphtheninja**](https://github.com/ralphtheninja)) ### Removed -- README: Remove Greenkeeper badge ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- README: Remove Greenkeeper badge ([**@ralphtheninja**](https://github.com/ralphtheninja)) ## [2.0.0-rc3] - 2017-09-16 ### Changed -- Update `levelup` to `2.0.0-rc3` ([**@ralphtheninja**](https://github.com/ralphtheninja)) -- Update `leveldown` to `^1.8.0` ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Update `levelup` to `2.0.0-rc3` ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Update `leveldown` to `^1.8.0` ([**@ralphtheninja**](https://github.com/ralphtheninja)) ## [2.0.0-rc2] - 2017-09-12 ### Changed -- Update `levelup` to `2.0.0-rc2` ([**@ralphtheninja**](https://github.com/ralphtheninja)) -- Update `encoding-down` to `~2.2.0` ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Update `levelup` to `2.0.0-rc2` ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Update `encoding-down` to `~2.2.0` ([**@ralphtheninja**](https://github.com/ralphtheninja)) ## [2.0.0-rc1] - 2017-09-04 ### Added -- Travis: add 8 ([**@ralphtheninja**](https://github.com/ralphtheninja)) -- README: add Greenkeeper badge ([**@ralphtheninja**](https://github.com/ralphtheninja)) -- README: add node badge ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Travis: add 8 ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- README: add Greenkeeper badge ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- README: add node badge ([**@ralphtheninja**](https://github.com/ralphtheninja)) ### Changed -- README: steer away from `LevelDOWN` to `abstract-leveldown` ([**@ralphtheninja**](https://github.com/ralphtheninja)) -- Update copyright year to 2017 ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- README: steer away from `LevelDOWN` to `abstract-leveldown` ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Update copyright year to 2017 ([**@ralphtheninja**](https://github.com/ralphtheninja)) ### Removed -- Travis: remove 0.12, 4, 5 and 7 ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Travis: remove 0.12, 4, 5 and 7 ([**@ralphtheninja**](https://github.com/ralphtheninja)) ### Fixed @@ -155,161 +172,163 @@ ### Added -- Travis: add 6 and 7 ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Travis: add 6 and 7 ([**@ralphtheninja**](https://github.com/ralphtheninja)) ### Changed -- Travis: use gcc 4.8 ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Travis: use gcc 4.8 ([**@ralphtheninja**](https://github.com/ralphtheninja)) ### Removed -- Travis: remove 0.10, 1.0, 1.8, 2 and 3 ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Travis: remove 0.10, 1.0, 1.8, 2 and 3 ([**@ralphtheninja**](https://github.com/ralphtheninja)) ## [1.2.0] - 2015-11-27 ### Added -- Add dependency badge ([**@ralphtheninja**](https://github.com/ralphtheninja)) -- Travis: add 1.0, 2, 3, 4 and 5 ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Add dependency badge ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Travis: add 1.0, 2, 3, 4 and 5 ([**@ralphtheninja**](https://github.com/ralphtheninja)) ### Changed -- Update `levelup` to `~1.3.0` ([**@ralphtheninja**](https://github.com/ralphtheninja)) -- Update `leveldown` to `^1.4.2` ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Update `levelup` to `~1.3.0` ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Update `leveldown` to `^1.4.2` ([**@ralphtheninja**](https://github.com/ralphtheninja)) ## [1.1.0] - 2015-06-09 ### Changed -- Update `levelup` to `~1.2.0` ([**@mcollina**](https://github.com/mcollina)) -- Update `leveldown` to `~1.2.2` ([**@mcollina**](https://github.com/mcollina)) +- Update `levelup` to `~1.2.0` ([**@mcollina**](https://github.com/mcollina)) +- Update `leveldown` to `~1.2.2` ([**@mcollina**](https://github.com/mcollina)) ## [1.0.0] - 2015-05-19 ### Changed -- README: add link to `level/community` repo ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- README: add link to `level/community` repo ([**@ralphtheninja**](https://github.com/ralphtheninja)) ## [1.0.0-0] - 2015-05-16 ### Added -- Add Travis ([**@ralphtheninja**](https://github.com/ralphtheninja)) -- Add `leveldown` dev dependency ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Add Travis ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Add `leveldown` dev dependency ([**@ralphtheninja**](https://github.com/ralphtheninja)) ### Changed -- Update `levelup` to `~1.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja)) -- Run tests using `packager(leveldown)` ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Update `levelup` to `~1.0.0` ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Run tests using `packager(leveldown)` ([**@ralphtheninja**](https://github.com/ralphtheninja)) ### Removed -- Remove `level` dependency ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Remove `level` dependency ([**@ralphtheninja**](https://github.com/ralphtheninja)) ## [0.19.7] - 2015-05-10 ### Added -- Add `level-test-*` to `.gitignore` ([**@juliangruber**](https://github.com/juliangruber)) +- Add `level-test-*` to `.gitignore` ([**@juliangruber**](https://github.com/juliangruber)) ### Changed -- Run the tests if they are not required ([**@juliangruber**](https://github.com/juliangruber)) -- Rename the repository to `packager` ([**@juliangruber**](https://github.com/juliangruber)) +- Run the tests if they are not required ([**@juliangruber**](https://github.com/juliangruber)) +- Rename the repository to `packager` ([**@juliangruber**](https://github.com/juliangruber)) ## [0.19.6] - 2015-05-10 ### Fixed -- Fix incorrect options logic ([**@juliangruber**](https://github.com/juliangruber)) +- Fix incorrect options logic ([**@juliangruber**](https://github.com/juliangruber)) ## [0.19.5] - 2015-05-10 ### Fixed -- Fixed bug with missing opening curly brace ([**@juliangruber**](https://github.com/juliangruber)) +- Fixed bug with missing opening curly brace ([**@juliangruber**](https://github.com/juliangruber)) ## [0.19.4] - 2015-05-10 ### Changed -- Use `typeof` instead of `util.isFunction()` ([**@juliangruber**](https://github.com/juliangruber)) +- Use `typeof` instead of `util.isFunction()` ([**@juliangruber**](https://github.com/juliangruber)) ## [0.19.3] - 2015-05-10 ### Fixed -- Fix missing closing parenthesis ([**@juliangruber**](https://github.com/juliangruber)) +- Fix missing closing parenthesis ([**@juliangruber**](https://github.com/juliangruber)) ## [0.19.2] - 2015-05-10 ### Fixed -- Fix missing closing parenthesis ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Fix missing closing parenthesis ([**@ralphtheninja**](https://github.com/ralphtheninja)) ## [0.19.1] - 2015-05-10 ### Fixed -- `null` options should not be treated as object ([**@deian**](https://github.com/deian)) +- `null` options should not be treated as object ([**@deian**](https://github.com/deian)) ## [0.19.0] - 2015-05-04 ### Changed -- Plain MIT license ([**@andrewrk**](https://github.com/andrewrk)) -- README: update logo and copyright year ([**@ralphtheninja**](https://github.com/ralphtheninja)) -- Update `levelup` to `~0.19.0` ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Plain MIT license ([**@andrewrk**](https://github.com/andrewrk)) +- README: update logo and copyright year ([**@ralphtheninja**](https://github.com/ralphtheninja)) +- Update `levelup` to `~0.19.0` ([**@ralphtheninja**](https://github.com/ralphtheninja)) ## [0.18.0] - 2013-11-18 ### Changed -- Bumped version ([**@rvagg**](https://github.com/rvagg)) +- Bumped version ([**@rvagg**](https://github.com/rvagg)) ## [0.17.0-5] - 2013-10-12 ### Changed -- Clean up debugging noise ([**@rvagg**](https://github.com/rvagg)) +- Clean up debugging noise ([**@rvagg**](https://github.com/rvagg)) ## [0.17.0-4] - 2013-10-12 ### Removed -- Remove `copy()` ([**@rvagg**](https://github.com/rvagg)) +- Remove `copy()` ([**@rvagg**](https://github.com/rvagg)) ### Fixed -- Fix `repair()` and `destroy()` ([**@rvagg**](https://github.com/rvagg)) +- Fix `repair()` and `destroy()` ([**@rvagg**](https://github.com/rvagg)) ## [0.17.0-3] - 2013-10-12 ### Fixed -- Made tests compatible with node 0.8 ([**@rvagg**](https://github.com/rvagg)) +- Made tests compatible with node 0.8 ([**@rvagg**](https://github.com/rvagg)) ## [0.17.0-2] - 2013-10-12 ### Added -- Add options to exported tests to handle memdown ([**@rvagg**](https://github.com/rvagg)) +- Add options to exported tests to handle memdown ([**@rvagg**](https://github.com/rvagg)) ### Changed -- README: `level` -> `level-packager` ([**@rvagg**](https://github.com/rvagg)) +- README: `level` -> `level-packager` ([**@rvagg**](https://github.com/rvagg)) ## [0.17.0-1] - 2013-10-09 ### Removed -- Remove `tape` from devDependencies, allow callers to pass in custom test function ([**@rvagg**](https://github.com/rvagg)) +- Remove `tape` from devDependencies, allow callers to pass in custom test function ([**@rvagg**](https://github.com/rvagg)) ## 0.17.0 - 2013-10-09 :seedling: Initial release. -[unreleased]: https://github.com/level/packager/compare/v4.0.1...HEAD +[unreleased]: https://github.com/level/packager/compare/v5.0.0...HEAD + +[5.0.0]: https://github.com/level/packager/compare/v4.0.1...v5.0.0 [4.0.1]: https://github.com/level/packager/compare/v4.0.0...v4.0.1 diff --git a/CONTRIBUTORS.md b/CONTRIBUTORS.md index 1f253fc..7d39a4c 100644 --- a/CONTRIBUTORS.md +++ b/CONTRIBUTORS.md @@ -1,7 +1,7 @@ # Contributors | Name | GitHub | Social | -| -------------------- | ------------------------------------------------------ | --------------------------------------------------------------- | +| :------------------- | :----------------------------------------------------- | :-------------------------------------------------------------- | | **Lars-Magnus Skog** | [**@ralphtheninja**](https://github.com/ralphtheninja) | [**@ralph@social.weho.st**](https://social.weho.st/@ralph) | | **Julian Gruber** | [**@juliangruber**](https://github.com/juliangruber) | [**@juliangruber@twitter**](https://twitter.com/juliangruber) | | **Rod Vagg** | [**@rvagg**](https://github.com/rvagg) | [**@rvagg@twitter**](https://twitter.com/rvagg) | diff --git a/README.md b/README.md index 1a17904..f3bbc1f 100644 --- a/README.md +++ b/README.md @@ -19,10 +19,10 @@ The constructor function has a `.errors` property which provides access to the d For example use-cases, see: -- [`level`](https://github.com/Level/level) -- [`level-mem`](https://github.com/Level/level-mem) -- [`level-hyper`](https://github.com/Level/level-hyper) -- [`level-lmdb`](https://github.com/Level/level-lmdb) +- [`level`](https://github.com/Level/level) +- [`level-mem`](https://github.com/Level/level-mem) +- [`level-hyper`](https://github.com/Level/level-hyper) +- [`level-lmdb`](https://github.com/Level/level-lmdb) Also available is a _test.js_ file that can be used to verify that the user-package works as expected. diff --git a/UPGRADING.md b/UPGRADING.md index fe6996f..ed3aaea 100644 --- a/UPGRADING.md +++ b/UPGRADING.md @@ -2,6 +2,10 @@ This document describes breaking changes and how to upgrade. For a complete list of changes including minor and patch releases, please refer to the [changelog](CHANGELOG.md). +## v5 + +Upgraded to [`levelup@4`](https://github.com/Level/levelup/blob/v4.0.0/UPGRADING.md#v4) and [`encoding-down@6`](https://github.com/Level/encoding-down/blob/v6.0.0/UPGRADING.md#v6). We recommend to pair `level-packager@5` only with a store based on `abstract-leveldown` >= 6. Please follow the earlier links for more information. + ## v4 The `test.js` file was rewritten to test the `level-packager` api and is no longer part of the api. Implementations based on `level-packager` should instead use the tests in the `abstract/` folder. diff --git a/package.json b/package.json index 0a69e51..9fd4536 100644 --- a/package.json +++ b/package.json @@ -7,20 +7,12 @@ "url": "https://github.com/Level/packager.git" }, "scripts": { - "test": "standard && nyc node test.js", + "test": "standard && hallmark && nyc node test.js", "coverage": "nyc report --reporter=text-lcov | coveralls", - "remark": "remark README.md CHANGELOG.md CONTRIBUTORS.md UPGRADING.md -o" + "hallmark": "hallmark --fix" }, - "remarkConfig": { - "plugins": [ - [ - "remark-git-contributors", - "level-community" - ], - [ - "remark-github" - ] - ] + "hallmark": { + "community": "level-community" }, "homepage": "https://github.com/Level/packager", "keywords": [ @@ -34,17 +26,15 @@ ], "main": "level-packager.js", "dependencies": { - "encoding-down": "~6.0.0", + "encoding-down": "^6.0.0", "levelup": "^4.0.0" }, "license": "MIT", "devDependencies": { "coveralls": "^3.0.2", + "hallmark": "^0.1.0", "level-community": "^3.0.0", "nyc": "^12.0.2", - "remark-cli": "^5.0.0", - "remark-git-contributors": "^0.2.2", - "remark-github": "^7.0.3", "standard": "^12.0.0", "tape": "^4.0.0" },