Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

can you include your favorite debugging workflow #3

Closed
born2net opened this issue Feb 6, 2016 · 65 comments
Closed

can you include your favorite debugging workflow #3

born2net opened this issue Feb 6, 2016 · 65 comments

Comments

@born2net
Copy link

born2net commented Feb 6, 2016

It would be awesome if you include your favorite workflow as far as debugging, do you use live sever or express? which arguments do you use... with gulp? or do you use ts watch or others?

tx as always

seen

@rubyboy
Copy link
Contributor

rubyboy commented Feb 6, 2016

I usually use live-server with both my IDE (currently using Atom) and Chrome open on the same screen, side-by-side. I'm running a terminal session inside the IDE. The Chrome Developer Tools is pretty awesome with debugging and with the help of Source Maps you can break in the TypeScript code. The Redux dev tools helps as well. The only thing I'm missing is hot reloading without losing state (and just the file that changed), but I haven't got that set up just yet.

With JSPM (which I absolutely love!) you don't really need a watcher because it uses the TypeScript loader on the fly, so you get the best of all worlds, with just a simple live-server and no need to recompile before serving again. I do use Gulp for running the build (testing, linting, and bundling the final distribution). I also use Gulp to run a little script that takes care of typings for me (using the "typings" project). You can find the Gulp scripts under "tasks" folder.
For tests I do a similar thing by running the "npm test" on a terminal on the side of my IDE and writing/fixing tests while it's reloading it.

Here's an example of how it looks like when testing the app in a browser:
debugging

@born2net
Copy link
Author

born2net commented Feb 6, 2016

as always right on the money... I am intrigued.. I use gulp for for my live-reload, which I am not a fan of, since sometimes you always get extra reloads... I just moved to JSPM from Webpack (becuase of your project) and I am very impressed with it... can you share more info on JSPM, does it have a watch? or you just run it by hand to recompile each time?

here is my gulp

gulp.task('x_server_systemjs', ['x_ts-compile', 'x_watch2'], function () {
    process.stdout.write('Starting browserSync and superstatic...\n');
    browserSync({
        port: 8003,
        open: false,
        files: ['index.html', '**/*.js'],
        injectChanges: true,
        logFileChanges: true,
        logLevel: 'info',
        logSnippet: true,
        logPrefix: 'log:',
        notify: true,
        reloadDebounce: 4000,
        server: {
            baseDir: './',
            directory: true,
            middleware: superstatic({debug: false})
        }
    });
    opn('http://localhost:8003/src/public/index_sys.html')
});

but sounds I could do better with JSPM?
tx again

Sean

@born2net
Copy link
Author

born2net commented Feb 6, 2016

I watch your awesome gif again, but didnt see how you executed JSPM to watch...
By the way, I am using Webstorm...

@rubyboy
Copy link
Contributor

rubyboy commented Feb 6, 2016

JSPM works in a different way. It uses SystemJS when loading its files, thus being able to convert them on the fly. It support loading various module formats (ES6, AMD, CJS, you name it!), then running it through plug-ing (what you would call "loader" in the Webpack world) and only then loading it in the browser.
So, that means there is no "js" file being generated on the server. It's all happening on the client.

Notice the network tab when the app loads:
image
It only loads the "ts" files. Then, it generates the "js" ones and you can find both in the "sources" tab:
image

So, no watcher aside from "live-server" that watchers the vanilla files and kicks of a browser reload when files change. The transpilation is happening in the browser.
Now, this is only relevant for development environment. In prod, you would definitely want to run the transpiled code. Look at the "dist" gulp task, or just run it on the example project ("npm run dist"). Comment out the "lint" bit if it's complaining about code formatting :) . Then, run "live-server" and go to http://localhost:8080/dist . This will be the end user experience on prod - loading just "js" as a single minified file.

A lot of it was inspired by Glen Maddern's awesome awesome presentation Javascript in 2015 .
The creator of JSPM is Guy Bedford and he is amazing! You can watch an old talk he gave here: Package Management for ES6 Modules

@born2net
Copy link
Author

born2net commented Feb 6, 2016

I understand, will have to play with it ASAP... tx again...

