Skip to content

Commit

Permalink
implement
Browse files Browse the repository at this point in the history
  • Loading branch information
tunnckoCore committed May 26, 2015
1 parent b0b0b69 commit ab16bb2
Show file tree
Hide file tree
Showing 10 changed files with 314 additions and 2 deletions.
22 changes: 22 additions & 0 deletions .editorconfig
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# .editorconfig <https://github.com/tunnckoCore/dotfiles>
#
# Copyright (c) 2015 Charlike Mike Reagent, contributors.
# Released under the MIT license.
#

root = true

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

[*.php]
indent_size = 4

[*.md]
insert_final_newline = false
trim_trailing_whitespace = false
56 changes: 56 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
# .gitignore <https://github.com/tunnckoCore/dotfiles>
#
# Copyright (c) 2015 Charlike Mike Reagent, contributors.
# Released under the MIT license.
#

# Always-ignore dirs #
# ####################
_gh_pages
node_modules
bower_components
components
vendor
build
dest
dist
src
lib-cov
coverage
nbproject
cache
temp
tmp
is-generator-function-name

# Packages #
# ##########
*.7z
*.dmg
*.gz
*.iso
*.jar
*.rar
*.tar
*.zip

# OS, Logs and databases #
# #########################
*.pid
*.dat
*.log
*.sql
*.sqlite
*~
~*

# Another files #
# ###############
Icon?
.DS_Store*
Thumbs.db
ehthumbs.db
Desktop.ini
npm-debug.log
.directory
._*
15 changes: 15 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
sudo: false
language: "node_js"
node_js:
- "0.10"
- "0.12"
- "iojs"
before_script:
- npm install standard
- standard
script:
- npm install istanbul-harmony
- istanbul cover test.js --report lcovonly
after_script:
- npm install coveralls
- cat ./coverage/lcov.info | coveralls
4 changes: 4 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@


## 0.0.0 - 2015-05-26
- first commits
32 changes: 32 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# Contributing Guidelines

Contributions are always welcome!

**Before spending lots of time on something, ask for feedback on your idea first!**

Please search issues and pull requests before adding something new to avoid duplicating efforts and conversations.


## Installing

Fork and clone the repo, then `npm install` to install all dependencies and `npm test` to ensure all is okey before you start anything.


## Testing

