fix: use more inclusive terminology in code (palantir#4226)

Author: adidahiya

.circleci/config-master.yml .circleci/config-gh-pages.yml

@@ -10,10 +10,10 @@
         "bundle": "lerna run --parallel bundle",
         "compile": "lerna run compile",
         "clean": "lerna run --parallel clean",
-        "copy:ci-config": "mkdir -p site/.circleci && cp .circleci/config-master.yml site/.circleci/config.yml",
+        "copy:ci-config": "mkdir -p site/.circleci && cp .circleci/config-gh-pages.yml site/.circleci/config.yml",
         "copy:docs-app": "cp -rf packages/docs-app/dist/ site/docs",
         "copy:landing-app": "cp -rf packages/landing-app/dist/ site",
-        "deploy": "gh-pages -d site -b master",
+        "deploy": "gh-pages -d site -b gh-pages",
         "dev": "lerna run dev --parallel --ignore \"!@blueprintjs/{landing-app,table-dev-app}\"",
         "dev:core": "lerna run dev --parallel --scope \"@blueprintjs/{core,icons,docs-app}\"",
         "dev:docs": "lerna run dev --parallel --scope \"@blueprintjs/{core,docs-app,docs-theme}\"",

package.json

@@ -137,12 +137,12 @@ const INVALID_PROPS = [
 ];
 
 /**
- * Typically applied to HTMLElements to filter out blacklisted props. When applied to a Component,
+ * Typically applied to HTMLElements to filter out disallowed props. When applied to a Component,
  * can filter props from being passed down to the children. Can also filter by a combined list of
- * supplied prop keys and the blacklist (only appropriate for HTMLElements).
+ * supplied prop keys and the denylist (only appropriate for HTMLElements).
  * @param props The original props object to filter down.
- * @param {string[]} invalidProps If supplied, overwrites the default blacklist.
- * @param {boolean} shouldMerge If true, will merge supplied invalidProps and blacklist together.
+ * @param {string[]} invalidProps If supplied, overwrites the default denylist.
+ * @param {boolean} shouldMerge If true, will merge supplied invalidProps and denylist together.
  */
 export function removeNonHTMLProps(
     props: { [key: string]: any },

packages/core/src/common/props.ts

@@ -14,14 +14,19 @@
  * limitations under the License.
  */
 
+/** @deprecated use IKeyAllowlist */
+export type IKeyWhitelist<T> = IKeyAllowlist<T>;
+/** @deprecated use IKeyDenylist */
+export type IKeyBlacklist<T> = IKeyDenylist<T>;
+
 // we use the empty object {} a lot in this public API
 /* eslint-disable @typescript-eslint/ban-types */
 
-export interface IKeyWhitelist<T> {
+export interface IKeyAllowlist<T> {
     include: Array<keyof T>;
 }
 
-export interface IKeyBlacklist<T> {
+export interface IKeyDenylist<T> {
     exclude: Array<keyof T>;
 }
 
@@ -46,7 +51,7 @@ export function arraysEqual(arrA: any[], arrB: any[], compare = (a: any, b: any)
  * of keys will be compared; otherwise, all keys will be compared.
  * @returns true if items are equal.
  */
-export function shallowCompareKeys<T extends {}>(objA: T, objB: T, keys?: IKeyBlacklist<T> | IKeyWhitelist<T>) {
+export function shallowCompareKeys<T extends {}>(objA: T, objB: T, keys?: IKeyDenylist<T> | IKeyAllowlist<T>) {
     // treat `null` and `undefined` as the same
     if (objA == null && objB == null) {
         return true;
@@ -122,7 +127,7 @@ export function getDeepUnequalKeyValues<T extends {}>(
 /**
  * Partial shallow comparison between objects using the given list of keys.
  */
-function shallowCompareKeysImpl<T>(objA: T, objB: T, keys: IKeyBlacklist<T> | IKeyWhitelist<T>) {
+function shallowCompareKeysImpl<T>(objA: T, objB: T, keys: IKeyDenylist<T> | IKeyAllowlist<T>) {
     return filterKeys(objA, objB, keys).every(key => {
         return objA.hasOwnProperty(key) === objB.hasOwnProperty(key) && objA[key] === objB[key];
     });
@@ -141,17 +146,17 @@ function isSimplePrimitiveType(value: any) {
     return typeof value === "number" || typeof value === "string" || typeof value === "boolean";
 }
 
-function filterKeys<T>(objA: T, objB: T, keys: IKeyBlacklist<T> | IKeyWhitelist<T>) {
-    if (isWhitelist(keys)) {
+function filterKeys<T>(objA: T, objB: T, keys: IKeyDenylist<T> | IKeyAllowlist<T>) {
+    if (isAllowlist(keys)) {
         return keys.include;
-    } else if (isBlacklist(keys)) {
+    } else if (isDenylist(keys)) {
         const keysA = Object.keys(objA);
         const keysB = Object.keys(objB);
 
         // merge keys from both objects into a big set for quick access
         const keySet = arrayToObject(keysA.concat(keysB));
 
-        // delete blacklisted keys from the key set
+        // delete denied keys from the key set
         keys.exclude.forEach(key => delete keySet[key]);
 
         // return the remaining keys as an array
@@ -161,12 +166,12 @@ function filterKeys<T>(objA: T, objB: T, keys: IKeyBlacklist<T> | IKeyWhitelist<
     return [];
 }
 
-function isWhitelist<T>(keys: any): keys is IKeyWhitelist<T> {
-    return keys != null && (keys as IKeyWhitelist<T>).include != null;
+function isAllowlist<T>(keys: any): keys is IKeyAllowlist<T> {
+    return keys != null && (keys as IKeyAllowlist<T>).include != null;
 }
 
-function isBlacklist<T>(keys: any): keys is IKeyBlacklist<T> {
-    return keys != null && (keys as IKeyBlacklist<T>).exclude != null;
+function isDenylist<T>(keys: any): keys is IKeyDenylist<T> {
+    return keys != null && (keys as IKeyDenylist<T>).exclude != null;
 }
 
 function arrayToObject(arr: any[]) {

packages/core/src/common/utils/compareUtils.ts

@@ -36,7 +36,7 @@ describe("Props", () => {
             };
         });
 
-        it("removes only from curated blacklist when supplied 1 argument", () => {
+        it("removes only from curated denylist when supplied 1 argument", () => {
             assert.deepEqual(removeNonHTMLProps(props), {
                 apple: true,
                 banana: true,
@@ -56,7 +56,7 @@ describe("Props", () => {
             });
         });
 
-        it("removes from the curated blacklist and the supplied array when shouldMerge=true", () => {
+        it("removes from the curated denylist and the supplied array when shouldMerge=true", () => {
             assert.deepEqual(removeNonHTMLProps(props, ["apple", "banana"], true), { cat: true });
         });
     });

packages/core/test/common/propsTests.ts

@@ -17,7 +17,7 @@
 /* eslint-disable max-classes-per-file */
 
 import { expect } from "chai";
-import { IKeyBlacklist, IKeyWhitelist } from "../../../src/common/utils";
+import { IKeyAllowlist, IKeyDenylist } from "../../../src/common/utils";
 import * as CompareUtils from "../../../src/common/utils/compareUtils";
 
 describe("CompareUtils", () => {
@@ -89,15 +89,15 @@ describe("CompareUtils", () => {
                 expectedResult: boolean,
                 a: any,
                 b: any,
-                keys: IKeyBlacklist<IKeys> | IKeyWhitelist<IKeys>,
+                keys: IKeyDenylist<IKeys> | IKeyAllowlist<IKeys>,
             ) {
                 it(getCompareTestDescription(a, b), () => {
                     expect(CompareUtils.shallowCompareKeys(a, b, keys)).to.equal(expectedResult);
                 });
             }
         });
 
-        describe("with `keys` defined as blacklist", () => {
+        describe("with `keys` defined as denylist", () => {
             describe("returns true if only the specified values are shallowly equal", () => {
                 runTest(true, { a: 1 }, { a: 1 }, bl(["b", "c", "d"]));
                 runTest(true, { a: 1, b: [1, 2, 3], c: "3" }, { b: [1, 2, 3], a: 1, c: "3" }, bl(["b"]));
@@ -127,7 +127,7 @@ describe("CompareUtils", () => {
                 expectedResult: boolean,
                 a: any,
                 b: any,
-                keys: IKeyBlacklist<IKeys> | IKeyWhitelist<IKeys>,
+                keys: IKeyDenylist<IKeys> | IKeyAllowlist<IKeys>,
             ) {
                 it(getCompareTestDescription(a, b), () => {
                     expect(CompareUtils.shallowCompareKeys(a, b, keys)).to.equal(expectedResult);
@@ -323,15 +323,15 @@ interface IKeys {
 }
 
 /**
- * A compactly named function for converting a string array to a key blacklist.
+ * A compactly named function for converting a string array to a key denylist.
  */
-function bl(keys: string[]): IKeyBlacklist<IKeys> {
+function bl(keys: string[]): IKeyDenylist<IKeys> {
     return { exclude: keys as Array<keyof IKeys> };
 }
 
 /**
  * A compactly named function for converting a string array to a key whitelist.
  */
-function wl(keys: string[]): IKeyWhitelist<IKeys> {
+function wl(keys: string[]): IKeyAllowlist<IKeys> {
     return { include: keys as Array<keyof IKeys> };
 }

packages/core/test/common/utils/compareUtilsTests.ts

@@ -29,10 +29,10 @@ const CSS_FONT_PROPERTIES = ["font-style", "font-variant", "font-weight", "font-
 
 // the functions using these interfaces now live in core. it's not clear how to
 // import interfaces from core and re-export them here, so just redefine them.
-export interface IKeyWhitelist<T> {
+export interface IKeyAllowlist<T> {
     include: Array<keyof T>;
 }
-export interface IKeyBlacklist<T> {
+export interface IKeyDenylist<T> {
     exclude: Array<keyof T>;
 }
 

packages/table/src/common/utils.ts

@@ -230,7 +230,7 @@ export interface IHeaderState {
     hasValidSelection?: boolean;
 }
 
-const SHALLOW_COMPARE_PROP_KEYS_BLACKLIST: Array<keyof IInternalHeaderProps> = ["focusedCell", "selectedRegions"];
+const SHALLOW_COMPARE_PROP_KEYS_DENYLIST: Array<keyof IInternalHeaderProps> = ["focusedCell", "selectedRegions"];
 
 export class Header extends React.Component<IInternalHeaderProps, IHeaderState> {
     protected activationIndex: number;
@@ -251,9 +251,9 @@ export class Header extends React.Component<IInternalHeaderProps, IHeaderState>
         return (
             !CoreUtils.shallowCompareKeys(this.state, nextState) ||
             !CoreUtils.shallowCompareKeys(this.props, nextProps, {
-                exclude: SHALLOW_COMPARE_PROP_KEYS_BLACKLIST,
+                exclude: SHALLOW_COMPARE_PROP_KEYS_DENYLIST,
             }) ||
-            !CoreUtils.deepCompareKeys(this.props, nextProps, SHALLOW_COMPARE_PROP_KEYS_BLACKLIST)
+            !CoreUtils.deepCompareKeys(this.props, nextProps, SHALLOW_COMPARE_PROP_KEYS_DENYLIST)
         );
     }
 

packages/table/src/headers/header.tsx

@@ -546,7 +546,7 @@ export class Table extends AbstractComponent2<ITableProps, ITableState, ITableSn
             selectedRegions: newSelectedRegions,
         };
 
-        if (!CoreUtils.deepCompareKeys(state, nextState, Table.SHALLOW_COMPARE_STATE_KEYS_BLACKLIST)) {
+        if (!CoreUtils.deepCompareKeys(state, nextState, Table.SHALLOW_COMPARE_STATE_KEYS_DENYLIST)) {
             return nextState;
         }
 
@@ -565,11 +565,11 @@ export class Table extends AbstractComponent2<ITableProps, ITableState, ITableSn
         getNumBufferLines: 1,
     };
 
-    private static SHALLOW_COMPARE_PROP_KEYS_BLACKLIST = [
+    private static SHALLOW_COMPARE_PROP_KEYS_DENYLIST = [
         "selectedRegions", // (intentionally omitted; can be deeply compared to save on re-renders in controlled mode)
     ] as Array<keyof ITableProps>;
 
-    private static SHALLOW_COMPARE_STATE_KEYS_BLACKLIST = [
+    private static SHALLOW_COMPARE_STATE_KEYS_DENYLIST = [
         "selectedRegions", // (intentionally omitted; can be deeply compared to save on re-renders in uncontrolled mode)
         "viewportRect",
     ] as Array<keyof ITableState>;
@@ -789,14 +789,14 @@ export class Table extends AbstractComponent2<ITableProps, ITableState, ITableSn
     }
 
     public shouldComponentUpdate(nextProps: ITableProps, nextState: ITableState) {
-        const propKeysBlacklist = { exclude: Table.SHALLOW_COMPARE_PROP_KEYS_BLACKLIST };
-        const stateKeysBlacklist = { exclude: Table.SHALLOW_COMPARE_STATE_KEYS_BLACKLIST };
+        const propKeysDenylist = { exclude: Table.SHALLOW_COMPARE_PROP_KEYS_DENYLIST };
+        const stateKeysDenylist = { exclude: Table.SHALLOW_COMPARE_STATE_KEYS_DENYLIST };
 
         return (
-            !CoreUtils.shallowCompareKeys(this.props, nextProps, propKeysBlacklist) ||
-            !CoreUtils.shallowCompareKeys(this.state, nextState, stateKeysBlacklist) ||
-            !CoreUtils.deepCompareKeys(this.props, nextProps, Table.SHALLOW_COMPARE_PROP_KEYS_BLACKLIST) ||
-            !CoreUtils.deepCompareKeys(this.state, nextState, Table.SHALLOW_COMPARE_STATE_KEYS_BLACKLIST)
+            !CoreUtils.shallowCompareKeys(this.props, nextProps, propKeysDenylist) ||
+            !CoreUtils.shallowCompareKeys(this.state, nextState, stateKeysDenylist) ||
+            !CoreUtils.deepCompareKeys(this.props, nextProps, Table.SHALLOW_COMPARE_PROP_KEYS_DENYLIST) ||
+            !CoreUtils.deepCompareKeys(this.state, nextState, Table.SHALLOW_COMPARE_STATE_KEYS_DENYLIST)
         );
     }
 

packages/table/src/table.tsx

@@ -71,13 +71,13 @@ export interface ITableBodyCellsProps extends IRowIndices, IColumnIndices, IProp
     viewportRect: Rect;
 }
 
-const SHALLOW_COMPARE_BLACKLIST: Array<keyof ITableBodyCellsProps> = ["viewportRect"];
+const SHALLOW_COMPARE_DENYLIST: Array<keyof ITableBodyCellsProps> = ["viewportRect"];
 
 /**
  * We don't want to reset the batcher when this set of keys changes. Any other
  * changes should reset the batcher's internal cache.
  */
-const BATCHER_RESET_PROP_KEYS_BLACKLIST: Array<keyof ITableBodyCellsProps> = [
+const BATCHER_RESET_PROP_KEYS_DENYLIST: Array<keyof ITableBodyCellsProps> = [
     "columnIndexEnd",
     "columnIndexStart",
     "rowIndexEnd",
@@ -102,7 +102,7 @@ export class TableBodyCells extends AbstractComponent2<ITableBodyCellsProps> {
     public shouldComponentUpdate(nextProps?: ITableBodyCellsProps) {
         return (
             !CoreUtils.shallowCompareKeys(nextProps, this.props, {
-                exclude: SHALLOW_COMPARE_BLACKLIST,
+                exclude: SHALLOW_COMPARE_DENYLIST,
             }) ||
             // "viewportRect" is not a plain object, so we can't just deep
             // compare; we need custom logic.
@@ -112,7 +112,7 @@ export class TableBodyCells extends AbstractComponent2<ITableBodyCellsProps> {
 
     public componentDidUpdate(prevProps: ITableBodyCellsProps) {
         const shouldResetBatcher = !CoreUtils.shallowCompareKeys(prevProps, this.props, {
-            exclude: BATCHER_RESET_PROP_KEYS_BLACKLIST,
+            exclude: BATCHER_RESET_PROP_KEYS_DENYLIST,
         });
         if (shouldResetBatcher) {
             this.batcher.reset();

packages/table/src/tableBodyCells.tsx

@@ -15,8 +15,8 @@ if [ ! -z "$CIRCLE_TAG" ]; then
     branch='develop'
 fi
 
-if ! [[ "$branch" == "master" || "$branch" == "develop" || "$branch" == "next" || "$branch" == release/* ]]; then
-    echo "Not on master, develop, next, release/* or a tag - not publishing."
+if ! [[ "$branch" == "develop" || "$branch" == "next" || "$branch" == release/* ]]; then
+    echo "Not on develop, next, release/* or a tag - not publishing."
     exit 1
 fi