Merge pull request #40 from Mindsers/develop

Version 0.3.0

Author: Nathanael CHERRIER

.editorconfig

@@ -1,4 +1,17 @@
+root = true
+
 [*]
+charset = utf-8
+indent_style = space
 indent_size = 2
 insert_final_newline = true
 end_of_line = lf
+trim_trailing_whitespace = true
+
+[*.md]
+max_line_length = 0
+trim_trailing_whitespace = false
+indent_size = 4
+
+[Dockerfile]
+indent_size = 4

.eslintrc.json

@@ -0,0 +1,34 @@
+{
+  "extends": "standard",
+  "env": {
+    "es6": true,
+    "node": true
+  },
+  "rules": {
+    "arrow-body-style": ["error", "as-needed"],
+    "arrow-parens": ["error", "as-needed"],
+    "arrow-spacing": "error",
+    "default-case": "error",
+    "guard-for-in": "error",
+    "generator-star-spacing": ["error", { "before": true, "after": false }],
+    "getter-return": ["error", { "allowImplicit": true }],
+    "no-compare-neg-zero": "error",
+    "no-confusing-arrow": "error",
+    "no-else-return": "error",
+    "no-empty": "error",
+    "no-implicit-coercion": "error",
+    "no-useless-return": "error",
+    "no-redeclare": "error",
+    "no-var": "error",
+    "prefer-arrow-callback": "error",
+    "prefer-const": "error",
+    "prefer-rest-params": "error",
+    "prefer-spread": "error",
+    "prefer-template": "error",
+    "space-before-function-paren": ["error", {
+      "anonymous": "always",
+      "named": "never",
+      "asyncArrow": "always"
+    }]
+  }
+}

.github/issue_template.md

@@ -0,0 +1,18 @@
+[...description...]
+
+### Steps to reproduce
+
+* ...
+
+### Expected behavior
+Tell us what should happen
+
+### Actual behavior
+Tell us what happens instead
+
+### System configuration
+**OS and version**:
+
+**NodeJS version**:
+
+**Yarn version**:

.github/pull_request_template.md

@@ -0,0 +1,15 @@
+### Summary
+
+Provide a general description of the code changes in your pull
+request... were there any bugs you had fixed? If so, mention them. If
+these bugs have open GitHub issues, be sure to tag them here as well,
+to keep the conversation linked together.
+
+### Other Informations
+
+If there's anything else that's important and relevant to your pull
+request, mention that information here. This could include
+benchmarks, or other information.
+
+If you are updating any of the CHANGELOG files or are asked to update the
+CHANGELOG files by reviewers, please add the CHANGELOG entry at the top of the file.

CHANGELOG.md

@@ -6,6 +6,16 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+## [0.3.0] - 2017-11-15
+### Added
+- A contribution guide (CONTRIBUTING.md) to help new contributors.
+- The local deployment of configuration file. (`-l` on `modules deploy`)
+
+### Changed
+- Adopte a git like command style: `configfile run` => `configfile scritps run`.
+- Create a "saved version" if preexisting file exist when user deploy a module.
+- Do not indentify the modules to deploy cause the deployment of all available modules. User authorization is required.
+
 ## [0.2.1] - 2017-10-13
 ### Fixed
 - Replace the JS error message (non-handled error) on `scripts` and `modules` commands
@@ -36,6 +46,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 - The README file to give first information on the project (installation, usage, etc.).
 
 [Unreleased]: https://github.com/Mindsers/configfile/tree/develop
+[0.3.0]: https://github.com/Mindsers/configfile/tree/0.3.0
 [0.2.1]: https://github.com/Mindsers/configfile/tree/0.2.1
 [0.2.0]: https://github.com/Mindsers/configfile/tree/0.2.0
 [0.1.1]: https://github.com/Mindsers/configfile/tree/0.1.1

CONTRIBUTING.md

