简单说说angular.json文件的使用


Posted in Javascript onOctober 29, 2018

Angular CLI 6+的版本后,原先的angular-cli.json就被换成了angular.json,而其中里面的字段变化挺大了,如果不了解基本的组成,或者直接把老版本的代码 copy 到新版本的工作空间中,会导致一些很不友好的错误。

这种变化主要还是因为Angular CLI引入了 monorepo (一个空间管理多个项目) 的开发模式,即使用ng new出来的相当于一个大的工作空间,通过angular.json配置来管理各种ng generate application | library出来的项目或组件库。

其实这种模式优势还是很明显的,比如一个公司有多种管理平台或者产品时,使用这种方式可以统一各个项目的环境,各个项目间共用的组件也被统一维护起来,所有项目共用npm包以及typescript配置。

monorepo下结构如:

简单说说angular.json文件的使用

但是其实大多数人还是一个工作空间维护一个项目,所以这个在这里不那么重要,只是想说json文件的改变是为了新的模式而已。

Angular.json的部分字段

当你ng new一个工作空间时,默认会在根目录创建一个项目以及对应e2e项目。初始的angular.json结构如下(省略的部分的配置代码)

{
  "$schema": "./node_modules/@angular/cli/lib/config/schema.json",
  "version": 1,
  "newProjectRoot": "projects",
  "projects": {
    "xxxx": {
      "root": "",
      "sourceRoot": "src",
      "projectType": "application",
      "prefix": "app",
      "schematics": {},
      "architect": {}
    }
  },
  "defaultProject": "xxxx"
}

这是部分的配置属性,我按照顺序简单做个记录,以后也好查阅。

$schema

指向一个 JSON Schema 文件,这个文件描述了angular.json所有的字段以及约束。

其实可以比作一个有“类型提示”功能文件,只要支持了这个功能的 IDE 或编辑器,在书写angular.json文件时便会给出相应的提示。

version

设置版本

newProjectRoot

新建项目所在的路径。

当使用ng generate application | library创建一个新的项目时,会自动装配到设定的newProjectRoot目录下

projects

放置所有项目的配置。其中一个项目为一个子项,如xxxx为一个项目,在创建时自动生成。

{
  "projects": {
    "xxxx": {
      "root": "",
      "sourceRoot": "src",
      "projectType": "application",
      "prefix": "app",
      "schematics": {},
      "architect": {}
    }
  }
}

在一个单独的配置中,可以通过灵活的配置实现一些自动化操作还有使用CLI内置的一些指令。

root

代表项目的“根目录”,也就是项目所在的位置,或者说项目源码的父级目录。项目的根目录包含了一些特定的配置。

sourceRoot

项目源码所在的目录,通常默认使用src目录。

projectType

标示这个项目是application还是library

prefix

使用ng generate component | directive生成组件或者指令时默认的selector前缀,通常我们使用命令创建的组件或指令都是app-xxx格式,我们可以手动在这里改动,使整个项目生效。

schematics

CLI中生成组件、指令、模块等文件的指令是使用@angular-devkit/schematics实现的,这些指令通常带有一些快捷配置,比如一个生成组件的命令:ng g c --spec=false --styleext=scss,这条命令可以直接生成一个 不带测试文件、使用scss为样式文件 的组件。如果每次都要手动输入这些配置就会显得麻烦,所以angular.json提供了schematics属性来统一设置一些生成类的命令配置。

这里的schematics是针对单个project来的。整个angular.json也有此字段,默认生效于所有project

CLI预设了几组选项,我们可以针对不同的选项进行配置:

  • @schematics/angular:component
  • @schematics/angular:class
  • @schematics/angular:directive
  • @schematics/angular:guard
  • @schematics/angular:module
  • @schematics/angular:pipe
  • @schematics/angular:service

component举例,如果要实现统一ng g c --spec=false --styleext=scss的效果,可以配置如下:

