Giter Club home page Giter Club logo

generator-nodecg's Introduction

generator-nodecg

NPM version Build Status Test Coverage

Yeoman generator for NodeCG bundles

generator-nodecg can be used to quickly start a new bundle with the barebones boilerplate files that every bundle needs. It can also be used to add a new panel, graphic, or extension in an existing bundle.

Installation

First, install Yeoman and generator-nodecg using npm (we assume you have pre-installed node.js).

npm install -g yo@latest
npm install -g generator-nodecg@latest

Then generate your new bundle:

# Run this command inside the directory of your bundle.
# For example, nodecg/bundles/my-bundle.
yo nodecg

generator-nodecg also has specific sub-generators that can be used on existing bundles:

yo nodecg:panel
yo nodecg:graphic
yo nodecg:extension

Special Thanks

Significant portions of this generator are based on generator-node. We thank the developers of generator-node and Yeoman for their years of hard work.

License

MIT © Alex Van Camp

generator-nodecg's People

Contributors

from-the-river-to-the-sea avatar github-actions[bot] avatar greenkeeper[bot] avatar greenkeeperio-bot avatar hoishin avatar simonfischer04 avatar tobybaratta avatar trezc0 avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

generator-nodecg's Issues

An in-range update of generator-node is breaking the build 🚨

☝️ Greenkeeper’s updated Terms of Service will come into effect on April 6th, 2018.

Version 2.4.0 of generator-node was just published.

Branch Build failing 🚨
Dependency generator-node
Current Version 2.3.0
Type dependency

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

generator-node is a direct dependency of this project, and it is very likely causing it to break. If other packages depend on yours, this update is probably also breaking those in turn.

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

Commits

