@dice-roller/vuepress-plugin-dice-roller 0.1.9

package/LICENSE.txt

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2020 - 2021 GreenImp Limited
+Copyright (c) 2021 - present GreenImp Media Limited
+
+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.

package/README.md

@@ -0,0 +1,51 @@
+<p align="center">
+    <img src="https://greenimp.github.io/rpg-dice-roller/hero.svg" alt="RPG Dice Roller" style="max-width: 100%;" width="180"/>
+</p>
+
+# RPG Dice Roller Vuepress Plugin
+
+Plugin for [VuePress](https://vuepress.vuejs.org/) that allows rolling dice.
+
+It is built upon this [RPG dice roller](https://github.com/GreenImp/rpg-dice-roller), and is used in the [documentation](https://greenimp.github.io/rpg-dice-roller).
+
+
+## Install
+
+Install the plugin:
+
+```bash
+npm install -D @dice-roller/vuepress-plugin
+# Or
+yarn add -D @dice-roller/vuepress-plugin
+```
+
+Then add the plugin to your Vuepress config file:
+
+```javascript
+module.exports = {
+  ...
+  plugins: [
+    ...
+    'dice-roller',
+  ],
+};
+```
+
+
+## Usage
+
+You can add a dice roller anywhere by using the following markdown syntax, where `{notation}` is the optional notation to pre-fill the input with:
+
+```
+::: roll {notation} :::
+```
+
+For example:
+
+```
+::: roll 4d6 ::
+```
+
+```
+::: roll (2*6)d10 / (4 - d20) :::
+```

package/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@dice-roller/vuepress-plugin-dice-roller",
+  "version": "0.1.9",
+  "description": "Plugin for VuePress that allows rolling dice",
+  "main": "src/index.js",
+  "scripts": {
+    "serve": "vue-cli-service serve",
+    "build": "vue-cli-service build",
+    "lint": "vue-cli-service lint",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/dice-roller/vuepress-plugin.git"
+  },
+  "keywords": [
+    "vuepress",
+    "dice",
+    "roll"
+  ],
+  "author": "GreenImp Media <info@greenimp.co.uk> (http://greenimp.co.uk)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/dice-roller/vuepress-plugin/issues"
+  },
+  "homepage": "https://github.com/dice-roller/vuepress-plugin",
+  "dependencies": {
+    "@dice-roller/vue": "^0.1.8",
+    "core-js": "^3.6.5",
+    "markdown-it-container": "^2.0.0",
+    "vue": "^2.6.12"
+  },
+  "devDependencies": {
+    "@vue/cli-plugin-babel": "~4.3.0",
+    "@vue/cli-plugin-eslint": "~4.3.0",
+    "@vue/cli-service": "~4.3.0",
+    "@vue/eslint-config-airbnb": "^5.1.0",
+    "babel-eslint": "^10.1.0",
+    "eslint": "^6.7.2",
+    "eslint-plugin-import": "^2.22.0",
+    "eslint-plugin-vue": "^6.2.2",
+    "vue-template-compiler": "^2.6.12"
+  }
+}

package/src/enhanceAppFile.js

@@ -0,0 +1,5 @@
+import DiceRoller from '@dice-roller/vue';
+
+export default ({ Vue }) => {
+  Vue.component('DiceRoller', DiceRoller);
+};

package/src/index.js

@@ -0,0 +1,26 @@
+const markdownItContainer = require('markdown-it-container');
+const path = require('path');
+
+function render(tokens, idx) {
+  const { nesting, info } = tokens[idx];
+
+  if (nesting === 1) {
+    // opening tag
+    const [, notation] = info.trim().match(/roll\s+(.*?(?=\s*:::))/);
+
+    return `<DiceRoller notation="${notation}"/>`;
+  }
+
+  // closing tag
+  return '';
+}
+
+module.exports = (options = {}) => ({
+  name: 'vuepress-plugin-dice-roller',
+  enhanceAppFiles: [
+    path.resolve(__dirname, 'enhanceAppFile.js'),
+  ],
+  extendMarkdown: (md) => {
+    md.use(markdownItContainer, 'roll', { render });
+  },
+});