Merge branch 'main' into prod

Author: github-actions

README.md

@@ -13,8 +13,7 @@ A collection of code snippets built with [Script Lab](//github.com/OfficeDev/scr
 1. [Fork](https://help.github.com/articles/about-forks/) this project into your GitHub account.
 1. Clone your fork to your development computer.
 1. Ensure that you have Node, version 6.10+, installed. (To check the version run the command `node -v`.)
-1. Install `yarn` as a global package `npm install yarn --global`.
-1. Be sure your CLI is in the root of the office-js-snippets repo and run `yarn install`. (It's similar to `npm install`.)
+1. Be sure your CLI is in the root of the office-js-snippets repo and run `npm install` to install all dependencies.
 1. Set up the original \OfficeDev\office-js-snippets as the upstream repo for your local repo by following the steps in [Configuring a remote for a fork](https://help.github.com/articles/configuring-a-remote-for-a-fork/).
 1. If you'll be using Visual Studio Code as your editor, install the [TSLint](https://marketplace.visualstudio.com/items?itemName=eg2.tslint) extension for Visual Studio Code.
 
@@ -46,11 +45,11 @@ A collection of code snippets built with [Script Lab](//github.com/OfficeDev/scr
 
 1. Open one of the `.yaml` files already in the group folder. If it has an `order` property near the top, then the snippets in the group folder are ordered in a particular sequence in Script Lab. Add an `order` property to the top of your `.yaml` file and give it a number that is between the order numbers of the snippets between which you want it to appear.
 1. Copy your `.yaml` file to the chosen group folder.
-1. Run `yarn start`. If there are no problems, the output will end with a `Done!`. If there are errors, review the output to check what caused the build validation to fail, and fix as needed. See [**Known errors and fixes**](#known-errors-and-fixes-in-the-build-tool) for more information.
+1. Run `npm start`. If there are no problems, the output will end with a `Done!`. If there are errors, review the output to check what caused the build validation to fail, and fix as needed. See [**Known errors and fixes**](#known-errors-and-fixes-in-the-build-tool) for more information.
 
-    > **Note**: The `yarn start` command adds an `id` property to the top of the file.
+    > **Note**: The `npm start` command adds an `id` property to the top of the file.
 
-1. Re-run `yarn start`, and fix errors, until the build succeeds.
+1. Re-run `npm start`, and fix errors, until the build succeeds.
 1. Run `git status`. You should see that, in addition to your new `.yaml` file (or possibly new folder), a `playlist\{host}.yaml` file (where `{host}` is `excel`, `word`, etc.) has also been changed. This is expected. The build tool you just ran added a reference to your new snippet to this file.
 1. Run the following two commands. The commit message should be a brief description of what the snippet demonstrates; for example, `"shows how to use getWhatever method"`.
 

config/build.documentation.ts

@@ -36,7 +36,7 @@ export async function buildReferenceDocSnippetExtracts(
     await rmRf('snippet-extractor-output');
     await mkDir('snippet-extractor-output');
 
-    const contents = snippetExtractsPerHost.map(extracts => jsyaml.safeDump(extracts)).join('');
+    const contents = snippetExtractsPerHost.map(extracts => jsyaml.dump(extracts)).join('');
     await writeFile(path.resolve(`snippet-extractor-output/snippets.yaml`), contents);
 }
 
@@ -119,7 +119,7 @@ function getExtractedDataFromSnippet(
     const filename = snippetIdsToFilenames[row.snippetId];
     if (filename) {
         try {
-            const script = (jsyaml.safeLoad(fs.readFileSync(filename).toString()) as ISnippet).script.content;
+            const script = (jsyaml.load(fs.readFileSync(filename).toString()) as ISnippet).script.content;
 
             const fullSnippetTextArray = script.split('\n')
                 .map(line => line.replace(/\r/, ''));

config/build.ts

@@ -2,7 +2,8 @@
 
 import * as path from 'path';
 import { isNil, isString, isArray, isEmpty, sortBy, cloneDeep } from 'lodash';
-import * as chalk from 'chalk';
+import chalk from 'chalk';
+import escapeStringRegexp from 'escape-string-regexp';
 import { status } from './status';
 import {
     SnippetFileInput, SnippetProcessedData,
@@ -14,7 +15,6 @@ import { getShareableYaml } from './snippet.helpers';
 import { processLibraries } from './libraries.processor';
 import { startCase, groupBy, map } from 'lodash';
 import * as jsyaml from 'js-yaml';
-import escapeStringRegexp = require('escape-string-regexp');
 import * as fsx from 'fs-extra';
 
 
@@ -84,7 +84,7 @@ async function processSnippets(processedSnippets: Dictionary<SnippetProcessedDat
 
             const fullPath = path.resolve(dir, file.relativePath);
             const originalFileContents = fsx.readFileSync(fullPath).toString().trim();
-            let snippet = jsyaml.safeLoad(originalFileContents) as ISnippet;
+            let snippet = jsyaml.load(originalFileContents) as ISnippet;
 
             // Do validations & auto-corrections
             validateStringFieldNotEmptyOrThrow(snippet, 'name');
@@ -103,7 +103,11 @@ async function processSnippets(processedSnippets: Dictionary<SnippetProcessedDat
             const additionalFields: ISnippet = <any>{};
             additionalFields.id = snippet.id;
             additionalFields.api_set = snippet.api_set;
-            additionalFields.author = snippet.author;
+
+            // Only set author field if it has a value
+            if (snippet.author) {
+                additionalFields.author = snippet.author;
+            }
 
             if ((typeof (snippet as any).order) !== 'undefined') {
                 // # for ordering, if present (used for samples only)
@@ -537,7 +541,7 @@ async function generatePlaylists(processedSnippets: Dictionary<SnippetProcessedD
             };
         });
 
-        let contents = jsyaml.safeDump(modifiedItems, {
+        let contents = jsyaml.dump(modifiedItems, {
             skipInvalid: true /* skip "undefined" (e.g., for "order" on some of the snippets) */
         });
 

config/helpers.ts

@@ -1,10 +1,9 @@
 import * as path from 'path';
 import * as fs from 'fs';
 import * as os from 'os';
-import * as chalk from 'chalk';
+import chalk from 'chalk';
 import * as jsyaml from 'js-yaml';
-import { console } from './status';
-import * as rimraf from 'rimraf';
+import { rimraf } from 'rimraf';
 import { isObject, isNil, isString, isEmpty } from 'lodash';
 
 export interface SnippetFileInput {
@@ -39,7 +38,7 @@ export interface SnippetProcessedData {
  * @param message Message of the banner.
  * @param chalkFunction Chalk color function.
  */
-export const banner = (title: string, message: string = null, chalkFn: chalk.ChalkChain = null) => {
+export const banner = (title: string, message: string = null, chalkFn: any = null) => {
     if (!chalkFn) {
         chalkFn = chalk.bold;
     }
@@ -55,7 +54,7 @@ export const banner = (title: string, message: string = null, chalkFn: chalk.Cha
 };
 
 export function getPrintableDetails(item: any, indent: number) {
-    const details = jsyaml.safeDump(item, {
+    const details = jsyaml.dump(item, {
         indent: 4,
         lineWidth: -1,
         skipInvalid: true
@@ -83,16 +82,11 @@ export const mkDir = (dir: string) =>
 * Deletes a folder.
 * @param dir An absolute path to the directory.
 */
-export const rmRf = (dir: string) =>
-    new Promise<string>((resolve, reject) => {
-        const location = path.resolve(dir);
-        rimraf(location, (err) => {
-            if (err) {
-                return reject(err);
-            }
-            return resolve(location);
-        });
-    });
+export const rmRf = async (dir: string): Promise<string> => {
+    const location = path.resolve(dir);
+    await rimraf(location);
+    return location;
+};
 
 /**
  * Load all the files and folders in a given directory.

config/snippet.helpers.ts

@@ -91,7 +91,7 @@ function scrubCarriageReturns(snippet: ISnippet) {
 export function getScrubbedSnippet(snippet: ISnippet, keep: SnippetFieldType): ISnippet {
     let copy = {};
     forIn(snippetFields, (fieldType, fieldName) => {
-        if (fieldType & keep) {
+        if (fieldType & keep && snippet[fieldName] !== undefined) {
             copy[fieldName] = snippet[fieldName];
         }
     });
@@ -103,7 +103,7 @@ export function getShareableYaml(rawSnippet: ISnippet, additionalFields: ISnippe
     const snippet = { ...getScrubbedSnippet(rawSnippet, SnippetFieldType.PUBLIC), ...additionalFields };
     scrubCarriageReturns(snippet);
 
-    return jsyaml.safeDump(snippet, {
+    return jsyaml.dump(snippet, {
         indent: 4,
         lineWidth: -1,
         sortKeys: <any>((a, b) => snippetFieldSortingOrder[a] - snippetFieldSortingOrder[b]),

config/status.ts

@@ -1,6 +1,5 @@
-import * as nodeStatus from 'node-status';
-import * as chalk from 'chalk';
-import { isString, find, isNil, isArray } from 'lodash';
+import chalk from 'chalk';
+import { isString, isNil, isArray } from 'lodash';
 
 interface IStage {
     steps: any[];
@@ -13,16 +12,29 @@ export class Status {
     steps: { [step: string]: boolean } = {};
 
     get console() {
-        return nodeStatus.console();
+        // Return the global console object methods
+        return {
+            log: global.console.log.bind(global.console),
+            error: global.console.error.bind(global.console),
+            warn: global.console.warn.bind(global.console),
+            info: global.console.info.bind(global.console)
+        };
     }
 
     constructor() {
-        /* Initialize the status library */
-        this.stages = nodeStatus.addItem('stages', {
-            steps: []
-        });
+        /* Initialize the simple status system */
+        this.stages = {
+            steps: [],
+            count: 0,
+            doneStep: this.doneStep.bind(this)
+        };
+    }
 
-        nodeStatus.start();
+    private doneStep(completed: boolean, message?: string): void {
+        const symbol = completed ? chalk.green('✓') : chalk.red('✗');
+        if (message) {
+            global.console.log(`${symbol} ${message}`);
+        }
     }
 
     /**
@@ -37,22 +49,18 @@ export class Status {
         success = success && additionalDetails.findIndex(item => item instanceof Error) < 0;
 
         const messageArray = getDetailsArray();
+        const symbol = success ? chalk.green('✓') : chalk.red('✗');
 
-        if (messageArray.length === 0) {
-            this.stages.doneStep(success);
-        } else {
-            // Add a newline before
-            messageArray.splice(0, 0, '');
-            this.stages.doneStep(success, messageArray.join('\n    * ') + '\n');
-            //FIXME `${chalk.bold.red('WARNING: one of the messages above was an error')}`)
-        }
-
-        this.steps[stage] = false;
+        // Log the completion with symbol
+        global.console.log(`${symbol} ${stage}`);
 
-        if (!find(this.steps as any, (item) => item === true)) {
-            nodeStatus.stop();
+        if (messageArray.length > 0) {
+            messageArray.forEach(msg => {
+                global.console.log(`    * ${msg}`);
+            });
         }
 
+        this.steps[stage] = false;
 
         // Helper:
         function getDetailsArray() {
@@ -82,12 +90,13 @@ export class Status {
     }
 
     /**
-     * Add a new stage and complete the previous stage.
+     * Add a new stage and mark it as started.
      * @param stage Name of the stage.
      */
     add(stage: string) {
         this.stages.steps.push(stage);
         this.steps[stage] = true;
+        global.console.log(chalk.cyan(`○ ${stage}`));
     }
 }
 

package.json

@@ -23,25 +23,22 @@
   },
   "homepage": "https://github.com/OfficeDev/office-js-snippets#readme",
   "dependencies": {
-    "chalk": "1.1.3",
-    "escape-string-regexp": "^2.0.0",
-    "exceljs": "^4.3.0",
-    "fs-extra": "3.0.1",
-    "js-yaml": "^3.13.1",
+    "chalk": "^4.1.2",
+    "escape-string-regexp": "^4.0.0",
+    "exceljs": "^4.4.0",
+    "fs-extra": "11.3.2",
+    "js-yaml": "^4.1.0",
     "lodash": "^4.17.21",
-    "node-status": "^1.0.0",
-    "rimraf": "^3.0.0",
-    "shelljs": "^0.8.5",
-    "yarn": "^1.22.19"
+    "rimraf": "^6.0.1",
+    "shelljs": "^0.10.0"
   },
   "devDependencies": {
-    "@types/chalk": "0.4.31",
-    "@types/fs-extra": "3.0.1",
-    "@types/js-yaml": "^3.12.0",
-    "@types/lodash": "^4.14.175",
-    "@types/node": "^11.10.5",
-    "@types/shelljs": "^0.8.3",
-    "tslint": "^6.1.0",
-    "typescript": "^3.3.3333"
+    "@types/fs-extra": "^11.0.4",
+    "@types/js-yaml": "^4.0.9",
+    "@types/lodash": "^4.17.20",
+    "@types/node": "^24.5.2",
+    "@types/shelljs": "^0.8.17",
+    "tslint": "^6.1.3",
+    "typescript": "^5.9.2"
   }
 }

playlists-prod/excel.yaml

@@ -30,7 +30,7 @@
 - id: excel-chart-axis
   name: Axis details
   fileName: chart-axis.yaml
-  description: 'Gets, sets, and removes axis unit, label, and title in a chart.'
+  description: Gets, sets, and removes axis unit, label, and title in a chart.
   rawUrl: >-
     https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-axis.yaml
   group: Chart
@@ -162,7 +162,7 @@
 - id: excel-chart-trendlines
   name: Trendlines
   fileName: chart-trendlines.yaml
-  description: 'Adds, gets, and formats trendlines in a chart.'
+  description: Adds, gets, and formats trendlines in a chart.
   rawUrl: >-
     https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-trendlines.yaml
   group: Chart
@@ -189,7 +189,7 @@
 - id: excel-comment-basics
   name: Comment basics
   fileName: comment-basics.yaml
-  description: 'Adds, edits, and removes comments.'
+  description: Adds, edits, and removes comments.
   rawUrl: >-
     https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/comment-basics.yaml
   group: Comments And Notes
@@ -207,7 +207,7 @@
 - id: excel-comment-replies
   name: Comment replies
   fileName: comment-replies.yaml
-  description: 'Adds, edits, and removes comment replies.'
+  description: Adds, edits, and removes comment replies.
   rawUrl: >-
     https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/comment-replies.yaml
   group: Comments And Notes
@@ -225,7 +225,7 @@
 - id: excel-note-basics
   name: Notes
   fileName: excel-note-basics.yaml
-  description: 'Adds, edits, and removes notes.'
+  description: Adds, edits, and removes notes.
   rawUrl: >-
     https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/12-comments-and-notes/excel-note-basics.yaml
   group: Comments And Notes
@@ -319,7 +319,7 @@
 - id: excel-custom-xml-parts-create-set-get-and-delete-custom-xml-parts
   name: Using custom XML parts
   fileName: create-set-get-and-delete-custom-xml-parts.yaml
-  description: 'Creates, sets, gets, and deletes a custom XML part.'
+  description: Creates, sets, gets, and deletes a custom XML part.
   rawUrl: >-
     https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/18-custom-xml-parts/create-set-get-and-delete-custom-xml-parts.yaml
   group: Custom XML Parts
@@ -625,9 +625,9 @@
   api_set:
     ExcelAPI: '1.14'
 - id: excel-named-item-create-and-remove-named-item
-  name: 'Create, access, and remove'
+  name: Create, access, and remove
   fileName: create-and-remove-named-item.yaml
-  description: 'Creates, accesses, and removes named items in a worksheet.'
+  description: Creates, accesses, and removes named items in a worksheet.
   rawUrl: >-
     https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/34-named-item/create-and-remove-named-item.yaml
   group: Named Item
@@ -785,16 +785,16 @@
 - id: excel-range-hyperlink
   name: Hyperlinks
   fileName: range-hyperlink.yaml
-  description: 'Creates, updates, and clears hyperlinks in a range.'
+  description: Creates, updates, and clears hyperlinks in a range.
   rawUrl: >-
     https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/range-hyperlink.yaml
   group: Range
   api_set:
     ExcelApi: '1.7'
 - id: excel-range-insert-delete-and-clear-range
-  name: 'Insert, delete, and clear'
+  name: Insert, delete, and clear
   fileName: insert-delete-clear-range.yaml
-  description: 'Inserts, deletes, and clears a range.'
+  description: Inserts, deletes, and clears a range.
   rawUrl: >-
     https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/42-range/insert-delete-clear-range.yaml
   group: Range
@@ -1217,9 +1217,9 @@
   api_set:
     ExcelApi: '1.1'
 - id: excel-worksheet-add-delete-rename-move-worksheet
-  name: 'Add, delete, rename, and move worksheet'
+  name: Add, delete, rename, and move worksheet
   fileName: add-delete-rename-move-worksheet.yaml
-  description: 'Adds, deletes, renames, and moves a worksheet.'
+  description: Adds, deletes, renames, and moves a worksheet.
   rawUrl: >-
     https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/54-worksheet/add-delete-rename-move-worksheet.yaml
   group: Worksheet