docs(): minor updates to charts and echarts added as peerDependency (T…

…eradata#29)

* fixed typos

* added echarts to peerDependencies

* added echarts peerDependencies

* docs(): tweak

build.conf.js

@@ -2,6 +2,7 @@
 
 module.exports = {
   deployed: 'deploy/platform/',
+  echartsVersion: '4.1.0',
   angularVersion: '7.0.0',
   materialVersion: '7.0.0'
 };

scripts/version-placeholders.js

@@ -16,11 +16,13 @@ gulp.task('version-placeholder', function(){
 const versionPlaceholderText = '0.0.0-COVALENT';
 const ngVersionPlaceholderText = '0.0.0-NG';
 const materialVersionPlaceholderText = '0.0.0-MATERIAL';
+const echartsVersionPlaceholderText = '0.0.0-ECHARTS';
 
 /** RegExp that matches version placeholders inside of a file. */
 const versionPlaceholderRegex = new RegExp(versionPlaceholderText, 'g');
 const ngVersionPlaceholderRegex = new RegExp(ngVersionPlaceholderText, 'g');
 const materialVersionPlaceholderRegex = new RegExp(materialVersionPlaceholderText, 'g');
+const echartsVersionPlaceholderRegex = new RegExp(echartsVersionPlaceholderText, 'g');
 
 /**
  * Walks through every file in a directory and replaces the version placeholders
@@ -36,6 +38,7 @@ function replaceVersionPlaceholders(packageDir, projectVersion) {
     const fileContent = readFileSync(filePath, 'utf-8')
       .replace(ngVersionPlaceholderRegex, buildConfig.angularVersion)
       .replace(materialVersionPlaceholderRegex, buildConfig.materialVersion)
+      .replace(echartsVersionPlaceholderRegex, buildConfig.echartsVersion)
       .replace(versionPlaceholderRegex, projectVersion);
 
     writeFileSync(filePath, fileContent);
@@ -56,12 +59,12 @@ function buildPlaceholderFindCommand(packageDir) {
   if (platform() === 'win32') {
     return {
       binary: 'findstr',
-      args: ['/msi', `${materialVersionPlaceholderText} ${ngVersionPlaceholderText} ${versionPlaceholderText}`, `${packageDir}\\*`]
+      args: ['/msi', `${materialVersionPlaceholderText} ${ngVersionPlaceholderText} ${echartsVersionPlaceholderText} ${versionPlaceholderText}`, `${packageDir}\\*`]
     };
   } else {
     return {
       binary: 'grep',
-      args: ['-ril', `${materialVersionPlaceholderText}\\|${ngVersionPlaceholderText}\\|${versionPlaceholderText}`, packageDir]
+      args: ['-ril', `${materialVersionPlaceholderText}\\|${echartsVersionPlaceholderText}\\|${ngVersionPlaceholderText}\\|${versionPlaceholderText}`, packageDir]
     };
   }
 }

src/app/components/types/line/line.component.html

@@ -243,4 +243,4 @@
   </mat-card-content>
 </mat-card>
 
-<td-readme-loader resourceUrl="platform/echarts/bar/README.md"></td-readme-loader>
+<td-readme-loader resourceUrl="platform/echarts/line/README.md"></td-readme-loader>

src/platform/echarts/README.md

@@ -17,6 +17,10 @@ Teradata customers work in massive datasets, the largest on the planet. SVG char
 
 ## Installing Covalent Echarts
 
+```bash
+npm install --save echarts
+```
+
 ```bash
 npm install --save @covalent/echarts
 ```

src/platform/echarts/package.json

@@ -30,6 +30,7 @@
     "Steven Ov <[email protected]>"
   ],
   "peerDependencies": {
+    "echarts": "^0.0.0-ECHARTS",
     "@angular/common": "^0.0.0-NG",
     "@angular/core": "^0.0.0-NG"
   }