ofzach / pgelectron

repo for testing a gui using electron for the project generator

pgelectron

My priceless app

Dev

$ npm install

Run

$ npm start

Build

$ npm run build

Builds the app for OS X, Linux, and Windows, using electron-packager.

License

MIT © Léo Colombaro

pgelectron's Issues

clean up front (semantic-ui)

the front gui got a little messy now with tiny icons, move some stuff to the settings menu maybe... I moved the recycle name to the field but I still feel like it should be cleaner. I think open project should only be on the dialog prompt for new / update not on the main gui.... I also think re-scan addons could be in the settings menu. will move some stuff around now.

platforms should be toggle (not multiselect) with default toggled on

and we should not let there be no platform selected :)

maybe we only need console when you do something like generate a project, etc

right now the always on screen (if button checked) console seems kind of excessive to me, it feels like we get a lot of value by popping the log up on the overlay on create or update. Maybe we don't need the additional bottom console?

open link to ofxaddons instead of showing tooltip

instead of showing a tooltip on the "Addons" label, maybe we should use an icon (like the glyphicon/halflings "share" icon) and this technique jlord/git-it-electron#35 to open a window to ofxaddons.com in a browser.

throw user-select: none on everything

the less it feels like a web app, the better.

unless there is an error message we specifically want people to be able to copy and paste to find out more (or it could link to a forum topic directly).

edit: it would also be cool if it didn't move around when scrolling -- but this is an important feature to have when the addons list is long enough, so it's not a priority.

platform selection should be disabled / grey'd out if advanced toggle not set

picking platforms is an advanced option. We should use the highlighted default platform (platform should be set in the settings.json)

Selecting addon from dropdown with mouse leaves partial text

This is looking really great guys! Thanks for all the work you've put into this.

I noticed a bug with the dropdown list for addons. If you start typing an addon, say "ofxG" and then click on something from the filtered list (like ofxGui), the initial few characters remain in the field. Maybe it's a "feature" so you can speed-add things (ofxGui! ofxGrabCam!) but I'm assuming it should clear out 😄

default project name should be something unique on launch

so that it doesn't default to update, ie, if it's always "myApp" the app will launch with update functionality once that project exists. Maybe we can look at what processing or arduino does for reference or leave the name field blank (with a suggestion not an actual value)

erratic behaviour of update button

There's several cases in which the behaviour of the create/update button is kind of weird:

• When you import a project the button changes to update but later if you change the name manually or even press the random name generator it won't change back to create
• When you type the name of an already existing project it should probably change to update automatically to let you know that the project already exists. This means parsing the fs with every keystroke but i think it should be fine

settings i/o

settings should have a save option so that on relaunching they are remembered

moniker can be discouraging

as much as love the dynamic name generation, this feels a bit too much:

Clean dependencies

I think we don't need the walk dependency in package.json ...
There might be others to remove too.

single-platform case unnecessary

i think when we are generating for a single platform (the one that this PG was packaged with for download) then the "platform" field might be unnecessary.

right now, for me it shows "Unknown" but maybe that has something to do with it not being initialized by default anywhere.