@rubyboy
Copy link
Contributor

rubyboy commented Feb 6, 2016

No worries. Feel free to ask any JSPM related questions. I've used it extensively when getting the architecture ready for our company's modern projects and know it quite well by now.
BTW, another huge benefit that you get with JSPM is the whole dependency management. It knows what depends on what and makes versioning management really easy.
You can see here - https://github.com/InfomediaLtd/angular2-tutorial - some more examples of using JSPM with some different dependencies than this one.

@born2net
Copy link
Author

born2net commented Feb 6, 2016

ya read about it... love it!

@rubyboy
Copy link
Contributor

rubyboy commented Feb 6, 2016

You're missing the application config and loading any dependencies. Check out this minimal config for Angular 2: https://github.com/InfomediaLtd/angular2-tutorial/tree/master/1-getting-started

Basically, do a "jspm init" in a folder and you should be golden from there.

Here's a guide I've written, part of the tutorial series that the angular2-tutorial code accompanies, that will help you get started: 01 Getting Started with Angular 2.pdf

@born2net
Copy link
Author

born2net commented Feb 6, 2016

SWEET... will read it all.. ya I did add

System.config({
    baseURL: "/",
    defaultJSExtensions: true,
    transpiler: "typescript",
    typescriptOptions: {
        "module": "commonjs",
        "emitDecoratorMetadata": true
    },
    packages: {
        "app": {
            "main": "main",
            "defaultExtension": "ts"
        },
        "studioEnterprise": {
            "main": "src/App.ts",
            "defaultExtension": "ts"
        }
    },

playing with it some more..

@born2net
Copy link
Author

born2net commented Feb 6, 2016

got it!!!!
TX again!!!! working... now I can't sleep, too excited... nerd I know

@rubyboy
Copy link
Contributor

rubyboy commented Feb 6, 2016

There's just two small things to fix and then you're good to go.

In your index.html change the import to be "src":

    System.import('src')

In your config.js update the package config:

  packages: {
    "src": {
      "main": "App",

@born2net
Copy link
Author

born2net commented Feb 6, 2016

exactly...

packages: {
    "src": {
      "main": "App",

u guru ;)

@born2net
Copy link
Author

born2net commented Feb 6, 2016

if u ever come down to Los Angeles, dinner is on me!!!

@rubyboy
Copy link
Contributor

rubyboy commented Feb 6, 2016

My pleasure. If you ever come to Israel, likewise :)

@born2net
Copy link
Author

born2net commented Feb 6, 2016

how did you know it was "src:" as many different examples online had app and other variations.. does that need to match the directory ...

are you serious? I am Israeli, Ma kore.. I come to Israel every couple of years...

@born2net
Copy link
Author

born2net commented Feb 6, 2016

so next summer I will be in Israel, will get together, I stay at Ramat aviv... ok Holech lishon... Toda al hakol... appreciate it! FYI I own digitalsignage.com, so maybe we can talk about some work options.. if you have time, we can talk soon on the phone... Yalla bye!

@rubyboy
Copy link
Contributor

rubyboy commented Feb 6, 2016

Small world.
I'm currently in Ness Ziona. Lived in Sydney for 7 years and moved back to Israel with the family a few months ago. BTW, I assume you can find my Twitter handle (same as username here) so it may be easier to chat over there. Or email (rubyboy@gmail.com) :)

Laila Tov!

@born2net
Copy link
Author

born2net commented Feb 6, 2016

will do :)

@born2net
Copy link
Author

born2net commented Feb 6, 2016

Boker tov,
I was wondering why you like the gulp minifier better over the built in minifier in JSPM

jspm bundle moduleA + module/b [outfile] [--minify]

tx

Sean

@born2net
Copy link
Author

born2net commented Feb 6, 2016

nvm, when I minified with the built in one, nothing loaded :)
tx

@rubyboy
Copy link
Contributor

rubyboy commented Feb 6, 2016

If I remember correctly the reason I did that was a bug in Angular 2 (at least until beta-2) where it wasn't loading properly if you also minified variable/function/argument names. Notice that the Gulp task has "mangle:false" for the uglify task. I had to do that, even though it means less minified code, to get it working. It was working prior to the beta's (alpha 4x), so I assume it's just a matter of waiting for an angular-2 version with this fixed.

@born2net
Copy link
Author

born2net commented Feb 6, 2016

got it, ya I remember seeing a bug on that, cool tx.

@born2net
Copy link
Author

born2net commented Feb 6, 2016

for me in order for eveyrthing to work, I have to include:
<script src="https://code.angularjs.org/2.0.0-beta.1/angular2-polyfills.js"></script>
but in your code it works with it.. any idea why? just wondering...

@born2net
Copy link
Author

born2net commented Feb 7, 2016

hopefully they release new ts paths feature microsoft/TypeScript#5039

@rubyboy
Copy link
Contributor

rubyboy commented Feb 7, 2016

The two main things that you need from the polyfills are reflect-metadata and zone.js . You did import reflect-metadata in your app.ts, but you need to also install and import zone.js.

Install it with (I used a specific version so it's compatible with the one that the specific Angular2 version is using):

jspm install zone.js@0.5.10

Then, in your app.ts add:

import "zone.js/dist/zone.min.js";

Now, you can get rid of the script line in index.html (which I don't like because it has a specific version in it and needs maintaining) and Angular2 can properly detect that the service call has completed and trigger its component refresh :)

Yeah, I'm waiting for that TS feature as well. I'm still not sure if it makes it into 1.8 or 2.0. I've written a whole workaround guide for our developers to provide typings intellisense until the TS project fixes it. You can have a look: Dependency Typings.pdf

@born2net
Copy link
Author

born2net commented Feb 7, 2016

this is great, do you have links to all your pdfs? love the ones you shared so far

@rubyboy
Copy link
Contributor

rubyboy commented Feb 7, 2016

Send me your email and I'll send them through. I need to figure out a way to convert them from Confluence to public friendly format. The images may be a problem - some are screen grabs from a presentation I liked, so it's good for sharing internally but not for using publicly.

@born2net
Copy link
Author

born2net commented Feb 7, 2016

I like how you passed the function to the child component, smart...

@born2net
Copy link
Author

born2net commented Feb 7, 2016

...            <tr *ngFor="#item of list">           
       <td *ngIf="!content" (click)="select.emit(item)">{{item}}</td>           
       <td *ngIf="content" (click)="select.emit(item)">{{content(item)}}</td> ..

@born2net
Copy link
Author

born2net commented Feb 7, 2016

good reading so far, in ch-3


  "jspm": {
    "dependencies": {
      "angular2": "npm:angular2@^2.0.0-beta.2",
      "angular2-simple-list": "github:InfomediaLtd/angular2-simple-list@master",

why does jspm need to update the package.json, isnt' config.js enough for it?
when you run jspm install, wouldn't it only look only at config.js? so what's the reason for updating package.json... reason I'd like to understand, if I add new packages in the future, I need to maintain updates to both config,js and package.json? (might be good to update in book as well)

@rubyboy
Copy link
Contributor

rubyboy commented Feb 8, 2016

Does it happen to you also in the angular2-tutorial project inside the 7-redux step?

I did notice something funky with the export of this module. I think you had trouble with importing it and had to change the way it was imported. Later on I had the same issue in the angular2-redux project...

@rubyboy
Copy link
Contributor

rubyboy commented Feb 8, 2016

In that project (7-redux) run "npm run typings" to get the typings to be created.

@born2net
Copy link
Author

born2net commented Feb 8, 2016

it was in my own project, it's ok I will play with it some more... tx

@born2net
Copy link
Author

born2net commented Feb 8, 2016

any tips on this issue I have: jspm/jspm-cli#1504

@rubyboy
Copy link
Contributor

rubyboy commented Feb 9, 2016

Not sure what you're trying to do there. Are you trying to bundle just part of your application? Is that for a purpose for building several bundles to be loaded lazily or for creating libraries?

Does regular self executing bundle work for you?

jspm bundle-sfx src/app out.js --skip-source-maps

(and then just import "out.js" in a top folder index.html)

Also - side note - wouldn't you want to bundle the "ts" itself and not the "js"? Not that this wouldn't change the result, but I was wondering why you would want to go down to the "js" in bundling. JSPM should produce the js from the source ts anyway...

@born2net
Copy link
Author

born2net commented Feb 9, 2016

yes I was trying to lazy load Modules... but so far no luck if I do a multi bundle config with jspm.
It works fine if I don't bundle, but of course it just loads from dir directly as in:

static LoadComponentAsync(name:string, path:string) {

        return System.import(path).then(c => c[name]);
        ...

I will play with it some more tx...

@born2net
Copy link
Author

Hi again,
How did you get TS compiler to not complain about:

import style from "./user-view.css!text"
@Component({
selector: 'user',
styles: [style],

as I get:
Error:(14, 19) TS2307: Cannot find module './user-view.css!text'.
Error:(20, 5) TS2345: Argument of type '{ selector: string; directives: (typeof ModalDialog | Type[])[]; templateUrl: string; style: any[...' is not assignable to parameter of type '{ selector?: string; inputs?: string[]; outputs?: string[]; properties?: string[]; events?: strin...'.
Object literal may only specify known properties, and 'style' does not exist in type '{ selector?: string; inputs?: string[]; outputs?: string[]; properties?: string[]; events?: strin...'.

regards,
Sean

@rubyboy
Copy link
Contributor

rubyboy commented Feb 14, 2016

I didn't. I use JSPM's TypeScript plugin, which goes around this problem by adding its own module resolution: microsoft/TypeScript#4595

Why do you need it to not complain? Are you using TSC outside of JSPM for some reason?
There's a good discussion about this problem here: microsoft/TypeScript#2709
The feature to support this in TSC is here (expected in 2.0, I think): microsoft/TypeScript#6615

@born2net
Copy link
Author

ya I am using webstorm, no worries tx

@rubyboy
Copy link
Contributor

rubyboy commented Feb 14, 2016

Oh, right. Yeah, I've got a little dotted red line in Atom as well :)

BTW, I'm a huge fan of IntelliJ, but I've abandoned it a couple of months ago in favour of Atom (for web development only) because I got annoyed by its constant reindexing and slowdown when running "npm install"/"jspm install". Did you work around this somehow or do you just accept it? I still believe it's the best IDE around for productivity, but I just couldn't bear with the lags and constant freezing...

@born2net
Copy link
Author

ha yes, just right click on the folde, select from the context menu "mark directory as" and set as excluded. Do that for node_modules, jspm and dist and it will never reindex all this stuff.
also be sure to .gitignore in the root of the project as:

src/**/*.map
src/**/*.js
src/*.js
src/*.map
/src/*.js
/src/*.map

and everything will work great!!!
I love the latest Webstorm early release, has all the Angular2 goodnes

@rubyboy
Copy link
Contributor

rubyboy commented Feb 14, 2016

Nice! I'll give that a try. Might just reignite my love for IntelliJ again :)

@born2net
Copy link
Author

cool, not sure if intellij has the latest ng2 intellisence... maybe try webstorm beta, its free while beta

@rubyboy
Copy link
Contributor

rubyboy commented Feb 14, 2016

Do you have the TypeScript compiler enabled or do you just use the JavaScript language settings on 6/7 and let it resolve that automatically without TS compilation?
image

I think the two are the same, aren't they? They following similar EAP releases. Do you have an example of ng2 intellisense feature of Webstorm that I can try it on my IntelliJ?

BTW, I quite liked Atom's experience - it's fast and the UI is nice and clean...

@born2net
Copy link
Author

will share my ui asap, check this https://youtu.be/RQSRKi3VZ3I

@born2net
Copy link
Author

here you go:

aaa

@born2net
Copy link
Author

so basically webstorm compiles so I can see the errors in the TS tab inside webstorm and of of course I also compile inside the browser tx to jspm, works awesome!

@born2net
Copy link
Author

I also recommend you checkout: https://github.com/born2net/ng2Boilerplate/blob/master/gulpfile.js
did some clever stuff like restarting local web server every 10min using forever for best performance and being able to run
gulp development --restart with flag so it does not launch a new browser every 10min
also found this config to be best for live server:

gulp.task('x_open_server_development', ['x_watch_source'], function () {
    process.stdout.write('Starting browserSync and superstatic...\n');
    browserSync({
        port: 8080,
        open: false,
        files: ['index.html', '**/*.ts'],
        notify: true,
        reloadDebounce: 400,
        server: {
            baseDir: './',
            directory: true
        }
    });
    opn('http://localhost:8080/src/public/index.html')
});

after a lot of trial and error...
hope that helps

@rubyboy
Copy link
Contributor

rubyboy commented Feb 14, 2016

Good stuff in there!! I'll definitely dig in and copy some of that to our own projects, if you don't mind :)
Thanks heaps.

@born2net
Copy link
Author

are kidding.. baroor... :)

@born2net
Copy link
Author

so did moving to Intelij worked out better?
I know you have a lot of experience with jspm, I am trying to load a global jquery lib but can't seem to get it to export the global

here: http://stackoverflow.com/questions/35422441/loading-jspm-bootbox-as-shim-global-member

any tips?

@rubyboy
Copy link
Contributor

rubyboy commented Feb 16, 2016

Still flip flopping between IntelliJ and Atom. Not sure I like configuring the exclusion per project - it's a bit annoying - but it may be just worth it for the awesome autocompletion. IntelliJ is by far the best IDE around, so I'm not giving up that easily :)

Couldn't find the page you've linked. Have you found a solution? I did something similar when loading MaterializeCSS in the angular2-materialize library: https://github.com/InfomediaLtd/angular2-materialize
You can add a shim to it when installing the dependency that needs it, like this:

jspm install materialize=github:Dogfalo/materialize -o "{'main': 'js/materialize','shim': {'js/materialize': {'deps': ['jquery','../css/materialize.css!'],'exports': '$'}},'dependencies': {'jquery': 'github:components/jquery','css': 'github:systemjs/plugin-css'}}"

@born2net
Copy link
Author

ha got it tx

@born2net
Copy link
Author

I improved a bit on your base class for Actions so I don't have to pass the store all the time, instead I inject it on the extending class..

export class Actions {

    private m_appStore:AppStore;

    constructor(i_appStore?:AppStore) {
        if (i_appStore)
            this.m_appStore = i_appStore;
    }

    public createDispatcher(action:(...n:any[])=>any, appStore?:AppStore):(...args)=>void {
        if (!appStore && !this.m_appStore)
            throw new Error('cant find AppStore for Actions base class');
        appStore = appStore || this.m_appStore;
        return (...n)=>appStore.dispatch(action.call(this, ...n))
    }
}

this way I can do manual dispatch/trigger in one short(er) command if need be:

    this.appdbAction.createDispatcher(this.appdbAction.authenticateUser)(i_user, i_pass);

@rubyboy
Copy link
Contributor

rubyboy commented Feb 17, 2016

Great idea!

Here's the final code to commit:

export class Actions {

    private appStore:AppStore = null;

    constructor(appStore?:AppStore) {
        if (appStore) this.appStore = appStore;
    }

    public createDispatcher(action:(...n:any[])=>any, appStore?:AppStore):(...n)=>void {
        if (!appStore && !this.appStore) throw new Error("Can't find AppStore for dispatching action");
        appStore = appStore || this.appStore;
        return (...n)=>appStore.dispatch(action.call(this, ...n))
    }

}

Would you like to create a pull request and I'll get that in? Happy to check the above in myself, but to be fair to you I think it should be on your name :)

@born2net
Copy link
Author

ha np,hosnstly I never did a PR, not sure on the process through webstom, no worries glad to help you back for all your support...

@rubyboy
Copy link
Contributor

rubyboy commented Feb 17, 2016

No worries. Will do.
Let's agree that next time you come up with a cool improvement I'll help you out with creating your first PR?

I recommend this free course on Egghead explaining the basics of Github and PR's: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
Also, even a better one, about creating an open source library: https://egghead.io/series/how-to-write-an-open-source-javascript-library

Both are by the awesome @kentcdodds

@born2net
Copy link
Author

sweet tx!

@kentcdodds
Copy link

Thanks for the shoutout @rubyboy! I hope this helps you @born2net! 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants