{"_id":"@alibot/dumi-plugin-api-parser","name":"@alibot/dumi-plugin-api-parser","dist-tags":{"latest":"1.0.3"},"versions":{"1.0.3":{"name":"@alibot/dumi-plugin-api-parser","version":"1.0.3","description":"Dumi Plugin - parser code to api table","keywords":["dumi"],"license":"MIT","sideEffects":false,"exports":{".":{"types":"./es/index.d.ts","import":"./es/index.js","require":"./lib/index.js"}},"main":"lib/index.js","module":"es/index.js","types":"es/index.d.ts","dependencies":{"debug":"^4.4.0","typescript":"^5.6.3"},"peerDependencies":{"dumi":"^2"},"optionalDependencies":{"react":"^18","react-dom":"^18"},"packageManager":"pnpm@8.0.0","_id":"@alibot/dumi-plugin-api-parser@1.0.3","gitHead":"71607f6524d10fd1dd9e27ff299d7208220f270c","_nodeVersion":"22.18.0","_npmVersion":"10.9.3","dist":{"integrity":"sha512-Epij7l2YgH3Y1OtNLhW69Ah1ZG+iR80vosb6oa+1C8XgfYCfvouqxNCrquvMnSI5Ke8EIZxxiLP0/Mxc9vtsJA==","shasum":"33c953693747d06ad008ba61e19e26b3e356b93e","tarball":"https://registry.npmjs.org/@alibot/dumi-plugin-api-parser/-/dumi-plugin-api-parser-1.0.3.tgz","fileCount":48,"unpackedSize":90196,"signatures":[{"keyid":"SHA256:DhQ8wR5APBvFHLF/+Tc+AYvPOdTpcIDqOhxsBHRwC7U","sig":"MEQCIHhFzbaSFJaE/2wA1DbDFfhNCyVGUxJ2xRp3g+FAC+k3AiAEUHbto+rGnqobpcedlA5+vnV8LtrkMGhXEmNDOq1XqQ=="}]},"_npmUser":{"name":"laomu","email":"laomu1988@qq.com"},"directories":{},"maintainers":[{"name":"laomu","email":"laomu1988@qq.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages-npm-production","tmp":"tmp/dumi-plugin-api-parser_1.0.3_1762310235105_0.77566228979569"},"_hasShrinkwrap":false}},"time":{"created":"2025-11-05T02:37:15.013Z","1.0.3":"2025-11-05T02:37:15.340Z","modified":"2025-11-05T02:37:15.635Z"},"maintainers":[{"name":"laomu","email":"laomu1988@qq.com"}],"description":"Dumi Plugin - parser code to api table","keywords":["dumi"],"license":"MIT","readme":"\n# dumi api转换插件\n\n 从现有文件中导入代码片段\n\n## Usage\n\n### Install\n\n```bash\nnpm install @alibot/dumi-plugin-api-parser --save-dev\n```\n\n### Apply\n\n```ts\n// .dumirc.ts\nexport default {\n  plugins: ['@alibot/dumi-plugin-api-parser'],\n  // 自定义配置，可选\n  'third:apiParser': {\n    // 自定义文案标签，支持将中英文拼接成html标签，假如带html标签，则自己控制展示处理\n    intlText: '<div><span class=\"lang-en\">{en}</span><span class=\"lang-cn\">{cn}</span></div>',\n    // 自定义中文文案\n    // langCn: {\n    //   parameter: '参数',\n    //   attribute: '属性名',\n    //   describe: '描述',\n    //   type: '类型',\n    //   isRequired: '是否必填',\n    //   default: '默认值',\n    //   return: '返回值',\n    //   required: '(必填)',\n    // },\n    // 自定义英文文案\n    // langEn: {\n    //   parameter: 'parameter',\n    //   attribute: 'attribute',\n    //   describe: 'desc',\n    //   type: 'Type',\n    //   isRequired: 'Is Required?',\n    //   default: 'Default',\n    //   return: 'Return',\n    //   required: '(Required)',\n    // }\n  },\n};\n```\n\n### Exampled\n\n```markdown\n<ApiParser source=\"./index.tsx\" id=\"interfaceName\"></ApiParser>\n```\n\n在dumi的md文件中，增加如上内容，则可以解析interface、函数等定义并生成markdown表格表格\n\n\n## 开发调试\n1. `dumi dev`命令启动dumi，可以查看展示实例\n2. `DEBUG=api_parser dumi dev`可以看dumi执行过程中log\n3. 可以执行单元测试，通过debug\n","readmeFilename":"README.md","_rev":"1-af3b8cff1d97f2d70548bcc94368d3a9"}