@warp-drive-mirror/build-config 5.6.0-alpha.3 → 5.6.0-alpha.5

package/dist/env.js

@@ -1,8 +1,132 @@
+/**
+ * Internal constants for instrumenting the library's code for different environments.
+ *
+ * @hidden
+ * @module
+ */
+
+/**
+ * a `boolean` indicating whether the code is running in a **development environment**
+ * which is converted into a [macroCondition](https://www.npmjs.com/package/@embroider/macros#the-macros) during the package's build process.
+ *
+ * code within a branch where `DEBUG === true` will be removed from **production** builds
+ * while code within a branch where `DEBUG === false` will be removed from **development** builds
+ *
+ * ```ts
+ * if (DEBUG) {
+ *   // debug code
+ * } else {
+ *   // production code
+ * }
+ * ```
+ *
+ * This constant may be used in ternary expressions but should not be
+ * otherwised used as a value.
+ *
+ * Negating the value is supported.
+ *
+ * ```ts
+ * if (!DEBUG) {
+ *   // production code
+ * } else {
+ *   // debug code
+ * }
+ * ```
+ *
+ * @internal
+ */
 const DEBUG = true;
+/**
+ * a `boolean` indicating whether the code is running in a **production environment**
+ * which is converted into a [macroCondition](https://www.npmjs.com/package/@embroider/macros#the-macros) during the package's build process.
+ *
+ * code within a branch where `PRODUCTION === true` will be removed from **development** builds
+ * while code within a branch where `PRODUCTION === false` will be removed from **production** builds
+ *
+ * ```ts
+ * if (PRODUCTION) {
+ *  // production code
+ * } else {
+ *   // debug code
+ * }
+ * ```
+ *
+ * This constant may be used in ternary expressions but should not be
+ * otherwised used as a value.
+ *
+ * Negating the value is supported.
+ *
+ * ```ts
+ * if (!PRODUCTION) {
+ *  // debug code
+ * } else {
+ *  // production code
+ * }
+ * ```
+ *
+ * @internal
+ */
 const PRODUCTION = true;
+/**
+ * a `boolean` indicating whether the code is running in a **testing environment**
+ * which is converted into a [macroCondition](https://www.npmjs.com/package/@embroider/macros#the-macros) during the package's build process.
+ *
+ * TESTING can be true for both development and production builds, it is always true
+ * in a development build, and also true when any of the following ENV variables are set:
+ *
+ * - `EMBER_ENV === 'test'`
+ * - `IS_TESTING`
+ * - `EMBER_CLI_TEST_COMMAND`
+ *
+ * ```ts
+ * if (TESTING) {
+ *   // test env code
+ * } else {
+ *   // non-test env code
+ * }
+ * ```
+ *
+ * Like DEBUG and PRODUCTION, this constant is converted into a macro during the package's
+ * build process, and code within the `false` branch will be removed from the build output.
+ *
+ * This constant may be used in ternary expressions but should not be
+ * otherwised used as a value.
+ *
+ * Negating the value is supported.
+ *
+ * ```ts
+ * if (!TESTING) {
+ *   // production code
+ * } else {
+ *   // testing code
+ * }
+ * ```
+ *
+ * @internal
+ */
 const TESTING = true;
+/**
+ * Indicates whether Holodeck is in a forced global recording mode.
+ *
+ * @internal
+ */
 const IS_RECORDING = true;
+/**
+ * Indicates whether the code is running in a CI environment.
+ *
+ * This is determined by the presence of the `CI` environment variable.
+ *
+ * @internal
+ */
 const IS_CI = true;
+/**
+ * Indicates whether holodeck should record the current test run.
+ *
+ * This is always true in a non-CI environment, and is true if
+ * `IS_RECORDING` is true.
+ *
+ * @internal
+ */
 const SHOULD_RECORD = true;
 
 export { DEBUG, IS_CI, IS_RECORDING, PRODUCTION, SHOULD_RECORD, TESTING };

package/dist/env.js.map

