{"_id":"@aliedu/interface-doc-online","_rev":"2-07a27cdc0f124120c169093af54a298f","name":"@aliedu/interface-doc-online","dist-tags":{"latest":"0.1.0"},"versions":{"0.1.0":{"name":"@aliedu/interface-doc-online","version":"0.1.0","description":"在线接口文档","main":"lib/index.js","module":"es/index.js","stylePath":"style.js","types":"lib/index.d.ts","scripts":{"start":"icejs start --config build_dev.json","build":"rm -rf src/services && build-scripts build && git reset --hard","watch":"npm run start -- --watch","addPage":"node ./scripts/create.js","test":"build-scripts test","prepublishOnly":"npm run build","eslint":"eslint --cache --ext .js,.jsx ./","eslint:fix":"npm run eslint -- --fix","stylelint":"stylelint \"**/*.{css,scss,less}\"","lint":"npm run eslint && npm run stylelint","f2elint-scan":"f2elint scan","f2elint-fix":"f2elint fix"},"keywords":["ice","react","component"],"dependencies":{"lodash":"^4.17.20","moment":"^2.29.1","react-ace":"^10.1.0","ace-builds":"^1.10.1","antd":"^4.21.0","brace":"^0.11.1"},"devDependencies":{"@alib/build-scripts":"^0.1.3","@b-design/ui":"2.0.33","@icedesign/container":"^1.0.4","@iceworks/spec":"^1.0.0","@types/react":"^16.9.13","@types/react-dom":"^16.9.4","axios":"^0.21.1","build-plugin-component":"^1.0.0","build-plugin-fusion":"^0.1.0","build-plugin-icestark":"^2.0.0","build-plugin-moment-locales":"^0.1.0","chalk":"^4.1.1","enzyme":"^3.10.0","enzyme-adapter-react-16":"^1.14.0","f2elint":"^2.2.0","fs-extra":"^10.0.0","ice.js":"^1.0.0","minimist":"^1.2.5","pont-engine":"1.0.13","prettier":"^2.3.0","react":"^16.3.0","react-dom":"^16.3.0"},"peerDependencies":{"@b-design/ui":"2.0.33","@iceworks/spec":"^1.0.0","ice.js":"^1.0.0","react":"^16.3.0","react-dom":"^16.3.0"},"componentConfig":{"name":"interface-doc-online","title":"interface-doc-online","category":"Others"},"publishConfig":{"access":"public","registry":"https://registry.npmjs.org"},"license":"MIT","husky":{"hooks":{"pre-commit":"f2elint commit-file-scan","commit-msg":"f2elint commit-msg-scan"}},"homepage":"","gitHead":"e98f6b438051bf5c19539cae8a2a25410cf82bc4","_id":"@aliedu/interface-doc-online@0.1.0","_nodeVersion":"16.13.2","_npmVersion":"8.4.0","dist":{"integrity":"sha512-mQc7mM0qGHiYP635aTU5o13QGd5PmgONvHklcGLqnXH07T3t+ZEBcy38HwIH7/HqVd2FrhmFXE2DEcxphsFG1w==","shasum":"da9f82a5f9f4b0075214dcfe7c2ac2f51e9c5528","tarball":"https://registry.npmjs.org/@aliedu/interface-doc-online/-/interface-doc-online-0.1.0.tgz","fileCount":60,"unpackedSize":114475,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIFBlU/s09vKP0hH1WZcQUjAxPIW0VKQLEaD8gUpaPYJqAiBH5eqbcVEuyf5nlPmP6xSwHM6DM+tCz0BOEyL/cY5x1g=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjdDvpACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2Vmqesg/9HHeINhR1ci+iOoAjsICQlt90PQcm0lrgCjLa4euRNsgFS3ST\r\naPFPr9UJrKk3i/kRBXB4bVZ3MFTzZXTZXqHYYscAgEHHPCjiPjBhiv3bUMEE\r\nZ1OLQlbof1wTzexwoe/9ao6Syx5fQ5FDd1MnYCXeBrNb0RCSBKax875lWWmC\r\nOBaXyDFymtSxTqA6xECKQ87bWY1ujFId+UPf3pMj1w3DdNCfjvwBP+Iotjxj\r\nAOztWN7vJE5dEkgGVaPY5q7dXG91CkUvVdx27r6J6qiyq4Broi9B+Z6XPCHt\r\naqRDfmbYFPuT+25T2ITx+BJ0jAZqkr0h75v50R5CPybVjrZtes+8qit472Gu\r\nzCtmkkyPx/2hpkU3+a5ZNUhPZKP59/nCW6dFHQ0rEb03ENE+kEfwvSwAvPtN\r\nYz6R0NNh4D1bZ8UCaBaQabZ8L7YBOKejR+w4LZDEBhXDPESa6XeHMIoRnQUB\r\neATkyVgnvyRQK+l8Izz9b3ijJNiNAnKeOUrOw/Z/mENal3r+Lv32jNAxvlvv\r\nphezGgxGgkk4yJQhknNbZXH8cFTt9W08IUMSKAMx3jP2KN1MCTrEN1PjUY/B\r\nwGfh21fC9e+DSiByLR7O9A3yrfIFngMo/NCkPKL9sPdD5QpfNrqbC+QNjQw9\r\ndz4ZOh397fPFlOTS1frlrFEcuinlLtwdgVk=\r\n=GIGN\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"webkaige","email":"webkaige@gmail.com"},"directories":{},"maintainers":[{"name":"liyaxuanliyaxuan","email":"15196387158@163.com"},{"name":"lizdchao","email":"472989232@qq.com"},{"name":"webkaige","email":"webkaige@gmail.com"},{"name":"jianting.bjt","email":"309079464@qq.com"},{"name":"zch759740844","email":"759740844@qq.com"},{"name":"caoyanyan-123","email":"18516994806@163.com"},{"name":"zhaojian6516","email":"zhaojian6516@163.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/interface-doc-online_0.1.0_1668561896978_0.5496106097616069"},"_hasShrinkwrap":false}},"time":{"created":"2022-11-16T01:24:56.892Z","0.1.0":"2022-11-16T01:24:57.147Z","modified":"2023-10-10T03:46:19.640Z"},"maintainers":[{"email":"309079464@qq.com","name":"jianting.bjt"},{"email":"759740844@qq.com","name":"zch759740844"},{"email":"zhaojian6516@163.com","name":"zhaojian6516"}],"description":"在线接口文档","keywords":["ice","react","component"],"license":"MIT","readme":"# 开发前必读\n\n该工程为页面(page)工程，开发完成后，需要通过发布 npm 包的方式集成到应用主工程中\n\n## 开发前准备\n\n1. node (建议版本 12.18.3 )\n2. npm\n3. https://www.npmjs.com/ 账号\n4. git\n5. vscode 与插件安装:\n   在 vscode 官网下载最新版 vscode 安装即可；\n   请安装以下几款 vscode 插件，以方便开发: pont、ESLint、Prettier、TSLint、AppWorks\n\n## 开发说明\n\n#### 先把 git 整起来，方便协作\n\n1. 新建代码库（请找 竹杖 开权限）\n   将代码库建在对应的分组中\n   仓库地址：\n\n   - 阿里员工：http://gitlab.alibaba-inc.com/\n   - 外包或者生态：https://codeup.aliyun.com/ 需注册（可使用钉钉或者支付宝账号注册）\n\n2. 请完成全局设置\n   git config --global user.name \"你的名字\"\n   git config --global user.email \"你的邮箱\"\n\n3. 工程初始化后，第一步请先完成 git 的出初始化:\n\n`cd 到当前的工程目录\n\ngit init\n\ngit add .\n\ngit commit '项目初始化'\n`\n\n4. 关联 git 仓库\n\n   git remote add origin 远程仓库地址\n\n   git push -u origin master\n\n#### 项目跑起来 - 开发态\n\n- 简单跑起来\n\n1. cd 到当前的工程目录\n2. npm install\n3. npm run start\n\n- 生成 service 层代码\n\n1. 通过 pont-config.json 中的 origins 字段来指定生成 services 层代码的 swagger 服务地址\n2. vscode 左下角 sync all generate 来生成 services 代码\n\n- 书写页面\n\n参考 pages 中的 Demo1 来完成一个完整的页面书写\n\n- 添加路由\n\n在 routes.ts 添加你的页面路由(参考 Demo1 和 Demo2 的路由配置)\n\n#### 构建和发布\n\n页面开发完成后\n\n- 构建：npm run build\n- 发布：\n  npm login - 使用自己的 https://www.npmjs.com/ 在本地登录\n\n  npm publish\n\n1. 页面会默认发布到 https://registry.npmjs.org 的 @aliedu 域下，请勿随意修改，如果没有权限，请联系 竹杖 添加权限；\n2. 如果发现不是在该域下，请在 package.json 中修改 name 字段为 @aliedu/xxx\n3. 发布前会自动完成构建；\n4. 同一个版本号只能发布一次；\n5. services 层代码只在开发态使用，不会发布\n\n#### 页面集成\n\n在需要的应用中使用 npm install @aliedu/xxx --save 的方式安装以集成该页面\n\n#### 工程目录结构及开发介绍\n\n参考文档 https://yuque.antfin-inc.com/docs/share/af2ae56b-1e5b-43e0-a0b8-e96795827a6b?# 《工程开发文档 - PC 端 web》\n\n#### 注意事项\n\n1. 请在代码中使用相对路径，不要用 alias 或者绝对路径\n2. services 层代码不参与编译，只在开发环境是使用，\n   具体使用的 swagger 文档和模块名称请于要集成的应用保持一致\n3. app.tsx 只在开发态使用，集成到应用中不使用，不要写业务代码，一般也不用修改\n4. routes.tsx 中的路由建议只使用一级\n5. ice，react，以及 fusion/@b-design 等通用基础组件库都使用顶层依赖，该工程中只安装 devDependencies\n","readmeFilename":"README.md"}