@yqg/permission 1.0.4-beta.0 → 1.0.5-beta.0

package/.arcconfig

@@ -0,0 +1,8 @@
+{
+    "project.name": "yqg-permission",
+    "phabricator.uri": "https://code.yangqianguan.com/",
+    "phutil_libraries": {
+        "libcustom": "./arcanist"
+    },
+	"lint.engine": "YqgWebDiffLintEngine"
+}

package/.husky/commit-msg

@@ -0,0 +1,20 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+echo "Running commit-msg hook"
+pnpm commitlint --edit "$1"
+
+# 定义前缀
+PREFIX="[yqg-permission]"
+
+# 读取提交信息文件路径
+COMMIT_MSG_FILE=$1
+COMMIT_MSG=$(cat $COMMIT_MSG_FILE)
+
+echo "$COMMIT_MSG" | grep -q "$PREFIX"
+# 检查提交信息是否已经包含前缀
+if ! echo "$COMMIT_MSG" | grep -q -F "$PREFIX"; then
+  # 添加前缀并写回提交信息文件
+  echo "$PREFIX $COMMIT_MSG" > $COMMIT_MSG_FILE
+  echo "Prefix added: $PREFIX $COMMIT_MSG"  # 调试信息
+fi

package/.husky/pre-commit

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

package/README.md

@@ -1,5 +1,128 @@
-# Vue 3 + TypeScript + Vite
+## Vue 3 + TypeScript + Vite
 
