w-md2docx 1.0.0

package/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 4
+end_of_line = crlf
+insert_final_newline = true
+trim_trailing_whitespace = true

package/.eslintignore

@@ -0,0 +1,3 @@
+/build/
+/config/
+/dist/

package/.eslintrc.js

@@ -0,0 +1,55 @@
+module.exports = {
+    'env': {
+        'browser': true,
+        'es6': true,
+        'mocha': true
+    },
+    'extends': ['plugin:vue/base', 'plugin:vue/essential', 'standard'],
+    'plugins': [
+        'vue'
+    ],
+    'globals': {
+        'Atomics': 'readonly',
+        'SharedArrayBuffer': 'readonly'
+    },
+    'parser': 'vue-eslint-parser',
+    'parserOptions': {
+        'parser': '@babel/eslint-parser',
+        'ecmaVersion': 2019,
+        'sourceType': 'module',
+    },
+    'rules': {
+        'generator-star-spacing': 'off',
+        'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off',
+        'indent': ['error', 4],
+        'no-console': 'off',
+        'comma-dangle': ['error', {
+            'arrays': 'ignore',
+            'objects': 'ignore',
+            'imports': 'never',
+            'exports': 'never',
+            'functions': 'ignore'
+        }],
+        'no-multiple-empty-lines': ['error', { 'max': 2, 'maxEOF': 2 }],
+        //'space-before-function-paren': ['error', { 'anonymous': 'always', 'named': 'never' }],
+        'space-before-function-paren': 'off',
+        'spaced-comment': 'off',
+        'brace-style': ['error', 'stroustrup'],
+        'padded-blocks': 'off',
+        'no-constant-condition': 'off',
+        'camelcase': 'off',
+        'no-new': 'off',
+        'prefer-const': 'off',
+        'quote-props': ['error', 'consistent'],
+        'dot-notation': 'off',
+        'standard/no-callback-literal': 'off',
+        'quotes': ['error', 'single', { 'allowTemplateLiterals': true }],
+        'prefer-promise-reject-errors': 'off',
+        'no-unused-vars': ['error', { 'args': 'none', 'ignoreRestSiblings': true, 'argsIgnorePattern': '^_' }],
+        'node/no-callback-literal': 'off',
+        'prefer-regex-literals': 'off',
+        'array-callback-return': 'off',
+        'no-unreachable-loop': 'off',
+        'vue/multi-word-component-names': 'off',
+    }
+}

package/.jsdoc

