Replace old profiler with new one

[bryanbecker]

This change is probably controversial, so lets hear feedback.

I ripped out the old profiler, and added https://github.com/screepers/screeps-typescript-profiler

It's set up with everything it needs to work, but commented out by default, since the starter doesn't include anything profilable (only classes and class-methods can be profiled).

Also updated the readme to reflect the repo needs to be cloned with --recursive tag

[KarateSnoopy]

btw, I pulled this change into my fork at https://github.com/KarateSnoopy/screeps-typescript-starter/tree/profiler-merged

My changes:

1. fixed the minor conflict in main.ts

2. I also had to change the submodule in .gitmodules to point to https://github.com/screepers/screeps-typescript-profiler.git so I could use "git submodule update --init"

3. I also updated the readme, since you should note that submodules aren't including in the .zip on github so you'll need to tell folks to clone --recursive or fetch run the git submodule update --init command.

4. For some reason, if I use the latest profiler submodule commit, I was getting an error in

[at-loader] ./src/lib/Profiler/Profiler/Profiler.ts:43:5
TS2322: Type '{ clear(): string; output(): string; start(): string; status(): "Profiler is running" | "Profiler...' is not assignable to type 'Profiler'.
Object literal may only specify known properties, and 'toString' does not exist in type 'Profiler'.

This pull request https://github.com/screepers/screeps-typescript-profiler/pull/1/files added this line.
Not sure why it errors for me.

5. Changed
   // global.P = Profiler.init();
   to
   // global.Profiler = Profiler.init();
   so the profiler readme's commands work without change.

6. But I'm having trouble using @profile. When I add that to creepManager's run function like so:

@profile
export function run(room: Room): void {
_loadCreeps(room);

Then I get this error which I can't figure out how to shake.

TS1206: Decorators are not valid here.

But I can get it working by doing it manually. For example:

function mainLoop() {
const start = Game.cpu.getUsed();
Main.go();
const end = Game.cpu.getUsed();
record("Main.go", end - start);
}

Any idea why @profile doesn't work? Thanks

[resir014]

@KarateSnoopy I haven't tried the typescript profiler, but I'm planning to migrate to it in my primary codebase. @bryanbecker seems to be inactive as of late, so I'll have to figure things out on my own atm. Will let you know if I find anything.

Regardless, his work on the new profiler looks promising. I'm considering merging this PR if I could get it to work on my primary codebase.

[resir014]

@KarateSnoopy Alright, I seem to have found what caused your issues.

• The reason why added toString - ingame help :) screeps-typescript-profiler#1 errors out is because that there's no associated typings to it. I've went and forked a version of the profiler with some tweaks and fixes here.
• Unfortunately the TypeScript profiler for now only works for classes and the methods inside them, since decorators only works on them. Until we have a working API to allow profiling pure functions, you might want to hold off for a bit. See my bug report on the profiler repo: Profiling pure functions screeps-typescript-profiler#3

As mentioned earlier, I've created a fork to attempt to fix many of the issues found in the profiler, so if you want, you can use that until the upstream is fixed.
https://github.com/resir014/screeps-typescript-profiler

[resir014]

Superseded with future plans of revamping the starter kit.