tiny changes, add DCO, clean up top-level

Author: Tim Etchells

.gitignore

@@ -5,3 +5,7 @@ node_modules/
 
 .DS_STORE
 .nyc_output
+
+todo.txt
+unused.txt
+*.code-workspace

DCO.txt

@@ -0,0 +1,37 @@
+Developer Certificate of Origin
+Version 1.1
+
+Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
+1 Letterman Drive
+Suite D4700
+San Francisco, CA, 94129
+
+Everyone is permitted to copy and distribute verbatim copies of this
+license document, but changing it is not allowed.
+
+
+Developer's Certificate of Origin 1.1
+
+       By making a contribution to this project, I certify that:
+
+       (a) The contribution was created in whole or in part by me and I
+           have the right to submit it under the open source license
+           indicated in the file; or
+
+       (b) The contribution is based upon previous work that, to the best
+           of my knowledge, is covered under an appropriate open source
+           license and I have the right under that license to submit that
+           work with modifications, whether created in whole or in part
+           by me, under the same open source license (unless I am
+           permitted to submit under a different license), as indicated
+           in the file; or
+
+       (c) The contribution was provided directly to me by some other
+           person who certified (a), (b) or (c) and I have not modified
+           it.
+
+       (d) I understand and agree that this project and the contribution
+           are public and that a record of the contribution (including all
+           personal information I submit with it, including my sign-off) is
+           maintained indefinitely and may be redistributed consistent with
+           this project or the open source license(s) involved.

README.md

@@ -28,4 +28,4 @@ For the README packaged with this extension, see [the extension README](https://
 - Toggle project auto-build
 - Easily scope your VSCode workspace to a Microclimate project or your `microclimate-workspace`
 - Manually initiate project builds
-- Disable, Enable, and Delete projects
+- Disable, Enable, and Delete projects

dev/src/Logger.ts

@@ -110,7 +110,7 @@ export class Log {
         const label = `[${level}: ${getDateTime()}${caller}]:`;
         const msg: string = `${label} ${argsStr}${os.EOL}`;
 
-        return new Promise<void>( (resolve, _) => {
+        return new Promise<void>( (resolve) => {
             // Send the message to both the 'console' and the logfile.
             const consoleFn = level === this.Levels.ERROR ? console.error : console.log;
             if (args.length > 0) {

dev/src/microclimate/connection/EventTypes.ts

@@ -1,6 +1,10 @@
 
 // non-nls-file
 
+/**
+ * Socket events we listen for from Microclimate Portal
+ * See MCSocket
+ */
 enum EventTypes {
     PROJECT_CHANGED = "projectChanged",
     PROJECT_STATUS_CHANGED = "projectStatusChanged",

dev/src/microclimate/connection/MCSocket.ts

@@ -12,6 +12,11 @@ import Translator from "../../constants/strings/translator";
 import ProjectState from "../project/ProjectState";
 import attachDebuggerCmd from "../../command/AttachDebuggerCmd";
 
+/**
+ * Receives and reacts to socket events from Portal
+ *
+ * Each Connection has exactly one socket
+ */
 export default class MCSocket {
 
     private static readonly STATUS_SUCCESS: string = "success";     // non-nls
@@ -155,6 +160,9 @@ export default class MCSocket {
                         Translator.t(StringNamespaces.DEFAULT, "restartDebugAttachFailure",
                         { startMode: StartModes.getUserFriendlyStartMode(startMode) })
                     );
+
+                    // restart is "done", and failed.
+                    return;
                 }
             }
             catch (err) {

dev/src/microclimate/project/ProjectState.ts

@@ -8,6 +8,11 @@ const KEY_CLOSED_STATE: string = "state";                   // non-nls
 const KEY_START_MODE:   string = "startMode";               // non-nls
 const KEY_BUILD_DETAIL: string = "detailedBuildStatus";     // non-nls
 
+/**
+ * Represents the project's state in Microclimate. This means app state, build state, and any status details.
+ *
+ * Immutable
+ */
 export class ProjectState {
     public readonly appState: ProjectState.AppStates;
     public readonly buildState: ProjectState.BuildStates;