Skip to content

Commit

Permalink
refactor(simplify): rewrite from scratch, update boilerplate stuff
Browse files Browse the repository at this point in the history
and provide ES6 and CJS bundles, so no big instal times

BREAKING CHANGE: Promisify just a function - sync and async. Allow passing args, custom promise ctor
and context through options
  • Loading branch information
tunnckoCore committed Mar 11, 2017
1 parent 63375b2 commit 3ff2cdc
Show file tree
Hide file tree
Showing 17 changed files with 4,816 additions and 493 deletions.
7 changes: 0 additions & 7 deletions .codeclimate.yml

This file was deleted.

21 changes: 3 additions & 18 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -1,27 +1,12 @@
# .editorconfig <https://github.com/tunnckoCore/dotfiles>

root = true

[*]
charset = utf-8
end_of_line = lf
indent_size = 2
indent_style = space

[*.js]
insert_final_newline = true
indent_size = 2
charset = utf-8
trim_trailing_whitespace = true

[*.php]
indent_size = 4
insert_final_newline = true
trim_trailing_whitespace = true

[*.md]
insert_final_newline = false
trim_trailing_whitespace = false

[*.py]
indent_size = 4
insert_final_newline = true
trim_trailing_whitespace = true
insert_final_newline = false
29 changes: 23 additions & 6 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,16 +1,13 @@
# .gitignore <https://github.com/tunnckoCore/dotfiles>

# Always-ignore dirs #
# ####################
_gh_pages
node_modules
jspm_packages
bower_components
components
vendor
build
dest
dist
src
lib-cov
coverage
nbproject
Expand All @@ -23,7 +20,6 @@ redolent
# ##########
*.7z
*.dmg
*.gz
*.iso
*.jar
*.rar
Expand All @@ -32,6 +28,7 @@ redolent

# OS, Logs and databases #
# #########################
logs
*.pid
*.dat
*.log
Expand All @@ -50,4 +47,24 @@ Desktop.ini
npm-debug.log
.directory
._*
lcov.info
lcov.info

# Runtime data
pids
*.pid
*.seed
*.pid.lock


# nyc test coverage
.nyc_output

# Grunt intermediate storage
# see here: http://gruntjs.com/creating-plugins#storing-task-files
.grunt

# Optional npm cache directory
.npm

# Optional REPL history
.node_repl_history
29 changes: 7 additions & 22 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -1,29 +1,14 @@
language: "node_js"
sudo: false
language: node_js

node_js:
- "0.10"
- "0.12"
- "node"
- "6"
- "4"
- "5"
- "0.12"
- "0.10"

notifications:
email:
on_success: never
on_failure: never

before_script:
- npm install standard
- standard

script:
- npm install istanbul
- node --harmony node_modules/.bin/istanbul cover test.js

after_success:
- npm install coveralls
- cat coverage/lcov.info | coveralls
email: false

matrix:
allow_failures:
- node_js: "0.10"
after_success: bash <(curl -s https://codecov.io/bash)
115 changes: 115 additions & 0 deletions .verb.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,115 @@
# {%= name %} {%= badge('npm') %} [![mit license][license-img]][license-url] {%= badge('downloads') %} [![npm total downloads][downloads-img]][downloads-url]

> {%= description %}
[![code climate][codeclimate-img]][codeclimate-url]
[![code style][standard-img]][standard-url]
[![linux build][travis-img]][travis-url]
[![windows build][appveyor-img]][appveyor-url]
[![code coverage][coverage-img]][coverage-url]
[![dependency status][david-img]][david-url]
[![paypal donate][paypalme-img]][paypalme-url]

{%= include('highlight') %}

## Table of Contents
<!-- toc -->

## Install
Install with [npm](https://www.npmjs.com/)

```
$ npm install {%= name %} --save
```

or install using [yarn](https://yarnpkg.com)

```
$ yarn add {%= name %}
```

## Usage
> For more use-cases see the [tests](test.js)
```js
const {%= varname %} = require('{%= name %}')
```

## API
{%= apidocs('index.js') %}

{% if (verb.related && verb.related.list && verb.related.list.length) { %}
## Related
{%= related(verb.related.list, {words: 20}) %}
{% } %}

## Contributing
Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/{%= repository %}/issues/new).
Please read the [contributing guidelines](CONTRIBUTING.md) for advice on opening issues, pull requests, and coding standards.
If you need some help and can spent some cash, feel free to [contact me at CodeMentor.io](https://www.codementor.io/tunnckocore?utm_source=github&utm_medium=button&utm_term=tunnckocore&utm_campaign=github) too.

**In short:** If you want to contribute to that project, please follow these things

1. Please DO NOT edit [README.md](README.md), [CHANGELOG.md](CHANGELOG.md) and [.verb.md](.verb.md) files. See ["Building docs"](#building-docs) section.
2. Ensure anything is okey by installing the dependencies and run the tests. See ["Running tests"](#running-tests) section.
3. Always use `npm run commit` to commit changes instead of `git commit`, because it is interactive and user-friendly. It uses [commitizen][] behind the scenes, which follows Conventional Changelog idealogy.
4. Do NOT bump the version in package.json. For that we use `npm run release`, which is [standard-version][] and follows Conventional Changelog idealogy.

Thanks a lot! :)

## Building docs
Documentation and that readme is generated using [verb-generate-readme][], which is a [verb][] generator, so you need to install both of them and then run `verb` command like that

```
$ npm install verbose/verb#dev verb-generate-readme --global && verb
```

_Please don't edit the README directly. Any changes to the readme must be made in [.verb.md](.verb.md)._

## Running tests
Clone repository and run the following in that cloned directory

```
$ npm install && npm test
```

## Author
{%= includeEither('authors', 'author') %}
+ [codementor/tunnckoCore](https://codementor.io/tunnckoCore)

## License
{%= copyright({ start: 2015, linkify: true, prefix: 'Copyright', symbol: '©' }) %} {%= licenseStatement %}

***

{%= include('footer') %}
_Project scaffolded using [charlike][] cli._

{%= reflinks(verb.reflinks) %}

[license-url]: https://www.npmjs.com/package/{%= name %}
[license-img]: https://img.shields.io/npm/l/{%= name %}.svg

[downloads-url]: https://www.npmjs.com/package/{%= name %}
[downloads-img]: https://img.shields.io/npm/dt/{%= name %}.svg

[codeclimate-url]: https://codeclimate.com/github/{%= repository %}
[codeclimate-img]: https://img.shields.io/codeclimate/github/{%= repository %}.svg

[travis-url]: https://travis-ci.org/{%= repository %}
[travis-img]: https://img.shields.io/travis/{%= repository %}/master.svg?label=linux

[appveyor-url]: https://ci.appveyor.com/project/tunnckoCore/{%= name %}
[appveyor-img]: https://img.shields.io/appveyor/ci/tunnckoCore/{%= name %}/master.svg?label=windows

[coverage-url]: https://codecov.io/gh/{%= repository %}
[coverage-img]: https://img.shields.io/codecov/c/github/{%= repository %}/master.svg

[david-url]: https://david-dm.org/{%= repository %}
[david-img]: https://img.shields.io/david/{%= repository %}.svg

[standard-url]: https://github.com/feross/standard
[standard-img]: https://img.shields.io/badge/code%20style-standard-brightgreen.svg

[paypalme-url]: https://www.paypal.me/tunnckoCore
[paypalme-img]: https://img.shields.io/badge/paypal-donate-brightgreen.svg
Loading

0 comments on commit 3ff2cdc

Please sign in to comment.