npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

edu-doc-tool

v2.2.1

Published

edu-doc-tool

Downloads

11

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

rookiebobrookiebob

Keywords

Readme

edu-doc-tool工具主要用于以下作用：

  • 修正eslint检测出来的，但是没法通过--fix参数默认修复的问题
  • 根据组件池的注释，一键生成API,并追加到README
  • 提供本地组件文档预览功能

快速使用

1,安装edu-doc-tool

npm install edu-doc-tool -g

2,修正脚本中错误的注释

cd component-xx
edu-doc-tool -l

看到输出并替换了错误的路径

开始处理：【/Users/rookiebob/edu-work/pool/component-calendar/src/datePicker/ui.js】
开始处理：【/Users/rookiebob/edu-work/pool/component-calendar/src/dateRangePicker/component.js】
>>该文件下被替换的错误路径： @class   module:pool/component-calendar/src/component/dateRangePicker/component.DateRangePicker
>>该文件下被替换的错误路径： @member {Number} module:pool/component-calendar/src/component/dateRangePicker/component.DateRangePicker#getGMTStartDate
>>该文件下被替换的错误路径： @member {Number} module:pool/component-calendar/src/component/dateRangePicker/component.DateRangePicker#getGMTEndDate
>>该文件下被替换的错误路径： @method  module:pool/component-calendar/src/component/dateRangePicker/component.DateRangePicker#config
>>该文件下被替换的错误路径： @method  module:pool/component-calendar/src/component/dateRangePicker/component.DateRangePicker#init
>>该文件下被替换的错误路径： @method  module:pool/component-calendar/src/component/dateRangePicker/component.DateRangePicker#doValidate
>>该文件下被替换的错误路径： @method  module:pool/component-calendar/src/component/dateRangePicker/component.DateRangePicker#destroy

3，生成组件API文档

cd component-xx
edu-doc-tool -g

看到输出了生成并追加到README的提示

开始处理：【/Users/rookiebob/edu-work/pool/component-calendar/src/calendar/component.js】
开始处理：【/Users/rookiebob/edu-work/pool/component-calendar/src/datePicker/component.js】
开始处理：【/Users/rookiebob/edu-work/pool/component-calendar/src/dateRangePicker/component.js】
开始处理：【/Users/rookiebob/edu-work/pool/component-calendar/src/dateTimePicker/component.js】
开始处理：【/Users/rookiebob/edu-work/pool/component-calendar/src/timePicker/component.js】
【/Users/rookiebob/edu-work/pool/component-calendar/src/datePicker/component.js】 apis append success!
【/Users/rookiebob/edu-work/pool/component-calendar/src/datePicker/component.js】 events append success!
【/Users/rookiebob/edu-work/pool/component-calendar/src/dateRangePicker/component.js】 apis append success!
【/Users/rookiebob/edu-work/pool/component-calendar/src/calendar/component.js】 apis append success!
【/Users/rookiebob/edu-work/pool/component-calendar/src/calendar/component.js】 events append success!
【/Users/rookiebob/edu-work/pool/component-calendar/src/dateTimePicker/component.js】 apis append success!
【/Users/rookiebob/edu-work/pool/component-calendar/src/dateTimePicker/component.js】 events append success!
【/Users/rookiebob/edu-work/pool/component-calendar/src/timePicker/component.js】 apis append success!
【/Users/rookiebob/edu-work/pool/component-calendar/src/timePicker/component.js】 events append success!

4，本地组件启动预览

edu-doc-tool -s

.gitignore已经忽略mock文件！
[/Users/rookiebob/mydemo/edu-doc-tool/src/template/_navbar.md] copy success!
[/Users/rookiebob/mydemo/edu-doc-tool/src/template/index.html] copy success!
[/Users/rookiebob/mydemo/edu-doc-tool/src/template/_sidebar.md] copy success!
/index.html已添加到.gitignore
/_sidebar.md已添加到.gitignore
/_navbar.md已添加到.gitignore
stdout: *** DEPRECATION WARNING *** The exts option will REPLACE extensions in 0.6.4. ***

stdout: 
Serving /Users/rookiebob/edu-work/pool/component-calendar now.
Listening at http://localhost:3000