углового JSDoc с НПМ

Question

Используя угловой-JSDoc Я использую эту команду, чтобы создать мои документы

узла. \ Node_modules \ JSDoc \ jsdoc.js приложение -с. \ Node_modules \ угловой JSDoc \ общих \ conf.json -d -t документы. \ node_modules \ углового JSDoc \ угловой шаблон \

Я не предпочитаю вводить такие длинные команды каждый раз, когда я-обновлять свой документ.

Я хотел бы знать некоторые ярлыки, чтобы избежать ввода или копирования/вставки этой команды.

Answer 1

Как указано в команде узел используется для выполнения. Я бы предложил использовать npm для создания проектных команд.

Это может быть сделано следующим образом:

1. Создайте файл package.json в своем главном каталоге (с помощью NPM инициализации).
2. Добавьте ниже объект JSON в package.json файле

"скрипты": { "gendoc": "узел \ node_modules \ JSDoc \ jsdoc.js приложение -c \ node_modules \ угловой.. -jsdoc \ Common \ conf.json -d -t документы. \ node_modules \ углового JSDoc \ углового шаблона \» }

Это создаст gendoc команду для проекта, который может быть выполнен из в командной строке:

НПМ запустить gendoc

Теперь вам не нужно вводить всю команду, просто введите приведенную выше команду, НПМ будет искать сценариев объект в package.json и выполнить сценарий чей ключ gendoc.