使用compodoc

时间:2018-06-15 05:58:33

标签: angular typescript npm documentation

我正在尝试记录我的Angular + Typescript应用程序。我正在使用Compodoc。我通过运行命令

使用npm安装了compodoc
   'npm install -g compodoc'. And added 

   "compodoc": "./node_modules/.bin/compodoc -p src/tsconfig.json"  

在我的package.json脚本中。当我运行npm run compodoc时,我收到此错误

PS D:\ Moya Proj \ VITMOBAPPHYD2016> npm run compodoc

  

moya-app@0.0.0 compodoc D:\ Moya Proj \ VITMOBAPPHYD2016   compodoc -p src / tsconfig.json

                                            _
                                           | |
    ___    ___    _ __ ___    _ __     ___     __| |   ___     ___
   / __|  / _ \  | '_ ` _ \  | '_ \   / _ \   / _` |  / _ \   / __|
  | (__  | (_) | | | | | | | | |_) | | (_) | | (_| | | (_) | | (__   0.0.41
   \___|  \___/  |_| |_| |_| | .__/   \___/   \__,_|  \___/   \___|
                       | |
                       |_|
  

[11:08:57]在当前目录中找不到“tsconfig.json”文件npm ERR!代码ELIFECYCLE

     

npm ERR!错误1

     

npm ERR! moya-app@0.0.0 compodoc:compodoc -p src / tsconfig.json

     

npm ERR!退出状态1

     

npm ERR!

     

npm ERR!在moya-app@0.0.0 compodoc脚本失败。

     

npm ERR!这可能不是npm的问题。上面可能有额外的日志记录输出。

     

npm ERR!可以在以下位置找到此运行的完整日志:

     

npm ERR! C:\ Users \用户Shahid.tabrez \应用程序数据\漫游\ NPM-cache_logs \ 2018-06-15T05_38_57_267Z-的debug.log

我应该向tsconfig.json添加任何内容吗?或者我做了什么有什么不对。 提前谢谢。

1 个答案:

答案 0 :(得分:1)

只需检查package.json文件中“ scripts”对象下是否正确提到了路径。默认情况下,路径为“ src / tsconfig.app.json”。如果您的tsconfig.app.json不在上述路径,请修改路径并检查,它肯定可以工作