Skip to content
This repository has been archived by the owner on Nov 10, 2019. It is now read-only.

Commit

Permalink
feat: create package
Browse files Browse the repository at this point in the history
  • Loading branch information
zkochan committed May 7, 2016
0 parents commit 36786ff
Show file tree
Hide file tree
Showing 10 changed files with 233 additions and 0 deletions.
7 changes: 7 additions & 0 deletions .eslintrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"extends": "standard",
"rules": {
"comma-dangle": [2, "always-multiline"],
"arrow-parens": [2, "as-needed"]
}
}
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
* text eol=lf
33 changes: 33 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -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
17 changes: 17 additions & 0 deletions .travis.yml
Original file line number Diff line number Diff line change
@@ -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
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -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.
55 changes: 55 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
<!--@'# ' + package.name-->
# mos-plugin-markdownscript
<!--/@-->

<!--@'> ' + package.description-->
> A [mos](https://github.com/zkochan/mos) plugin that adds markownscript helpers to the markdown scope
<!--/@-->
<!--@shields.flatSquare('npm', 'travis', 'coveralls')-->
[![NPM version](https://img.shields.io/npm/v/mos-plugin-markdownscript.svg?style=flat-square)](https://www.npmjs.com/package/mos-plugin-markdownscript) [![Build status for master](https://img.shields.io/travis/zkochan/mos-plugin-markdownscript/master.svg?style=flat-square)](https://travis-ci.org/zkochan/mos-plugin-markdownscript) [![Test coverage for master](https://img.shields.io/coveralls/zkochan/mos-plugin-markdownscript/master.svg?style=flat-square)](https://coveralls.io/r/zkochan/mos-plugin-markdownscript?branch=master)
<!--/@-->

<!--@installation()-->
## Installation

This module is installed via npm:

```sh
npm install mos-plugin-markdownscript --save
```
<!--/@-->

<!--@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-markdownscript/master.svg?style=flat-square)](https://david-dm.org/zkochan/mos-plugin-markdownscript/master)

- [markdownscript](https://github.com/zkochan/markdownscript): Creates markdown Abstract Syntax Tree
- [reserved-words](https://github.com/zxqfox/reserved-words): ECMAScript reserved words checker

<!--/@-->

<!--@devDependencies({ shield: 'flat-square' })-->
## <a name="dev-dependencies">Dev Dependencies</a> [![devDependency status for master](https://img.shields.io/david/dev/zkochan/mos-plugin-markdownscript/master.svg?style=flat-square)](https://david-dm.org/zkochan/mos-plugin-markdownscript/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

<!--/@-->
11 changes: 11 additions & 0 deletions index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
'use strict'
module.exports = plugin

const m = require('markdownscript')
const reserved = require('reserved-words')

function plugin (markdown) {
const scope = { m }
Object.keys(m).filter(key => !reserved.check(key, 'next')).forEach(key => { scope[key] = m[key] })
return scope
}
15 changes: 15 additions & 0 deletions index.spec.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
'use strict'
const describe = require('mocha').describe
const it = require('mocha').it
const expect = require('chai').expect

const markdownscriptPlugin = require('.')

describe('mos-plugin-markdownscript', () => {
it('should extend markdown scope with markdownscript helpers', () => {
const scope = markdownscriptPlugin({})
expect(scope.m).to.be.a('function')
expect(scope.h1).to.be.a('function')
expect(scope.blockquote).to.be.a('function')
})
})
72 changes: 72 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
{
"name": "mos-plugin-markdownscript",
"version": "0.0.0-placeholder",
"description": "A [mos](https://github.com/zkochan/mos) plugin that adds markownscript helpers to the markdown scope",
"files": [
"index.js"
],
"main": "index.js",
"preferDev": true,
"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-markdownscript"
},
"keywords": [
"mos-plugin",
"markdownscript"
],
"author": {
"name": "Zoltan Kochan",
"email": "zoltan.kochan@gmail.com",
"url": "http://kochan.io"
},
"license": "MIT",
"bugs": {
"url": "https://github.com/zkochan/mos-plugin-markdownscript/issues"
},
"homepage": "https://github.com/zkochan/mos-plugin-markdownscript#readme",
"dependencies": {
"markdownscript": "^1.1.0",
"reserved-words": "^0.1.1"
},
"devDependencies": {
"chai": "^3.4.1",
"cz-conventional-changelog": "1.1.5",
"eslint": "^2.8.0",
"eslint-config-standard": "^5.1.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"
},
"peerDependencies": {
"mos": "^0.16.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"
}
}
}
1 change: 1 addition & 0 deletions test/mocha.opts
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
{lib/**/*,index}.spec.js

0 comments on commit 36786ff

Please sign in to comment.