Approach 0.1.0 for the project (#1)

* Template for the new project

* Utils created

- Copy folder recursively
- Replace a string by a dictionary
- Get object format for placeholders

* Generic process to build the new project

* Project class

- some issues with git values

* Dependencies and linter

* Command for dependencies with output for results

* Note for a fix needed

* Fix linting rules

* Update copy to do it sync and method to promify the exec

* Constructor default values for project and git methods

* Git utilities module

* Wrap function for packageGenerator

* Renamed git handler module

* Included information for the oauth for github

* commit and addRemote methods for git

* github handler to create repositories

* git method to push

* git values for project object

* Updated error msg for exec promised

* Included logic to create github repository, commit and push

* documentation

* Added documentation for methods

* MD fixes on readme

* Included eslint-plugin-node

* Promisified spawn for npm commands

* Fix for the status code from github response

* First approach for the questionnarie

* Function to generate project name with dashes

* New keywords

* First licenses files

* Updates on the TO-DOs progress

* Fix typo on questionnarie module name

* Test and cleanup scripts

* Method to delete a directory

* Adding questions for auth and github

* Move auth to its own module and add method to delete github repo

* :nailcare: Linter happiness

* 🔜 progress on the to-do list

* cwd for exec method

* Fix keywords and templating dictionary values

* 🔜 Update progress on to-do list

* Messaging for different processes

* 💅 Linter happiness

* Validations for questionnaire when project use github or has remote

* Validations for questionnaire when project use github or has remote

* 🔜 Updated the progress on to-do list

* Fix issue with path for auth.json

* New settings object to handle testing packages

* Improve folder structure for project

* 💅 Improve documentation

* Changed the settings to object instead of instance of class

* Using settings on auth

* Fix message when a github repository is deleted

* 💅 Linter happiness

* Include extra properties to create the github repo

* Add bin value in package.json

Author: nmicht

.eslintrc

@@ -1,6 +1,6 @@
 {
-  "extends": "airbnb-base",
+  "extends": ["airbnb-base", "plugin:node/recommended"],
     "rules": {
-      "no-console": off
+      "no-console": off,
   }
 }

README.md

@@ -4,30 +4,95 @@
 
 An [npm initializer][npm/init] to scaffold a node project and include basic tools like lint, testing, etc.
 
+> _`npm init <initializer>` can be used to set up a new or existing npm package._  
+> _`initializer` in this case is an npm package named `create-<initializer>`, which will be installed by `npx`, and then have its main bin executed -- presumably creating or updating `package.json` and running any other initialization-related operations._  
+> _[&mdash; Source: `docs.npmjs.com`][npm/init]_
+
 ## Requirements
 
-- `npm >= 6.x`
-- `node >= 8.*`
+- `npm >= x.x`
+- `node >= x.x`
 
 ## Usage
 
-```bash
-npm init node-project [params]
-```
-
-## How does this work?
-
-> _`npm init <initializer>` can be used to set up a new or existing npm package._  
-> _`initializer` in this case is an npm package named `create-<initializer>`, which will be installed by `npx`, and then have its main bin executed -- presumably creating or updating `package.json` and running any other initialization-related operations._  
-> _[&mdash; Source: `docs.npmjs.com`][npm/init]_
+`npm init node-project path/to/project [params]`
 
 ## Params
 
-- Project path
+### Project path
+
+`npm init node-project path/to/project [params]`
+
+Will create a new folder for the project in the specified path.
+
+## About this package
+
+So, this started as a dry thing.  
+I'm not super 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 a-demo-project`  
+and with this have a new folder my-new-project with everything ready to work.  
+
+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.
+
+So far, what this package will do (already does) is:
+1. Create the folder for the new project
+2. Create a git repo
+3. Copy the structure for files (src, and root files like eslintrc, gitignore, readme, etc)
+4. Create a github repository
+5. Install eslint and jest dependencies
+6. Update package.json
+7. Commit and push the initial commit
+
+What I have in my TODO list:
+1. Fix the structure of modules, classes and etc
+2. ~~Avoid as much dependencies as possible~~
+3. ~~Understand about the difference for eslint airbnb and eslint plugin node~~
+4. Add unit testing
+5. ~~Improve the calls for shell (right now is with exec, but I need to use spawn in order to have the stdout inherit, but that mess with the sync method and the responses)~~
+6. ~~Add documentation for classes, modules and methods~~
+7. Add options to create the project with params instead of questionnaire
+8. ~~Add questionnaire for the creation~~
+9. Publish the npm package
+10. Add 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
+13. Include license files to the template copy/update process
+14. A logger ? (just for learning)
+15. ~~CWD for git commands~~
+16. Best place for the auth.json
+17. Ability to handle auth for different github accounts
+18. Option to questionnaire with all the default values
+
+## Github Auth
+
+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.
+```
+ Token Description: (your computer name)
+ Scopes:
+     [X] repo
+         [X] repo:status
+         [X] repo_deployment
+         [X] public_repo
+         [X] repo:invite
+     [X] delete_repo
+```
+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.
 
-`npm init node-project path/to/project`
+```
+# nano ~/auth.json
 
-Will create a new folder for the project and use the forlder name as the project name.
+{
+  "github-oauth": {
+    "github.com": "YOUR_TOKEN"
+  }
+}
+```
 
 
 

auth-example.json

@@ -0,0 +1,5 @@
+{
+   "github": {
+     "token": "YOUR_TOKEN"
+   }
+}

licenses/isc

@@ -0,0 +1,7 @@
+ISC License (ISC)
+
+Copyright PROJECT_YEAR PROJECT_AUTHOR_NAME
+
+Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

licenses/mit

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright PROJECT_YEAR PROJECT_AUTHOR_NAME
+
+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.