Code Monkey home page Code Monkey logo

generator-badges's Introduction

generator-badges

Greenkeeper badge

NPM version Build Status Coveralls Status Dependency Status DevDependency Status

Yeoman generator for adding badges to your README.md Works great as cli and with other generators too.

Install

npm install --global yo generator-badges

Usage

yo badges noPrompts -u i-am-user -p my-awesome-project -b travis,npm

This command creates README.md (if doesn't exist) or created one and put there follow rows on the top:

[![Build Status][travis-image]][travis-url]
[travis-url]: https://travis-ci.org/i-am-user/my-awesome-project
[travis-image]: https://img.shields.io/travis/i-am-user/my-awesome-project/master.svg?style=flat-square

[![NPM version][npm-image]][npm-url]
[npm-url]: https://npmjs.org/package/my-awesome-project
[npm-image]: https://img.shields.io/npm/v/my-awesome-project.svg?style=flat-square

OR

you can use prompt mode:

yo badges

Now supports follow badges in options:

  • appveyor — NPM version
  • npm — NPM version
  • travis — Travis CI
  • coveralls — coveralls.io
  • dependencies — dependency status
  • devDependencies — devDependency status
  • codeship — codeship build status
  • scrutinizer — scrutinizer code quality
  • werckerwercker.com

Composability

Composability is a way to combine smaller parts to make one large thing. Sort of like Voltron®

— Yeoman docs

Just plug in for generates badges into your README.md into your generator.

Install

npm install --save generator-badges

Compose

this.composeWith('badges', { options:  {
    'skip-install': this.options['skip-install'],
    config: {
        user: "i-am-user",
        project: "my-awesome-project",
        badges: ['travis', 'npm']
}}}, {
  local: require.resolve('generator-badges')
});

License

MIT © Aleksandr Filatov alfilatov.com

generator-badges's People

Contributors

greenkeeper[bot] avatar greenkeeperio-bot avatar greybax avatar

Stargazers

 avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

generator-badges's Issues

An in-range update of yeoman-test is breaking the build 🚨

Version 1.9.0 of yeoman-test was just published.

Branch Build failing 🚨
Dependency yeoman-test
Current Version 1.8.0
Type devDependency

This version is covered by your current version range and after updating it in your project the build failed.

yeoman-test is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details
  • continuous-integration/travis-ci/push: The Travis CI build failed (Details).

Release Notes v1.9.0
  • Fix tests silencing failure happening inside the generator under test own code.

This fix could break some users tests - but these tests should've been failing as the generator itself would be throwing an exception.

Commits

The new version differs by 3 commits.

  • d4c9ef9 1.9.0
  • 5cf9090 Update build process (bye gulp) and bump dependencies
  • 06f2d6d Catch errors from yeoman-generator (#47)

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.


Your Greenkeeper Bot 🌴

An in-range update of coveralls is breaking the build 🚨

The devDependency coveralls was updated from 3.0.2 to 3.0.3.

🚨 View failing branch.

This version is covered by your current version range and after updating it in your project the build failed.

coveralls is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details
  • continuous-integration/travis-ci/push: The Travis CI build failed (Details).

Release Notes for Dependency security updates

As suggested by NPM and Snyk.

Commits

The new version differs by 1 commits.

  • aa2519c dependency security audit fixes from npm & snyk (#210)

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.


Your Greenkeeper Bot 🌴

Add interactive prompt

This generator is a great idea, but do you plan do add support for more badges? You can find lots of badges at http://shields.io/

I plan to add some more like Codeship and Scrunitizer.

Probably a personal preference, but I think would be simple to use your generator with an interactive prompt asking for the project, user, and badges (selecting from a list) instead of specifying directly via the generator options.

An in-range update of yeoman-test is breaking the build 🚨

Version 1.8.0 of yeoman-test was just published.

Branch Build failing 🚨
Dependency yeoman-test
Current Version 1.7.2
Type devDependency

This version is covered by your current version range and after updating it in your project the build failed.

yeoman-test is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details
  • continuous-integration/travis-ci/push The Travis CI build failed Details

Release Notes v1.8.0

Add capacity to define namespace and resolved path to stubbed generators.

Commits

The new version differs by 2 commits.

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.


Your Greenkeeper Bot 🌴

An in-range update of yeoman-test is breaking the build 🚨

Version 1.7.2 of yeoman-test was just published.

Branch Build failing 🚨
Dependency yeoman-test
Current Version 1.7.1
Type devDependency

This version is covered by your current version range and after updating it in your project the build failed.

yeoman-test is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details
  • continuous-integration/travis-ci/push The Travis CI build failed Details

Commits

The new version differs by 2 commits.

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.


Your Greenkeeper Bot 🌴

An in-range update of mocha is breaking the build 🚨

Version 5.2.0 of mocha was just published.

Branch Build failing 🚨
Dependency mocha
Current Version 5.1.1
Type devDependency

This version is covered by your current version range and after updating it in your project the build failed.

mocha is a devDependency of this project. It might not break your production code or affect downstream projects, but probably breaks your build or test tools, which may prevent deploying or publishing.

Status Details
  • continuous-integration/travis-ci/push The Travis CI build failed Details

Release Notes v5.2.0

5.2.0 / 2018-05-18

🎉 Enhancements

🐛 Fixes

📖 Documentation

🔩 Other

Commits

The new version differs by 30 commits.

  • 5bd33a0 Release v5.2.0
  • 0a5604f reformat missed files
  • 7c8f551 ensure scripts/*.js gets prettiered
  • d8ea2ba update CHANGELOG.md for v5.2.0 [ci skip]
  • 7203ed7 update all dependencies
  • fb5393b migrate Mocha's tests to Unexpected assertion library (#3343)
  • fae9af2 docs(docs/index.md): Update "mocha.opts" documentation
  • 9d9e6c6 feat(bin/options.js): Add support for comment lines in "mocha.opts"
  • e0306ff fix busted lint-staged config
  • f2be6d4 Annotate when exceptions are caught but ignored; closes #3354 (#3356)
  • 889e681 remove dead code in bin/_mocha
  • 8712b95 fix(ocd): re-order Node.js tests in .travis.yml (descending)
  • 3ab0e7e fix to exit correctly when using bail flag
  • d87b12e add Node.js v10 to build; fix win32 issues (#3350)
  • b392af5 update package-lock.json for npm@6 [ci skip]

There are 30 commits in total.

See the full diff

FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.


Your Greenkeeper Bot 🌴

Version 10 of node.js has been released

Version 10 of Node.js (code name Dubnium) has been released! 🎊

To see what happens to your code in Node.js 10, Greenkeeper has created a branch with the following changes:

  • Added the new Node.js version to your .travis.yml

If you’re interested in upgrading this repo to Node.js 10, you can open a PR with these changes. Please note that this issue is just intended as a friendly reminder and the PR as a possible starting point for getting your code running on Node.js 10.

More information on this issue

Greenkeeper has checked the engines key in any package.json file, the .nvmrc file, and the .travis.yml file, if present.

  • engines was only updated if it defined a single version, not a range.
  • .nvmrc was updated to Node.js 10
  • .travis.yml was only changed if there was a root-level node_js that didn’t already include Node.js 10, such as node or lts/*. In this case, the new version was appended to the list. We didn’t touch job or matrix configurations because these tend to be quite specific and complex, and it’s difficult to infer what the intentions were.

For many simpler .travis.yml configurations, this PR should suffice as-is, but depending on what you’re doing it may require additional work or may not be applicable at all. We’re also aware that you may have good reasons to not update to Node.js 10, which is why this was sent as an issue and not a pull request. Feel free to delete it without comment, I’m a humble robot and won’t feel rejected 🤖


FAQ and help

There is a collection of frequently asked questions. If those don’t help, you can always ask the humans behind Greenkeeper.


Your Greenkeeper Bot 🌴

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on all branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because we are using your CI build statuses to figure out when to notify you about breaking changes.

Since we did not receive a CI status on the greenkeeper/initial branch, we assume that you still need to configure it.

If you have already set up a CI for this repository, you might need to check your configuration. Make sure it will run on all new branches. If you don’t want it to run on every branch, you can whitelist branches starting with greenkeeper/.

We recommend using Travis CI, but Greenkeeper will work with every other CI service as well.

Cannot read property 'Symbol(Symbol.iterator)' of undefined

Hi. When running your generator, I got the following error:

TypeError: Cannot read property 'Symbol(Symbol.iterator)' of undefined
    at Function.all (native)
    at module.exports.yeoman.Base.extend.writing.app (/media/DATA/Projects/personal/generators/generator-badges/app/index.js:81:21)
    at Object.<anonymous> (/media/DATA/Projects/personal/generators/generator-badges/node_modules/yeoman-generator/lib/base.js:436:25)
    at /media/DATA/Projects/personal/generators/generator-badges/node_modules/run-async/index.js:26:25
    at /media/DATA/Projects/personal/generators/generator-badges/node_modules/run-async/index.js:25:19
    at /media/DATA/Projects/personal/generators/generator-badges/node_modules/yeoman-generator/lib/base.js:448:8
    at processImmediate [as _immediateCallback] (timers.js:383:17)

I think the problem is that you are calling Promise.all() without arguments and according to this it must receive an iterable object.

If i pass an empty array like Promise.all([]) it works.
Not sure if is the best way. Is that promise really needed?

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.