Merge branch 'stg'

Author: nmicht

.eslintrc

@@ -2,5 +2,6 @@
   "extends": ["airbnb-base", "plugin:node/recommended"],
     "rules": {
       "no-console": off,
+      "comma-dangle": [error, always-multiline, {functions: never}]
   }
 }

CHANGELOG.md

@@ -0,0 +1,19 @@
+# Changelog
+
+## 0.1.4
+
+* Handle the Github tokens for multiple accounts/users
+* Fix problem with keywords on package.json
+* Post install script to setup github auth details
+
+## 0.1.3
+
+* Create the folder for the new project
+* Guide you through a questionnarie to setup the project
+* Initialize a git repo
+* Copy the template files (src, eslintrc, gitignore, readme, etc)
+* Can create a Github repository
+* Install eslint dependencies
+* Install the selected testing dependencies
+* Generate package.json with all the project details
+* Commit and push the initial commit

LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright 2019 Michelle Torres
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,3 +1,5 @@
+<img width="75px" height="75px" align="right" alt="Create NodeJS Project Logo" src="https://raw.githubusercontent.com/nmicht/create-nodejs-project/master/assets/create-nodejs-project.png" title="Create NodeJS Project"/>
+
 # Node Project Initializer
 
 [![License][license-image]][license-url] [![version][npm-image]][npm-url]
@@ -15,46 +17,55 @@ An [npm initializer][npm/init] to scaffold a node project and include basic tool
 
 ## Usage
 
