Skip to content
This repository was archived by the owner on Dec 1, 2024. It is now read-only.

Commit 5f7f146

Browse files
vweeversvweevers
authored
Apply common project tweaks (#580)
* Sort package.json * Upgrade hallmark devDependency from ~0.1.0 to ^0.1.0 * Add level-community devDependency * Add hallmark configuration * Add hallmark to npm scripts * Add CONTRIBUTORS.md * Update LICENSE.md * Update License section in README.md * Update Contributing section in README.md * Run hallmark * Fix 'Do not use upper-case characters in definition labels' in CHANGELOG.md * Fix repository in package.json * Fix homepage in package.json
1 parent d2aa638 commit 5f7f146

5 files changed

Lines changed: 96 additions & 39 deletions

File tree

‎CHANGELOG.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Changelog
22

3-
## [Unreleased]
3+
## [Unreleased][unreleased]
44

55
### Changed
66

@@ -26,7 +26,7 @@
2626
- Tweak copyright years for less maintenance ([`98cbb4f`](https://github.com/level/leveldown/commit/98cbb4f)) ([**@ralphtheninja**](https://github.com/ralphtheninja))
2727
- Document new platform support and prebuilt binaries ([#558](https://github.com/level/leveldown/issues/558), [#563](https://github.com/level/leveldown/issues/563)) ([**@vweevers**](https://github.com/vweevers))
2828
- Replace `remark-cli` with `hallmark` ([#548](https://github.com/level/leveldown/issues/548)) ([**@vweevers**](https://github.com/vweevers))
29-
- Update `.npmignore` (@vweevers)
29+
- Update `.npmignore` ([**@vweevers**](https://github.com/vweevers))
3030

3131
### Added
3232

‎CONTRIBUTORS.md‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
# Contributors
2+
3+
| Name | GitHub | Social |
4+
| :------------------------- | :----------------------------------------------------- | :----------------------------------------------------------------------- |
5+
| **Lars-Magnus Skog** | [**@ralphtheninja**](https://github.com/ralphtheninja) | [**@ralph@social.weho.st**](https://social.weho.st/@ralph) |
6+
| **Rod Vagg** | [**@rvagg**](https://github.com/rvagg) | [**@rvagg@twitter**](https://twitter.com/rvagg) |
7+
| **Vincent Weevers** | [**@vweevers**](https://github.com/vweevers) | [**@vweevers@twitter**](https://twitter.com/vweevers) |
8+
| **David Björklund** | [**@kesla**](https://github.com/kesla) | [**@david_bjorklund@twitter**](https://twitter.com/david_bjorklund) |
9+
| **Julian Gruber** | [**@juliangruber**](https://github.com/juliangruber) | [**@juliangruber@twitter**](https://twitter.com/juliangruber) |
10+
| **Yichao 'Peak' Ji** | [**@peakji**](https://github.com/peakji) | |
11+
| **Mathias Buus** | [**@mafintosh**](https://github.com/mafintosh) | [**@mafintosh@twitter**](https://twitter.com/mafintosh) |
12+
| **Dominic Tarr** | [**@dominictarr**](https://github.com/dominictarr) | [**@dominictarr@twitter**](https://twitter.com/dominictarr) |
13+
| **Philippe Schommers** | | |
14+
| **Christopher Jeffrey** | | |
15+
| **Raynos** | | |
16+
| **Gordon Hall** | [**@bookchin**](https://github.com/bookchin) | |
17+
| **Max Ogden** | [**@maxogden**](https://github.com/maxogden) | [**@maxogden@twitter**](https://twitter.com/maxogden) |
18+
| **Geoff Greer** | [**@ggreer**](https://github.com/ggreer) | |
19+
| **Meirion Hughes** | [**@MeirionHughes**](https://github.com/MeirionHughes) | |
20+
| **Matteo Collina** | [**@mcollina**](https://github.com/mcollina) | [**@matteocollina@twitter**](https://twitter.com/matteocollina) |
21+
| **Oguz Bastemur** | [**@obastemur**](https://github.com/obastemur) | [**@obastemur@twitter**](https://twitter.com/obastemur) |
22+
| **Braydon Fuller** | [**@braydonf**](https://github.com/braydonf) | |
23+
| **duralog** | | |
24+
| **Amine Mouafik** | [**@kytwb**](https://github.com/kytwb) | |
25+
| **James Butler** | [**@sandfox**](https://github.com/sandfox) | |
26+
| **Super-User** | | |
27+
| **Luandro** | [**@luandro**](https://github.com/luandro) | |
28+
| **Joyee Cheung** | [**@joyeecheung**](https://github.com/joyeecheung) | [**@joyeecheung@twitter**](https://twitter.com/joyeecheung) |
29+
| **Andre Staltz** | | |
30+
| **Nathan Shively-Sanders** | [**@sandersn**](https://github.com/sandersn) | |
31+
| **Huan LI** | [**@zixia**](https://github.com/zixia) | [**@zixia@twitter**](https://twitter.com/zixia) |
32+
| **Michael Ihde** | | |
33+
| **Aaron Bieber** | [**@qbit**](https://github.com/qbit) | |
34+
| **Anton Whalley** | [**@no9**](https://github.com/no9) | [**@dhigit9@twitter**](https://twitter.com/dhigit9) |
35+
| **Tim Kuijsten** | [**@timkuijsten**](https://github.com/timkuijsten) | [**@timkuijsten@mastodon.social**](https://mastodon.social/@timkuijsten) |
36+
| **Michael Nisi** | [**@michaelnisi**](https://github.com/michaelnisi) | |
37+
| **Sharvil Nanavati** | [**@sharvil**](https://github.com/sharvil) | |
38+
| **Thorsten Lorenz** | [**@thlorenz**](https://github.com/thlorenz) | |
39+
| **Andrew Kelley** | [**@andrewrk**](https://github.com/andrewrk) | |
40+
| **Adam Bliss** | [**@abliss**](https://github.com/abliss) | |
41+
| **flames of love** | | |
42+
| **mscdex** | [**@mscdex**](https://github.com/mscdex) | |
43+
| **Dean Landolt** | [**@deanlandolt**](https://github.com/deanlandolt) | |
44+
| **No9** | | |
45+
| **Mark Wolfe** | [**@wolfeidau**](https://github.com/wolfeidau) | |
46+
| **Alex Gentile** | [**@agentilela**](https://github.com/agentilela) | |

‎LICENSE.md‎

Lines changed: 17 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,21 @@
1-
The MIT License (MIT)
2-
=====================
1+
# The MIT License (MIT)
32

4-
Copyright (c) 2017 Rod Vagg
5-
---------------------------
3+
**Copyright © 2012-present Rod Vagg and [Contributors](CONTRIBUTORS.md).**
64

7-
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:
5+
Permission is hereby granted, free of charge, to any person obtaining a copy
6+
of this software and associated documentation files (the "Software"), to deal
7+
in the Software without restriction, including without limitation the rights
8+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9+
copies of the Software, and to permit persons to whom the Software is
10+
furnished to do so, subject to the following conditions:
811

9-
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
12+
The above copyright notice and this permission notice shall be included in all
13+
copies or substantial portions of the Software.
1014

11-
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.
15+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21+
SOFTWARE.

‎README.md‎

Lines changed: 4 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -343,11 +343,11 @@ There are multiple ways you can find help in using LevelDB in Node.js:
343343

344344
## Contributing
345345

346-
`leveldown` is an **OPEN Open Source Project**. This means that:
346+
[`Level/leveldown`](https://github.com/Level/leveldown) is an **OPEN Open Source Project**. This means that:
347347

348348
> Individuals making significant and valuable contributions are given commit-access to the project to contribute as they see fit. This project is more like an open wiki than a standard guarded open source project.
349349
350-
See the [contribution guide](https://github.com/Level/community/blob/master/CONTRIBUTING.md) for more details.
350+
See the [Contribution Guide](https://github.com/Level/community/blob/master/CONTRIBUTING.md) for more details.
351351

352352
### Git Submodules
353353

@@ -374,16 +374,10 @@ $ git submodule update --init --recursive
374374
7. Add changelog to the GitHub release
375375
8. Finally: `npm publish`
376376

377-
### Windows
378-
379-
A large portion of the Windows support comes from code by [Krzysztof Kowalczyk](http://blog.kowalczyk.info/) [@kjk](https://twitter.com/kjk), see his Windows LevelDB port [here](http://code.google.com/r/kkowalczyk-leveldb/). If you're using `leveldown` on Windows, you should give him your thanks!
380-
381377
## License
382378

383-
Copyright © 2012-present `leveldown` [contributors](https://github.com/level/community#contributors).
384-
385-
`leveldown` is licensed under the MIT license. All rights not explicitly granted in the MIT license are reserved. See the included `LICENSE.md` file for more details.
379+
[MIT](LICENSE.md) © 2012-present Rod Vagg and [Contributors](CONTRIBUTORS.md).
386380

387-
*`leveldown` builds on the excellent work of the LevelDB and Snappy teams from Google and additional contributors. LevelDB and Snappy are both issued under the [New BSD Licence](http://opensource.org/licenses/BSD-3-Clause).*
381+
_`leveldown` builds on the excellent work of the LevelDB and Snappy teams from Google and additional contributors. LevelDB and Snappy are both issued under the [New BSD License](http://opensource.org/licenses/BSD-3-Clause). A large portion of `leveldown` Windows support comes from the [Windows LevelDB port](http://code.google.com/r/kkowalczyk-leveldb/) (archived) by [Krzysztof Kowalczyk](http://blog.kowalczyk.info/) ([`@kjk`](https://twitter.com/kjk)). If you're using `leveldown` on Windows, you should give him your thanks!_
388382

389383
[level-badge]: http://leveldb.org/img/badge.svg

‎package.json‎

Lines changed: 27 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,17 +1,18 @@
11
{
22
"name": "leveldown",
3-
"description": "A low-level Node.js LevelDB binding",
43
"version": "5.0.0-1",
5-
"repository": {
6-
"type": "git",
7-
"url": "https://github.com/level/leveldown.git"
8-
},
9-
"homepage": "https://github.com/level/leveldown",
10-
"keywords": [
11-
"leveldb",
12-
"level"
13-
],
4+
"description": "A low-level Node.js LevelDB binding",
5+
"license": "MIT",
146
"main": "leveldown.js",
7+
"scripts": {
8+
"install": "node-gyp-build",
9+
"test": "standard && hallmark && nyc tape test/*-test.js",
10+
"coverage": "nyc report --reporter=text-lcov | coveralls",
11+
"rebuild": "node-gyp rebuild",
12+
"prebuild": "prebuildify -t 8.14.0 -t electron@3.0.0 --napi --strip",
13+
"download-prebuilds": "prebuildify-ci download",
14+
"hallmark": "hallmark --fix"
15+
},
1516
"dependencies": {
1617
"abstract-leveldown": "~6.0.0",
1718
"bindings": "~1.3.0",
@@ -24,7 +25,8 @@
2425
"coveralls": "^3.0.2",
2526
"delayed": "~1.0.1",
2627
"du": "~0.1.0",
27-
"hallmark": "~0.1.0",
28+
"hallmark": "^0.1.0",
29+
"level-community": "^3.0.0",
2830
"level-concat-iterator": "^2.0.0",
2931
"mkfiletree": "~1.0.1",
3032
"monotonic-timestamp": "~0.0.8",
@@ -41,17 +43,22 @@
4143
"tempy": "^0.2.1",
4244
"uuid": "^3.2.1"
4345
},
44-
"scripts": {
45-
"install": "node-gyp-build",
46-
"test": "standard && nyc tape test/*-test.js",
47-
"coverage": "nyc report --reporter=text-lcov | coveralls",
48-
"rebuild": "node-gyp rebuild",
49-
"prebuild": "prebuildify -t 8.14.0 -t electron@3.0.0 --napi --strip",
50-
"download-prebuilds": "prebuildify-ci download",
51-
"hallmark": "hallmark --fix UPGRADING.md CHANGELOG.md"
46+
"hallmark": {
47+
"community": "level-community",
48+
"ignore": [
49+
"README.md"
50+
]
5251
},
53-
"license": "MIT",
5452
"gypfile": true,
53+
"repository": {
54+
"type": "git",
55+
"url": "https://github.com/Level/leveldown.git"
56+
},
57+
"homepage": "https://github.com/Level/leveldown",
58+
"keywords": [
59+
"leveldb",
60+
"level"
61+
],
5562
"engines": {
5663
"node": ">=8.6.0"
5764
}

0 commit comments

Comments
 (0)
⚡