feat: create package

.eslintrc

@@ -0,0 +1,7 @@
+{
+  "extends": "standard",
+  "rules": {
+    "comma-dangle": [2, "always-multiline"],
+    "arrow-parens": [2, "as-needed"]
+  }
+}

.gitattributes

@@ -0,0 +1 @@
+* text eol=lf

.gitignore

@@ -0,0 +1,33 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directory
+node_modules
+
+# Optional npm cache directory
+.npm
+
+# Optional REPL history
+.node_repl_history

.travis.yml

@@ -0,0 +1,17 @@
+language: node_js
+sudo: false
+node_js:
+  - v4
+
+cache:
+  directories:
+    - node_modules
+
+before_install:
+  - npm install -g npm@3
+install:
+  - npm install
+
+after_success:
+  - npm run coveralls
+  - npm run semantic-release

LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Zoltan Kochan
+
+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

@@ -0,0 +1,76 @@
+<!--@'# ' + package.name-->
+# mos-plugin-installation
+<!--/@-->
+
+<!--@'> ' + package.description-->
+> A mos plugin for creating installation section
+<!--/@-->
+
+<!--@shields.flatSquare('npm', 'travis', 'coveralls')-->
+[![NPM version](https://img.shields.io/npm/v/mos-plugin-installation.svg?style=flat-square)](https://www.npmjs.com/package/mos-plugin-installation) [![Build status for master](https://img.shields.io/travis/zkochan/mos-plugin-installation/master.svg?style=flat-square)](https://travis-ci.org/zkochan/mos-plugin-installation) [![Test coverage for master](https://img.shields.io/coveralls/zkochan/mos-plugin-installation/master.svg?style=flat-square)](https://coveralls.io/r/zkochan/mos-plugin-installation?branch=master)
+<!--/@-->
+
+<!--@installation()-->
+## Installation
+
+This module is installed via npm:
+
+```sh
+npm install mos-plugin-installation --save
+```
+<!--/@-->
+
+## Usage
+
+Add this code snippet to your `README.md`
+
+```md
+<!--@installation()-->
+<!--/@-->
+```
+
+Run `mos` in the terminal.
+
+You'll get an installation section in your README that will instruct how to install the package via npm.
+
+The plugin will use information from the `package.json` in order to figure out what should the installation command look like.
+
+- If there is a `preferGlobal: true` specified in the `package.json`, the generated command will be `npm install --global`
+- If there is a `private: true`, the command instruction will suggest to clone the repo and install its dependencies
+- Otherwise, the generated command will be `npm install --save`
+
+## API
+
+`installation()`
+
+<!--@license()-->
+## License
+
+[MIT](./LICENSE) © [Zoltan Kochan](http://kochan.io)
+<!--/@-->
+
+* * *
+
+<!--@dependencies({ shield: 'flat-square' })-->
+## <a name="dependencies">Dependencies</a> [![Dependency status for master](https://img.shields.io/david/zkochan/mos-plugin-installation/master.svg?style=flat-square)](https://david-dm.org/zkochan/mos-plugin-installation/master)
+
+None
+<!--/@-->
+
+<!--@devDependencies({ shield: 'flat-square' })-->
+## <a name="dev-dependencies">Dev Dependencies</a> [![devDependency status for master](https://img.shields.io/david/dev/zkochan/mos-plugin-installation/master.svg?style=flat-square)](https://david-dm.org/zkochan/mos-plugin-installation/master#info=devDependencies)
+
+- [chai](https://github.com/chaijs/chai): BDD/TDD assertion library for node.js and the browser. Test framework agnostic.
+- [cz-conventional-changelog](https://github.com/commitizen/cz-conventional-changelog): Commitizen adapter following the conventional-changelog format.
+- [eslint](https://github.com/eslint/eslint): An AST-based pattern checker for JavaScript.
+- [eslint-config-standard](https://github.com/feross/eslint-config-standard): JavaScript Standard Style - ESLint Shareable Config
+- [eslint-plugin-promise](https://github.com/xjamundx/eslint-plugin-promise): Enforce best practices for JavaScript promises
+- [eslint-plugin-standard](https://github.com/xjamundx/eslint-plugin-standard): ESlint Plugin for the Standard Linter
+- [ghooks](https://github.com/gtramontina/ghooks): Simple git hooks
+- [istanbul](https://github.com/gotwarlost/istanbul): Yet another JS code coverage tool that computes statement, line, function and branch coverage with module loader hooks to transparently add coverage when running tests. Supports all JS coverage use cases including unit tests, server side functional tests
+- [mocha](https://github.com/mochajs/mocha): simple, flexible, fun test framework
+- [mos](https://github.com/zkochan/mos): A pluggable module that injects content into your markdown files via hidden JavaScript snippets
+- [semantic-release](https://github.com/semantic-release/semantic-release): automated semver compliant package publishing
+- [validate-commit-msg](https://github.com/kentcdodds/validate-commit-msg): Script to validate a commit message follows the conventional changelog standard
+
+<!--/@-->

index.js

@@ -0,0 +1,10 @@
+'use strict'
+module.exports = plugin
+
+const renderInstallation = require('./lib/render-installation')
+
+function plugin (markdown) {
+  return {
+    installation: () => renderInstallation(markdown),
+  }
+}

index.spec.js

@@ -0,0 +1,2 @@
+'use strict'
+require('.')

lib/render-installation.js

@@ -0,0 +1,24 @@
+'use strict'
+const m = require('markdownscript')
+const h2 = m.h2
+const p = m.paragraph
+const code = m.code
+
+module.exports = md => [
+  h2(['Installation']),
+  p(['This module is installed via npm:']),
+  code({
+    lang: 'sh',
+    value: createCommand(md),
+  }),
+]
+
+function createCommand (md) {
+  if (md.pkg.private || md.pkg.license === 'private') {
+    return [
+      `git clone ${md.repo.clone_url} && cd ./${md.repo.repo}`,
+      'npm install',
+    ].join('\n')
+  }
+  return `npm install ${md.pkg.name} ${md.pkg.preferGlobal ? '--global' : '--save'}`
+}

lib/render-installation.spec.js

@@ -0,0 +1,116 @@
+'use strict'
+const describe = require('mocha').describe
+const it = require('mocha').it
+const expect = require('chai').expect
+const m = require('markdownscript')
+const heading = m.heading
+const text = m.text
+const paragraph = m.paragraph
+const code = m.code
+
+const renderInstallation = require('./render-installation')
+
+describe('createInstallation', () => {
+  it('should create installation section for global package', () => {
+    const pkg = {
+      name: 'foo',
+      preferGlobal: 'MIT',
+    }
+    const installation = renderInstallation({pkg})
+    expect(installation).to.eql([
+      heading({ depth: 2 }, [
+        text({
+          value: 'Installation',
+        }),
+      ]),
+      paragraph([
+        text({
+          value: 'This module is installed via npm:',
+        }),
+      ]),
+      code({
+        lang: 'sh',
+        value: 'npm install foo --global',
+      }),
+    ])
+  })
+
+  it('should create installation section for local package', () => {
+    const pkg = {
+      name: 'foo',
+    }
+    const installation = renderInstallation({pkg})
+    expect(installation).to.eql([
+      heading({ depth: 2 }, [
+        text({
+          value: 'Installation',
+        }),
+      ]),
+      paragraph([
+        text({
+          value: 'This module is installed via npm:',
+        }),
+      ]),
+      code({
+        lang: 'sh',
+        value: 'npm install foo --save',
+      }),
+    ])
+  })
+
+  it('should create installation section for private package', () => {
+    const pkg = {
+      name: 'foo',
+      private: true,
+    }
+    const repo = {
+      repo: 'foo',
+      clone_url: 'https://github.com/zkochan/foo',
+    }
+    const installation = renderInstallation({pkg, repo})
+    expect(installation).to.eql([
+      heading({ depth: 2 }, [
+        text({
+          value: 'Installation',
+        }),
+      ]),
+      paragraph([
+        text({
+          value: 'This module is installed via npm:',
+        }),
+      ]),
+      code({
+        lang: 'sh',
+        value: 'git clone https://github.com/zkochan/foo && cd ./foo\nnpm install',
+      }),
+    ])
+  })
+
+  it('should create installation section for package with private license', () => {
+    const pkg = {
+      name: 'foo',
+      license: 'private',
+    }
+    const repo = {
+      repo: 'foo',
+      clone_url: 'https://github.com/zkochan/foo',
+    }
+    const installation = renderInstallation({pkg, repo})
+    expect(installation).to.eql([
+      heading({ depth: 2 }, [
+        text({
+          value: 'Installation',
+        }),
+      ]),
+      paragraph([
+        text({
+          value: 'This module is installed via npm:',
+        }),
+      ]),
+      code({
+        lang: 'sh',
+        value: 'git clone https://github.com/zkochan/foo && cd ./foo\nnpm install',
+      }),
+    ])
+  })
+})

package.json

@@ -0,0 +1,65 @@
+{
+  "name": "mos-plugin-installation",
+  "version": "0.0.0-placeholder",
+  "description": "A mos plugin for creating installation section",
+  "files": [
+    "index.js"
+  ],
+  "main": "index.js",
+  "scripts": {
+    "test": "mocha && npm run lint && mos test",
+    "lint": "eslint lib/**/*.js index.js",
+    "commit": "git-cz",
+    "coverage": "istanbul cover -x \"**/*.spec.js\" node_modules/mocha/bin/_mocha -- -R spec",
+    "precoveralls": "istanbul cover -x \"**/*.spec.js\" node_modules/mocha/bin/_mocha --report lcovonly -- -R spec && npm i coveralls@2",
+    "coveralls": "cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js",
+    "postcoveralls": "rm -rf ./coverage",
+    "md": "mos",
+    "semantic-release": "semantic-release pre && npm publish && semantic-release post"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/zkochan/mos-plugin-installation"
+  },
+  "keywords": [
+    "mos-plugin",
+    "installation"
+  ],
+  "author": {
+    "name": "Zoltan Kochan",
+    "email": "zoltan.kochan@gmail.com",
+    "url": "http://kochan.io"
+  },
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/zkochan/mos-plugin-installation/issues"
+  },
+  "homepage": "https://github.com/zkochan/mos-plugin-installation#readme",
+  "dependencies": {},
+  "devDependencies": {
+    "chai": "^3.4.1",
+    "cz-conventional-changelog": "1.1.5",
+    "eslint": "^2.9.0",
+    "eslint-config-standard": "^5.3.0",
+    "eslint-plugin-promise": "^1.1.0",
+    "eslint-plugin-standard": "^1.3.2",
+    "ghooks": "^1.2.1",
+    "istanbul": "^0.4.2",
+    "mocha": "^2.3.4",
+    "mos": "^0.16.1",
+    "semantic-release": "^4.3.5",
+    "validate-commit-msg": "^2.6.1"
+  },
+  "engines": {
+    "node": ">=4"
+  },
+  "config": {
+    "commitizen": {
+      "path": "./node_modules/cz-conventional-changelog"
+    },
+    "ghooks": {
+      "commit-msg": "node ./node_modules/validate-commit-msg/index.js",
+      "pre-commit": "npm test"
+    }
+  }
+}

test/mocha.opts

@@ -0,0 +1 @@
+{lib/**/*,index}.spec.js