{
  "schematics": {
    "@schematics/angular:component": {
       "styleext": "less",
       "spec": false
    }
  }
}

接着就可以直接使用ng g c直接生成对应的组件了。

architect

包含几组CLI相关的项目自动化命令配置,比如本地运行、编译、测试等等。默认预设了几组命令配置如buildserve等等:

{
  "architect":{
    "build":{},
    "serve":{},
    "extract-i18n":{},
    "test":{},
    "lint":{}
  }
}

配置属性

每一个配置项都有 3 个字段属性:builderoptionsconfigurations,例如默认的build命令配置:

{
  "architect": {
    "build": {
      "builder": "@angular-devkit/build-angular:browser",
      "options": {
        "outputPath": "dist/testApp",
        "index": "src/index.html",
        "main": "src/main.ts",
        "polyfills": "src/polyfills.ts",
        "tsConfig": "src/tsconfig.app.json",
        "assets": [
          "src/favicon.ico",
          "src/assets"
        ],
        "styles": [
          "src/styles.css"
        ],
        "scripts": []
       },
       "configurations": {
         "production": {
           "fileReplacements": [
             {
               "replace": "src/environments/environment.ts",
               "with": "src/environments/environment.prod.ts"
             }
           ],
           "optimization": true,
           "outputHashing": "all",
           "sourceMap": false,
           "extractCss": true,
           "namedChunks": false,
           "aot": true,
           "extractLicenses": true,
           "vendorChunk": false,
           "buildOptimizer": true
         }
       }
     }
   }
}

这个是项目默认生成的配置。

builder代表要执行的内置程序,因为CLI内置了一些自动化工具,architect只是提供了一个facade模式(通俗地讲,就是开发者不需要知道内部的复杂实现)给开发者配置使用,本质上还是调用的内置工具。

options代表针对当前builder要配置的配置项,调用不同的内置程序,是需要传对应的配置项的,由于配置项很多,这里也不会列出。

configurations代表这个命令的多种调用模式,在此配置里,我们可以定义不同的别名,然后使用不同的配置(配置的字段还是属于options里的),最后在使用命令时便可以手动选择不同的模式。

如何使用

CLI其实内置了几个快捷命令来对应默认生成的配置如ng serveng build等等,如果是我们额外自定义的配置,则可以使用ng run <project>:<architect>[:configurations] [其他配置]
命令来实现,其中projectarchitect为必填,configurations为选填。

比如我们简单额外自定义一个本地运行的服务器命令:

{
  "architect":{
    "myServe":{
      "builder": "@angular-devkit/build-angular:dev-server",
      "options": {
        "browserTarget": "xxxx:build",
        "port": 8800
      },
      "configurations": {
        "port1": {
          "port": 8801
        },
        "port2": {
          "port": 880
        }
      }
    }
  }
}

配置使用了内置的运行本地服务器程序,然后使用默认的build配置,加上自定义的运行端口,另外加上两个不同模式,运行不同端口。

使用ng run xxxx:myServe可以正常运行本地服务器跑项目,端口是8800
使用ng run xxxx:myServe:port1端口是8801

当然,我们还可以直接使用额外的命令行配置直接覆盖已经定义的配置:
ng run xxxx:myServe:port1 --port=8808

这里的例子只是为了简单了解下architect的用法。

defaultProject

默认项目,当使用一些CLI命令没有指定项目名称时,默认指向的项目。

schema.json