Tests are run with `npm test`. Please ensure all tests are passing before submitting a pull request (unless you're creating a failing test to increase test coverage or show a problem).

## Code Style

[![standard][standard-image]][standard-url]

This repository uses [`standard`][standard-url] to maintain code style and consistency, and to avoid style arguments. You are encouraged to install it globally. `npm test` runs `standard` so you don't have to!

```
npm i standard -g
```

It is intentional to don't have `standard`, `istanbul` and `coveralls` in the devDependencies. Travis will handle all that stuffs. That approach will save bandwidth also installing and development time.

[standard-image]: https://cdn.rawgit.com/feross/standard/master/badge.svg
[standard-url]: https://github.com/feross/standard
21 changes: 21 additions & 0 deletions LICENSE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# The MIT License

Copyright (c) 2015 [Charlike Make Reagent](http://j.mp/1stW47C)

> 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.
93 changes: 91 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,2 +1,91 @@
# is-generator-function-name
Check that given value have `GeneratorFunction` name.
# is-generator-function-name [![npmjs.com][npmjs-img]][npmjs-url] [![The MIT License][license-img]][license-url]

> Check that given value have `GeneratorFunction` name.
[![code climate][codeclimate-img]][codeclimate-url] [![standard code style][standard-img]][standard-url] [![travis build status][travis-img]][travis-url] [![coverage status][coveralls-img]][coveralls-url] [![dependency status][david-img]][david-url]


## Install
```
npm i is-generator-function-name --save
npm test
```


## Usage
> For more use-cases see the [tests](./test.js)
```js
var isGeneratorFunctionName = require('is-generator-function-name')

isGeneratorFunctionName({foo: 'bar'})
//=> false

isGeneratorFunctionName(function () {})
//=> false

isGeneratorFunctionName(function GeneratorFunction () {})
//=> false

isGeneratorFunctionName(function * () {})
//=> true

isGeneratorFunctionName(function * () { yield 42 })
//=> true
```


## Contributing

Pull requests and stars are always welcome. For bugs and feature requests, [please create an issue](https://github.com/tunnckoCore/is-generator-function-name/issues/new).
But before doing anything, please read the [CONTRIBUTING.md](./CONTRIBUTING.md) guidelines.


## [Charlike Make Reagent](http://j.mp/1stW47C) [![new message to charlike][new-message-img]][new-message-url] [![freenode #charlike][freenode-img]][freenode-url]

[![tunnckocore.tk][author-www-img]][author-www-url] [![keybase tunnckocore][keybase-img]][keybase-url] [![tunnckoCore npm][author-npm-img]][author-npm-url] [![tunnckoCore twitter][author-twitter-img]][author-twitter-url] [![tunnckoCore github][author-github-img]][author-github-url]


[npmjs-url]: https://www.npmjs.com/package/is-generator-function-name
[npmjs-img]: https://img.shields.io/npm/v/is-generator-function-name.svg?label=is-generator-function-name

[license-url]: https://github.com/tunnckoCore/is-generator-function-name/blob/master/LICENSE.md
[license-img]: https://img.shields.io/badge/license-MIT-blue.svg


[codeclimate-url]: https://codeclimate.com/github/tunnckoCore/is-generator-function-name
[codeclimate-img]: https://img.shields.io/codeclimate/github/tunnckoCore/is-generator-function-name.svg

[travis-url]: https://travis-ci.org/tunnckoCore/is-generator-function-name
[travis-img]: https://img.shields.io/travis/tunnckoCore/is-generator-function-name.svg

[coveralls-url]: https://coveralls.io/r/tunnckoCore/is-generator-function-name
[coveralls-img]: https://img.shields.io/coveralls/tunnckoCore/is-generator-function-name.svg

[david-url]: https://david-dm.org/tunnckoCore/is-generator-function-name
[david-img]: https://img.shields.io/david/tunnckoCore/is-generator-function-name.svg

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


[author-www-url]: http://www.tunnckocore.tk
[author-www-img]: https://img.shields.io/badge/www-tunnckocore.tk-fe7d37.svg

[keybase-url]: https://keybase.io/tunnckocore
[keybase-img]: https://img.shields.io/badge/keybase-tunnckocore-8a7967.svg

[author-npm-url]: https://www.npmjs.com/~tunnckocore
[author-npm-img]: https://img.shields.io/badge/npm-~tunnckocore-cb3837.svg

[author-twitter-url]: https://twitter.com/tunnckoCore
[author-twitter-img]: https://img.shields.io/badge/twitter-@tunnckoCore-55acee.svg

[author-github-url]: https://github.com/tunnckoCore
[author-github-img]: https://img.shields.io/badge/github-@tunnckoCore-4183c4.svg

[freenode-url]: http://webchat.freenode.net/?channels=charlike
[freenode-img]: https://img.shields.io/badge/freenode-%23charlike-5654a4.svg

[new-message-url]: https://github.com/tunnckoCore/messages
[new-message-img]: https://img.shields.io/badge/send%20me-message-green.svg
16 changes: 16 additions & 0 deletions index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
/*!
* is-generator-function-name <https://github.com/tunnckoCore/is-generator-function-name>
*
* Copyright (c) 2015 Charlike Mike Reagent, contributors.
* Released under the MIT license.
*/

'use strict'

module.exports = function isGeneratorFunctionName (co) {
if (!co || !co.constructor) {
return false
}
return co.constructor.name === 'GeneratorFunction' ||
co.constructor.displayName === 'GeneratorFunction'
}
17 changes: 17 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"name": "is-generator-function-name",
"version": "0.0.0",
"description": "Check that given value have `GeneratorFunction` name.",
"repository": "tunnckoCore/is-generator-function-name",
"author": "Charlike Mike Reagent <@tunnckoCore> (http://www.tunnckocore.tk)",
"main": "index.js",
"license": "MIT",
"scripts": {
"test": "standard && node test.js"
},
"dependencies": {},
"devDependencies": {
"assertit": "^0.1.0"
},
"keywords": []
}
40 changes: 40 additions & 0 deletions test.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
/*!
* is-generator-function-name <https://github.com/tunnckoCore/is-generator-function-name>
*
* Copyright (c) 2015 Charlike Mike Reagent, contributors.
* Released under the MIT license.
*/

/* jshint asi:true */

'use strict'

var test = require('assertit')
var isGeneratorFunctionName = require('./index')

test('is-generator-function-name:', function () {
test('generators', function () {
test('should return false with non-generators', function () {
test.equal(isGeneratorFunctionName(null), false)
test.equal(isGeneratorFunctionName(undefined), false)
test.equal(isGeneratorFunctionName([1, 2, 3]), false)
test.equal(isGeneratorFunctionName({then: true}), false)
test.equal(isGeneratorFunctionName(25), false)
test.equal(isGeneratorFunctionName('test'), false)
})
test('should return false with a generator', function () {
test.equal(isGeneratorFunctionName((function * () {})()), false)
})
})

test('generator functions', function () {
test('should return false with non-generator function', function () {
test.equal(isGeneratorFunctionName(function () {}), false)
test.equal(isGeneratorFunctionName(function GeneratorFunction () {}), false)
})
test('should return true with a generator functions', function () {
test.equal(isGeneratorFunctionName(function * () {}), true)
test.equal(isGeneratorFunctionName(function * () { yield 42 }), true)
})
})
})

0 comments on commit ab16bb2

Please sign in to comment.