-`npm init node-project path/to/project`
+1. Install the package as global
+```
+npm install -g create-nodejs-project
+```
+
+2. You will be prompted for your Github information  
+If you do not have the information at the moment, you can keep it empty.  
+In order to create projects with Github integration, you will need to add the authentication information later. See [Github Auth](#configure-Github-authentication)
+
+3. Create your project
+```
+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
-2. Initialize a git repo
+2. Initialize a git repository
 3. Copy the template files (src, eslintrc, gitignore, readme, etc)
 4. Can create a Github repository
-5. Install eslint
+5. Handle the Github tokens for multiple accounts/users
+5. Install eslint dependencies
 5. Install the selected testing dependencies
 6. Generate package.json with all the project details
 7. Commit and push the initial commit
 
 ## About this package
 
-So, this started as a dry thing.  
-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.  
-So, the idea is to have a create package to use it in the form of:  
-`npm init node-project path/to/project`
-and with this have a new folder my-new-project with everything ready to work.  
+The motivation started as a **DRY** thing.
+
+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.   
+
+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.  
 
-I know there are a lot of similar packages out there, but the idea is to learn more about nodejs api, handling files, packages, etc.
 
 ## Future features
 
-1. Fix the structure of modules, classes and etc
-4. Add unit testing
-7. Add options to create the project with params instead of questionnaire
-10. Add a good error handler
+1. Unit testing
+7. Options to create the project with params instead of questionnaire
+10. A good error handler
 11. Color for the console messages
-12. Modify template structure (the one that is generated in the new project) to include unit test
+12. Improve the template structure (the one that is generated in the new project) to include unit test
 13. Include license files to the template copy/update process
-14. A logger ? (just for learning)
-17. Ability to handle auth for different github accounts
 18. Option to questionnaire with all the default values
 
-## Github Auth
+## Configure Github Authentication
 
-If you are planning to allow this script to create your github repositories, is required to generate a Github Token.
+If you are planning to allow this script to create your Github repositories, is required to generate a Github Token.
 
 1. Visit https://github.com/settings/tokens.
 2. Click Generate new token.
@@ -70,24 +81,31 @@ If you are planning to allow this script to create your github repositories, is
 ```
 3. Click Generate token.
 4. Copy the generated string to a safe place, such as a password safe.
-5. Open Terminal and add the github token. Note: The file may be empty, you can use `auth-example.json` to copy and paste.
+5. Open Terminal and add the Github token.
 
 ```
 # nano ~/auth.json
 
 {
-  "github-oauth": {
-    "github.com": "YOUR_TOKEN"
-  }
+   "Github": [
+     {
+       "user": "YOUR_USER",
+       "token": "YOUR_TOKEN"
+     },
+     {
+       "user": "OTHER_USER",
+       "token": "OTHER_TOKEN"
+     }
+   ]
 }
 ```
 
 
 
 [license-url]: LICENSE
-[license-image]: https://img.shields.io/github/license/ahmadnassri/node-create.svg?style=for-the-badge&logo=circleci
+[license-image]: https://img.shields.io/github/license/nmicht/create-nodejs-project.svg?style=for-the-badge&logo=appveyor
 
 [npm-url]: https://www.npmjs.com/package/create-nodejs-project
-[npm-image]: https://img.shields.io/npm/v/@nmicht/create.svg?style=for-the-badge&logo=npm
+[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

assets/create-nodejs-project.png

@@ -1,5 +1,12 @@
 {
-   "github": {
-     "token": "YOUR_TOKEN"
-   }
+   "github": [
+     {
+       "user": "YOUR_USER",
+       "token": "YOUR_TOKEN"
+     },
+     {
+       "user": "OTHER_USER",
+       "token": "OTHER_TOKEN"
+     }
+   ]
 }

auth-example.json

@@ -0,0 +1,37 @@
+const fs = require('fs');
+const inquirer = require('inquirer');
+
+const utils = require('../src/utils');
+
+async function install() {
+  const authPath = utils.fs.resolvePath('~/auth.json');
+
+  const answers = await inquirer.prompt([
+    {
+      type: 'input',
+      name: 'user',
+      message: 'What is your github user?',
+    },
+
+    {
+      type: 'input',
+      name: 'token',
+      message: 'What is your GitHub token?',
+    },
+  ]);
+
+  // Write file
+  const data = {
+    github: [
+      {
+        user: answers.user,
+        token: answers.token,
+      },
+    ],
+  };
+
+  fs.writeFileSync(authPath, JSON.stringify(data));
+  console.log(`File ${authPath} created with your github details`);
+}
+
+install();

install/index.js

@@ -1,6 +1,6 @@
 {
   "name": "create-nodejs-project",
-  "version": "0.1.3",
+  "version": "0.1.4",
   "description": "An npm initializer to scaffold a node project and include basic tools like lint, testing, etc.",
   "main": "src/index.js",
   "bin": "src/index.js",
@@ -18,9 +18,9 @@
   "license": "MIT",
   "private": false,
   "scripts": {
+    "postinstall": "node install/index.js",
     "start": "node src/index.js",
-    "cleanup": "node test/cleanup.js a-demo-project",
-    "test": "node src/index.js ../a-demo-project"
+    "cleanup": "node test/cleanup.js"
   },
   "engines": {
     "node": ">=10.0.0"

package-lock.json

@@ -1,31 +1,103 @@
 const fs = require('fs');
-const path = require('path');
 
 const settings = require('../settings');
+const utils = require('../utils');
 
 /**
  * Get the Github token from the auth file
- * @param  {String} [path=''] The path for the auth.json file
- * @return {String} The github token
+ * @param  {String} [user=undefined] The user owner of the token
+ * @param  {String} [path='']        The path for the auth.json file
+ * @return {String}                  The github token
  */
-async function getToken(jsonPath = '') {
+function getToken(user = undefined, jsonPath = '') {
   let auth = {};
+  let ghData;
   const authPath = jsonPath || settings.authPath;
-  const authFile = path.resolve(authPath);
+  const authFile = utils.fs.resolvePath(authPath);
 
   try {
     auth = JSON.parse(fs.readFileSync(authFile, 'utf8'));
   } catch (error) {
     throw error;
   }
 
-  if (!auth.github.token) {
+  if (user) {
+    [ghData] = auth.github.filter(obj => obj.user === user);
+  } else {
+    [ghData] = auth.github;
+  }
+
+  const { token } = ghData;
+
+  if (!token) {
     throw new Error('Token missing');
   }
 
-  return auth.github.token;
+  return token;
+}
+
+/**
+ * Update the Token
+ * @param  {String} [user=undefined] The user owner of the token
+ * @param  {String} token            The token
+ * @param  {String} [jsonPath='']    The path for the auth.json file
+ * @return {Boolean}                 True in case the file gets updated
+ */
+function updateToken(user = undefined, token, jsonPath = '') {
+  let auth = {};
+  let currentToken = '';
+  let userIndex = 0;
+  const authPath = jsonPath || settings.authPath;
+  const authFile = utils.fs.resolvePath(authPath);
+
+  try {
+    auth = JSON.parse(fs.readFileSync(authFile, 'utf8'));
+  } catch (error) {
+    throw error;
+  }
+
+  currentToken = auth.github[0].token;
+
+  if (user) {
+    for (let k = 0; k < auth.github.length; k += 1) {
+      if (auth.github[k].user === user) {
+        userIndex = k;
+        currentToken = auth.github[k].token;
+        break;
+      }
+    }
+  }
+
+  if (currentToken !== token) {
+    auth.github[userIndex].token = token;
+    fs.writeFileSync(authFile, JSON.stringify(auth));
+    return true;
+  }
+
+  return false;
+}
+
+/**
+ * Get the first user from the auth file
+ * @param  {String} [jsonPath=''] The auth.json file path
+ * @return {String}               The user
+ */
+function getFirstUser(jsonPath = '') {
+  let auth = {};
+  const authPath = jsonPath || settings.authPath;
+  const authFile = utils.fs.resolvePath(authPath);
+
+  try {
+    auth = JSON.parse(fs.readFileSync(authFile, 'utf8'));
+  } catch (error) {
+    throw error;
+  }
+
+  return auth.github[0].user;
 }
 
 module.exports = {
   getToken,
+  updateToken,
+  getFirstUser,
 };