Skip to content

Commit 393472c

Browse files
update readme and gulp scripts (#532)
1 parent 7ddc5e4 commit 393472c

File tree

17 files changed

+545
-72
lines changed

17 files changed

+545
-72
lines changed

browser/public/index.html

+16
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,7 @@
3737
<a class="nav-link" href="#" data-nav="/samples/charts/category-chart/annotations-all"><span>Annotations All</span></a>
3838
<a class="nav-link" href="#" data-nav="/samples/charts/category-chart/annotations-callouts"><span>Annotations Callouts</span></a>
3939
<a class="nav-link" href="#" data-nav="/samples/charts/category-chart/annotations-crosshairs"><span>Annotations Crosshairs</span></a>
40+
<a class="nav-link" href="#" data-nav="/samples/charts/category-chart/annotations-custom"><span>Annotations Custom</span></a>
4041
<a class="nav-link" href="#" data-nav="/samples/charts/category-chart/annotations-final-value"><span>Annotations Final Value</span></a>
4142
<a class="nav-link" href="#" data-nav="/samples/charts/category-chart/annotations-highlighting"><span>Annotations Highlighting</span></a>
4243
<a class="nav-link" href="#" data-nav="/samples/charts/category-chart/area-chart-multiple-sources"><span>Area Chart Multiple Sources</span></a>
@@ -57,12 +58,14 @@
5758
<a class="nav-link" href="#" data-nav="/samples/charts/category-chart/column-chart-styling"><span>Column Chart Styling</span></a>
5859
<a class="nav-link" href="#" data-nav="/samples/charts/category-chart/column-chart-with-highlighting"><span>Column Chart With Highlighting</span></a>
5960
<a class="nav-link" href="#" data-nav="/samples/charts/category-chart/column-chart-with-tooltips"><span>Column Chart With Tooltips</span></a>
61+
<a class="nav-link" href="#" data-nav="/samples/charts/category-chart/custom-selection"><span>Custom Selection</span></a>
6062
<a class="nav-link" href="#" data-nav="/samples/charts/category-chart/data-aggregations"><span>Data Aggregations</span></a>
6163
<a class="nav-link" href="#" data-nav="/samples/charts/category-chart/data-legend"><span>Data Legend</span></a>
6264
<a class="nav-link" href="#" data-nav="/samples/charts/category-chart/data-legend-formatting-decimals"><span>Data Legend Formatting Decimals</span></a>
6365
<a class="nav-link" href="#" data-nav="/samples/charts/category-chart/data-tooltip"><span>Data Tooltip</span></a>
6466
<a class="nav-link" href="#" data-nav="/samples/charts/category-chart/data-tooltip-formatting-decimals"><span>Data Tooltip Formatting Decimals</span></a>
6567
<a class="nav-link" href="#" data-nav="/samples/charts/category-chart/data-tooltip-positioning"><span>Data Tooltip Positioning</span></a>
68+
<a class="nav-link" href="#" data-nav="/samples/charts/category-chart/format-specifiers"><span>Format Specifiers</span></a>
6669
<a class="nav-link" href="#" data-nav="/samples/charts/category-chart/high-frequency"><span>High Frequency</span></a>
6770
<a class="nav-link" href="#" data-nav="/samples/charts/category-chart/high-volume"><span>High Volume</span></a>
6871
<a class="nav-link" href="#" data-nav="/samples/charts/category-chart/highlighting"><span>Highlighting</span></a>
@@ -97,6 +100,7 @@
97100
</div>
98101
<label id="nav-data-chart" class="nav-component">Data Chart</label>
99102
<div id="nav-data-chart-list" class="nav-list" state="collapsed">
103+
<a class="nav-link" href="#" data-nav="/samples/charts/data-chart/annotations-custom"><span>Annotations Custom</span></a>
100104
<a class="nav-link" href="#" data-nav="/samples/charts/data-chart/axis-annotations"><span>Axis Annotations</span></a>
101105
<a class="nav-link" href="#" data-nav="/samples/charts/data-chart/axis-annotations-corner-radius"><span>Axis Annotations Corner Radius</span></a>
102106
<a class="nav-link" href="#" data-nav="/samples/charts/data-chart/axis-crossing"><span>Axis Crossing</span></a>
@@ -118,6 +122,8 @@
118122
<a class="nav-link" href="#" data-nav="/samples/charts/data-chart/chart-titles"><span>Chart Titles</span></a>
119123
<a class="nav-link" href="#" data-nav="/samples/charts/data-chart/composite-chart"><span>Composite Chart</span></a>
120124
<a class="nav-link" href="#" data-nav="/samples/charts/data-chart/crosshair-layer-styling"><span>Crosshair Layer Styling</span></a>
125+
<a class="nav-link" href="#" data-nav="/samples/charts/data-chart/custom-drawing-annotations"><span>Custom Drawing Annotations</span></a>
126+
<a class="nav-link" href="#" data-nav="/samples/charts/data-chart/custom-editing-data"><span>Custom Editing Data</span></a>
121127
<a class="nav-link" href="#" data-nav="/samples/charts/data-chart/dash-array-axes"><span>Dash Array Axes</span></a>
122128
<a class="nav-link" href="#" data-nav="/samples/charts/data-chart/dash-array-series"><span>Dash Array Series</span></a>
123129
<a class="nav-link" href="#" data-nav="/samples/charts/data-chart/dash-array-tickmarks"><span>Dash Array Tickmarks</span></a>
@@ -132,6 +138,7 @@
132138
<a class="nav-link" href="#" data-nav="/samples/charts/data-chart/type-financial-overlays"><span>Financial Overlays</span></a>
133139
<a class="nav-link" href="#" data-nav="/samples/charts/data-chart/financial-price-series"><span>Financial Price Series</span></a>
134140
<a class="nav-link" href="#" data-nav="/samples/charts/data-chart/type-financial-series"><span>Financial Series</span></a>
141+
<a class="nav-link" href="#" data-nav="/samples/charts/data-chart/format-specifiers"><span>Format Specifiers</span></a>
135142
<a class="nav-link" href="#" data-nav="/samples/charts/data-chart/legends"><span>Legends</span></a>
136143
<a class="nav-link" href="#" data-nav="/samples/charts/data-chart/polar-area-chart"><span>Polar Area Chart</span></a>
137144
<a class="nav-link" href="#" data-nav="/samples/charts/data-chart/polar-area-chart-styling"><span>Polar Area Chart Styling</span></a>
@@ -210,6 +217,7 @@
210217
<a class="nav-link" href="#" data-nav="/samples/charts/financial-chart/data-tooltip"><span>Data Tooltip</span></a>
211218
<a class="nav-link" href="#" data-nav="/samples/charts/financial-chart/data-tooltip-formatting-currency"><span>Data Tooltip Formatting Currency</span></a>
212219
<a class="nav-link" href="#" data-nav="/samples/charts/financial-chart/data-tooltip-styling-props"><span>Data Tooltip Styling Props</span></a>
220+
<a class="nav-link" href="#" data-nav="/samples/charts/financial-chart/format-specifiers"><span>Format Specifiers</span></a>
213221
<a class="nav-link" href="#" data-nav="/samples/charts/financial-chart/high-frequency"><span>High Frequency</span></a>
214222
<a class="nav-link" href="#" data-nav="/samples/charts/financial-chart/high-volume"><span>High Volume</span></a>
215223
<a class="nav-link" href="#" data-nav="/samples/charts/financial-chart/indicator-customization"><span>Indicator Customization</span></a>
@@ -434,6 +442,7 @@
434442
<a class="nav-link" href="#" data-nav="/samples/grids/grid/column-sorting-options"><span>Column Sorting Options</span></a>
435443
<a class="nav-link" href="#" data-nav="/samples/grids/grid/column-sorting-style"><span>Column Sorting Style</span></a>
436444
<a class="nav-link" href="#" data-nav="/samples/grids/grid/conditional-cell-style-1"><span>Conditional Cell Style1</span></a>
445+
<a class="nav-link" href="#" data-nav="/samples/grids/grid/conditional-cell-style-2"><span>Conditional Cell Style2</span></a>
437446
<a class="nav-link" href="#" data-nav="/samples/grids/grid/conditional-row-selectors"><span>Conditional Row Selectors</span></a>
438447
<a class="nav-link" href="#" data-nav="/samples/grids/grid/custom-context-menu"><span>Custom Context Menu</span></a>
439448
<a class="nav-link" href="#" data-nav="/samples/grids/grid/data-batch-editing-actions"><span>Data Batch Editing Actions</span></a>
@@ -466,6 +475,7 @@
466475
<a class="nav-link" href="#" data-nav="/samples/grids/grid/groupby-summary-options"><span>Groupby Summary Options</span></a>
467476
<a class="nav-link" href="#" data-nav="/samples/grids/grid/groupby-summary-styling"><span>Groupby Summary Styling</span></a>
468477
<a class="nav-link" href="#" data-nav="/samples/grids/grid/infinite-scroll"><span>Infinite Scroll</span></a>
478+
<a class="nav-link" href="#" data-nav="/samples/grids/grid/keyboard-custom-navigation"><span>Keyboard Custom Navigation</span></a>
469479
<a class="nav-link" href="#" data-nav="/samples/grids/grid/keyboard-mrl-navigation"><span>Keyboard Mrl Navigation</span></a>
470480
<a class="nav-link" href="#" data-nav="/samples/grids/grid/layout-display-density"><span>Layout Display Density</span></a>
471481
<a class="nav-link" href="#" data-nav="/samples/grids/grid/master-detail"><span>Master Detail</span></a>
@@ -487,6 +497,7 @@
487497
<a class="nav-link" href="#" data-nav="/samples/grids/grid/row-selection-mode"><span>Row Selection Mode</span></a>
488498
<a class="nav-link" href="#" data-nav="/samples/grids/grid/row-selection-template-excel"><span>Row Selection Template Excel</span></a>
489499
<a class="nav-link" href="#" data-nav="/samples/grids/grid/row-selection-template-numbers"><span>Row Selection Template Numbers</span></a>
500+
<a class="nav-link" href="#" data-nav="/samples/grids/grid/row-styles"><span>Row Styles</span></a>
490501
<a class="nav-link" href="#" data-nav="/samples/grids/grid/styling-custom-css"><span>Styling Custom Css</span></a>
491502
<a class="nav-link" href="#" data-nav="/samples/grids/grid/toolbar-sample-1"><span>Toolbar Sample1</span></a>
492503
<a class="nav-link" href="#" data-nav="/samples/grids/grid/toolbar-sample-2"><span>Toolbar Sample2</span></a>
@@ -718,11 +729,16 @@
718729
<label id="nav-dock-manager" class="nav-component">Dock Manager</label>
719730
<div id="nav-dock-manager-list" class="nav-list" state="collapsed">
720731
<a class="nav-link" href="#" data-nav="/samples/layouts/dock-manager/add-content-runtime"><span>Add Content Runtime</span></a>
732+
<a class="nav-link" href="#" data-nav="/samples/layouts/dock-manager/contained-in-boundaries"><span>Contained In Boundaries</span></a>
721733
<a class="nav-link" href="#" data-nav="/samples/layouts/dock-manager/customize-buttons"><span>Customize Buttons</span></a>
722734
<a class="nav-link" href="#" data-nav="/samples/layouts/dock-manager/embedding-frames"><span>Embedding Frames</span></a>
735+
<a class="nav-link" href="#" data-nav="/samples/layouts/dock-manager/focus-panes"><span>Focus Panes</span></a>
736+
<a class="nav-link" href="#" data-nav="/samples/layouts/dock-manager/hide-pane-headers"><span>Hide Pane Headers</span></a>
723737
<a class="nav-link" href="#" data-nav="/samples/layouts/dock-manager/hiding-panes"><span>Hiding Panes</span></a>
724738
<a class="nav-link" href="#" data-nav="/samples/layouts/dock-manager/overview"><span>Overview</span></a>
739+
<a class="nav-link" href="#" data-nav="/samples/layouts/dock-manager/proximity-dock"><span>Proximity Dock</span></a>
725740
<a class="nav-link" href="#" data-nav="/samples/layouts/dock-manager/styling"><span>Styling</span></a>
741+
<a class="nav-link" href="#" data-nav="/samples/layouts/dock-manager/toggle-inner-dock"><span>Toggle Inner Dock</span></a>
726742
<a class="nav-link" href="#" data-nav="/samples/layouts/dock-manager/updating-panes"><span>Updating Panes</span></a>
727743
</div>
728744
<label id="nav-expansion-panel" class="nav-component">Expansion Panel</label>

browser/tasks/gulp-samples.js

+48-51
Original file line numberDiff line numberDiff line change
@@ -439,49 +439,55 @@ function copySamples(cb) {
439439
} exports.copySamples = copySamples;
440440

441441

442-
function updateSampleReadme(cb) {
442+
function updateReadme(cb) {
443443

444-
// log('updating readme files... ');
444+
var changeFilesCount = 0;
445445
var template = fs.readFileSync("./browser/templates/sample/ReadMe.md", "utf8");
446446
for (const sample of samples) {
447447

448-
// let outputPath = sampleOutputFolder + '/' + sample.SampleFolderPath;
449-
let outputPath = sampleOutputFolder + sample.SampleFolderPath + "/ReadMe.md";
450-
makeDirectoryFor(outputPath);
451-
// log(outputPath);
452-
let readmeFile = Transformer.updateReadme(sample, template);
453-
fs.writeFileSync(outputPath, readmeFile);
454-
// break;
455-
}
456-
cb();
457-
} exports.updateSampleReadme = updateSampleReadme;
458-
459-
// updating package.json files for all sample using a template
460-
function updateSamplePackages(cb) {
461-
462-
// getting content of package.json file from templates
463-
let templatePackageFile = fs.readFileSync("./browser/templates/sample/package.json");
464-
let templatePackageJson = JSON.parse(templatePackageFile.toString());
465-
466-
// let last = samples[samples.length - 1];
467-
// let content = Transformer.getPackage(last, templatePackageJson);
468-
// fs.writeFileSync(sampleOutputFolder + "package.json", content);
469-
470-
for (const sample of samples) {
471-
let outputPath = sampleOutputFolder + sample.SampleFolderPath + "/package.json";
472-
let packageFileOld = fs.readFileSync(outputPath).toString();
473-
474-
// makeDirectoryFor(outputPath);
475-
476-
let packageFileNew = Transformer.getPackage(sample, templatePackageJson);
477-
if (packageFileNew !== packageFileOld) {
478-
console.log('file updated: ' + outputPath);
479-
fs.writeFileSync(outputPath, packageFileNew);
448+
let readmePath = sampleOutputFolder + sample.SampleFolderPath + "/ReadMe.md";
449+
makeDirectoryFor(readmePath);
450+
451+
let readmeNewFile = Transformer.updateReadme(sample, template);
452+
453+
let readmeOldFile = "";
454+
if (fs.existsSync(readmePath)) {
455+
readmeOldFile = fs.readFileSync(readmePath).toString();
456+
}
457+
458+
if (readmeNewFile !== readmeOldFile) {
459+
console.log('UPDATED: ' + readmePath)
460+
changeFilesCount++;
461+
fs.writeFileSync(readmePath, readmeNewFile);
480462
}
481463
}
482464

465+
if (changeFilesCount > 0) {
466+
console.log('WARNING: you must commit above ' + changeFilesCount + ' readme files in a pull request')
467+
}
483468
cb();
484-
} exports.updateSamplePackages = updateSamplePackages;
469+
} exports.updateReadme = updateReadme;
470+
471+
// // updating package.json files for all sample using a template
472+
// function updateSamplePackages(cb) {
473+
// // getting content of package.json file from templates
474+
// let templatePackageFile = fs.readFileSync("./browser/templates/sample/package.json");
475+
// let templatePackageJson = JSON.parse(templatePackageFile.toString());
476+
// // let last = samples[samples.length - 1];
477+
// // let content = Transformer.getPackage(last, templatePackageJson);
478+
// // fs.writeFileSync(sampleOutputFolder + "package.json", content);
479+
// for (const sample of samples) {
480+
// let outputPath = sampleOutputFolder + sample.SampleFolderPath + "/package.json";
481+
// let packageFileOld = fs.readFileSync(outputPath).toString();
482+
// // makeDirectoryFor(outputPath);
483+
// let packageFileNew = Transformer.getPackage(sample, templatePackageJson);
484+
// if (packageFileNew !== packageFileOld) {
485+
// console.log('file updated: ' + outputPath);
486+
// fs.writeFileSync(outputPath, packageFileNew);
487+
// }
488+
// }
489+
// cb();
490+
// } exports.updateSamplePackages = updateSamplePackages;
485491

486492
// updating browser's package.json file using template's package.json
487493
function copyPackageJson(cb) {
@@ -939,9 +945,8 @@ function updateIG(cb) {
939945
del.sync("./samples/**/node_modules", {force:true});
940946

941947
// NOTE: change this array with new version of packages and optionally use "@infragistics/" proget prefix, e.g.
942-
// "igniteui-angular-charts" instead of "igniteui-angular-charts", e.g.
943-
// { name: "@infragistics/igniteui-webcomponents-core", version: "22.1.62" }, // proget
944-
// { name: "igniteui-webcomponents-core", version: "3.2.2" }, // npm
948+
// { name: "@infragistics/igniteui-webcomponents-core", version: "22.1.62" }, // LOCAL PROGET
949+
// { name: "igniteui-webcomponents-core", version: "3.2.2" }, // PUBLIC NPM
945950
let packageUpgrades = [
946951
// these IG packages are often updated:
947952
{ name: "@infragistics/igniteui-webcomponents-core" , version: "23.2.17" },
@@ -968,27 +973,19 @@ function updateIG(cb) {
968973
'./package.json', // browser
969974
'./samples/**/package.json',
970975
// './samples/charts/**/package.json',
971-
// './samples/editors/**/package.json',
972-
// './samples/excel/**/package.json',
973976
// './samples/gauges/**/package.json',
974-
// './samples/grids/**/package.json',
975-
// './samples/inputs/**/package.json',
976-
// './samples/layouts/**/package.json',
977-
// './samples/maps/**/package.json',
978-
// './samples/menus/**/package.json',
979-
// './samples/notifications/**/package.json',
980-
// './samples/scheduling/**/package.json',
981-
// './samples/charts/category-chart/**/package.json',
982-
// './samples/maps/geo-map/type-scatter-bubble-series/package.json',
977+
978+
// skip packages in node_modules folders
983979
'!./samples/**/node_modules/**/package.json',
980+
'!./samples/**/node_modules/**',
981+
'!./samples/**/node_modules',
984982
];
985983

986984
// creating package mapping without proget prefix so we can upgrade to/from proget packages
987985
let packageMappings = {};
988986
for (const item of packageUpgrades) {
989987
item.id = item.name.replace("@infragistics/", "");
990-
let name = item.name.replace("@infragistics/", "");
991-
packageMappings[name] = item;
988+
packageMappings[item.id] = item;
992989
}
993990
// console.log(packageMappings);
994991

gulpfile.js

+8-7
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ exports.updateBrowser = updateBrowser = gulp.series(
88
sb.findSamples,
99
sb.copySamples,
1010
sb.updateCodeViewer,
11+
sb.updateReadme,
1112
);
1213

1314
exports.findSamples = findSamples = gulp.series(
@@ -21,8 +22,8 @@ exports.lintSamples = lintSamples = gulp.series(
2122
exports.updateSamples = updateSamples = gulp.series(
2223
// sb.lintSamples,
2324
sb.findSamples,
24-
sb.updateSampleReadme,
25-
sb.updateSamplePackages,
25+
sb.updateReadme,
26+
// sb.updateSamplePackages,
2627
// sb.updateSampleIndex,
2728
sb.updateSampleStyles,
2829
// sb.updateSampleResources,
@@ -31,13 +32,13 @@ exports.updateSamples = updateSamples = gulp.series(
3132

3233
exports.updateReadme = updateReadme = gulp.series(
3334
sb.findSamples,
34-
sb.updateSampleReadme,
35+
sb.updateReadme,
3536
);
3637

37-
exports.updateSamplePackages = updatePackages = gulp.series(
38-
sb.findSamples,
39-
sb.updateSamplePackages,
40-
);
38+
// exports.updateSamplePackages = updatePackages = gulp.series(
39+
// sb.findSamples,
40+
// sb.updateSamplePackages,
41+
// );
4142

4243
exports.updateSampleWebpackConfigs = updateSampleWebpackConfigs = gulp.series(
4344
sb.findSamples,

0 commit comments

Comments
 (0)