add docs & tests for editor. improve editor open perf

Author: ShMcK

lib/modules/alert/index.js

@@ -1,6 +1,6 @@
 "use strict";
 var types_1 = require('./types');
-var colors = {
+exports.colors = {
     PASS: '#73C990',
     FAIL: '#FF4081',
     NOTE: '#9DA5B4',
@@ -10,7 +10,7 @@ exports._alert = {
     open: false,
     action: 'NOTE',
     duration: 1500,
-    color: colors.NOTE
+    color: exports.colors.NOTE
 };
 var open = {
     open: true,
@@ -19,7 +19,7 @@ var open = {
 };
 var current = exports._alert;
 function setAlert(a) {
-    a.color = colors[a.action] || colors.NOTE;
+    a.color = exports.colors[a.action] || exports.colors.NOTE;
     var statusBarAlert = document.getElementsByClassName('cr-alert-replay')[0];
     statusBarAlert.style.color = a.color;
     current = a;

lib/modules/editor/actions/file.js

@@ -11,9 +11,8 @@ exports.save = save;
 function open(file, options) {
     if (options === void 0) { options = {}; }
     return new Promise(function (resolve, reject) {
-        var openTimeout = 300;
         atom.workspace.open(file, options);
-        setTimeout(function () { return resolve(); }, openTimeout);
+        atom.workspace.onDidOpen(function () { return resolve(); });
     });
 }
 exports.open = open;

lib/modules/editor/actions/writeFile.js

@@ -5,7 +5,7 @@ var path_1 = require('path');
 function writeFileFromContent(_a) {
     var to = _a.to, content = _a.content, dir = _a.dir;
     var toAbs = path_1.join(dir, to);
-    createFolders({ dir: dir, to: to }).then(function () {
+    createFolder({ dir: dir, to: to }).then(function () {
         fs_1.writeFile(toAbs, content, function (writeErr) {
             if (writeErr) {
                 console.log("Error: tried but failed to write to " + toAbs + " with: " + content, writeErr);
@@ -19,7 +19,7 @@ function writeFileFromFile(_a) {
     var to = _a.to, from = _a.from, dir = _a.dir, tutorialDir = _a.tutorialDir;
     var toAbs = path_1.join(dir, to);
     var fromAbs = path_1.join(tutorialDir, from);
-    createFolders({ dir: dir, to: to }).then(function () {
+    createFolder({ dir: dir, to: to }).then(function () {
         fs_1.readFile(fromAbs, 'utf8', function (readErr, data) {
             var err = "Error: tried to write '" + fromAbs + "' to '" + toAbs + "' but failed.";
             if (readErr) {
@@ -35,7 +35,7 @@ function writeFileFromFile(_a) {
     });
 }
 exports.writeFileFromFile = writeFileFromFile;
-function createFolders(_a) {
+function createFolder(_a) {
     var dir = _a.dir, to = _a.to;
     return new Promise(function (resolve, reject) {
         var folders = to.split('/').slice(0, -1);

src/modules/dir/reducer.test.ts

@@ -1,3 +1,6 @@
+/// <reference path="../../typings/globals/jest/index.d.ts" />
+/// <reference path="../../typings/common/global.d.ts" />
+
 import dir from './index';
 import {atomPath} from '../../__tests__/mocks/atom';
 
@@ -10,11 +13,11 @@ describe('dir reducer', () => {
   it('should return the project directory in Atom', () => {
     const pathToDir = './path/to/dir'; 
     global.atom = atomPath(pathToDir);
-    expect(dir()).toBe(pathToDir);
+    expect(dir('')).toBe(pathToDir);
   });
 
   it('should throw an error if no project directory is found', () => {
-    expect(() => dir()).toThrowError(/No project directory/);
+    expect(() => dir('')).toThrowError(/No project directory/);
   });
 
 });

src/modules/editor/Save/index.tsx

@@ -1,11 +1,23 @@
+/**
+ * Toggle atom devtools console
+ * @returns void
+ */
 export function toggleDevTools(): void {
   atom.toggleDevTools();
 }
 
+/**
+ * Clear atom devtools console
+ * @returns void
+ */
 export function clearConsole(): void {
   atom.executeJavaScriptInDevTools(console.clear());
 }
 
+/**
+ * Open atom devtools
+ * @returns void
+ */
 export function openDevTools(): void {
   atom.openDevTools();
 }

src/modules/editor/ToggleDevTools/index.tsx

@@ -1,3 +1,7 @@
+/**
+ * Get the current active atom editor
+ * @returns Promise
+ */
 export function getEditor(): Promise<AtomCore.IEditor> {
   return new Promise((resolve, reject) => {
     const editor = atom.workspace.getActiveTextEditor();

src/modules/editor/actions/console.ts

@@ -3,28 +3,44 @@ import {unlink} from 'fs';
 import {getEditor} from './editor';
 import fileExists from 'node-file-exists';
 
+/**
+ * Open a new folder in atom
+ * @returns void
+ */
 export function openFolder(): void {
   atom.open();
 }
 
-export function save() {
+/**
+ * Saves the current editor
+ * @returns void
+ */
+export function save(): void {
   getEditor().then(editor => editor.save());
 }
 
+/**
+ * Opens a file
+ * https://atom.io/docs/api/v1.10.2/Workspace#instance-open
+ * @param  {string} file file name
+ * @param  {} options={} file open options
+ * @returns Promise
+ */
 export function open(file: string, options = {}): Promise<any> {
   return new Promise((resolve, reject) => {
-    // delete file first, to avoid bug
-    // if (fileExists(file)) {
-    //   unlink(file);
-    // }
-    // delay necessary since opening a file is slow
-    const openTimeout = 300;
     atom.workspace.open(file, options);
-    setTimeout(() => resolve(), openTimeout);
+    // resolve when file opens
+    // https://atom.io/docs/api/v1.10.2/Workspace#instance-onDidOpen
+    atom.workspace.onDidOpen(() => resolve());
   });
 }
 
-export function scroll(content: string): Promise<void> {
+/**
+ * Scroll to cursor position
+ * @param  {string} content text editor content
+ * @returns Promise
+ */
+export function scroll(content: string): any {
   return getEditor().then((editor: AtomCore.IEditor) => {
     const regex = new RegExp(
       content.replace(/[\\\.\+\*\?\^\$\[\]\(\)\{\}\/\'\#\:\!\=\|]/ig, '\\$&'), 'gm'

src/modules/editor/actions/editor.ts

@@ -1,3 +1,7 @@
+/**
+ * close all other tabs
+ * @returns void
+ */
 export function closeAllPanels(): void {
   let editors: AtomCore.IEditor[] = atom.workspace.getTextEditors();
   editors.forEach((editor: AtomCore.IEditor) => {

src/modules/editor/actions/file.ts

@@ -1,6 +1,13 @@
 import {getEditor} from './editor';
 
-function write(action: 'set' | 'insert', text: string, options = {}) {
+/**
+ * add text to the active editor
+ * @param  {'set'|'insert'} action
+ * @param  {string} text
+ * @param  {} options={}
+ * @result Promise
+ */
+function write(action: 'set' | 'insert', text: string, options = {}): Promise<any> {
   return getEditor().then((editor: AtomCore.IEditor) => {
     editor.moveToBottom();
     editor[`${action}Text`](text, options);
@@ -11,16 +18,31 @@ function write(action: 'set' | 'insert', text: string, options = {}) {
   });
 }
 
-// Set text, removes any previous content in file
+/**
+ * set text
+ * https://atom.io/docs/api/v1.10.2/TextEditor#instance-setText
+ * @param  {string} text
+ */
 export function set(text: string) {
   return write('set', text);
 }
 
+/**
+ * insert text
+ * https://atom.io/docs/api/v1.10.2/TextEditor#instance-insertText
+ * @param  {string} text
+ * @param  {} options={}
+ */
 export function insert(text: string, options = {}) {
   return write('insert', text, options);
 }
 
 const cursor: RegExp = /::>/g;
+
+/**
+ * replace ::> with cursor position
+ * @param  {AtomCore.IEditor} editor
+ */
 function setCursorPosition(editor: AtomCore.IEditor) {
   return editor.scan(cursor, (scanned) => {
     editor.setCursorScreenPosition(scanned.range.start);

src/modules/editor/actions/tabs.ts

@@ -2,9 +2,15 @@ import { mkdirSync, readFile, writeFile } from 'fs';
 import fileExists from 'node-file-exists';
 import { join } from 'path';
 
-export function writeFileFromContent({to, content, dir}) {
+/**
+ * writes content to a user file
+ * @param  {} {to user file path
+ * @param  {} content text editor content
+ * @param  {} dir} user directory
+ */
+export function writeFileFromContent({to, content, dir}): void {
   const toAbs = join(dir, to);
-  createFolders({dir, to}).then(() => {
+  createFolder({dir, to}).then(() => {
     writeFile(toAbs, content, (writeErr) => {
       if (writeErr) {
         console.log(`Error: tried but failed to write to ${toAbs} with: ${content}`, writeErr);
@@ -14,11 +20,19 @@ export function writeFileFromContent({to, content, dir}) {
   });
 }
 
-export function writeFileFromFile({to, from, dir, tutorialDir}) {
+/**
+ * writes from a tutorial file to a user file
+ * @param  {} {to user file path
+ * @param  {} from tutorial file path
+ * @param  {} dir user directory
+ * @param  {} tutorialDir} tutorial directory
+ * @returns void
+ */
+export function writeFileFromFile({to, from, dir, tutorialDir}): void {
   const toAbs = join(dir, to);
   const fromAbs = join(tutorialDir, from);
 
-  createFolders({dir, to}).then(() => {
+  createFolder({dir, to}).then(() => {
     // writes { to: './dest.js', from: '' }
     readFile(fromAbs, 'utf8', (readErr, data) => {
       const err = `Error: tried to write '${fromAbs}' to '${toAbs}' but failed.`;
@@ -31,7 +45,12 @@ export function writeFileFromFile({to, from, dir, tutorialDir}) {
   });
 }
 
-function createFolders({dir, to}) {
+/**
+ * create user folder 
+ * @param  {} {dir user directory
+ * @param  {} to} user folder path
+ */
+function createFolder({dir, to}): Promise<any> {
   return new Promise((resolve, reject) => {
     // extract folders without final file name
     const folders = to.split('/').slice(0, -1);

src/modules/editor/actions/write.ts

@@ -0,0 +1,12 @@
+/// <reference path="../../typings/globals/jest/index.d.ts" />
+import reducer from './reducer';
+import * as types from './types';
+
+describe('editor reducer', () => {
+
+  it('does nothing if action types do not match', () => {
+    const action = { type: 'unknown' };
+    expect(reducer(undefined, action)).toBe('atom');
+  });
+
+});

src/modules/editor/actions/writeFile.ts

@@ -3,6 +3,12 @@ import {
 } from './types';
 import {insert, open, save, scroll, set, toggleDevTools, writeFileFromContent, writeFileFromFile} from './index';
 
+/**
+ * Editor Reducer triggers editor actions
+ * @param  {} editor='atom'
+ * @param  {Action} action 
+ * @returns string editor name
+ */
 export default function editor(
   editor = 'atom', action: Action
 ): string {