refactor(config): refactor the config object. (angular#1809)

This also will load angular-cli.json in the HOME directory as a fallback, supports more stuff from the JSON Schema (like default values) than the old one, and actually verify that what you inputs is the right thing. This will be its own NPM package at some point, as other people will probably be interested in having a JSON Schema loader that gives type safety and provides fallbacks and metadata. Closesangular#1763

Author: hansl

addon/ng2/commands/get.ts

@@ -12,7 +12,9 @@ const GetCommand = Command.extend({
 
 run: function(commandOptions,rawArgs): Promise<void>{
 returnnewPromise(resolve=>{
-constvalue=newCliConfig().get(rawArgs[0]);
+constconfig=CliConfig.fromProject();
+constvalue=config.get(rawArgs[0]);
+
 if(value===null){
 console.error(chalk.red('Value cannot be found.'));
 }elseif(typeofvalue=='object'){

addon/ng2/commands/github-pages-deploy.ts

@@ -27,12 +27,12 @@ module.exports = Command.extend({
 type: String,
 default: 'new gh-pages version',
 description: 'The commit message to include with the build, must be wrapped in quotes.'
-},{
+},{
 name: 'target',
 type: String,
-default: 'production',
+default: 'production',
 aliases: ['t',{'dev': 'development'},{'prod': 'production'}]
-},{
+},{
 name: 'environment',
 type: String,
 default: '',
@@ -72,12 +72,12 @@ module.exports = Command.extend({
 }
 if(options.target==='production'){
 options.environment='prod';
-}
+}
 }
 
 varprojectName=this.project.pkg.name;
 
-constoutDir=CliConfig.fromProject().apps[0].outDir;
+constoutDir=CliConfig.fromProject().config.apps[0].outDir;
 
 letghPagesBranch='gh-pages';
 letdestinationBranch=options.userPage ? 'master' : ghPagesBranch;

addon/ng2/commands/set.ts

@@ -1,3 +1,4 @@
+import*asSilentErrorfrom'silent-error';
 import*asCommandfrom'ember-cli/lib/models/command';
 import{CliConfig}from'../models/config';
 
@@ -11,10 +12,38 @@ const SetCommand = Command.extend({
 {name: 'global',type: Boolean,default: false,aliases: ['g']},
 ],
 
+asBoolean: function(raw: string): boolean{
+if(raw=='true'||raw=='1'){
+returntrue;
+}elseif(raw=='false'||raw==''||raw=='0'){
+returnfalse;
+}else{
+thrownewSilentError(`Invalid boolean value: "${raw}"`);
+}
+},
+asNumber: function(raw: string): number{
+if(Number.isNaN(+raw)){
+thrownewSilentError(`Invalid number value: "${raw}"`);
+}
+return+raw;
+},
+
 run: function(commandOptions,rawArgs): Promise<void>{
 returnnewPromise(resolve=>{
-constconfig=newCliConfig();
-config.set(rawArgs[0],rawArgs[1],commandOptions.force);
+const[jsonPath,rawValue]=rawArgs;
+constconfig=CliConfig.fromProject();
+consttype=config.typeOf(jsonPath);
+letvalue: any=rawValue;
+
+switch(type){
+case'boolean': value=this.asBoolean(rawValue);break;
+case'number': value=this.asNumber(rawValue);break;
+case'string': value=rawValue;break;
+
+default: value=JSON.parse(rawValue);
+}
+
+config.set(jsonPath,value);
 config.save();
 resolve();
 });

addon/ng2/commands/test.ts

@@ -1,6 +1,6 @@
 import*asTestCommandfrom'ember-cli/lib/commands/test';
-import*asconfigfrom'../models/config';
 import*asTestTaskfrom'../tasks/test';
+import{CliConfig}from'../models/config';
 
 module.exports=TestCommand.extend({
 availableOptions: [
@@ -14,7 +14,7 @@ module.exports = TestCommand.extend({
 ],
 
 run: function(commandOptions){
-this.project.ngConfig=this.project.ngConfig||config.CliConfig.fromProject();
+this.project.ngConfig=this.project.ngConfig||CliConfig.fromProject();
 
 vartestTask=newTestTask({
 ui: this.ui,

custom-typings.d.ts addon/ng2/custom-typings.d.tscustom-typings.d.ts renamed to addon/ng2/custom-typings.d.ts

@@ -7,7 +7,7 @@ module.exports ={
 name: 'ng2',
 
 config: function(){
-this.project.ngConfig=this.project.ngConfig||config.CliConfig.fromProject();
+this.project.ngConfig=this.project.ngConfig||config.CliConfig.fromProject().config;
 },
 
 includedCommands: function(){

addon/ng2/index.js

@@ -1,12 +1,14 @@
+import{CliConfigasCliConfigBase}from'./config/config';
+import{CliConfigasConfigInterface}from'../../../lib/config/schema';
+import*aschalkfrom'chalk';
 import*asfsfrom'fs';
 import*aspathfrom'path';
-import*aschalkfrom'chalk';
 
 constschemaPath=path.resolve(process.env.CLI_ROOT,'lib/config/schema.json');
 constschema=require(schemaPath);
 
 exportconstCLI_CONFIG_FILE_NAME='angular-cli.json';
-exportconstARRAY_METHODS=['push','splice','sort','reverse','pop','shift'];
+
 
 function_findUp(name: string,from: string){
 letcurrentDir=from;
@@ -16,175 +18,46 @@ function _findUp(name: string, from: string){
 returnp;
 }
 
-currentDir=path.resolve(currentDir,'..');
+currentDir=path.dirname(currentDir);
 }
 
 returnnull;
 }
 
 
-exportclassCliConfig{
-private_config: any;
-
-constructor(path?: string){
-if(path){
-try{
-fs.accessSync(path);
-this._config=require(path);
-}catch(e){
-thrownewError(`Config file does not exits.`);
-}
-}else{
-this._config=CliConfig.fromProject();
-}
-}
-
-save(path: string=CliConfig._configFilePath()){
-if(!path){
-thrownewError('Could not find config path.');
-}
-
-fs.writeFileSync(path,JSON.stringify(this._config,null,2),{encoding: 'utf-8'});
-}
-
-set(jsonPath: string,value: any,force: boolean=false): boolean{
-letmethod: any=null;
-letsplittedPath=jsonPath.split('.');
-if(ARRAY_METHODS.indexOf(splittedPath[splittedPath.length-1])!=-1){
-method=splittedPath[splittedPath.length-1];
-splittedPath.splice(splittedPath.length-1,1);
-jsonPath=splittedPath.join('.');
-}
-
-let{ parent, name, remaining }=this._findParent(jsonPath);
-letproperties: any;
-letadditionalProperties: boolean;
-
-constcheckPath=jsonPath.split('.').reduce((o,i)=>{
-if(!o||!o.properties){
-thrownewError(`Invalid config path.`);
-}
-properties=o.properties;
-additionalProperties=o.additionalProperties;
-
-returno.properties[i];
-},schema);
-constconfigPath=jsonPath.split('.').reduce((o,i)=>o[i],this._config);
-
-if(!properties[name]&&!additionalProperties){
-thrownewError(`${name} is not a known property.`);
-}
-
-if(method){
-if(Array.isArray(configPath)&&checkPath.type==='array'){
-[][method].call(configPath,value);
-returntrue;
-}else{
-thrownewError(`Trying to use array method on non-array property type.`);
-}
-}
-
-if(typeofcheckPath.type==='string'&&isNaN(value)){
-parent[name]=value;
-returntrue;
-}
-
-if(typeofcheckPath.type==='number'&&!isNaN(value)){
-parent[name]=value;
-returntrue;
-}
-
-if(typeofvalue!=checkPath.type){
-thrownewError(`Invalid value type. Trying to set ${typeofvalue} to ${path.type}`);
-}
-}
-
-get(jsonPath: string): any{
-let{ parent, name, remaining }=this._findParent(jsonPath);
-if(remaining||!(nameinparent)){
-returnnull;
-}else{
-returnparent[name];
-}
-}
-
-private_validatePath(jsonPath: string){
-if(!jsonPath.match(/^(?:[-_\w\d]+(?:\[\d+\])*\.)*(?:[-_\w\d]+(?:\[\d+\])*)$/)){
-throw`Invalid JSON path: "${jsonPath}"`;
-}
-}
-
-private_findParent(jsonPath: string): {parent: any,name: string|number,remaining?: string}{
-this._validatePath(jsonPath);
-
-letparent: any=null;
-letcurrent: any=this._config;
-
-constsplitPath=jsonPath.split('.');
-letname: string|number='';
-
-while(splitPath.length>0){
-constm=splitPath.shift().match(/^(.*?)(?:\[(\d+)\])*$/);
-
-name=m[1];
-constindex: string=m[2];
-parent=current;
-current=current[name];
-
-if(current===null||current===undefined){
-return{
- parent,
- name,
-remaining: (!isNaN(index) ? `[${index}]` : '')+splitPath.join('.')
-};
-}
-
-if(!isNaN(index)){
-name=index;
-parent=current;
-current=current[index];
-
-if(current===null||current===undefined){
-return{
- parent,
- name,
-remaining: splitPath.join('.')
-};
-}
-}
-}
+functiongetUserHome(){
+returnprocess.env[(process.platform=='win32') ? 'USERPROFILE' : 'HOME'];
+}
 
-return{ parent, name };
-}
 
+exportclassCliConfigextendsCliConfigBase<ConfigInterface>{
 privatestatic_configFilePath(projectPath?: string): string{
 // Find the configuration, either where specified, in the angular-cli project
 // (if it's in node_modules) or from the current process.
 return(projectPath&&_findUp(CLI_CONFIG_FILE_NAME,projectPath))
-||_findUp(CLI_CONFIG_FILE_NAME,__dirname)
-||_findUp(CLI_CONFIG_FILE_NAME,process.cwd());
+||_findUp(CLI_CONFIG_FILE_NAME,process.cwd())
+||_findUp(CLI_CONFIG_FILE_NAME,__dirname);
 }
 
-publicstaticfromProject(): any{
-constconfigPath=CliConfig._configFilePath();
+
+staticfromProject(): CliConfig{
+constconfigPath=this._configFilePath();
+constglobalConfigPath=path.join(getUserHome(),CLI_CONFIG_FILE_NAME);
 
 if(!configPath){
 return{};
 }
 
-letconfig=require(configPath);
-
-if(config.defaults.sourceDir||config.defaults.prefix){
-config.apps[0].root=config.apps[0].root||config.defaults.sourceDir;
-config.apps[0].prefix=config.apps[0].prefix||config.defaults.prefix;
-
+constcliConfig=CliConfigBase.fromConfigPath(CliConfig._configFilePath(),[globalConfigPath]);
+if(cliConfig.alias('apps.0.root','defaults.sourceDir')
++cliConfig.alias('apps.0.prefix','defaults.prefix')){
 console.error(chalk.yellow(
-'The "defaults.prefix" and "defaults.sourceDir" properties of angular-cli.json'
+'The "defaults.prefix" and "defaults.sourceDir" properties of angular-cli.json\n'
 +'are deprecated in favor of "apps[0].root" and "apps[0].prefix".\n'
 +'Please update in order to avoid errors in future versions of angular-cli.'
 ));
 }
-
-returnconfig;
+
+returncliConfigasCliConfig;
 }
 }