@@ -0,0 +1,25 @@
+{
+    "tags": {
+        "allowUnknownTags": true
+    },
+    "source": {
+        "include": ["src/"],
+        "includePattern": ".+\\.(js(doc|x)?|mjs|vue)$",
+        "excludePattern": "(node_modules/|docs)"
+    },
+    "plugins": [
+        "plugins/markdown",
+        "node_modules/jsdoc-vuejs"
+    ],
+    "opts": {
+        "template": "node_modules/docdash",
+        "encoding": "utf8",
+        "destination": "docs/",
+        "recurse": true,
+        "verbose": true
+    },
+    "templates": {
+        "cleverLinks": false,
+        "monospaceLinks": false
+    }
+}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 semisphere(yu-da, lyu 呂昱達)
+
+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,83 @@
+# w-md2docx
+A tool for Markdown to Docx.
+
+![language](https://img.shields.io/badge/language-JavaScript-orange.svg) 
+[![npm version](http://img.shields.io/npm/v/w-md2docx.svg?style=flat)](https://npmjs.org/package/w-md2docx) 
+[![license](https://img.shields.io/npm/l/w-md2docx.svg?style=flat)](https://npmjs.org/package/w-md2docx) 
+[![npm download](https://img.shields.io/npm/dt/w-md2docx.svg)](https://npmjs.org/package/w-md2docx) 
+[![npm download](https://img.shields.io/npm/dm/w-md2docx.svg)](https://npmjs.org/package/w-md2docx) 
+[![jsdelivr download](https://img.shields.io/jsdelivr/npm/hm/w-md2docx.svg)](https://www.jsdelivr.com/package/npm/w-md2docx)
+
+## Documentation
+To view documentation or get support, visit [docs](https://yuda-lyu.github.io/w-md2docx/global.html).
+
+## Core
+> `w-md2docx` is based on `w-md2html` (Markdown to Html) and `w-html2docx` (Html to Docx via `win32com` of `Microsoft Word`), so the docx conversion only runs in `Windows` with `Microsoft Word` installed.
+
+It provides four entries:
+- `cvMdToDocx`: convert a Markdown file to a Docx file.
+- `cvMdTo`: convert Markdown content (with attached assets) to Html/Docx content in base64.
+- `ApiServer`: a hapi service (`GET /api/health`, `GET /api/selftest`, `POST /api/convert`) that wraps `cvMdTo`, so machines without Word can convert through it.
+- `ApiClient`: a client for `ApiServer`, reading a local Markdown file with its images and writing back the converted files.
+
+## Installation
+
+### Using npm(ES6 module):
+```alias
+npm i w-md2docx
+```
+
+#### Example:
+> **Link:** [[dev source code](https://github.com/yuda-lyu/w-md2docx/blob/master/g.mjs)]
+```alias
+import w from 'wsemi'
+import WMd2docx from './src/WMd2docx.mjs'
+//import WMd2docx from 'w-md2docx/src/WMd2docx.mjs'
+//import WMd2docx from 'w-md2docx'
+
+
+async function test() {
+
+    let fpIn = `./test/report.md`
+    let fpOut = `./test/report.docx`
+    let opt = {
+        fpInTemp: './src/templates/temp_tpc.docx', //docx模板, 未給則用w-html2docx內建模板
+        optMd2html: {
+            imgWidthMax: '500px',
+        },
+        optHtml2docx: {
+            imgRatioWidthMax: 0.5,
+        },
+    }
+
+    let r = await WMd2docx.cvMdToDocx(fpIn, fpOut, opt)
+    console.log(r)
+    // => { fpOutDocx: '...\\test\\report.docx', sizeDocx: 40960, sizeHtml: 61785, ms: 6532 }
+
+    w.fsDeleteFile(fpOut)
+
+}
+test()
+    .catch((err) => {
+        console.log('catch', err)
+    })
+```
+
+#### API service and client:
+```alias
+import WMd2docx from 'w-md2docx/src/WMd2docx.mjs'
+
+//server (Windows with Microsoft Word)
+let { server } = await WMd2docx.ApiServer({ port: 22000, token: '' })
+console.log(`listening on ${server.info.uri}`)
+
+//client (any machine)
+let r = await WMd2docx.ApiClient.cvMdTo({
+    host: '127.0.0.1',
+    port: 22000,
+    fpInMd: './test/report.md',
+    fpOutDocx: './test/report.docx',
+})
+console.log(r)
+// => { ms: 6532, nAssets: 1, template: 'default', docx: { fp: '...', size: 40960 } }
+```

package/SECURITY.md

@@ -0,0 +1,5 @@
+# Security Policy
+
+## Reporting a Vulnerability
+
+Please report security issues to `firsemisphere@gmail.com`

package/babel.config.js

@@ -0,0 +1,16 @@
+module.exports = {
+    'presets': [
+        ['@babel/preset-env', {
+            'useBuiltIns': 'entry',
+            'corejs': 3
+        }]
+    ],
+    'plugins': [
+        '@babel/plugin-transform-runtime',
+        '@babel/plugin-proposal-export-default-from',
+        // '@babel/plugin-syntax-import-assertions', //已被棄用
+        // '@babel/plugin-proposal-nullish-coalescing-operator', //browser與nodejs已支援
+        // '@babel/plugin-proposal-object-rest-spread', //browser與nodejs已支援
+        // '@babel/plugin-proposal-optional-chaining', //browser與nodejs已支援
+    ]
+}