add npm init example

Author: chfw

.moban.d/docs/source/index.rst

@@ -26,6 +26,6 @@ Documentation
 .. toctree::
 
    usage
-
+   extended_usage
 
 .. _moban: https://github.com/chfw/moban

docs/source/extended_usage.rst

@@ -0,0 +1,34 @@
+Custom use case: scaffolding a npm package
+================================================================================
+
+As mentioned in previous section, **yehua** would take a yehua.yml from command
+line options. This section walk you through creating a npm package, **non-python
+package**.
+
+If you are familiar with npm, you can try and compare with yehua::
+
+    $ npm init
+
+Evaluation
+--------------------------------------------------------------------------------
+
+Please first checkout yehua repository so that you will have the access to
+example directory. Then make sure you have **yehua** installed. Let's do these
+steps to evaluate it::
+
+    $ cd /tmp
+	$ yehua
+
+yehua.yml for npm package
+--------------------------------------------------------------------------------
+
+Let us go through the variant yehua file.
+
+configuration section
+********************************************************************************
+
+
+
+.. literalinclude:: ../../examples/npm-init/yehua.yml
+   :lines: 12-15
+

docs/source/usage.rst

@@ -1,16 +1,20 @@
-How it works
+Default use case: scaffolding a python package
 ================================================================================
 
 **yehua** reads a configuration file named yehua.yml which then instruct **yehua
 to ask questions to collect project specific variables, and create the file
-structures. Its default usage is to create a blank python package but it is not
-limited to it. You can provide your own yehua file and do something else.
+structures.
 
+It takes a yehua file from command line option, or YEHUA_FILE in the environment
+varaible. If none is found, it resorts to the default yehua.yml file included
+in the package. And the default yehua.yml create a blank python package.
 
-Default behaviour
+
+Default yehua.yml file
 --------------------------------------------------------------------------------
 
-Let us go through the default yehua file. And then talk about the customization.
+Let us go through the default yehua file. And then talk about the customization
+in the next chapter
 
 configuration section
 ********************************************************************************

examples/npm-init/index.js

@@ -0,0 +1 @@
+console.log("hello world");

examples/npm-init/package.json.jj2

@@ -0,0 +1,18 @@
+{
+	"name": "{{project_name}}",
+	"version": "{{version}}",
+	"description": "{{description}}",
+	"main": "{{entry_point}}",
+	"scripts": {
+		"test": "{{test_command}}",
+	},
+	"repository": {
+	    "type": "git",
+		"url": "{{git_repo}}"
+	},
+	"keywords": [
+	  "{{keywords}}"
+	],
+	"author": "{{author}}",
+	"license": "{{license}}"
+}

examples/npm-init/yehua.yml

@@ -0,0 +1,28 @@
+introduction: |
+  This utility will walk you through creating a package.json file.
+  It only covers the most common items, and tries to guess sensible defaults.
+  
+  See `npm help json` for definitive documentation on these fields
+  and exactly what they do.
+  
+  Use `npm install <pkg> --save` afterwards to install a package and
+  save it as a dependency in the package.json file.
+  
+  Press ^C at any time to quit.
+configuration:
+  template_path: .
+  static_path: .
+questions:
+  - project_name: "name:"
+  - version: "version:"
+  - description: "description:"
+  - entry_point: "entry point:"
+  - test_command: "test command:"
+  - git_repo: "git repository:"
+  - keywords: "keywords:"
+  - author: "author:"
+  - license: "license:"
+templates:
+  - package.json: package.json.jj2
+static:
+  - index.js: index.js

yehua/project.py

@@ -21,8 +21,10 @@ def __init__(self, yehua_file):
         self._template_yehua_file()
 
     def create_all_directories(self):
-        temp = {self.answers['project_name']: self.directives['layout']}
-        utils.make_directories(None, temp)
+        folder_tree = {
+            self.answers['project_name']: self.directives.get('layout', None)
+        }
+        utils.make_directories(None, folder_tree)
 
     def templating(self):
         for template in self.directives['templates']:
@@ -99,7 +101,7 @@ def raise_complex_question(question):
         suggested_answers = sorted(subq.keys())
         long_question = [subquestion] + suggested_answers
         choice = '(%s): ' % (
-            ','.join([str(x) for x in xrange(1, len(long_question))]))
+            ','.join([str(x) for x in range(1, len(long_question))]))
         long_question.append(choice)
         a = utils.yehua_input('\n'.join(long_question))
         for key in suggested_answers:

yehua/utils.py

@@ -37,6 +37,8 @@ def make_directories(parent, node_dictionary):
         else:
             the_parent = key
         mkdir(the_parent)
+        if value is None:
+            continue
         for item in value:
             if isinstance(item, dict):
                 make_directories(the_parent, item)