(i'm going to post a couple other things i noticed rather than compiling it in one issue/thread)

we should have show when an operation is completed

most tasks are immediate, but even seeing a visual done message (as the current gui simple) is pretty nice.

ui bugs at the moment(?)

i'd like to contribute but i'm not really sure where this is right now. here's the experience i'm getting:

• after a fresh download of the git repo, after npm start the first thing i see is "no addons were found in /User/addons". but i would expect it to use ../../addons or similar on first startup.
• i go to settings and change the OF root manually
• i go to create/update and open a project with no addons. the addons field still says "No addons found, is OF path right?" even though i updated it already.
• i switch to an example with an addon: example-simplePoints inside ofxDelaunay. now the addons field updates to show the addon.
• i click "update project" but it gives me an error: "please select a platform first". it just says "Unknown" and i can't change it.
• i go to settings and turn on advanced settings.
• i come back and select "OS X" and hit "Update Project"
• i get an error:

Command failed: /bin/sh -c /Users/kyle/Documents/openFrameworks/pgElectron/app/commandLinePG  -o"/Users/kyle/Documents/openFrameworks" -a"ofxDelaunay" -x"osx" "/Users/kyle/Documents/openFrameworks/addons/ofxDelaunay/example-simplePoints"
/bin/sh: /Users/kyle/Documents/openFrameworks/pgElectron/app/commandLinePG: Permission denied

• i open terminal and cd to pgElectron/app/ and chmod +x commandLinePG
• i do it again and it says "success". but when i look at the directory, there is no project file. from the i don't see any error messages in terminal.

Windows 10: can't select platform

First of all: This project generator looks amazing! I really like the project name generator (very meta).

Running on Windows 10, testing the binary release from the Windows dropbox link (https://www.dropbox.com/s/2s6n08fywb8es9z/projectGenerator.zip?dl=0), however, I was not able to generate a project, for the "Platforms" dropdown stays greyed out, not letting me select a platform. Maybe it's something to do with the platform detection?

icon

we need a dope icon

browse + cancel = error

also: set OF path + cancel = error and set update location + cancel = error

looks like we need to handle this condition...

Using path in index.js causes error

Using path in index.js (server side) causes an error.., sometimes yes, sometimes not.

In this case it happens when re-generating a moniker name (which uses path)

Uncaught Exception:
TypeError: Cannot read property 'join' of undefined
    at EventEmitter.<anonymous> (/Developer/openFrameworks/projectGenerator-darwin-x64/projectGenerator.app/Contents/Resources/app/index.js:374:25)

I tried caching it like tmpPath = require('path'); but same issue, it sometimes crashes with the same error.
Btw, it happens mostly when the Gui switched to (single) update mode but I can't figure out what's causing the problem.

design / selected color isn't clear

here, in one case grey = selected, while in another case, white = selected. needs maybe some consistency?

drag and drop

useful ?
https://github.com/atom/electron/blob/master/docs/api/file-object.md

win32 error

sorry to post here if this is not ready yet,i'm just curious to see the new pg.so i did packed as win32 app,somehow it didn't work,am i missing something?
cheers

top bar drag

to fix the top bar drag issue that @kylemcdonald mentioned in feedback I suggest creating a top bar above the menu and making both these things fixed. the top bar would be draggable but the menu would not be.

I've tried styling this with different colors, but the best thing I've seen it to actually use a small image sliver... I'm not sure if this is too distracting -- including a few refs as examples.....

localization

this seems like the perfect chance to separate our strings out :)

this is the kind of thing that might make sense to roll this ourselves instead of trying to use a library.

one way to do it would be to remove all the text from the HTML, and have a js object like this:

var strings = {
    "#platform": {
        "en": "Platform",
        "jp": "プラットフォーム"
    },
    ".addons": {
        "en": "Addons"
    },
};

where, if a language is not available it defaults to english. then in settings there would be a dropdown based on the available keys.

advanced mode toggle

we need an advanced mode in settings for allowing for platform selection and for doing the batch updating (which we should not let beginners do...)

add verbose toggle

verbose with the command line tool is really helpful we should expose this in the gui.

addons list include non addon folders (like obj from makefile system).

paths should be relative if inside of the OF directory

this could be a setting in the settings.json, but we should convert any path inside the root of the OF location to relative to the root of OF. ie, if it's testApp in OF/apps/myApps the path should be

 apps/myApps

not absolute as it is now. this should be be possible with:

https://nodejs.org/api/path.html#path_path_relative_from_to

we could have a setting in settings.json if folks want to work with fixed paths.

If it's outside of the OF directory, I think it's better to use absolute paths (and even if we can, post a warning that the project is created relatively to OF location)

javascript error

does this work on 0.8.4? i get this when i start up, and then the platform selector is unavailable. guessing it's missing some file that's in 0.9 RC

open project causes error

for me the open project button gives a white screen and some errors

[1722:0831/124444:INFO:CONSOLE(15)] "Popup:", source: file:///Users/zachlieberman/Desktop/pgElectron/js/semantic.min.js (15)
[1722:0831/124444:INFO:CONSOLE(2)] "Uncaught TypeError: Cannot read property 'replace' of undefined", source: file:///Users/zachlieberman/Desktop/pgElectron/js/jquery.min.js (2)
[1722:0831/124444:WARNING:ipc_message_attachment_set.cc(37)] MessageAttachmentSet destroyed with unconsumed descriptors: 0/1

will dig into this a bit. (and move this to the dialog after the generate or update action has completed)

GUI falsely reporting missing addons for update without project files

Just noticed this...I went to create project files from one of the examples. The gui reports that I'm missing addons (ofxNetwork, parsed from addons.make) though this addon does exist in the addons folder. Creating the project worked fine (and the project compiles & runs). Once the project files are created and you "re-import" this folder (technically this happens automatically when you hit the "update" button), the error goes away. Looks like it's related to being in update mode and not being able to find existing project files.

How to handle missing addons ?

@kylemcdonald mentions 2 behaviours for handling the missing addons:

• is this an error, and it will not generate a project file? (probably the best behavior)
• is this a warning, and it automatically removes those addons? (dangerous)

Maybe the best thing to do is to put the missing addons back in the addons.make while generating the project anyways with the available addons ?

But.... does it make sense to generate it anyways, event if you don't have the needed addon ?
What is the OF philosophy behind this? Allow and learn from your errors I guess; so don't restrict the user ?

What if an addon vanishes from the internet? There should always be an option to remove a missing addon.

we should capture the output of the command line tool and allow people to see it somehow

ala,
http://stackoverflow.com/questions/12941083/get-the-output-of-a-shell-command-in-node-js

use clearer / less nerdy names for platforms?

right now: osx, win_cb, vs, ios, linux, linux64, linuxarmv6l, linuxarmv7l

perhaps: OS X (Xcode), iOS (Xcode), Windows (Visual Studio 2015), Linux 32-bit (Code::Blocks), Linux 64-bit (Code::Blocks), Linux ARMv6 (Makefiles), Linux ARMv7 (Makefiles)

instead of OS (Build system) we could also do Build system (OS)

No addons found

When the "no addons found" message has been shown in the addons multiselect; it doesn't disappear when it's updated until next launch. (the message disappears at least 1 addon is selected, and comes back when it's none are selected)

window height should be smaller

i suggest the default height is based on the "Create / Update" tab in "simple" mode. if it gets bigger with lots of addons, it's still possible to scroll.

app name is still "Electron"

this appears in command+tab, and in the menubar at the top left.

this might just be because i was running the app from npm start though? when i run npm run build i get errors. it's off topic, but here it is anyway :)

kyle:pgElectron kyle$ npm run build

> [email protected] build /Users/kyle/Documents/openFrameworks/pgElectron
> electron-packager . $npm_package_productName --out=dist --ignore=['dist','readme.md'] --prune --all --version=0.30.0 --icon=icon.ico

Packaging app for platform linux ia32 using electron v0.30.0
Command failed: /bin/sh -c npm prune --production
npm ERR! Darwin 14.4.0
npm ERR! argv "node" "/usr/local/bin/npm" "prune" "--production"
npm ERR! node v0.12.4
npm ERR! npm  v2.10.1
npm ERR! path /private/var/folders/18/0s6nty6s7x3c8b5x57fp4czw0000gn/T/electron-packager/linux-ia32/pgElectron-linux-ia32/resources/app/package.json
npm ERR! code ENOENT
npm ERR! errno -2

npm ERR! enoent ENOENT, open '/private/var/folders/18/0s6nty6s7x3c8b5x57fp4czw0000gn/T/electron-packager/linux-ia32/pgElectron-linux-ia32/resources/app/package.json'
npm ERR! enoent This is most likely not a problem with npm itself
npm ERR! enoent and is related to npm not being able to find a file.
npm ERR! enoent 

npm ERR! Please include the following file with any support request:
npm ERR!     /private/var/folders/18/0s6nty6s7x3c8b5x57fp4czw0000gn/T/electron-packager/linux-ia32/pgElectron-linux-ia32/resources/app/npm-debug.log


npm ERR! Darwin 14.4.0
npm ERR! argv "node" "/usr/local/bin/npm" "run" "build"
npm ERR! node v0.12.4
npm ERR! npm  v2.10.1
npm ERR! code ELIFECYCLE
npm ERR! [email protected] build: `electron-packager . $npm_package_productName --out=dist --ignore=['dist','readme.md'] --prune --all --version=0.30.0 --icon=icon.ico`
npm ERR! Exit status 1
npm ERR! 
npm ERR! Failed at the [email protected] build script 'electron-packager . $npm_package_productName --out=dist --ignore=['dist','readme.md'] --prune --all --version=0.30.0 --icon=icon.ico'.
npm ERR! This is most likely a problem with the pgelectron package,
npm ERR! not with npm itself.
npm ERR! Tell the author that this fails on your system:
npm ERR!     electron-packager . $npm_package_productName --out=dist --ignore=['dist','readme.md'] --prune --all --version=0.30.0 --icon=icon.ico
npm ERR! You can get their info via:
npm ERR!     npm owner ls pgelectron
npm ERR! There is likely additional logging output above.

npm ERR! Please include the following file with any support request:
npm ERR!     /Users/kyle/Documents/openFrameworks/pgElectron/npm-debug.log