改造成npm模块

Author: kscript

.npmignore

@@ -0,0 +1,4 @@
+.github
+/node_modules
+/src
+webpack.config.js

README.md

@@ -1,7 +1,7 @@
 # markdown-download
 markdown文档下载 chrome插件
 
-## 使用方法
+## 作为插件使用
 1. 在命令行中执行拉取/安装/打包
 ``` cmd
 git clone https://github.com/kscript/download-markdown
@@ -14,6 +14,32 @@ npm run build
 3. 选择`加载已解压的扩展程序`, 选中项目打包后的dist文件夹
 4. 访问已支持的网站的文章详情页面, 等待文章内图片全部加载后, 点击插件图标
 
+## 作为模块使用
+### 安装
+```
+npm i markdown-downloader
+```
+### 使用
+> 由于会操作dom元素, 所以运行时需要在浏览器环境下
+``` js
+// 方式1. 导入模块
+import markdownDownload, { convert, download, websiteConfigs } from 'markdown-downloader'
+markdownDownload(websiteConfigs.juejin, {
+	// 包含所有信息的innerHTML文本
+	context: ``
+})
+```
+```html
+<!-- 方式2. 直接使用脚本文件 -->
+<script src="./markdownDownload.js"></script>
+<script>
+	// 给window对象添加一个markdownDownload函数, convert, download, websiteConfigs作为其属性
+	markdownDownload(markdownDownload.websiteConfigs.juejin, {
+		// 包含所有信息的innerHTML文本
+		context: ``
+	})
+</script>
+```
 
 ## 已支持的网站
 [掘金](https://juejin.cn/)  

build/copy.js

@@ -1,20 +1,26 @@
 {
-  "name": "markdown-download",
+  "name": "markdown-downloader",
   "version": "1.0.0",
-  "description": "",
-  "main": "index.js",
+  "description": "markdown文章下载",
+  "main": "dist/index.js",
   "scripts": {
     "build": "npx webpack",
-    "release": "npm run build && node build/copy.js",
-    "zip": "node build/zip.js",
+    "release": "cross-env BUILD_MODE=npm npm run build",
     "test": "echo \"Error: no test specified\" && exit 1"
   },
   "repository": {
     "type": "git",
-    "url": "git+https://kscript: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@github.com/kscript/markdown-download.git"
+    "url": "git+https://github.com/kscript/markdown-download.git"
   },
-  "keywords": [],
-  "author": "",
+  "keywords": [
+    "markdown",
+    "download",
+    "chrome",
+    "extension",
+    "hexo",
+    "html2markdown"
+  ],
+  "author": "luren",
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/kscript/markdown-download/issues"
@@ -33,15 +39,13 @@
     "babel-runtime": "^6.26.0",
     "copy-webpack-plugin": "^9.0.1",
     "core-js": "^2.6.12",
+    "cross-env": "^7.0.3",
     "html-to-md": "^0.5.3",
     "jszip": "^3.7.1",
     "md5": "^2.3.0",
+    "path-browserify": "^1.0.1",
     "webpack": "^5.63.0",
-    "webpack-cli": "^4.9.1"
-  },
-  "dependencies": {
-    "fs-extra": "^10.0.0",
-    "path": "^0.12.7",
-    "path-browserify": "^1.0.1"
+    "webpack-cli": "^4.9.1",
+    "webpack-merge": "^5.8.0"
   }
 }

build/zip.js

@@ -1,72 +1,5 @@
-import md5 from 'md5'
-import JSZip from 'jszip'
-import FileSaver from 'jszip/vendor/FileSaver'
 import { configs } from './websites'
-const noop = (func, defaultFunc) => {
-  return typeof func === 'function' ? func : typeof defaultFunc === 'function' ? defaultFunc : () => {}
-}
-
-const ajax = (options) => {
-  var xhr = new XMLHttpRequest()
-  options.method = options.method || 'get'
-  xhr.responseType = options.dataType || 'json';
-  xhr.onreadystatechange = () => {
-    if (xhr.readyState == 4) {
-      try {
-        noop(options.success)(xhr.response, xhr)
-      } catch (err) {
-        noop(options.error)(err, xhr)
-      }
-    }
-  }
-  xhr.error = (err) => {
-    console.log(err)
-    noop(options.error)(err, xhr)
-  }
-  if (/post/i.test(options.method)) {
-    xhr.open(options.method, options.url, options.async !== false)
-    xhr.setRequestHeader('Content-type', /json/i.test(options.dataType) ? 'application/json' : 'application/x-www-form-urlencoded')
-    xhr.send(options.data)
-  } else {
-    xhr.open(options.method, options.url, options.async !== false)
-    xhr.send()
-  }
-}
-
-const downloadZip = (files, fileName) => {
-  fileName = fileName || md5(files.map(item => item.downloadUrl).join('|'))
-  const zip = new JSZip()
-  const fetchFile = (file) =>{
-    return new Promise((resolve, reject) => {
-      if (file.content) {
-        const blob = new Blob([file.content], {type : file.type || 'text/plain'})
-        zip.file(file.name, blob)
-        resolve(blob)
-      } else {
-        ajax({
-          url: file.downloadUrl,
-          type: 'get',
-          data: '',
-          dataType: 'blob',
-          success: (blob) => {
-            zip.file(file.name, blob);
-            resolve(blob)
-          },
-          error: reject
-        })
-      }
-    })
-  }
-  return Promise.all(
-    files.map(file => fetchFile(file))
-  ).then((datas) => {
-    zip.generateAsync({
-      type: "blob"
-    }).then(function(content) {
-      FileSaver(content, fileName + '.zip');
-    })
-  })
-}
+import downloadZip from './download'
 
 chrome.runtime.onMessage.addListener((message, sender, sendResponse) => {
   const getHeaders = (xhr) => {
@@ -111,7 +44,7 @@ chrome.runtime.onMessage.addListener((message, sender, sendResponse) => {
       }
     })
   } else if (message.type === 'download') {
-    downloadZip(message.files, message.fileName)
+    downloadZip(message.fileName, message.files)
   }
   return true
 })

package-lock.json

@@ -0,0 +1,19 @@
+import convert from './'
+import download from './download'
+import { configs as websiteConfigs } from './websites'
+
+export { convert, download, websiteConfigs }
+
+export const markdownDownload = (options, customOptions) => {
+	const {fileName, files} = convert(options, customOptions)
+	download(fileName, files)
+}
+
+if (typeof window !== 'undefined') {
+	markdownDownload.websiteConfigs = websiteConfigs
+	markdownDownload.convert = convert
+	markdownDownload.download = download
+	window.markdownDownload = markdownDownload
+}
+
+export default markdownDownload

package.json

@@ -0,0 +1,70 @@
+import md5 from 'md5'
+import JSZip from 'jszip'
+import FileSaver from 'jszip/vendor/FileSaver'
+const noop = (func, defaultFunc) => {
+  return typeof func === 'function' ? func : typeof defaultFunc === 'function' ? defaultFunc : () => {}
+}
+
+const ajax = (options) => {
+  var xhr = new XMLHttpRequest()
+  options.method = options.method || 'get'
+  xhr.responseType = options.dataType || 'json';
+  xhr.onreadystatechange = () => {
+    if (xhr.readyState == 4) {
+      try {
+        noop(options.success)(xhr.response, xhr)
+      } catch (err) {
+        noop(options.error)(err, xhr)
+      }
+    }
+  }
+  xhr.error = (err) => {
+    console.log(err)
+    noop(options.error)(err, xhr)
+  }
+  if (/post/i.test(options.method)) {
+    xhr.open(options.method, options.url, options.async !== false)
+    xhr.setRequestHeader('Content-type', /json/i.test(options.dataType) ? 'application/json' : 'application/x-www-form-urlencoded')
+    xhr.send(options.data)
+  } else {
+    xhr.open(options.method, options.url, options.async !== false)
+    xhr.send()
+  }
+}
+
+export const downloadZip = (fileName, files) => {
+  fileName = fileName || md5(files.map(item => item.downloadUrl).join('|'))
+  const zip = new JSZip()
+  const fetchFile = (file) =>{
+    return new Promise((resolve, reject) => {
+      if (file.content) {
+        const blob = new Blob([file.content], {type : file.type || 'text/plain'})
+        zip.file(file.name, blob)
+        resolve(blob)
+      } else {
+        ajax({
+          url: file.downloadUrl,
+          type: 'get',
+          data: '',
+          dataType: 'blob',
+          success: (blob) => {
+            zip.file(file.name, blob);
+            resolve(blob)
+          },
+          error: reject
+        })
+      }
+    })
+  }
+  return Promise.all(
+    files.map(file => fetchFile(file))
+  ).then((datas) => {
+    zip.generateAsync({
+      type: "blob"
+    }).then(function(content) {
+      FileSaver(content, fileName + '.zip');
+    })
+  })
+}
+
+export default downloadZip