init tutorial search logic, rely on node-file-exists

ShMcK · ShMcK · commit a8cb1d2a698b · 2016-06-01T09:51:59.000-07:00
diff --git a/lib/build/parser/import.js b/lib/build/parser/import.js
@@ -1,7 +1,7 @@
 "use strict";
 var fs_1 = require('fs');
 var path_1 = require('path');
-var file_1 = require('../../tools/file');
+var node_file_exists_1 = require('node-file-exists');
 var cleanup_1 = require('./cleanup');
 var settings_1 = require('./settings');
 function loadImport(lines, pathToMd) {
@@ -10,7 +10,7 @@ function loadImport(lines, pathToMd) {
         pathToMd = pathToMd.concat('.md');
     }
     var realPath = path_1.join(process.cwd(), settings_1.tutorialDir, pathToMd);
-    if (!file_1.fileExists(realPath)) {
+    if (!node_file_exists_1.default(realPath)) {
         console.log('Invalid path to markdown file', realPath);
         return;
     }
diff --git a/lib/build/readme.js b/lib/build/readme.js
@@ -1,15 +1,15 @@
 "use strict";
 var fs_1 = require('fs');
-var file_1 = require('../tools/file');
+var node_file_exists_1 = require('node-file-exists');
 var chalk_1 = require('chalk');
 function createReadme() {
-    if (!file_1.fileExists('./README.md')) {
+    if (!node_file_exists_1.default('./README.md')) {
     }
-    if (!file_1.fileExists('./coderoad.json')) {
+    if (!node_file_exists_1.default('./coderoad.json')) {
         console.log(chalk_1.red('No coderoad.json file found'));
         return false;
     }
-    if (!file_1.fileExists('./package.json')) {
+    if (!node_file_exists_1.default('./package.json')) {
         console.log(chalk_1.red('No package.json file found'));
         return false;
     }
diff --git a/lib/cli.js b/lib/cli.js
diff --git a/lib/create/write-demo.js b/lib/create/write-demo.js
@@ -2,16 +2,16 @@
 var fs_1 = require('fs');
 var path_1 = require('path');
 var sort_package_json_1 = require('sort-package-json');
-var file_1 = require('../tools/file');
+var node_file_exists_1 = require('node-file-exists');
 function createFile(pathToFile) {
-    if (!file_1.fileExists(pathToFile)) {
+    if (!node_file_exists_1.default(pathToFile)) {
         var inputPath = path_1.join(__dirname, '..', '..', 'setup', pathToFile);
         var test = fs_1.readFileSync(inputPath, 'utf8');
         fs_1.writeFileSync(pathToFile, test, 'utf8');
     }
 }
 function createFolder(pathToFolder) {
-    if (!file_1.fileExists(pathToFolder)) {
+    if (!node_file_exists_1.default(pathToFolder)) {
         fs_1.mkdirSync(pathToFolder);
     }
 }
@@ -40,7 +40,7 @@ function createTutorialMd() {
 exports.createTutorialMd = createTutorialMd;
 function createPackageJson(name) {
     return new Promise(function (resolve, reject) {
-        if (!file_1.fileExists('package.json')) {
+        if (!node_file_exists_1.default('package.json')) {
             var inputPath = path_1.join(__dirname, '..', '..', 'setup', 'package.json');
             var packageJson = JSON.parse(fs_1.readFileSync(inputPath, 'utf8'));
             packageJson.name = 'coderoad-' + name;
diff --git a/lib/tools/file.js b/lib/tools/file.js
diff --git a/lib/tutorials/find-tutorials.js b/lib/tutorials/find-tutorials.js
@@ -0,0 +1,33 @@
+"use strict";
+var path_1 = require('path');
+var fs_1 = require('fs');
+var node_file_exists_1 = require('node-file-exists');
+var is_tutorial_1 = require('./is-tutorial');
+var update_1 = require('./update');
+function searchForTutorials(dir, deps) {
+    if (!!deps && Object.keys(deps).length > 0) {
+        return (Object.keys(deps)
+            .filter(function (name) { return is_tutorial_1.isTutorial(dir, name); })
+            .map(function (name) {
+            var pathToTutorialPackageJson = path_1.join(dir, 'node_modules', name, 'package.json');
+            if (!node_file_exists_1.default(pathToTutorialPackageJson)) {
+                console.log("Error with " + name + ": no package.json file found. " + is_tutorial_1.tutorialError);
+                return {
+                    name: name,
+                    version: 'NOT INSTALLED'
+                };
+            }
+            var tutorialPackageJson = JSON.parse(fs_1.readFileSync(pathToTutorialPackageJson, 'utf8'));
+            var version = tutorialPackageJson.version;
+            return {
+                name: name,
+                version: version,
+                latest: !!update_1.canUpdateTutorial(name, version)
+            };
+        }));
+    }
+    else {
+        return [];
+    }
+}
+exports.searchForTutorials = searchForTutorials;
diff --git a/lib/tutorials/is-tutorial.js b/lib/tutorials/is-tutorial.js
@@ -0,0 +1,29 @@
+"use strict";
+var path_1 = require('path');
+var fs_1 = require('fs');
+var node_file_exists_1 = require('node-file-exists');
+exports.tutorialError = 'This is an error with the tutorial itself';
+function isTutorial(dir, name) {
+    var pathToTutorialPackageJson = path_1.join(dir, 'node_modules', name, 'package.json');
+    if (!node_file_exists_1.default(pathToTutorialPackageJson)) {
+        console.log("Error with " + name + ": no package.json file found. " + exports.tutorialError);
+        return false;
+    }
+    var packageJson = JSON.parse(fs_1.readFileSync(pathToTutorialPackageJson, 'utf8'));
+    if (!packageJson.main && packageJson.main.match(/coderoad.json$/)) {
+        console.log("Error with " + name + ": main does not load a coderoad.json file. " + exports.tutorialError);
+        return false;
+    }
+    var pathToCoderoadJson = path_1.join(dir, 'node_modules', name, packageJson.main);
+    if (!node_file_exists_1.default(pathToCoderoadJson)) {
+        console.log("Error with " + name + ": no coderoad.json file. " + exports.tutorialError);
+        return false;
+    }
+    ;
+    if (!packageJson.config || !packageJson.config.runner) {
+        console.log("Error with " + name + ": no test runner specified. " + exports.tutorialError);
+        return false;
+    }
+    return true;
+}
+exports.isTutorial = isTutorial;
diff --git a/lib/tutorials/update.js b/lib/tutorials/update.js
@@ -0,0 +1,26 @@
+"use strict";
+var atom_plugin_command_line_1 = require('atom-plugin-command-line');
+function tutorialUpdate(name) {
+    console.log("run \"npm install --save-dev " + name + "\"");
+}
+exports.tutorialUpdate = tutorialUpdate;
+function canUpdateTutorial(name, currentVersion) {
+    if (!navigator.onLine) {
+        return null;
+    }
+    return (atom_plugin_command_line_1.default('npm', "outdated " + name).then(function (res) {
+        console.log(res);
+        if (res.length > 0) {
+            var linked = res.match(/[0-9\.]+\s+linked/);
+            if (linked) {
+                return false;
+            }
+            var match = res.match(/[0-9\.]+\s+[0-9\.]+\s+([0-9\.]+)/);
+            if (match.length >= 2) {
+                return true;
+            }
+        }
+        return null;
+    }));
+}
+exports.canUpdateTutorial = canUpdateTutorial;
diff --git a/package.json b/package.json
@@ -24,9 +24,11 @@
         "*.md"
     ],
     "dependencies": {
+        "atom-plugin-command-line": "1.0.2",
         "chalk": "1.1.3",
         "commander": "2.9.0",
         "lodash.kebabcase": "4.0.1",
+        "node-file-exists": "1.1.0",
         "prompt": "1.0.0",
         "sort-package-json": "^1.4.0",
         "validate-npm-package-name": "2.2.2"
diff --git a/src/build/parser/import.ts b/src/build/parser/import.ts
@@ -1,6 +1,6 @@
 import {readFileSync} from 'fs';
 import {join} from 'path';
-import {fileExists} from '../../tools/file';
+import fileExists from 'node-file-exists';
 import {trimQuotes} from './cleanup';
 import {tutorialDir} from './settings';
 
diff --git a/src/build/readme.ts b/src/build/readme.ts
@@ -1,5 +1,5 @@
 import {readFileSync, writeFileSync} from 'fs';
-import {fileExists} from '../tools/file';
+import fileExists from 'node-file-exists';
 import {red} from 'chalk';
 
 export function createReadme(): boolean {
diff --git a/src/create/write-demo.ts b/src/create/write-demo.ts
@@ -1,7 +1,7 @@
 import {readFileSync, writeFileSync, mkdirSync} from 'fs';
 import {join} from 'path';
 import {sortPackageJson} from 'sort-package-json'
-import {fileExists} from '../tools/file';
+import fileExists from 'node-file-exists';
 
 function createFile(pathToFile: string): void {
   if (!fileExists(pathToFile)) {
diff --git a/src/tools/file.ts b/src/tools/file.ts
diff --git a/src/tutorials/find-tutorials.ts b/src/tutorials/find-tutorials.ts
@@ -0,0 +1,40 @@
+import {join} from 'path';
+import {readFileSync} from 'fs';
+import fileExists from 'node-file-exists';
+import {isTutorial, tutorialError} from './is-tutorial';
+import {canUpdateTutorial} from './update';
+
+export function searchForTutorials(dir: string, deps: Object): Tutorial.Info[] {
+  if (!!deps && Object.keys(deps).length > 0) {
+    return (Object.keys(deps)
+      .filter((name: string) => isTutorial(dir, name))
+      .map(function(name: string) {
+        const pathToTutorialPackageJson = join(
+          dir, 'node_modules', name, 'package.json'
+        );
+        // no package.json
+        if (!fileExists(pathToTutorialPackageJson)) {
+          console.log(
+            `Error with ${name}: no package.json file found. ${tutorialError}`
+          );
+          return {
+            name,
+            version: 'NOT INSTALLED'
+          };
+        }
+
+        let tutorialPackageJson = JSON.parse(
+          readFileSync(pathToTutorialPackageJson, 'utf8')
+        );
+        const version = tutorialPackageJson.version;
+
+        return {
+          name,
+          version,
+          latest: !!canUpdateTutorial(name, version)
+        };
+      }));
+  } else {
+    return [];
+  }
+}
diff --git a/src/tutorials/index.ts b/src/tutorials/index.ts
@@ -1,60 +1,7 @@
-// import {join} from 'path';
 import {yellow} from 'chalk';
-// import {fileExists} from '../tools/file';
-// import {readFileSync} from 'fs';
 
 export default function tutorials(): void {
   console.log(`List of tutorial packages in this directory...\n`);
   console.log(yellow('This feature is not yet implemented'));
   // getTutorials();
 }
-
-// function loadRootPackageJson(): PackageJson {
-//   let pathToPackageJson = join(process.cwd(), './package.json');
-//   if (fileExists(pathToPackageJson)) {
-//     return JSON.parse(readFileSync(pathToPackageJson, 'utf8'));
-//   } else {
-//     console.log('no package.json file available. Try typing "npm init" in terminal');
-//     process.exit(1);
-//   }
-// }
-
-// function isTutorial(name: string): boolean {
-//   let pathToTutorialPackageJson = join(process.cwd(), 'node_modules', name, 'package.json');
-//   if (fileExists(pathToTutorialPackageJson)) {
-//     // has package.json
-//     let packageJson = JSON.parse(readFileSync(pathToTutorialPackageJson, 'utf8'));
-//     // main path to coderoad.json
-//     if (packageJson.main && packageJson.main.match(/coderoad.json$/)) {
-//       let pathToCoderoadJson = join(process.cwd(), 'node_modules', name, packageJson.main);
-//       // coderoad.json file exists
-//       if (fileExists(pathToCoderoadJson)) {
-//         return true;
-//       }
-//     }
-//   }
-//   return false;
-// }
-//
-// function searchForTutorials(location): string[] {
-//   if (!!location) {
-//     return Object.keys(location)
-//       .filter((name) => isTutorial(name));
-//   } else {
-//     return [];
-//   }
-// }
-
-// function getTutorials(): void {
-//   let packageJson: PackageJson = loadRootPackageJson();
-//   let tutorials: string[] = []
-//     .concat(searchForTutorials(packageJson.dependencies))
-//     .concat(searchForTutorials(packageJson.devDependencies));
-//   if (tutorials.length) {
-//     console.log('Available tutorials: ');
-//     tutorials.forEach((tutorial: string) => {
-//       console.log('  - ' + tutorial);
-//     });
-//   }
-//   console.log('No tutorials available');
-// }
diff --git a/src/tutorials/is-tutorial.ts b/src/tutorials/is-tutorial.ts
@@ -0,0 +1,44 @@
+import {join} from 'path';
+import {readFileSync} from 'fs';
+import fileExists from 'node-file-exists';
+
+export const tutorialError = 'This is an error with the tutorial itself';
+
+export function isTutorial(dir: string, name: string): boolean {
+  // has package.json
+  const pathToTutorialPackageJson = join(
+    dir, 'node_modules', name, 'package.json'
+  );
+  if (!fileExists(pathToTutorialPackageJson)) {
+    console.log(`Error with ${name}: no package.json file found. ${tutorialError}`);
+    return false;
+  }
+  // main path to coderoad.json
+  let packageJson = JSON.parse(readFileSync(pathToTutorialPackageJson, 'utf8'));
+  if (!packageJson.main && packageJson.main.match(/coderoad.json$/)) {
+    console.log(`Error with ${name}: main does not load a coderoad.json file. ${tutorialError}`);
+    return false;
+  }
+  // coderoad.json file exists
+  let pathToCoderoadJson = join(
+    dir, 'node_modules', name, packageJson.main
+  );
+  if (!fileExists(pathToCoderoadJson)) {
+    console.log(`Error with ${name}: no coderoad.json file. ${tutorialError}`);
+    return false;
+  };
+  if (!packageJson.config || !packageJson.config.runner) {
+    console.log(`Error with ${name}: no test runner specified. ${tutorialError}`);
+    return false;
+  }
+
+  // let currentTutorialVersion: string = packageJson.dependencies[name] || packageJson.devDependencies[name];
+  // canUpdateTutorial(name, currentTutorialVersion);
+
+  // let pathToTestRunner = path.join(dir, 'node_modules', packageJson.config.testRunner);
+  // // if (!fileExists(pathToTestRunner)) {
+  // //   console.log(`Error with ${name}: ${packageJson.config.testRunner} test runner not installed`);
+  // //   return false;
+  // // }
+  return true;
+}
diff --git a/src/tutorials/update.ts b/src/tutorials/update.ts
diff --git a/tsconfig.json b/tsconfig.json