其实我只是为了记录自己有点印象的属性,整个angular.json还有很多其他的字段,如果想要全面了解,我们可以直接打开$schema所指向的文件,里面详细地展示了各种字段的类型、配置以及描述说明。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Javascript 相关文章推荐
JQuery each()函数如何优化循环DOM结构的性能
Dec 10 Javascript
JS判断文本框内容改变事件的简单实例
Mar 07 Javascript
浅谈javascript中for in 和 for each in的区别
Apr 23 Javascript
javascript动态生成树形菜单的方法
Nov 14 Javascript
AngularJs 指令详解及示例代码
Sep 01 Javascript
Js查找字符串中出现次数最多的字符及个数实例解析
Sep 05 Javascript
如何正确理解javascript的模块化
Mar 02 Javascript
详解如何让InstantClick兼容MathJax、百度统计等
Sep 12 Javascript
详解vue 项目白屏解决方案
Oct 31 Javascript
vue路由中前进后退的一些事儿
May 18 Javascript
javascript实现的字符串转换成数组操作示例
Jun 13 Javascript
解决vue.js提交数组时出现数组下标的问题
Nov 05 Javascript
JS 实现获取验证码 倒计时功能
Oct 29 #Javascript
浅析微信扫码登录原理(小结)
Oct 29 #Javascript
详解Node.js中path模块的resolve()和join()方法的区别
Oct 29 #Javascript
详解vue-router数据加载与缓存使用总结
Oct 29 #Javascript
vue mounted 调用两次的完美解决办法
Oct 29 #Javascript
Electron中实现大文件上传和断点续传功能
Oct 28 #Javascript
JS 正则表达式验证密码、邮箱格式的实例代码
Oct 28 #Javascript
You might like
谈谈PHP语法(4)
2006/10/09 PHP
可以在线执行PHP代码包装修正版
2008/03/15 PHP
php 截取字符串并以零补齐str_pad() 函数
2011/05/07 PHP
解决ajax+php中文乱码的方法详解
2013/06/09 PHP
如何让搜索引擎抓取AJAX内容解决方案
2014/08/25 PHP
Zend Framework教程之路由功能Zend_Controller_Router详解
2016/03/07 PHP
PHP7 windows支持
2021/03/09 PHP
ie和firefox中img对象区别的困惑
2006/12/27 Javascript
JS中简单的实现像C#中using功能(有源码下载)
2007/01/09 Javascript
JAVASCRIPT style 中visibility和display之间的区别
2010/01/22 Javascript
js操作textarea方法集合封装(兼容IE,firefox)
2011/02/22 Javascript
下载文件个别浏览器文件名乱码解决办法
2013/03/19 Javascript
jQuery动态添加删除select项(实现代码)
2013/09/03 Javascript
JQuery弹出层示例可自定义
2014/05/19 Javascript
Jquery插件实现点击获取验证码后60秒内禁止重新获取
2015/03/13 Javascript
jQuery使用$.ajax进行即时验证的方法
2015/12/08 Javascript
AngularJS入门教程之路由与多视图详解
2016/08/19 Javascript
JavaScript遍历Json串浏览器输出的结果不统一问题
2016/11/03 Javascript
原生Aajax 和jQuery Ajax 写法个人总结
2017/03/24 jQuery
AngularJS 监听变量变化的实现方法
2018/10/09 Javascript
jQuery实现弹出层效果
2019/12/10 jQuery
使用Python的Scrapy框架编写web爬虫的简单示例
2015/04/17 Python
CSS3 animation实现逐帧动画效果
2016/06/02 HTML / CSS
电子邮箱格式怎么写
2014/01/12 职场文书
市场营销求职信范文
2014/02/21 职场文书
建筑安全员岗位职责
2014/03/13 职场文书
如何写一份好的英文求职信
2014/03/19 职场文书
员工廉洁自律承诺书
2014/05/26 职场文书
初中学习计划书范文
2014/09/15 职场文书
党的群众路线教育实践活动自我剖析材料
2014/10/08 职场文书
社区文明倡议书
2015/04/28 职场文书
雨雪天气温馨提示
2015/07/15 职场文书
高三物理教学反思
2016/02/20 职场文书
《为人民服务》教学反思
2016/02/20 职场文书
OpenStack虚拟机快照和增量备份实现方法
2022/04/04 Servers
Ruby序列化和持久化存储 Marshal和Pstore介绍
2022/04/18 Ruby