@@ -1 +1 @@
-{"version":3,"file":"env.js","sources":["../src/env.ts"],"sourcesContent":["export const DEBUG: boolean = true;\nexport const PRODUCTION: boolean = true;\nexport const TESTING: boolean = true;\nexport const IS_RECORDING: boolean = true;\nexport const IS_CI: boolean = true;\nexport const SHOULD_RECORD: boolean = true;\n"],"names":["DEBUG","PRODUCTION","TESTING","IS_RECORDING","IS_CI","SHOULD_RECORD"],"mappings":"AAAO,MAAMA,KAAc,GAAG;AACvB,MAAMC,UAAmB,GAAG;AAC5B,MAAMC,OAAgB,GAAG;AACzB,MAAMC,YAAqB,GAAG;AAC9B,MAAMC,KAAc,GAAG;AACvB,MAAMC,aAAsB,GAAG;;;;"}
+{"version":3,"file":"env.js","sources":["../src/env.ts"],"sourcesContent":["/**\n * Internal constants for instrumenting the library's code for different environments.\n *\n * @hidden\n * @module\n */\n\n/**\n * a `boolean` indicating whether the code is running in a **development environment**\n * which is converted into a [macroCondition](https://www.npmjs.com/package/@embroider/macros#the-macros) during the package's build process.\n *\n * code within a branch where `DEBUG === true` will be removed from **production** builds\n * while code within a branch where `DEBUG === false` will be removed from **development** builds\n *\n * ```ts\n * if (DEBUG) {\n *   // debug code\n * } else {\n *   // production code\n * }\n * ```\n *\n * This constant may be used in ternary expressions but should not be\n * otherwised used as a value.\n *\n * Negating the value is supported.\n *\n * ```ts\n * if (!DEBUG) {\n *   // production code\n * } else {\n *   // debug code\n * }\n * ```\n *\n * @internal\n */\nexport const DEBUG: boolean = true;\n/**\n * a `boolean` indicating whether the code is running in a **production environment**\n * which is converted into a [macroCondition](https://www.npmjs.com/package/@embroider/macros#the-macros) during the package's build process.\n *\n * code within a branch where `PRODUCTION === true` will be removed from **development** builds\n * while code within a branch where `PRODUCTION === false` will be removed from **production** builds\n *\n * ```ts\n * if (PRODUCTION) {\n *  // production code\n * } else {\n *   // debug code\n * }\n * ```\n *\n * This constant may be used in ternary expressions but should not be\n * otherwised used as a value.\n *\n * Negating the value is supported.\n *\n * ```ts\n * if (!PRODUCTION) {\n *  // debug code\n * } else {\n *  // production code\n * }\n * ```\n *\n * @internal\n */\nexport const PRODUCTION: boolean = true;\n/**\n * a `boolean` indicating whether the code is running in a **testing environment**\n * which is converted into a [macroCondition](https://www.npmjs.com/package/@embroider/macros#the-macros) during the package's build process.\n *\n * TESTING can be true for both development and production builds, it is always true\n * in a development build, and also true when any of the following ENV variables are set:\n *\n * - `EMBER_ENV === 'test'`\n * - `IS_TESTING`\n * - `EMBER_CLI_TEST_COMMAND`\n *\n * ```ts\n * if (TESTING) {\n *   // test env code\n * } else {\n *   // non-test env code\n * }\n * ```\n *\n * Like DEBUG and PRODUCTION, this constant is converted into a macro during the package's\n * build process, and code within the `false` branch will be removed from the build output.\n *\n * This constant may be used in ternary expressions but should not be\n * otherwised used as a value.\n *\n * Negating the value is supported.\n *\n * ```ts\n * if (!TESTING) {\n *   // production code\n * } else {\n *   // testing code\n * }\n * ```\n *\n * @internal\n */\nexport const TESTING: boolean = true;\n/**\n * Indicates whether Holodeck is in a forced global recording mode.\n *\n * @internal\n */\nexport const IS_RECORDING: boolean = true;\n/**\n * Indicates whether the code is running in a CI environment.\n *\n * This is determined by the presence of the `CI` environment variable.\n *\n * @internal\n */\nexport const IS_CI: boolean = true;\n/**\n * Indicates whether holodeck should record the current test run.\n *\n * This is always true in a non-CI environment, and is true if\n * `IS_RECORDING` is true.\n *\n * @internal\n */\nexport const SHOULD_RECORD: boolean = true;\n"],"names":["DEBUG","PRODUCTION","TESTING","IS_RECORDING","IS_CI","SHOULD_RECORD"],"mappings":"AAAA;AACA;AACA;AACA;AACA;AACA;;AAEA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMA,KAAc,GAAG;AAC9B;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMC,UAAmB,GAAG;AACnC;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMC,OAAgB,GAAG;AAChC;AACA;AACA;AACA;AACA;AACO,MAAMC,YAAqB,GAAG;AACrC;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMC,KAAc,GAAG;AAC9B;AACA;AACA;AACA;AACA;AACA;AACA;AACA;AACO,MAAMC,aAAsB,GAAG;;;;"}