The new version differs by 11 commits.

  • ddd83c8 v2.4.0
  • d6ad8eb Update Yarn lockfile
  • c7c85e3 Update dependencies (#278)
  • 129c233 Add support for scoped package (Fix #272) (#275)
  • fd50d93 Setup coverage output in the terminal
  • 4fec892 Replace deprecated prepublish by prepublishOnly (#271)
  • 32f1c96 Correct opencollective badge
  • 80e7e9c Update README.md (#270)
  • e1260dc Bump dependencies
  • a791156 Update the generator/git to ES6 Class (#269)
  • ad88f00 Bump dependencies

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 lodash is breaking the build 🚨

Version 4.17.9 of lodash was just published.

Branch Build failing 🚨
Dependency lodash
Current Version 4.17.5
Type dependency

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

lodash is a direct dependency of this project, and it is very likely causing it to break. If other packages depend on yours, this update is probably also breaking those in turn.

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

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 🌴

Install Syntax Error

I was unable to use yo nodecg , due to a syntax error present at line 61 of: generators/app/index.js :

}, this).then(function ({name}) {

The bold curly brackets were given as the cause.

Edit: Sorry, it seems the install worked when i upgraded my node from version 4 to the latest.

Sync with the main nodecg repo

(Originally was incorrectly posted to generator-nodecg/#56)

nodecg-cli has been a bit unloved in the past year or two. It's not been kept up-to-date with changes happening in NodeCG itself. Specifically, it doesn't know about all the current package manifest properties, and it still recommends ~0.8.0 as the default compatibleRange.

This project should be given a once-over to ensure it is sync'd with NodeCG itself.

An in-range update of deep-extend is breaking the build 🚨

Version 0.5.1 of deep-extend was just published.

Branch Build failing 🚨
Dependency deep-extend
Current Version 0.5.0
Type dependency

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

deep-extend is a direct dependency of this project, and it is very likely causing it to break. If other packages depend on yours, this update is probably also breaking those in turn.

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

Commits

The new version differs by 7 commits.

  • 2e0110e prepared v0.5.1 release
  • 433ee51 Avoid using deprecated Buffer API
  • 9d71360 .editorconfig: added max-line-length
  • 715555b Merge branch 'pr-40' into dev
  • 9423fae Prevent Object prototype pollution.
  • ffe04c3 added test for issue #33
  • 9653940 updated yarn.lock

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 🌴

docs: Add clarification for what some of the prompts do/mean

The generator prompts you to answer some questions that I think are a bit unclear to answer to someone just setting up a new bundle. For example, "Is this a "single instance" graphic?" -- without any context, this is hard to understand what is meant by it. Does this mean the graphic is only in one scene in OBS? The graphic is only used in one way with a single replicant populating its data (ie: same graphic, different replicant of data is used in parallel)?

In addition, the question regarding React is a bit unclear - some folk (myself included) might want React for their Dashboard but not for Graphics. I think it might be a bit better to be a bit clearer on the prompt for what it's doing / where.

I think another spot that could be helpful for clarification would be "panel name" versus "panel title". I put "Dashboard" in for the first option, had that get changed to dashboard, and then saw the prompt for the second question have the suggestion / autofill of "Dashboard" and got a bit confused as to what was meant by the first question. IE: Is it auto filled off the prior answer or off of a standard for Dashboard panels?

Add option to output TypeScript

NodeCG v2 is Coming Soon ™️ and will natively support TypeScript. As such, we should offer an option to have generator-nodecg output a TypeScript-ready bundle template.

An in-range update of generator-license is breaking the build 🚨

☝️ Greenkeeper’s updated Terms of Service will come into effect on April 6th, 2018.

Version 5.3.0 of generator-license was just published.

Branch Build failing 🚨
Dependency generator-license
Current Version 5.2.0
Type dependency

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

generator-license is a direct dependency of this project, and it is very likely causing it to break. If other packages depend on yours, this update is probably also breaking those in turn.

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

Release Notes v5.3.0
  • Replace nolicense with UNLICENSED
  • Do not prompt user to re-answer some prompts if the master generator passed null or undefined down.
Commits

The new version differs by 5 commits.

  • c092604 5.3.0
  • a1446b9 Update lock format and travis matrix
  • 6b88b27 Undefined or null (#87)
  • e694910 Remove redundant dep, git-config, fixes #85 (#86)
  • 9009547 Replace nolicense with UNLICENSED (#83)

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 🌴

bug: Running `yo nodecg` in a random empty folder inside of `nodecg` shows error message about package manager

Reproduction steps:

  1. Have Node and npm installed, using nvm.
  2. Run yo nodecg in an entirely empty folder.
  3. Answer prompts normally.
  4. See below error message (should maybe be a warning?)
image

Environment:

  • Node version: v18.16.1
  • NPM Version: 9.8.0
  • Windows 11, run in pwsh preview through Windows Terminal.

Expected behavior

Either:

  • detect I am using npm somehow magically
  • prompt me and ask what package manager I'm using

Do not fall back to npm without confirming with end-user that that's the desired behavior, IMO, to avoid running into annoying potential symlink issues further down the line.

Travis CI not running on builds & has broken icon

Description

Due to the lack of a .travis.yml file setup to run with pull requests or releases, Travis CI doesn't have any builds on record for this repository. Thus, the link & image in the README are broken.

The URL should, regardless, point to: https://travis-ci.com/github/nodecg/generator-nodecg, rather than that path without the /github/ in the URL.

Suggested Fix Options

  • Setup Travis CI
  • Delete the broken link + broken image from the README.

Add support for command-line options instead of prompts

As already mentioned in PR: #79, supporting program arguments could give some benefits:

  • re-allow some sort of Windows test?
  • allow integration into other tools (for example: I may develop an IntelliJ plugin for nodecg development, if I can find time for it => interacting with the generator over stdin/out would not be fun...)

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

Version 1.7.1 of yeoman-test was just published.

Branch Build failing 🚨
Dependency yeoman-test
Current Version 1.7.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 could not complete due to an error 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 chalk is breaking the build 🚨

Version 2.4.0 of chalk was just published.

Branch Build failing 🚨
Dependency chalk
Current Version 2.3.2
Type dependency

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

chalk is a direct dependency of this project, and it is very likely causing it to break. If other packages depend on yours, this update is probably also breaking those in turn.

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

Release Notes v2.4.0
  • Added Flow type definitions. 7c6f83f

v2.3.2...v2.4.0

Commits

The new version differs by 4 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 🌴

Update dependencies / convert to ES-Modules

Hi,
First things first: thanks for this great project, really helps to getting started and also speeds up development further down the line.

Just found that there are a lot of old / vulnerable dependencies, so a wanted to-do something about it. (updating everything to what was currently available as stable)

In the process i discovered multiple thing. For example that yeoman-test@7 is not compatible with CommonJS anymore (See: yeoman/yeoman-test#164). So furthermore I ported everything to ES-Modules in the process.

Summary of what I did:

  • update dependencie
  • port everything to work with ES-Modules
  • switched to native mocha (instead of ts-mocha), because had problems with that: (related: piotrwitek/ts-mocha#70)
  • changed to commonly used *.spec.ts format for test, instead of plain *.ts
  • by updating packages being able to get rid of some @types packages, by using native typescript versions

=> See pull request: #79

Further ideas:

  • ES-Modules: (still could get some optimisations using new features, but just wanted to get it working for this Issue/PR - I may do improvements here myself following later)
  • enable dependabot for this repo, to get automatic updates in the future. any specific reason it is disabled?

No valid versions available for generator-nodecg

I have been unable to install the generator using the documented command.

$ npm install generator-nodecg
npm ERR! code ENOVERSIONS
npm ERR! No valid versions available for generator-nodecg

npm ERR! A complete log of this run can be found in:
npm ERR!     /home/inaki/.npm/_logs/2021-02-14T14_54_25_234Z-debug.log

It seems that it is not published to npm.

I have been able to install it running
npm install https://github.com/nodecg/generator-nodecg

An in-range update of npm-name is breaking the build 🚨

☝️ Greenkeeper’s updated Terms of Service will come into effect on April 6th, 2018.

Version 3.2.0 of npm-name was just published.

Branch Build failing 🚨
Dependency npm-name
Current Version 3.1.0
Type devDependency

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

npm-name 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 3 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 🌴

some refactoring steps

This project got some get some refactoring.
Here a list of things I found during my recent development of ES-Module port (see: #78 and #79):

Just a list to have them collected and address whenever fits, not necessary to "fix" straight away.

I intend this issue to stay open for quite some time at least and be updated with any new ideas / suggestions, so feel free to comment.

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.