style: code formatter config

Author: alphawq

.eslintrc.js

@@ -0,0 +1,21 @@
+module.exports = {
+  env: {
+    browser: true,
+    es2021: true,
+    node: true
+  },
+  extends: ['plugin:@typescript-eslint/recommended', 'plugin:prettier/recommended'],
+  parser: '@typescript-eslint/parser',
+  parserOptions: {
+    ecmaVersion: 12,
+    sourceType: 'module'
+  },
+  plugins: ['@typescript-eslint'],
+  rules: {
+    // 允许方法不设置参数类型以及返回值类型
+    '@typescript-eslint/explicit-module-boundary-types': 0,
+    allowArgumentsExplicitlyTypedAsAny: 0,
+    'no-unused-vars': 'off',
+    '@typescript-eslint/no-unused-vars': ['off']
+  }
+}

.husky/commit-msg

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn commitlint --edit $1

.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+yarn lint-staged

.npmignore

@@ -11,3 +11,7 @@ __tests__
 src
 tsconfig.json
 node_modules
+.eslintrc.js
+.prettierrc.js
+.husky
+commitlint.config.js

.prettierrc.js

@@ -0,0 +1,10 @@
+module.exports = {
+  printWidth: 120,
+  semi: false,
+  singleQuote: true,
+  bracketSpacing: true,
+  arrowParens: 'avoid',
+  tabWidth: 2,
+  useTabs: false,
+  trailingComma: 'none'
+}

CHANGELOG.md