-This template should help get you started developing with Vue 3 and TypeScript in Vite. The template uses Vue 3 `<script setup>` SFCs, check out the [script setup docs](https://v3.vuejs.org/api/sfc-script-setup.html#sfc-script-setup) to learn more.
+# 申请权限弹窗
 
-Learn more about the recommended Project Setup and IDE Support in the [Vue Docs TypeScript Guide](https://vuejs.org/guide/typescript/overview.html#project-setup).
+给业务方提供的申请权限的弹窗组件
+![默认组件](./public/card.png)
+![申请弹窗](./public/dialog.png)
+
+
+### [Demo URL](https://crane-test.yangqianguan.com/role)
+
+### [接入文档](https://wiki.fintopia.tech/pages/viewpage.action?pageId=117280979)
+
+## Table of Contents
+
+-   [Installation](#installation)
+    -   [Install with npm](#install-with-npm)
+    -   [Use inline script directly](#use-inline-script-directly)
+-   [Usage](#usage)
+-   [Config](#config)
+-   [FAQ](#FAQ)
+-   [Browser Support](#browser-support)
+-   [Acknowledgement](#acknowledgement)
+
+### Installation
+
+#### Install with npm
+
+```bash
+$ npm install @yqg/permission
+```
+
+#### Install with yarn
+
+```bash
+$ yarn add @yqg/permission
+```
+
+#### Install with install
+
+```bash
+$ pnpm install @yqg/permission
+```
+
+
+### Usage
+
+step1: 在入口文件(main.js/index.js/app.ts/)引入@yag/permission，并调用start方法注册。
+[See example](./src/main.ts)
+
+```js
+import yqgPermission from './yqg-permission';
+yqgPermission.start();
+//支持定义组件标签名，默认为‘<yqg-permission></yqg-permission>’
+yqgPermission.start({tagName: 'my-element'});
+
+```
+
+step2: 像原生标签一样进行使用
+[See example](./src/App.ts)
+
+```js
+	<yqg-permission 
+		workNumber="05184"
+		businessCode="PPDL"
+		:permissions="['permissionCode1, permissionCode2']"
+		:color="'red'"
+		:locale="'zh-CN'"
+		@success="() => {console.log('请求成功')}"
+		>
+	</yqg-permission>
+
+```
+### 配置说明
+
+支持自定义标签：yqgPermission.start({tagName: 'my-element'});
+
+### yqg-permission 组件参数说明
+
+| 参数项           |  是否必传 ｜     说明           |   类型               | 默认值    |
+| --------------  | -------- | ------------------ | ------------------  | -------- |
+| `work-number`   |     是   | 当前登陆人工号        |    string           |   ''     |
+| `business-code`  |     是   | 系统的权限code        |   string            |  ''      |
+| `permissions`   |     是   | 当前页面下所有权限点   |    string[]或string  |   []     |
+| `color`         |     否   | 主题色（同antd）      |    string           |   #1677ff |
+| `locale`        |     否   | 当前语言类型（同i18n） |    string           |   zn-CH   |
+| `success`       |     否   | 申请成功时回调函数(vue)|    Function         |   ()=> {}  |
+| `type`          |     否   | 组件类型             |    string           |   default  |
+ 
+
+### type 参数说明
+
+type = "default": 默认展示图+按钮组件，点击可弹出弹窗
+type = "text": 展示‘申请权限’文案，点击可弹出弹窗
+type = "custom": 支持自定义组件，以slot的方式添加自定义组件，点击自定义组件可弹出弹窗，例如：
+```js
+	<yqg-permission 
+		workNumber="05184"
+		businessCode="PPDL"
+		:permissions="['permissionCode1, permissionCode2']"
+		:color="'red'"
+		:locale="'zh-CN'"
+		type="custom"
+		@success="() => {console.log('请求成功')}"
+		>
+		<div>自定义按钮</div>
+	</yqg-permission>
+
+```
+
+
+### Browser Support
+
+因为该npm包底层使用webComponent中customElements.define，所以仅支持customElements.define的浏览器
+![浏览器customElements支持现状](./public/image.png)
+
+### NPM scripts
+
+-   `pnpm install`: 安装依赖
+-   `pnpm dev`: 启动项目
+-   `pnpm build`: 编译项目
+-   `npm publish`: 发布项目
+
+###  todo
+todo：优化项 react中成功回调、多语言
+
+### 问题反馈
+-------

package/arcanist/.phutil_module_cache

@@ -0,0 +1 @@
+{"__symbol_cache_version__":11,"0861795cb7fca1601b342f4e44fe1aed":{"have":{"class":{"YqgWebDiffLintEngine":13}},"need":{"class":{"ArcanistLintEngine":42,"ExecFuture":1832,"PhutilConsole":1780}},"xmap":{"YqgWebDiffLintEngine":["ArcanistLintEngine"]}}}

package/arcanist/__phutil_library_init__.php

@@ -0,0 +1,3 @@
+<?php
+
+phutil_register_library('libcustom', __FILE__);

package/arcanist/__phutil_library_map__.php

@@ -0,0 +1,18 @@
+<?php
+
+/**
+ * This file is automatically generated. Use 'arc liberate' to rebuild it.
+ *
+ * @generated
+ * @phutil-library-version 2
+ */
+phutil_register_library_map(array(
+  '__library_version__' => 2,
+  'class' => array(
+    'YqgWebDiffLintEngine' => 'lint/engine/YqgWebDiffLintEngine.php',
+  ),
+  'function' => array(),
+  'xmap' => array(
+    'YqgWebDiffLintEngine' => 'ArcanistLintEngine',
+  ),
+));

package/arcanist/lint/engine/YqgWebDiffLintEngine.php

@@ -0,0 +1,68 @@
+<?php
+
+class YqgWebDiffLintEngine extends ArcanistLintEngine
+{
+    /** @Override */
+    public function buildLinters()
+    {
+        // Filter the affected paths.
+        $paths = $this->getPaths();
+        foreach ($paths as $key => $path) {
+            if (!$this->pathExists($path)) {
+                // Don't lint removed files. In more complex linters it is sometimes
+                // appropriate to lint removed files so you can raise a warning like
+                // "you deleted X, but forgot to delete Y!", but most linters do not
+                // operate correctly on removed files.
+                unset($paths[$key]);
+                continue;
+            }
+
+            $disk = $this->getFilePathOnDisk($path);
+            if (is_dir($disk)) {
+                // Don't lint directories. (In SVN, they can be directly modified by
+                // changing properties on them, and may appear as modified paths.)
+                unset($paths[$key]);
+                continue;
+            }
+        }
+
+        $command = '';
+        $patterns = array(
+            '/\.(jsx?｜tsx?|vue?|ts?)$/' => 'pnpm eslint',
+            // '/\.(less|s?css)$/' => 'npx stylelint --fix' // 理论上暂时不用 style lint
+        );
+
+        foreach ($patterns as $pattern => $lintCommand) {
+            $matchedPaths = preg_grep($pattern, $paths);
+            if (count($matchedPaths) > 0) {
+                if (strlen($command)) {
+                    $command .= ' && \\';
+                }
+
+                $command .= $lintCommand . ' ' . join(' ', $matchedPaths);
+            }
+        }
+
+        $root = $this->getWorkingCopy()->getProjectRoot();
+        $console = PhutilConsole::getConsole();
+
+        $future = new ExecFuture($command);
+        $future->setCWD($root . "/");
+        list($exitcode, $stdout, $stderr) = $future->resolve();
+        $console->writeOut($stdout);
+        $console->writeOut($stderr);
+        $console->writeOut("\n");
+
+        if ($exitcode != 0) {
+            $console->writeOut("All code in any code-base should look like a single person typed it, no matter how many people contributed. --idiomatic.js\n");
+            $console->writeOut("无论有多少人在维护，所有在代码仓库中的代码理应看起来像同一个人写的。 --idiomatic.js\n");
+            $console->writeOut("https://github.com/rwaldron/idiomatic.js/tree/master/translations/zh_CN\n");
+            throw new Exception("Keep it in mind!");
+        } else {
+            $console->writeOut("All code are clean, you did a great job!\n");
+        }
+
+        return;
+    }
+
+}

package/commitlint.config.js

@@ -0,0 +1,32 @@
+module.exports = {
+    extends: ['@commitlint/config-conventional'],
+    plugins: [
+        {
+            rules: {
+                yqgPermission: (parsed) => {
+                    const { type, subject } = parsed;
+                    if (type === null && subject === null) {
+                        return [false, "commit message 格式应该类似 'type: subject' "];
+                    }
+
+                    if (!['feat', 'fix', 'patch', 'style', 'refactor', 'perf', 'test', 'build', 'chore', 'script'].includes(type)) {
+                        return [false, 'type 应该为 feat, fix, patch, style, refactor, perf, test, build, chore, script 中的一个'];
+                    }
+                    return [true, ''];
+                },
+            },
+        },
+    ],
+    rules: {
+        yqgPermission: [2, 'always'],
+        'header-max-length': [2, 'always', 200],
+        'body-max-line-length': [2, 'always', 500],
+        'footer-max-line-length': [2, 'always', 500],
+    },
+    parserPreset: {
+        parserOpts: {
+            headerPattern: /^(?:\[(.+?)\] )?(.+?): (.+?)$/,
+            headerCorrespondence: ['prefix', 'type', 'subject'],
+        },
+    },
+};