move setup to lib

ShMcK · ShMcK · commit d2c99f9a2119 · 2016-02-29T17:13:15.000-08:00
diff --git a/lib/create/setup/package.json b/lib/create/setup/package.json
@@ -0,0 +1,25 @@
+{
+  "name": "coderoad-package-name",
+  "version": "0.1.0",
+  "description": "Coderoad tutorial",
+  "author": "Name <email> (site)",
+  "contributers": [],
+  "main": "coderoad.json",
+  "files": [
+    "coderoad.json",
+    "tutorial"
+  ],
+  "keywords": ["coderoad", "tutorial"],
+  "engines": {
+    "node" : ">=0.10.3"
+  },
+  "dependencies": {
+    "mocha-coderoad": "^0.5.0"
+  },
+  "license": "MIT",
+  "config": {
+    "testDir": "tutorial",
+    "testSuffix": ".spec.js",
+    "testRunner": "mocha-coderoad"
+  }
+}
diff --git a/lib/create/setup/tutorial/1/01/01.spec.js b/lib/create/setup/tutorial/1/01/01.spec.js
@@ -0,0 +1,29 @@
+var expect = require('chai').expect;
+
+var loadJS = require('./common/loadJS').default;
+loadJS('page-01.js')
+
+describe('01 addOne', function() {
+
+  it('doesn\'t exist', function() {
+    expect(addOne).to.not.be.undefined;
+  });
+
+  it('should take a parameter', function() {
+    expect(addOne).to.have.length(1);
+  });
+
+  it('doesn\'t return anything', function() {
+    expect(addOne(1)).to.exist;
+  });
+
+  it('should output a number', function() {
+    expect(addOne(1)).to.be.a('number');
+  });
+
+  it('doesn\'t add 1 + 1', function() {
+    expect(addOne(1)).to.equal(2);
+    expect(addOne(10)).to.equal(11);
+  });
+
+});
diff --git a/lib/create/setup/tutorial/1/01/02.spec.js b/lib/create/setup/tutorial/1/01/02.spec.js
@@ -0,0 +1,20 @@
+describe('02 subtractOne', function() {
+
+  it('doesn\'t exist', function () {
+    expect(subtractOne).to.not.be.undefined;
+  });
+
+  it('should take a parameter', function() {
+    expect(subtractOne).to.have.length(1);
+  });
+
+  it('should output a number', function () {
+    expect(subtractOne(1)).to.be.a('number');
+  });
+
+  it('doesn\'t subtract 1', function() {
+    expect(subtractOne(1)).to.equal(0);
+    expect(subtractOne(10)).to.equal(9);
+  });
+
+});
diff --git a/lib/create/setup/tutorial/1/01/page-one.md b/lib/create/setup/tutorial/1/01/page-one.md
@@ -0,0 +1,34 @@
+### Add & Subtract
+Writing basic functions.
+
+A function has inputs and outputs. The inputs we call "parameters" and wrap them in `(` brackets `)`.
+
+The output is `return`ed from the function.
+
+```
+                    // input
+function doSomething(parameter) {
+  // output
+  return parameter;
+}
+```
+
+Try making your own basic functions.
+
++ write a function `addOne` that adds one to a number
+@test('1/01/01')
+@action(open('page-01.js'))
+@action(set(
+```
+// addOne
+```  
+))
+
++ write a function `subtractOne` that subtracts one from a number
+@test('1/01/02')
+@action(insert(
+```
+
+// subtractOne
+```  
+))
diff --git a/lib/create/setup/tutorial/1/02/01.spec.js b/lib/create/setup/tutorial/1/02/01.spec.js
@@ -0,0 +1,26 @@
+var expect = require('chai').expect;
+
+var loadJS = require('./common/loadJS').default;
+loadJS('page-02.js')
+
+
+describe('01 divideOne', function() {
+
+  it('doesn\'t exist', function () {
+    expect(divideOne).to.not.be.undefined;
+  });
+
+  it('should take a parameter', function() {
+    expect(divideOne).to.have.length(1);
+  });
+
+  it('doesn\'t output a number', function () {
+    expect(divideOne(1)).to.be.a('number');
+  });
+
+  it('returns the same number', function() {
+    expect(divideOne(1)).to.equal(1);
+    expect(divideOne(10)).to.equal(10);
+  });
+
+});
diff --git a/lib/create/setup/tutorial/1/02/02.spec.js b/lib/create/setup/tutorial/1/02/02.spec.js
@@ -0,0 +1,20 @@
+describe('02 multiplyOne', function() {
+
+  it('doesn\'t exist', function () {
+    expect(multiplyOne).to.not.be.undefined;
+  });
+
+  it('should take a parameter', function() {
+    expect(multiplyOne).to.have.length(1);
+  });
+
+  it('should output a number', function () {
+    expect(multiplyOne(1)).to.be.a('number');
+  });
+
+  it('returns the multiplied number by one', function() {
+    expect(multiplyOne(1)).to.equal(1);
+    expect(multiplyOne(10)).to.equal(10);
+  });
+
+});
diff --git a/lib/create/setup/tutorial/1/02/page-two.md b/lib/create/setup/tutorial/1/02/page-two.md
@@ -0,0 +1,22 @@
+### Divide & Multiply
+Writing basic functions continued.
+
+We'll write two more basic functions, this time without any help.
+
++ write a function `divideOne` divides a number by 1
+@test('1/02/01')
+@action(open('page-02.js'))
+@action(set(
+```
+// divideOne
+```  
+))
+
++ write a function `mutiplyone` that multiplies a number by 1
+@test('1/02/02')
+@action(insert(
+```
+
+// multiplyOne
+```  
+))
diff --git a/lib/create/setup/tutorial/common/loadJS.js b/lib/create/setup/tutorial/common/loadJS.js
@@ -0,0 +1,11 @@
+"use strict";
+var vm = require('vm');
+var fs = require('fs');
+var path = require('path');
+function loadContext(pathToContext) {
+    var absPath = path.join(process.env.DIR, pathToContext);
+    var context = fs.readFileSync(absPath, 'utf8');
+    vm.runInThisContext(context);
+}
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = loadContext;
diff --git a/lib/create/setup/tutorial/tutorial.md b/lib/create/setup/tutorial/tutorial.md
@@ -0,0 +1,9 @@
+# Project Title
+Project description.
+
+## Chapter One Title
+Chapter one description.
+
+@import('tutorial/1/01/page-one')
+
+@import('tutorial/1/02/page-two')
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "coderoad-cli",
-  "version": "0.3.20",
+  "version": "0.3.21",
   "description": "Command line interface for CodeRoad. Build project files.",
   "keywords": [
     "coderoad"
@@ -20,8 +20,7 @@
   "files": [
     "lib",
     "package.json",
-    "README.md",
-    "LICENSE.md"
+    "*.md"
   ],
   "dependencies": {
     "chalk": "1.1.1",