@@ -0,0 +1,12 @@
+# Change Log
+
+All notable changes to this project will be documented in this file.
+See [Conventional Commits](https://conventionalcommits.org) for commit guidelines.
+
+## 0.0.2 (2021-09-14)
+
+
+### Bug Fixes
+
+* number secret lead to encrypt failed ([f36df5b](https://github.com/alphawq/vuepress-plugin-posts-encrypt/commit/f36df5bd29524dd04d9ba6ce99fb7e3fafa30534))
+* **vuepress-plugin-posts-encrypt:** number secret lead to encrypt failed ([b893eb9](https://github.com/alphawq/vuepress-plugin-posts-encrypt/commit/b893eb9bbbb543b465edd192954e5ec29610ddcd))

README.md

@@ -14,11 +14,12 @@ English | [简体中文](./README.zh-cn.md)
 ```sh
 yarn add vuepress-plugin-posts-encrypt
 ```
+
 ## Usage
 
-###  Step 1: Init configuration in vuepress config file
+### Step 1: Init configuration in vuepress config file
 
-``` js
+```js
 // .vuepress/config.js
 module.exports = {
 
@@ -35,11 +36,12 @@ module.exports = {
     ]
 }
 ```
+
 👇[All configuration items](#Configs) can be seen at `Configs` part👇
 
 ### Step 2: Configure the posts that need to be encrypted access in the blog
 
-- Set `secret: true` in the article [Front Matter](https://vuepress.vuejs.org/zh/guide/frontmatter.html#%E5%85%B6%E4%BB%96%E6%A0%BC%E5%BC%8F%E7%9A%84-front-matter) 
+- Set `secret: true` in the article [Front Matter](https://vuepress.vuejs.org/zh/guide/frontmatter.html#%E5%85%B6%E4%BB%96%E6%A0%BC%E5%BC%8F%E7%9A%84-front-matter)
 
 ```yml
 ---
@@ -72,12 +74,12 @@ passwd: 1233211234567
 
 ### Step3: Run it & See the effect
 
-*BTW*: **Under dev mode `encryptInDev: true` also needs to be configured**
+_BTW_: **Under dev mode `encryptInDev: true` also needs to be configured**
 
 Execute the following command to start the development service
 
 ```sh
-vuepress dev docs 
+vuepress dev docs
 ```
 
 Click to enter a page that needs to verify the password, you can see the following effects:
@@ -88,27 +90,30 @@ Click to enter a page that needs to verify the password, you can see the followi
 
 ### Support custom templates
 
-In the custom template scenario, the plugin needs to inject some logic into your template file, such as `the logic related to password verification`. So you need to provide a mark to inject this part of the code in the template. 
+In the custom template scenario, the plugin needs to inject some logic into your template file, such as `the logic related to password verification`. So you need to provide a mark to inject this part of the code in the template.
 
 The following marks except `<%crypto_inject_tag%>` & `<%validate_js_tag%>` are required, the others are optional. You are free to choose:
 
-*BTW*: **The following marks are inserted into the template from top to bottom, so you need to pay attention to the writing position of the mark**
+_BTW_: **The following marks are inserted into the template from top to bottom, so you need to pay attention to the writing position of the mark**
 
 The position markers for content injection in the template include the following
 
 #### `<%iview_css_tag%>` [`Optional`]
 
-> [`iView`](https://www.iviewui.com/docs/introduce) Component library's CSS injection location mark. 
+> [`iView`](https://www.iviewui.com/docs/introduce) Component library's CSS injection location mark.
+
 - Need to set `iview: true` in the `injectConfig` configuration
 
 #### `<%animate_css_tag%>` [`Optional`]
 
 > [`Animate.css`](https://animate.style/) injection location mark.
+
 - Need to set `animate: true` in the `injectConfig` configuration
 
-#### `<%iview_js_tag%>`  [`Optional`]
+#### `<%iview_js_tag%>` [`Optional`]
 
 > [`iView`](https://www.iviewui.com/docs/introduce) Component library's JS injection location mark.
+
 - Need to set `iview: true` in the `injectConfig` configuration
 
 #### `<%minified_css_tag%>` [`Optional`]
@@ -117,20 +122,21 @@ The position markers for content injection in the template include the following
 
 - If you don't want to write `css` in the template, this configuration allows you to separate the style files that need to be used in the template into the `less` file. The plugin will help you `compile and insert` to the corresponding location. You only need Specify the absolute path of the style file in the `less` setting of `injectConfig`
 
-
 #### `<%crypto_inject_tag%>` [`Required`]
+
 - [`CryptoJS`](https://github.com/brix/crypto-js) Script file insertion position
 
 #### `<%validate_js_tag%>` [`Required`]
->  **Password verification** and **Verified routing storage** injection location mark of related logic
+
+> **Password verification** and **Verified routing storage** injection location mark of related logic
 
 ### Support setting password expiration time
 
 By default, if the verified route is on the same device and the same browser and the user does not clear the local cache, there is no need to verify again next time you come in, because it is stored in `localstorage`
 
 If you don't want this, you can set `expires` for the password, the unit is `milliseconds (ms)`. This expiration time is for each route, not all routes.
 
-*BTW*: **Do not set the expiration time too short, otherwise it may cause an endless loop of routing**
+_BTW_: **Do not set the expiration time too short, otherwise it may cause an endless loop of routing**
 
 ### The following are all supported configuration options：
 
@@ -159,7 +165,7 @@ interface Options {
   injectConfig?: InjectConfig
 }
 
-// The default options 
+// The default options
 const options: Options = {
   route: '/auth',
   passwd: 'hello world',
@@ -169,12 +175,13 @@ const options: Options = {
   injectConfig: {
     less: '',
     iview: false,
-    animate: false
-  }
+    animate: false,
+  },
 }
 ```
+
 👏👏 **One key triple connection** 👏👏
 
 ## License
 
-**[MIT](./LICENSE)**
+**[MIT](./LICENSE)**

README.zh-cn.md

@@ -9,17 +9,17 @@
 
 > **一个用于为你的博客添加 `访问验证` 功能的 `vuepress` 插件。**
 
-
-##  安装
+## 安装
 
 ```sh
 yarn add vuepress-plugin-posts-encrypt
 ```
+
 ## Usage 使用
 
-###  Step 1: 在 `.vuepress/config.js` 中初始化配置
+### Step 1: 在 `.vuepress/config.js` 中初始化配置
 
-``` js
+```js
 // .vuepress/config.js
 module.exports = {
 
@@ -36,8 +36,8 @@ module.exports = {
     ]
 }
 ```
-> 👇[所有配置项](#配置项) 参见下方 `Configs` 部分👇
 
+> 👇[所有配置项](#配置项) 参见下方 `Configs` 部分 👇
 
 ### Step 2: 配置博客中需要加密访问的文章
 
@@ -74,12 +74,12 @@ passwd: 1233211234567
 
 ### Step3: 运行起来看下效果吧
 
-*BTW*： **开发环境下，还需要配置 `encryptInDev: true`**
+_BTW_： **开发环境下，还需要配置 `encryptInDev: true`**
 
 执行如下命令，启动开发服务，
 
 ```sh
-vuepress dev docs 
+vuepress dev docs
 ```
 
 点击进入一个需要验证密码的页面，就可以看到如下效果：
@@ -94,46 +94,50 @@ vuepress dev docs
 
 以下标记除了 **`<%validate_js_tag%>` & `<%crypto_inject_tag%>`** 之外，其他都是可选的，你可以自由选择：
 
-*BTW*：**以下标记都是自上而下依次插入到模板中的，所以需要额外注意标记的书写位置**
+_BTW_：**以下标记都是自上而下依次插入到模板中的，所以需要额外注意标记的书写位置**
 
 模板中内容注入的位置标记包括如下几种
 
 #### `<%iview_css_tag%>` 【非必须】
 
-> [`iView`](https://www.iviewui.com/docs/introduce) 组件库 `CSS` 资源注入位置标记 
-- 需要在 `injectConfig` 配置中设置 `iview: true`
+> [`iView`](https://www.iviewui.com/docs/introduce) 组件库 `CSS` 资源注入位置标记
 
+- 需要在 `injectConfig` 配置中设置 `iview: true`
 
 #### `<%animate_css_tag%>` 【非必须】
 
 > [`Animate.css`](https://animate.style/) 注入位置标记
+
 - 需要在 `injectConfig` 配置中设置 `animate: true`
 
 #### `<%iview_js_tag%>` 【非必须】
 
 > [`iView`](https://www.iviewui.com/docs/introduce) 组件库 `JS` 注入位置标记
+
 - 需要在 `injectConfig` 配置中设置 `iview: true`
 
 #### `<%minified_css_tag%>` 【非必须】
 
 > 外部 `less` 文件编译后的注入位置标记
+
 - 如果你不想在模板里面写 `css`，这个配置可以允许你将模板中需要用到的样式文件单独抽离到 `less` 文件中，插件会帮你 `编译并插入` 到对应位置。
-你只需要在 `injectConfig` 的 `less` 设置中指定样式文件的绝对路径即可
+  你只需要在 `injectConfig` 的 `less` 设置中指定样式文件的绝对路径即可
 
 #### `<%crypto_inject_tag%>` 【必须】
-> [`CryptoJS`](https://github.com/brix/crypto-js) 脚本文件插入位置 
+
+> [`CryptoJS`](https://github.com/brix/crypto-js) 脚本文件插入位置
 
 #### `<%validate_js_tag%>` 【必须】
-> **密码校验**以及**已验证路由的存储**相关逻辑的注入位置标记 
 
+> **密码校验**以及**已验证路由的存储**相关逻辑的注入位置标记
 
 ### 支持设置密码过期时间
 
 默认情况下，已验证通过的路由在同一台设备同一个浏览器且用户没有清理本地缓存的情况下，下次进来是不需要再次进行验证的，因为是存储在 `localstorage` 中的
 
 如果你不想这样的话，可以为密码设置 `expires`，单位是`毫秒（ms）`。这个过期时间是针对每个路由而言的，而不是所有路由。
 
-*BTW*: **过期时间不要设置得过短，否则可能会造成路由死循环**
+_BTW_: **过期时间不要设置得过短，否则可能会造成路由死循环**
 
 ### 以下是支持的所有配置选项：
 
@@ -168,15 +172,17 @@ const options: Options = {
   template: '', // 自定义模板的文件路径，不指定则使用默认模板
   encryptInDev: false, // 开发模式下是否开启文章加密（可用于预览）， 默认 false
   expires: 0, // 密码过期时间，默认永不过期
-  injectConfig: { // 自定义模板时，需要注入的外部资源配置
+  injectConfig: {
+    // 自定义模板时，需要注入的外部资源配置
     less: '',
     iview: false,
-    animate: false
-  }
+    animate: false,
+  },
 }
 ```
+
 👏👏 **One key triple connection** 👏👏
 
 ## License
 
-**[MIT](./LICENSE)**
+**[MIT](./LICENSE)**

assets/enhanceAppFiles.js

@@ -1,5 +1,4 @@
-
-module.exports = function genEnhanceAppFile (path, STORAGE_KEY) {
+module.exports = function genEnhanceAppFile(path, STORAGE_KEY) {
   return `export default ({ Vue, router, siteData, isServer }) => {
     // 获取所有需要加密的路由
     if(!isServer) {
@@ -42,4 +41,4 @@ module.exports = function genEnhanceAppFile (path, STORAGE_KEY) {
       })
     }
   }`
-}
+}