Merge pull request #22 from nmicht/feature/settings

Feature/settings

Author: nmicht

.travis.yml

@@ -0,0 +1,3 @@
+language: node_js
+node_js:
+  - "10"

README.md

@@ -2,7 +2,7 @@
 
 # Node.js Project Initializer
 
-[![License][license-image]][license-url] [![version][npm-image]][npm-url]
+[![License][license-image]][license-url] [![version][npm-image]][npm-url] [![downloads][downloads-image]][downloads-url]
 
 An [npm initializer][npm/init] to scaffold a node project and include basic tools like lint, testing, etc.
 
@@ -34,11 +34,10 @@ npm init nodejs-project path/to/new/project
 ## What it does
 
 1. Create the folder for the new project
-1. Guide you through a questionnarie to setup the project
+1. Guide you through a questionnaire to setup the project
 2. Initialize a git repository
 3. Copy the template files (src, eslintrc, gitignore, readme, etc)
-4. Can create a Github repository
-5. Handle the Github tokens for multiple accounts/users
+4. Create a Github repository
 5. Install eslint dependencies
 5. Install the selected testing dependencies
 6. Generate package.json with all the project details
@@ -47,22 +46,22 @@ npm init nodejs-project path/to/new/project
 
 ## About this package
 
-The motivation started as a **DRY** thing.
+Every time that I start a new project in Node.js, I hate to go to other project folder, copy files like eslintrc, editorconfig; install the same dependencies, create folder structure, etc.
 
-I'm not expert with NodeJS, but every time that I start a new project, I hate to go to other project, copy files like eslintrc, editorconfig, install the same dependencies, create folder structure, etc.   
+With this in mind, the motivation to build this package started as a **DRY** (Do not repeat yourself) thing.   
 
-So, the idea is to have an automated way to initialize new NodeJS projects and with this have a new folder with everything ready to work in what really matters.  
+This package is intended to automated the initialization of new Node.js projects and with this have a new folder with everything ready to work, basically an scaffolding tool.  
 
 
 ## Future features
 
 1. Unit testing
-7. Options to create the project with params instead of questionnaire
+7. Options to create the project with parameters instead of questionnaire
 10. A good error handler
 11. Color for the console messages
 12. Improve the template structure (the one that is generated in the new project) to include unit test
 18. Option to questionnaire with all the default values
-2. Logic to handle multiple auth files and multiple github accounts
+2. Logic to handle multiple authentication files and multiple Github accounts
 
 ## Configure Github Authentication
 
@@ -105,3 +104,6 @@ If you are planning to allow this script to create your Github repositories, is
 [npm-image]: https://img.shields.io/npm/v/create-nodejs-project.svg?style=for-the-badge&logo=npm
 
 [npm/init]: https://docs.npmjs.com/cli/init#description
+
+[downloads-url]: https://www.npmjs.com/package/create-nodejs-project
+[downloads-image]: https://img.shields.io/npm/dt/create-nodejs-project.svg?style=for-the-badge

create-nodejs-settings-example.json

@@ -31,8 +31,10 @@
     "license": "GNU GPLv3",
     "version": "0.1.0"
   },
+  "templates": [
+    "nodejs-project",
+  ],
   "settingsPath": "/YOUR_PATH/create-nodejs-project/create-nodejs-settings.json",
   "templatesPath": "/YOUR_PATH/create-nodejs-project/templates",
-  "nodejsTemplatePath": "/YOUR_PATH/create-nodejs-project/templates/nodejs-project",
   "licensesPath": "/YOUR_PATH/create-nodejs-project/templates/licenses"
 }

package.json

