@carbon/feature-flags 0.1.0 → 0.3.0

package/README.md

@@ -60,7 +60,7 @@ import { enable, disable, merge } from '@carbon/feature-flags';
 enable('feature-flag-a');
 
 // Disable `feature-flag-a`
-disable('feature-flag-a);
+disable('feature-flag-a');
 
 // Set a variety of feature flags to a specific value
 merge({

package/es/index.js

@@ -5,82 +5,189 @@
  * LICENSE file in the root directory of this source tree.
  */
 
+const enabled$1 = {};
+
+try {
+  if (process.env.CARBON_ENABLE_CSS_CUSTOM_PROPERTIES) {
+    if (process.env.CARBON_ENABLE_CSS_CUSTOM_PROPERTIES === 'true') {
+      enabled$1.enableCssCustomProperties = true;
+    } else {
+      enabled$1.enableCssCustomProperties = false;
+    }
+  } else {
+    enabled$1.enableCssCustomProperties = false;
+  }
+
+  if (process.env.CARBON_ENABLE_USE_CONTROLLED_STATE_WITH_VALUE) {
+    if (process.env.CARBON_ENABLE_USE_CONTROLLED_STATE_WITH_VALUE === 'true') {
+      enabled$1.enableUseControlledStateWithValue = true;
+    } else {
+      enabled$1.enableUseControlledStateWithValue = false;
+    }
+  } else {
+    enabled$1.enableUseControlledStateWithValue = false;
+  }
+
+  if (process.env.CARBON_ENABLE_CSS_GRID) {
+    if (process.env.CARBON_ENABLE_CSS_GRID === 'true') {
+      enabled$1.enableCssGrid = true;
+    } else {
+      enabled$1.enableCssGrid = false;
+    }
+  } else {
+    enabled$1.enableCssGrid = false;
+  }
+
+  if (process.env.CARBON_ENABLE_2021_RELEASE) {
+    if (process.env.CARBON_ENABLE_2021_RELEASE === 'true') {
+      enabled$1.enable_2021Release = true;
+    } else {
+      enabled$1.enable_2021Release = false;
+    }
+  } else {
+    enabled$1.enable_2021Release = false;
+  }
+} catch (error) {
+  enabled$1.enableCssCustomProperties = false;
+  enabled$1.enableUseControlledStateWithValue = false;
+  enabled$1.enableCssGrid = false;
+  enabled$1.enable_2021Release = false;
+}
+
 const featureFlagInfo = [{
   name: "enable-css-custom-properties",
   description: "Describe what the flag does",
-  enabled: process.env.CARBON_ENABLE_CSS_CUSTOM_PROPERTIES || false
+  enabled: enabled$1.enableCssCustomProperties
 }, {
   name: "enable-use-controlled-state-with-value",
   description: "Enable components to be created in either a controlled or uncontrolled mode\n",
-  enabled: process.env.CARBON_ENABLE_USE_CONTROLLED_STATE_WITH_VALUE || false
+  enabled: enabled$1.enableUseControlledStateWithValue
+}, {
+  name: "enable-css-grid",
+  description: "Enable CSS Grid Layout in the Grid and Column React components\n",
+  enabled: enabled$1.enableCssGrid
+}, {
+  name: "enable-2021-release",
+  description: "Enable the features and functionality for the 2021 Release\n",
+  enabled: enabled$1.enable_2021Release
 }];
 
-const featureFlags = new Map();
+class FeatureFlagScope {
+  constructor(flags) {
+    this.flags = new Map();
+
+    if (flags) {
+      Object.keys(flags).forEach((key) => {
+        this.flags.set(key, flags[key]);
+      });
+    }
+  }
+
+  /**
+   * Check to see if a flag exists
+   * @param {string} name
+   */
+  checkForFlag(name) {
+    if (!this.flags.has(name)) {
+      throw new Error(
+        `Unable to find a feature flag with the name: \`${name}\``
+      );
+    }
+  }
+
+  /**
+   * Add a feature flag
+   * @param {string} name
+   * @param {boolean} enabled
+   */
+  add(name, enabled) {
+    if (this.flags.has(name)) {
+      throw new Error(`The feature flag: ${name} already exists`);
+    }
+    this.flags.set(name, enabled);
+  }
+
+  /**
+   * Enable a feature flag
+   * @param {string} name
+   */
+  enable(name) {
+    this.checkForFlag(name);
+    this.flags.set(name, true);
+  }
+
+  /**
+   * Disable a feature flag
+   * @param {string} name
+   */
+  disable(name) {
+    this.checkForFlag(name);
+    this.flags.set(name, false);
+  }
+
+  /**
+   * Merge the given feature flags with the current set of feature flags.
+   * Duplicate keys will be set to the value in the given feature flags.
+   * @param {object} flags
+   */
+  merge(flags) {
+    Object.keys(flags).forEach((key) => {
+      this.flags.set(key, flags[key]);
+    });
+  }
+
+  /**
+   * @param {FeatureFlagScope} scope
+   */
+  mergeWithScope(scope) {
+    for (const [key, value] of scope.flags) {
+      if (this.flags.has(key)) {
+        continue;
+      }
+      this.flags.set(key, value);
+    }
+  }
+
+  /**
+   * Check if a feature flag is enabled
+   * @param {string} name
+   * @returns {boolean}
+   */
+  enabled(name) {
+    this.checkForFlag(name);
+    return this.flags.get(name);
+  }
+}
+
+const FeatureFlags = createScope();
 
 for (let i = 0; i < featureFlagInfo.length; i++) {
   const featureFlag = featureFlagInfo[i];
-  featureFlags.set(featureFlag.name, featureFlag.enabled);
+  FeatureFlags.add(featureFlag.name, featureFlag.enabled);
 }
 
-/**
- * Check to see if a flag exists
- * @param {string} name
- */
-function checkForFlag(name) {
-  if (!featureFlags.has(name)) {
-    throw new Error(`Unable to find a feature flag with the name \`${name}\``);
-  }
+function createScope(flags) {
+  return new FeatureFlagScope(flags);
 }
 
-/**
- * Add a feature flag
- * @param {string} name
- * @param {boolean} enabled
- */
-function add(name, enabled) {
-  if (featureFlags.has(name)) {
-    throw new Error(`The feature flag: ${name} already exists`);
-  }
-  featureFlags.set(name, enabled);
+function add(...args) {
+  return FeatureFlags.add(...args);
 }
 
-/**
- * Enable a feature flag
- * @param {string} name
- */
-function enable(name) {
-  checkForFlag(name);
-  featureFlags.set(name, true);
+function enable(...args) {
+  return FeatureFlags.enable(...args);
 }
 
-/**
- * Disable a feature flag
- * @param {string} name
- */
-function disable(name) {
-  checkForFlag(name);
-  featureFlags.set(name, false);
+function disable(...args) {
+  return FeatureFlags.disable(...args);
 }
 
-/**
- * Merge the given feature flags with the current set of feature flags.
- * Duplicate keys will be set to the value in the given feature flags.
- * @param {object} flags
- */
-function merge(flags) {
-  Object.keys(flags).forEach((key) => {
-    featureFlags.set(key, flags[key]);
-  });
+function enabled(...args) {
+  return FeatureFlags.enabled(...args);
 }
 
-/**
- * Check if a feature flag is enabled
- * @param {string} name
- * @returns {boolean}
- */
-function enabled(name) {
-  checkForFlag(name);
-  return featureFlags.get(name);
+function merge(...args) {
+  return FeatureFlags.merge(...args);
 }
 
-export { add, disable, enable, enabled, merge, featureFlagInfo as unstable_featureFlagInfo };
+export { FeatureFlags, add, createScope, disable, enable, enabled, merge };

package/lib/index.js

@@ -9,87 +9,195 @@
 
 Object.defineProperty(exports, '__esModule', { value: true });
 
+const enabled$1 = {};
+
+try {
+  if (process.env.CARBON_ENABLE_CSS_CUSTOM_PROPERTIES) {
+    if (process.env.CARBON_ENABLE_CSS_CUSTOM_PROPERTIES === 'true') {
+      enabled$1.enableCssCustomProperties = true;
+    } else {
+      enabled$1.enableCssCustomProperties = false;
+    }
+  } else {
+    enabled$1.enableCssCustomProperties = false;
+  }
+
+  if (process.env.CARBON_ENABLE_USE_CONTROLLED_STATE_WITH_VALUE) {
+    if (process.env.CARBON_ENABLE_USE_CONTROLLED_STATE_WITH_VALUE === 'true') {
+      enabled$1.enableUseControlledStateWithValue = true;
+    } else {
+      enabled$1.enableUseControlledStateWithValue = false;
+    }
+  } else {
+    enabled$1.enableUseControlledStateWithValue = false;
+  }
+
+  if (process.env.CARBON_ENABLE_CSS_GRID) {
+    if (process.env.CARBON_ENABLE_CSS_GRID === 'true') {
+      enabled$1.enableCssGrid = true;
+    } else {
+      enabled$1.enableCssGrid = false;
+    }
+  } else {
+    enabled$1.enableCssGrid = false;
+  }
+
+  if (process.env.CARBON_ENABLE_2021_RELEASE) {
+    if (process.env.CARBON_ENABLE_2021_RELEASE === 'true') {
+      enabled$1.enable_2021Release = true;
+    } else {
+      enabled$1.enable_2021Release = false;
+    }
+  } else {
+    enabled$1.enable_2021Release = false;
+  }
+} catch (error) {
+  enabled$1.enableCssCustomProperties = false;
+  enabled$1.enableUseControlledStateWithValue = false;
+  enabled$1.enableCssGrid = false;
+  enabled$1.enable_2021Release = false;
+}
+
 const featureFlagInfo = [{
   name: "enable-css-custom-properties",
   description: "Describe what the flag does",
-  enabled: process.env.CARBON_ENABLE_CSS_CUSTOM_PROPERTIES || false
+  enabled: enabled$1.enableCssCustomProperties
 }, {
   name: "enable-use-controlled-state-with-value",
   description: "Enable components to be created in either a controlled or uncontrolled mode\n",
-  enabled: process.env.CARBON_ENABLE_USE_CONTROLLED_STATE_WITH_VALUE || false
+  enabled: enabled$1.enableUseControlledStateWithValue
+}, {
+  name: "enable-css-grid",
+  description: "Enable CSS Grid Layout in the Grid and Column React components\n",
+  enabled: enabled$1.enableCssGrid
+}, {
+  name: "enable-2021-release",
+  description: "Enable the features and functionality for the 2021 Release\n",
+  enabled: enabled$1.enable_2021Release
 }];
 
-const featureFlags = new Map();
+class FeatureFlagScope {
+  constructor(flags) {
+    this.flags = new Map();
+
+    if (flags) {
+      Object.keys(flags).forEach((key) => {
+        this.flags.set(key, flags[key]);
+      });
+    }
+  }
+
+  /**
+   * Check to see if a flag exists
+   * @param {string} name
+   */
+  checkForFlag(name) {
+    if (!this.flags.has(name)) {
+      throw new Error(
+        `Unable to find a feature flag with the name: \`${name}\``
+      );
+    }
+  }
+
+  /**
+   * Add a feature flag
+   * @param {string} name
+   * @param {boolean} enabled
+   */
+  add(name, enabled) {
+    if (this.flags.has(name)) {
+      throw new Error(`The feature flag: ${name} already exists`);
+    }
+    this.flags.set(name, enabled);
+  }
+
+  /**
+   * Enable a feature flag
+   * @param {string} name
+   */
+  enable(name) {
+    this.checkForFlag(name);
+    this.flags.set(name, true);
+  }
+
+  /**
+   * Disable a feature flag
+   * @param {string} name
+   */
+  disable(name) {
+    this.checkForFlag(name);
+    this.flags.set(name, false);
+  }
+
+  /**
+   * Merge the given feature flags with the current set of feature flags.
+   * Duplicate keys will be set to the value in the given feature flags.
+   * @param {object} flags
+   */
+  merge(flags) {
+    Object.keys(flags).forEach((key) => {
+      this.flags.set(key, flags[key]);
+    });
+  }
+
+  /**
+   * @param {FeatureFlagScope} scope
+   */
+  mergeWithScope(scope) {
+    for (const [key, value] of scope.flags) {
+      if (this.flags.has(key)) {
+        continue;
+      }
+      this.flags.set(key, value);
+    }
+  }
+
+  /**
+   * Check if a feature flag is enabled
+   * @param {string} name
+   * @returns {boolean}
+   */
+  enabled(name) {
+    this.checkForFlag(name);
+    return this.flags.get(name);
+  }
+}
+
+const FeatureFlags = createScope();
 
 for (let i = 0; i < featureFlagInfo.length; i++) {
   const featureFlag = featureFlagInfo[i];
-  featureFlags.set(featureFlag.name, featureFlag.enabled);
+  FeatureFlags.add(featureFlag.name, featureFlag.enabled);
 }
 
-/**
- * Check to see if a flag exists
- * @param {string} name
- */
-function checkForFlag(name) {
-  if (!featureFlags.has(name)) {
-    throw new Error(`Unable to find a feature flag with the name \`${name}\``);
-  }
+function createScope(flags) {
+  return new FeatureFlagScope(flags);
 }
 
-/**
- * Add a feature flag
- * @param {string} name
- * @param {boolean} enabled
- */
-function add(name, enabled) {
-  if (featureFlags.has(name)) {
-    throw new Error(`The feature flag: ${name} already exists`);
-  }
-  featureFlags.set(name, enabled);
+function add(...args) {
+  return FeatureFlags.add(...args);
 }
 
-/**
- * Enable a feature flag
- * @param {string} name
- */
-function enable(name) {
-  checkForFlag(name);
-  featureFlags.set(name, true);
+function enable(...args) {
+  return FeatureFlags.enable(...args);
 }
 
-/**
- * Disable a feature flag
- * @param {string} name
- */
-function disable(name) {
-  checkForFlag(name);
-  featureFlags.set(name, false);
+function disable(...args) {
+  return FeatureFlags.disable(...args);
 }
 
-/**
- * Merge the given feature flags with the current set of feature flags.
- * Duplicate keys will be set to the value in the given feature flags.
- * @param {object} flags
- */
-function merge(flags) {
-  Object.keys(flags).forEach((key) => {
-    featureFlags.set(key, flags[key]);
-  });
+function enabled(...args) {
+  return FeatureFlags.enabled(...args);
 }
 
-/**
- * Check if a feature flag is enabled
- * @param {string} name
- * @returns {boolean}
- */
-function enabled(name) {
-  checkForFlag(name);
-  return featureFlags.get(name);
+function merge(...args) {
+  return FeatureFlags.merge(...args);
 }
 
+exports.FeatureFlags = FeatureFlags;
 exports.add = add;
+exports.createScope = createScope;
 exports.disable = disable;
 exports.enable = enable;
 exports.enabled = enabled;
 exports.merge = merge;
-exports.unstable_featureFlagInfo = featureFlagInfo;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@carbon/feature-flags",
   "description": "Build with feature flags in Carbon",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "license": "Apache-2.0",
   "main": "lib/index.js",
   "module": "es/index.js",
@@ -11,6 +11,12 @@
     "directory": "packages/feature-flags"
   },
   "bugs": "https://github.com/carbon-design-system/carbon/issues",
+  "files": [
+    "es",
+    "lib",
+    "scss",
+    "index.scss"
+  ],
   "keywords": [
     "ibm",
     "carbon",
@@ -28,6 +34,7 @@
   },
   "devDependencies": {
     "@babel/generator": "^7.10.2",
+    "@babel/template": "^7.12.13",
     "@babel/types": "^7.10.2",
     "@carbon/scss-generator": "^10.13.0",
     "change-case": "^4.1.2",
@@ -38,5 +45,5 @@
     "rollup-plugin-strip-banner": "^2.0.0"
   },
   "sideEffects": false,
-  "gitHead": "d3dc7ca3254a97d52d39ef8d26b9afdbc1235390"
+  "gitHead": "05909da32a2ee6aa2fb1965eb57871ea77c81c0e"
 }

package/scss/generated/feature-flags.scss

@@ -9,4 +9,6 @@
 $generated-feature-flags: (
   'enable-css-custom-properties': false,
   'enable-use-controlled-state-with-value': false,
+  'enable-css-grid': false,
+  'enable-2021-release': false,
 );

package/feature-flags.yml

@@ -1,16 +0,0 @@
-#
-# Copyright IBM Corp. 2015, 2020
-#
-# This source code is licensed under the Apache-2.0 license found in the
-# LICENSE file in the root directory of this source tree.
-#
-
-feature-flags:
-  - name: enable-css-custom-properties
-    description: Describe what the flag does
-    enabled: false
-  - name: enable-use-controlled-state-with-value
-    description: >
-      Enable components to be created in either a controlled or uncontrolled
-      mode
-    enabled: false

package/rollup.config.js

@@ -1,48 +0,0 @@
-/**
- * Copyright IBM Corp. 2015, 2020
- *
- * This source code is licensed under the Apache-2.0 license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-import path from 'path';
-import stripBanner from 'rollup-plugin-strip-banner';
-
-const BANNER = `/**
- * Copyright IBM Corp. 2015, 2020
- *
- * This source code is licensed under the Apache-2.0 license found in the
- * LICENSE file in the root directory of this source tree.
- */
-`;
-
-const baseConfig = {
-  external: [],
-  plugins: [
-    stripBanner(),
-    {
-      renderChunk(code) {
-        return `${BANNER}\n${code}`;
-      },
-    },
-  ],
-};
-
-export default [
-  {
-    ...baseConfig,
-    input: path.join(__dirname, './src/index.js'),
-    output: {
-      file: 'es/index.js',
-      format: 'esm',
-    },
-  },
-  {
-    ...baseConfig,
-    input: path.join(__dirname, './src/index.js'),
-    output: {
-      file: 'lib/index.js',
-      format: 'commonjs',
-    },
-  },
-];

package/src/generated/feature-flags.js

@@ -1,17 +0,0 @@
-/**
- * Code generated by @carbon/feature-flags. DO NOT EDIT.
- *
- * Copyright IBM Corp. 2015, 2020
- *
- * This source code is licensed under the Apache-2.0 license found in the
- * LICENSE file in the root directory of this source tree.
- */
-export const featureFlagInfo = [{
-  name: "enable-css-custom-properties",
-  description: "Describe what the flag does",
-  enabled: process.env.CARBON_ENABLE_CSS_CUSTOM_PROPERTIES || false
-}, {
-  name: "enable-use-controlled-state-with-value",
-  description: "Enable components to be created in either a controlled or uncontrolled mode\n",
-  enabled: process.env.CARBON_ENABLE_USE_CONTROLLED_STATE_WITH_VALUE || false
-}];

package/src/index.js

@@ -1,78 +0,0 @@
-/**
- * Copyright IBM Corp. 2015, 2020
- *
- * This source code is licensed under the Apache-2.0 license found in the
- * LICENSE file in the root directory of this source tree.
- */
-
-import { featureFlagInfo } from './generated/feature-flags';
-
-const featureFlags = new Map();
-
-for (let i = 0; i < featureFlagInfo.length; i++) {
-  const featureFlag = featureFlagInfo[i];
-  featureFlags.set(featureFlag.name, featureFlag.enabled);
-}
-
-/**
- * Check to see if a flag exists
- * @param {string} name
- */
-function checkForFlag(name) {
-  if (!featureFlags.has(name)) {
-    throw new Error(`Unable to find a feature flag with the name \`${name}\``);
-  }
-}
-
-/**
- * Add a feature flag
- * @param {string} name
- * @param {boolean} enabled
- */
-export function add(name, enabled) {
-  if (featureFlags.has(name)) {
-    throw new Error(`The feature flag: ${name} already exists`);
-  }
-  featureFlags.set(name, enabled);
-}
-
-/**
- * Enable a feature flag
- * @param {string} name
- */
-export function enable(name) {
-  checkForFlag(name);
-  featureFlags.set(name, true);
-}
-
-/**
- * Disable a feature flag
- * @param {string} name
- */
-export function disable(name) {
-  checkForFlag(name);
-  featureFlags.set(name, false);
-}
-
-/**
- * Merge the given feature flags with the current set of feature flags.
- * Duplicate keys will be set to the value in the given feature flags.
- * @param {object} flags
- */
-export function merge(flags) {
-  Object.keys(flags).forEach((key) => {
-    featureFlags.set(key, flags[key]);
-  });
-}
-
-/**
- * Check if a feature flag is enabled
- * @param {string} name
- * @returns {boolean}
- */
-export function enabled(name) {
-  checkForFlag(name);
-  return featureFlags.get(name);
-}
-
-export { featureFlagInfo as unstable_featureFlagInfo };