@@ -0,0 +1,112 @@
+# How to contribute to Configfile
+
+*First off, thanks for taking the time to contribute!*
+
+This file is a set of guilines for contributing to *Configfile* project. These are mostly guidelines, not rules. Use your best judgment, and feel free to propose changes to this document in a pull request.
+
+#### Table of contents
+
+[How can I contribute?](#how-can-i-contribute)
+
+* [Did you find a bug?](#did-you-find-a-bug)
+* [Did you write a patch that fixes a bug?](#did-you-write-a-patch-that-fixes-a-bug)
+* [Did you fix whitespace, format code, or make a purely cosmetic patch?](#did-you-fix-whitespace-format-code-or-make-a-purely-cosmetic-patch)
+* [Do you intend to add a new feature or change an existing one?](#do-you-intend-to-add-a-new-feature-or-change-an-existing-one)
+* [Do you have questions about the source code?](#do-you-have-questions-about-the-source-code)
+* [Do you want to contribute to the Configfile documentation?](#do-you-want-to-contribute-to-the-Configfile-documentation)
+
+[Styleguides](#styleguides)
+
+* [JavaScript styleguide](#javaScript-styleguide)
+* [Git commit messages](#git-commit-messages)
+
+## How can I contribute?
+
+### Did you find a bug?
+
+* **Ensure the bug was not already reported** by searching on GitHub under [Issues][Issues].
+
+* If you're unable to find an open issue addressing the problem, [open a new one](https://github.com/Mindsers/configfile/issues/new). Be sure to include a **title and clear description**, as much relevant information as possible, and a **code sample** or an **executable test case** demonstrating the expected behavior that is not occurring.
+
+* If possible, use the relevant bug report templates to create the issue.
+
+### Did you write a patch that fixes a bug?
+
+* Write new unit test(s) that match the bug case to limit future regression.
+
+* Open a new GitHub pull request with the patch.
+
+* Ensure the PR description clearly describes the problem and solution. Include the relevant issue number if applicable.
+
+* Before submitting, please ensure your code follow the code convention.
+
+### Did you fix whitespace, format code, or make a purely cosmetic patch?
+
+* Your changes must follow the coding convention.
+
+* Please ensure that your changes does not include regression.
+
+### Do you intend to add a new feature or change an existing one?
+
+* Please ask first ([open an issue][Issues] or [talk about it on gitter][gitter]) before embarking on any significant pull request (e.g. implementing features, refactoring code), otherwise you risk spending a lot of time working on something that the project's developers might not want to merge into the project.
+
+* Please adhere to the coding conventions used in this project (indentation, accurate comments, etc.) and any other requirements (such as test coverage, documentation).
+
+### Do you have questions about the source code?
+
+* Ask any question about how to use Configfile in the [gitter channel][gitter] or on [Stack Overflow](https://stackoverflow.com).
+
+### Do you want to contribute to the Configfile documentation?
+
+Documentation file are stored in the project source code.
+
+* Please refer to "Do you intend to add a new feature or change an existing one?" section.
+
+## Styleguides
+
+### JavaScript styleguide
+
+All JavaScript must adhere to [JavaScript Standard Style](https://standardjs.com).
+
+Exepctions to Standard style:
+
+* We do not want space after function name `function name(arg) { ... }`
+
+Additional rules:
+
+* Prefer spread operator (`prefer-spread`)
+* No useless brackets for arrow functions (`arrow-body-style`)
+* No useless parens for arrow functions (`arrow-parens`)
+* Require space before/after arrow function’s arrow (`arrow-spacing`)
+* `switch` must have a default case (`default-case`)
+* `for...in` loop must be guard by an `if` (`guard-for-in`)
+* Require space before the star of generator function (`generator-star-spacing`)
+* Getter properties must return a value (`getter-return`)
+* Compare to `-0` is an error (`no-compare-neg-zero`)
+* Use brackets if arrow function body could be confused with comparisons (`no-confusing-arrow`)
+* No `else` when return is used (`no-else-return`)
+* No empty block statements (`no-empty`)
+* No type conversion with shorter notations (`no-implicit-coercion`)
+* No useless `return` statement (`no-useless-return`)
+* No redeclare variables (`no-redeclare`)
+* Using `var` statement is an error (`no-var`)
+* Prefer arrow function for callback (`prefer-arrow-callback`)
+* Prefer using constant (`prefer-const`)
+* Prefer rest parameter (`prefer-rest-params`)
+* Prefer using template literals (`prefer-template`)
+
+All the rules are listed in `.eslinrc.json` on the root directory.
+
+### Git commit messages
+
+* Use the present tense ("Add feature" not "Added feature").
+
+* Use the imperative mood ("Move cursor to..." not "Moves cursor to...").
+
+* Limit the first line to 72 characters or less.
+
+* Reference issues and pull requests liberally after the first line.
+
+
+[Issues]: https://github.com/Mindsers/configfile/issues
+[gitter]: https://gitter.im/mindsers/configfile

README.md

@@ -10,7 +10,7 @@
 
 ## Data storage
 
-This tool **does not store** configuration files for you. A git repo is needed to store your configuration files.
+This tool **does not store** configuration files for you. A git repo ([dotfiles](https://github.com/topics/dotfiles)) is needed to store your configuration files.
 
 Please follow this structure:
 
@@ -25,27 +25,26 @@ Please follow this structure:
     /scriptfile.sh
 ```
 
-## Usage
-
-### Initialization / configuration
-
-`configfile init` Initialize *configfile* on the current user session.
-
-### List of modules
+## Installation
 
-`configfile modules` Display a list of all modules available via *Configfile*.
+To install *Configfile*, you need to use NPM or Yarn.
 
-### Deploy configuration files (module)
-
-`configfile deploy [moduleName...]` Deploy the configuration files for the given module name.
+```bash
+yarn global add configfile@latest
+```
 
-### List of scripts
+## Usage
 
-`configfile scripts` Display a list of all scripts available via *Configfile*.
+- `configfile init` or `configfile i`: Initialize *configfile* on the current user session.
+- `configfile modules list` or `configfile m l`: Display a list of all modules available via *Configfile*.
+- `configfile modules deploy [moduleName...]` or `configfile m d [moduleName...]`: Deploy the configuration files for the given module name.
+    - `-l, --local` deploy authorized file to the current directory.
+- `configfile scripts` or `configfile s`: Display a list of all scripts available via *Configfile*.
+- `configfile scripts run <scriptName>` or `configfile s r <scriptName>`: Execute the script identifying by the given script name.
 
-### Run script
+## Contribution
 
-`configfile run <scriptName>` Execute the script identifying by the given script name.
+Contributions to the source code of *Configfile* are welcomed and greatly appreciated. For help on how to contribute in this project, please refer to [How to contribute to Configfile](https://github.com/Mindsers/configfile/blob/develop/CONTRIBUTING.md).
 
 ## Support
 

bin/configfile-modules.js

@@ -0,0 +1,35 @@
+#!/usr/bin/env node
+
+const program = require('commander')
+const fs = require('fs')
+const path = require('path')
+
+const { deployCommand, modulesCommand } = require('../src/commands')
+
+const { ConfigService } = require('../src/services/config')
+const { FileService } = require('../src/services/file')
+
+const packageData = JSON.parse(fs.readFileSync(path.join(__dirname, '../package.json')))
+const optionsFilePath = packageData.config.optionsFilePath.replace('~', process.env.HOME)
+
+const configService = new ConfigService(optionsFilePath)
+const fileService = new FileService(configService)
+
+program
+  .version(packageData.version)
+  .description('Configuration modules manager.')
+
+program
+  .command('list')
+  .alias('l')
+  .description('list all modules available.')
+  .action(modulesCommand(fileService))
+
+program
+  .command('deploy [modules...]')
+  .alias('d')
+  .description('deploy configuration files.')
+  .option('-l, --local', 'deploy only local files of the module(s) in the current folder')
+  .action(deployCommand(fileService))
+
+program.parse(process.argv)

bin/configfile-scripts.js

@@ -0,0 +1,34 @@
+#!/usr/bin/env node
+
+const program = require('commander')
+const fs = require('fs')
+const path = require('path')
+
+const { runCommand, scriptsCommand } = require('../src/commands')
+
+const { ConfigService } = require('../src/services/config')
+const { FileService } = require('../src/services/file')
+
+const packageData = JSON.parse(fs.readFileSync(path.join(__dirname, '../package.json')))
+const optionsFilePath = packageData.config.optionsFilePath.replace('~', process.env.HOME)
+
+const configService = new ConfigService(optionsFilePath)
+const fileService = new FileService(configService)
+
+program
+  .version(packageData.version)
+  .description('Custom scripts manager.')
+
+program
+  .command('list')
+  .alias('l')
+  .description('list all custom configuration scripts available.')
+  .action(scriptsCommand(fileService))
+
+program
+  .command('run <name>')
+  .alias('r')
+  .description('run custom configuration scripts.')
+  .action(runCommand(configService, fileService))
+
+program.parse(process.argv)

bin/configfile.js

@@ -0,0 +1,35 @@
+#!/usr/bin/env node
+
+const program = require('commander')
+const fs = require('fs')
+const path = require('path')
+
+const { ConfigService } = require('../src/services/config')
+
+const { initCommand } = require('../src/commands')
+
+const packageData = JSON.parse(fs.readFileSync(path.join(__dirname, '../package.json')))
+const optionsFilePath = packageData.config.optionsFilePath.replace('~', process.env.HOME)
+
+const configService = new ConfigService(optionsFilePath)
+
+program
+  .version(packageData.version)
+  .description('Configuration files manager.')
+
+program
+  .command('init')
+  .alias('i')
+  .description('activate configfiles on user session.')
+  .option('-f, --force', 'force parameters file overwrite.')
+  .action(initCommand(configService))
+
+program
+  .command('scripts', 'work with custom scripts available.')
+  .alias('s')
+
+program
+  .command('modules', 'work with modules available.')
+  .alias('m')
+
+program.parse(process.argv)