@@ -19,8 +19,9 @@
   "private": false,
   "scripts": {
     "postinstall": "node --no-warnings scripts/install.js",
-    "start": "node --no-warnings src/index.js",
+    "setup": "node --no-warnings scripts/setup.js",
     "cleanup": "node --no-warnings scripts/cleanup.js",
+    "start": "node --no-warnings src/index.js",
     "test": "mocha"
   },
   "engines": {

scripts/install.js

@@ -1,32 +1,15 @@
-const questions = require('../src/questionnaire/questions');
+const fs = require('fs').promises;
+
 const settings = require('../src/settings');
 
 /**
- * Install function for the package, it set up the github auth details
- * TODO Consider the case for a previous auth file with different tokens
+ * Install function for the package, it set up all the settings details
  */
 (async () => {
-  let user;
-  await settings.load();
-
-  const authFileAnswers = await questions.promptSettingsFile(settings.settingsPath);
-  settings.settingsPath = authFileAnswers.settingsPath;
-
   try {
-    user = await settings.firstUser();
+    await fs.access(settings.settingsPath);
+    await settings.load();
   } catch (e) {
-    // console.log('fixme');
+    settings.update();
   }
-
-
-  const authUser = await questions.promptGithubUser(user.user || '');
-  const authToken = await questions.promptAuthToken(user.user || '', user.token || '');
-
-  settings.githubAuth = {
-    user: authUser.github.user,
-    token: authToken.github.token,
-  };
-
-  await settings.update();
-  console.log(`Your settings file was updated on ${settings.settingsPath}`);
 })();

scripts/setup.js

@@ -0,0 +1,39 @@
+const fs = require('fs').promises;
+
+const questions = require('../src/questionnaire/questions');
+const settings = require('../src/settings');
+
+/**
+ * Install function for the package, it set up the github auth details
+ * TODO Consider the case for a previous auth file with different tokens
+ */
+(async () => {
+  let user;
+  try {
+    await fs.access(settings.settingsPath);
+    await settings.load();
+  } catch (e) {
+    settings.update();
+  }
+
+  const authFileAnswers = await questions.promptSettingsFile(settings.settingsPath);
+  settings.settingsPath = authFileAnswers.settingsPath;
+
+  try {
+    user = await settings.firstUser();
+  } catch (e) {
+    // console.log('fixme');
+  }
+
+
+  const authUser = await questions.promptGithubUser(user.user || '');
+  const authToken = await questions.promptAuthToken(user.user || '', user.token || '');
+
+  settings.githubAuth = {
+    user: authUser.github.user,
+    token: authToken.github.token,
+  };
+
+  await settings.update();
+  console.log(`Your settings file was updated on ${settings.settingsPath}`);
+})();

src/project/index.js

@@ -1,4 +1,5 @@
 const fs = require('fs').promises;
+const path = require('path');
 
 const questionnaire = require('../questionnaire');
 const gitHandler = require('../gitHandler');
@@ -40,6 +41,7 @@ class Project {
    * @param {String}  [path='']         The full path for the project folder
    * @param {String}  [year='']         The year to be used on the license
    * @param {Array}   [testPackages=[]] The list of the test packages selected
+   * @param {String}  [template='']     The list of the test packages selected
    */
   constructor({
     name = '',
@@ -66,9 +68,10 @@ class Project {
     },
     issueTracker = '',
     isPrivate = false,
-    path = '',
+    thePath = '',
     year = '',
     testPackages = [],
+    theTemplate = '',
   }) {
     this.name = name;
     this.description = description;
@@ -94,9 +97,10 @@ class Project {
     };
     this.issueTracker = issueTracker;
     this.isPrivate = isPrivate;
-    this.path = path;
+    this.path = thePath;
     this.year = year || (new Date()).getFullYear();
     this.testPackages = testPackages;
+    this.template = theTemplate;
   }
 
   /**
@@ -207,7 +211,10 @@ class Project {
    * @return {Promise}
    */
   async generateTemplateFiles() {
-    await template.copyTemplate(Project.settings.nodejsTemplatePath, this.path);
+    await template.copyTemplate(
+      path.join(Project.settings.templatesPath, this.template),
+      this.path
+    );
 
     return Promise.all([
       template.updateTemplateFiles(this.dictionary, this.path),

src/questionnaire/index.js

@@ -20,7 +20,12 @@ async function run(name, settings) {
   let currentAuthUser;
   let currentToken;
 
-  const resp = await questions.promptProjectDetails(name, settings.licenses, settings.testingPkgs);
+  const resp = await questions.promptProjectDetails(
+    name,
+    settings.licenses,
+    settings.testingPkgs,
+    settings.templates
+  );
 
   if (!resp.useGithub) {
     remoteAnswers = await questions.promptGitRemoteDetails();

src/questionnaire/questions.js

@@ -12,11 +12,13 @@ const utils = require('../utils');
  * @param  {String} defaults.license        The default license for the project
  * @param  {String} defaults.gitUserName    The git username setup for the project
  * @param  {String} defaults.gitUserEmail   The git username setup for the project
+ * @param  {String} defaults.template       The name for the default template
  * @param  {Array} licenses                 The list of options for licenses
  * @param  {Array} testingPkgs              The list of options for testingPkgs
+ * @param  {Array} templates                The list of options for templates
  * @return {Promise}
  */
-async function promptProjectDetails(defaults, licenses, testingPkgs) {
+async function promptProjectDetails(defaults, licenses, testingPkgs, templates) {
   return inquirer.prompt([
     {
       type: 'input',
@@ -25,6 +27,14 @@ async function promptProjectDetails(defaults, licenses, testingPkgs) {
       default: defaults.projectName,
     },
 
+    {
+      type: 'list',
+      name: 'template',
+      message: 'What kind of project are you creating?',
+      choices: templates,
+      default: defaults.template,
+    },
+
     {
       type: 'input',
       name: 'description',

src/settings/index.js

@@ -10,7 +10,6 @@ const SETTINGS_PATH = path.resolve(path.join(__dirname, '..', '..', 'create-node
  * @class Settings
  */
 class Settings {
-
   constructor({
     lintPkgs = [
       'eslint',
@@ -36,13 +35,16 @@ class Settings {
       'MIT License',
       'ISC License',
     ],
+    templates = [
+      'nodejs-project',
+    ],
     settingsPath = SETTINGS_PATH,
     templatesPath = path.resolve(path.join(__dirname, '..', '..', 'templates')),
-    nodejsTemplatePath = path.resolve(path.join(__dirname, '..', '..', 'templates', 'nodejs-project')),
     licensesPath = path.resolve(path.join(__dirname, '..', '..', 'templates', 'licenses')),
     defaults = {
       license: 'GNU GPLv3',
       version: '0.1.0',
+      template: 'nodejs-project',
     },
     githubAuth = {
       user: 'YOUR_USER',
@@ -59,10 +61,11 @@ class Settings {
     this.defaults = {
       license: defaults.license,
       version: defaults.version,
+      template: defaults.template,
     };
+    this.templates = templates;
     this.settingsPath = settingsPath;
     this.templatesPath = templatesPath;
-    this.nodejsTemplatePath = nodejsTemplatePath;
     this.licensesPath = licensesPath;
   }
 
@@ -98,7 +101,7 @@ class Settings {
     this.licenses = json.licenses;
     this.settingsPath = json.settingsPath;
     this.templatesPath = json.templatesPath;
-    this.nodejsTemplatePath = json.nodejsTemplatePath;
+    this.templates = json.templates;
     this.licensesPath = json.licensesPath;
   }