Merge pull request #54 from blackflux/dev

[Gally]: master <- dev

.roboconfig.json

@@ -0,0 +1,15 @@
+{
+  "tasks": [
+    "assorted/@npm-opensource",
+    "jetbrains/@default",
+    "editor/@default"
+  ],
+  "variables": {
+    "repoKey": "blackflux/robo-config",
+    "repoName": "robo-config",
+    "projectName": "robo-config",
+    "owner": "simlu",
+    "authorName": "Lukas Siemon",
+    "mergeBot": "MrsFlux"
+  }
+}

CONFDOCS.md

@@ -0,0 +1,233 @@
+# Codebase Configuration Documentation
+
+Documents configuration tasks managed by [robo-config](https://github.com/blackflux/robo-config).
+
+## `assorted/@npm-opensource`
+
+Manage various configuration files for an open source npm github repo.
+
+<details>
+  <summary>Details</summary>
+
+### `badges/@npm-opensource`
+
+Display various badges in README.
+
+  <details>
+    <summary>Details</summary>
+
+#### badges/js-gardener
+
+_Updating `README.md` using `merge-below-title`._
+
+_Requires `js-gardener`._
+
+- Display [js-gardener](https://github.com/blackflux/js-gardener) badge in README.
+
+#### badges/semantic-release
+
+_Updating `README.md` using `merge-below-title`._
+
+_Requires `semantic-release`._
+
+- Display [semantic-release](https://github.com/semantic-release/semantic-release) badge in README.
+
+#### badges/npm-downloads
+
+_Updating `README.md` using `merge-below-title`._
+
+_Requires `npm-published`._
+
+- Display [npm downloads](https://www.npmjs.com/) badge in README.
+
+#### badges/npm-status
+
+_Updating `README.md` using `merge-below-title`._
+
+_Requires `npm-published`._
+
+- Display [npm status](https://www.npmjs.com/) badge in README.
+
+#### badges/david-dm
+
+_Updating `README.md` using `merge-below-title`._
+
+_Requires `david-dm`._
+
+- Display [david-dm.com](https://david-dm.org/) badge in README.
+
+#### badges/dependabot
+
+_Updating `README.md` using `merge-below-title`._
+
+_Requires `dependabot`._
+
+- Display [dependabot](https://dependabot.com/) badge in README.
+
+#### badges/coveralls
+
+_Updating `README.md` using `merge-below-title`._
+
+_Requires `coveralls`._
+
+- Display [coveralls](https://coveralls.io/) badge in README.
+
+#### badges/circleci
+
+_Updating `README.md` using `merge-below-title`._
+
+_Requires `circleci`._
+
+- Display [circleci](https://circleci.com/) badge in README.
+
+  </details>
+
+### `dependabot/@default-js`
+
+Recommended base [dependabot configuration](https://dependabot.com/) for javascript projects.
+
+  <details>
+    <summary>Details</summary>
+
+#### dependabot/js-instant
+
+_Updating `.dependabot/config.yml` using `overwrite`._
+
+_Requires `dependabot`, `github`, `javascript`._
+
+- Configure dependabot to instantly merge javascript dependency updates into the `dev` branch.
+
+  </details>
+
+### `git/@default`
+
+Recommended base configuration when using [git](https://en.wikipedia.org/wiki/Git).
+
+  <details>
+    <summary>Details</summary>
+
+#### git/gitignore
+
+_Updating `.gitignore` using `merge-top`._
+
+_Requires `git`._
+
+- Inject recommended entries into [gitignore file](https://help.github.com/en/articles/ignoring-files).
+- Default ignores for JetBrains IDE.
+- Default ignores for OSX
+- Default ignores for NodeJs
+
+  </details>
+
+### `license/@MIT-npm`
+
+Recommended base configuration when using MIT License with npm.
+
+  <details>
+    <summary>Details</summary>
+
+#### license/MIT-LICENSE
+
+_Updating `LICENSE` using `overwrite`._
+
+- Generate [MIT license](https://en.wikipedia.org/wiki/MIT_License) file.
+
+#### license/MIT-npm
+
+_Updating `package.json` using `merge-shallow`._
+
+_Requires `npm`._
+
+- Link MIT license file into [npm](https://www.npmjs.com/) configuration.
+
+  </details>
+
+### `npm/@default`
+
+Recommended base configuration when using [npm](https://www.npmjs.com/).
+
+  <details>
+    <summary>Details</summary>
+
+#### npm/npmignore
+
+_Updating `.npmignore` using `merge-top`._
+
+_Requires `npm`._
+
+- Inject comment into .npmignore explaining when to use it.
+
+  </details>
+
+### `semantic-release/@default`
+
+Recommended base configuration when using [semantic-release](https://github.com/semantic-release/semantic-release).
+
+  <details>
+    <summary>Details</summary>
+
+#### semantic-release/commit-conventions
+
+_Updating `.releaserc.json` using `overwrite`._
+
+_Requires `semantic-release`._
+
+- Slightly extended [release commit convention](https://github.com/semantic-release/semantic-release#commit-message-format) for semantic-release.
+
+  </details>
+
+### circleci/npm-opensource:two-branch
+
+_Updating `.circleci/config.yml` using `overwrite`._
+
+_Requires `npm`, `yarn`, `gally`, `github`, `circleci`, `coveralls`, `dependabot`, `semantic-release`._
+
+- Restrictive two-branch [gally](https://github.com/loopmediagroup/gally#readme) config. Custom for npm open source packages.
+- TODO
+
+### gally/npm-opensource:two-branch
+
+_Updating `.gally.json` using `overwrite`._
+
+_Requires `circleci`, `gally`, `github`._
+
+- Restrictive two-branch [gally](https://github.com/loopmediagroup/gally#readme) config. Custom for npm open source packages.
+- TODO ...
+
+</details>
+
+## `jetbrains/@default`
+
+Recommended base configuration when using Jetbrains.
+
+<details>
+  <summary>Details</summary>
+
+### jetbrains/exclude-coverage-folder
+
+_Updating `.idea/${projectName}.iml` using `xml-merge`._
+
+_Requires `jetbrains`, `nyc`._
+
+- Mark `coverage` Folder as excluded in Jetbrains.
+
+</details>
+
+## `editor/@default`
+
+Recommended base [code editor configuration](https://editorconfig.org/).
+
+<details>
+  <summary>Details</summary>
+
+### editor/two-space
+
+_Updating `.editorconfig` using `overwrite`._
+
+- Two space line indentation.
+- Set `lf` line endings.
+- Set `utf8` encoding.
+- Remove unnecessary whitespaces.
+
+</details>
+

README.md

@@ -13,7 +13,7 @@ Automatically manage configuration files.
 
 ## But why...?
 
-_Why the hell does this package even exist?_ -
+_Why does this package even exist?_ -
 Let's face it, without npm and micro-services this repo would probably not exist. 
 Npm has encouraged us to create a new repo and package for every 
 re-usable code snippet. This is great from the re-usability perspective,
@@ -35,8 +35,8 @@ you will inadvertently forget to apply the change to some repos. That's where th
 
 ### Sounds scary...?
 
-Simply pick the config (set) that is most appropriate for your repo or create your own (prs are welcome).
-Config snippets are reused as appropriate. A change to a snippet will then quickly make it to every repository using it.
+Simply pick the task(s) that is most appropriate for your repo or create your own (prs are encouraged).
+Tasks and snippets are reused as appropriate. A change to a snippet will then quickly make it to every repository using it.
 
 Sounds scary?
 Consider that configuration changes are tied to version updates of this package and can not be
@@ -52,6 +52,6 @@ It does not do it automatically or silently.
 
 ...
 
-## Assorted Configs
+## Assorted Tasks
 
-- [Npm Open Source](docs/configs/assorted/npm-opensource.md)
+All usable tasks are documented [here](src/docs).

package.json

@@ -40,7 +40,7 @@
     "babel-eslint": "10.0.1",
     "chai": "4.2.0",
     "coveralls": "3.0.3",
-    "eslint": "5.15.1",
+    "eslint": "5.15.2",
     "js-gardener": "1.38.4",
     "nyc": "13.3.0",
     "semantic-release": "15.13.3",
@@ -97,6 +97,6 @@
     "lodash.difference": "4.5.0",
     "object-deep-contain": "1.0.4",
     "object-scan": "5.0.3",
-    "smart-fs": "1.3.0"
+    "smart-fs": "1.4.1"
   }
 }