Rename to getEnvVariable

sumup-oss · Oct 24, 2024 · ac3b847 · ac3b847
1 parent e0f520e
commit ac3b847
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 11 deletions.
diff --git a/packages/circuit-ui/components/Display/Display.tsx b/packages/circuit-ui/components/Display/Display.tsx
@@ -18,7 +18,7 @@ import { forwardRef, type HTMLAttributes } from 'react';
 import { clsx } from '../../styles/clsx.js';
 import { CircuitError } from '../../util/errors.js';
 import { deprecate } from '../../util/logger.js';
-import { getEnv } from '../../util/env.js';
+import { getEnvVariable } from '../../util/env.js';
 
 import classes from './Display.module.css';
 
@@ -76,7 +76,7 @@ export const Display = forwardRef<HTMLHeadingElement, DisplayProps>(
     if (
       process.env.NODE_ENV !== 'production' &&
       process.env.NODE_ENV !== 'test' &&
-      !getEnv('UNSAFE_DISABLE_ELEMENT_ERRORS') &&
+      !getEnvVariable('UNSAFE_DISABLE_ELEMENT_ERRORS') &&
       !as
     ) {
       throw new CircuitError('Display', 'The `as` prop is required.');

diff --git a/packages/circuit-ui/components/Headline/Headline.tsx b/packages/circuit-ui/components/Headline/Headline.tsx
@@ -18,7 +18,7 @@ import { forwardRef, type HTMLAttributes } from 'react';
 import { clsx } from '../../styles/clsx.js';
 import { CircuitError } from '../../util/errors.js';
 import { deprecate } from '../../util/logger.js';
-import { getEnv } from '../../util/env.js';
+import { getEnvVariable } from '../../util/env.js';
 
 import classes from './Headline.module.css';
 
@@ -69,7 +69,7 @@ export const Headline = forwardRef<HTMLHeadingElement, HeadlineProps>(
     if (
       process.env.NODE_ENV !== 'production' &&
       process.env.NODE_ENV !== 'test' &&
-      !getEnv('UNSAFE_DISABLE_ELEMENT_ERRORS') &&
+      !getEnvVariable('UNSAFE_DISABLE_ELEMENT_ERRORS') &&
       !as
     ) {
       throw new CircuitError('Headline', 'The `as` prop is required.');

diff --git a/packages/circuit-ui/util/env.spec.ts b/packages/circuit-ui/util/env.spec.ts
@@ -15,10 +15,10 @@
 
 import { beforeEach, describe, expect, it } from 'vitest';
 
-import { getEnv } from './env.js';
+import { getEnvVariable } from './env.js';
 
 describe('env', () => {
-  describe('getEnvironment', () => {
+  describe('getEnvVariable', () => {
     const originalProcess = process;
 
     beforeEach(() => {
@@ -28,24 +28,24 @@ describe('env', () => {
 
     it('should return the environment variable`', () => {
       process.env.FOO = 'foo';
-      const actual = getEnv('FOO');
+      const actual = getEnvVariable('FOO');
       expect(actual).toBe('foo');
     });
 
     it('should return undefined if the environment variable is not defined', () => {
-      const actual = getEnv('FOO');
+      const actual = getEnvVariable('FOO');
       expect(actual).toBeUndefined();
     });
 
     it('should return undefined if `process` is not defined', () => {
       // @ts-expect-error We're testing for this error
       process = undefined;
-      const actual = getEnv('FOO');
+      const actual = getEnvVariable('FOO');
       expect(actual).toBeUndefined();
     });
 
     it('should throw an error when used for `NODE_ENV`', () => {
-      const actual = () => getEnv('NODE_ENV');
+      const actual = () => getEnvVariable('NODE_ENV');
       expect(actual).toThrowError();
     });
   });

diff --git a/packages/circuit-ui/util/env.ts b/packages/circuit-ui/util/env.ts
@@ -13,7 +13,7 @@
  * limitations under the License.
  */
 
-export function getEnv(name: string) {
+export function getEnvVariable(name: string) {
   if (name === 'NODE_ENV') {
     // Some bundlers have special logic for `process.env.NODE_ENV` which
     // relies on it being written as a continuous string. Destructuring or