Rename isFormattingActivated to getIsFormattingActivated

src/helpers/isFormattingActivated/index.ts → src/helpers/getIsFormattingActivated/index.ts

@@ -9,7 +9,7 @@ export type FormattingConfiguration = {
   [key in FormattingSettings]: boolean
 }
 
-const isFormattingActivated = () => {
+const getIsFormattingActivated = () => {
   const editorConfiguration = getConfiguration('editor')
   const formattingToggleConfiguration = getConfiguration('formattingToggle')
   const affectsConfiguration = formattingToggleConfiguration.get(
@@ -26,4 +26,4 @@ const isFormattingActivated = () => {
   return isAnyRelevantSettingActivated
 }
 
-export default isFormattingActivated
+export default getIsFormattingActivated

src/helpers/isFormattingActivated/spec.ts → src/helpers/getIsFormattingActivated/spec.ts

@@ -1,6 +1,6 @@
 import { FormattingSettings } from '../../constants'
 import getConfiguration from '../getConfiguration'
-import isFormattingActivated, { FormattingConfiguration } from './'
+import getIsFormattingActivated, { FormattingConfiguration } from './'
 
 jest.mock('../getConfiguration')
 
@@ -27,7 +27,7 @@ const mockGetConfiguration = (configurationMock: ConfigurationMock) =>
     }
   )
 
-describe('The `isFormattingActivated` helper', () => {
+describe('The `getIsFormattingActivated` helper', () => {
   it('should return `true` if any of the formatting settings is enabled (without any custom `affects` configuration)', () => {
     const testCases: ConfigurationMock[] = [
       {
@@ -85,7 +85,7 @@ describe('The `isFormattingActivated` helper', () => {
       mockGetConfiguration(configurationMock)
 
       const expected = true
-      const actual = isFormattingActivated()
+      const actual = getIsFormattingActivated()
 
       expect(actual).toEqual(expected)
     })
@@ -157,7 +157,7 @@ describe('The `isFormattingActivated` helper', () => {
       mockGetConfiguration(configurationMock)
 
       const expected = true
-      const actual = isFormattingActivated()
+      const actual = getIsFormattingActivated()
 
       expect(actual).toEqual(expected)
     })
@@ -173,7 +173,7 @@ describe('The `isFormattingActivated` helper', () => {
     })
 
     const expected = false
-    const actual = isFormattingActivated()
+    const actual = getIsFormattingActivated()
 
     expect(actual).toEqual(expected)
   })
@@ -244,7 +244,7 @@ describe('The `isFormattingActivated` helper', () => {
       mockGetConfiguration(configurationMock)
 
       const expected = false
-      const actual = isFormattingActivated()
+      const actual = getIsFormattingActivated()
 
       expect(actual).toEqual(expected)
     })

src/helpers/getStatusBarText/index.ts

@@ -1,12 +1,12 @@
-import isFormattingActivated from '../isFormattingActivated'
+import getIsFormattingActivated from '../getIsFormattingActivated'
 
 export const ENABLED_TEXT = 'Formatting: $(check)'
 export const DISABLED_TEXT = 'Formatting: $(x)'
 
 const getStatusBarText = () => {
-  const shouldDisableFormatting = isFormattingActivated()
+  const isFormattingActivated = getIsFormattingActivated()
 
-  return shouldDisableFormatting ? ENABLED_TEXT : DISABLED_TEXT
+  return isFormattingActivated ? ENABLED_TEXT : DISABLED_TEXT
 }
 
 export default getStatusBarText

src/helpers/getStatusBarText/spec.ts

@@ -1,13 +1,13 @@
-import isFormattingActivated from '../isFormattingActivated'
+import getIsFormattingActivated from '../getIsFormattingActivated'
 import getStatusBarText, { ENABLED_TEXT, DISABLED_TEXT } from './'
 
-jest.mock('../isFormattingActivated')
+jest.mock('../getIsFormattingActivated')
 
-const mockedIsFormattingActivated = isFormattingActivated as jest.Mock
+const mockedGetIsFormattingActivated = getIsFormattingActivated as jest.Mock
 
 describe('The `getStatusBarText` helper', () => {
   it(`should return \`${ENABLED_TEXT}\` if the formatting is enabled`, () => {
-    mockedIsFormattingActivated.mockReturnValueOnce(true)
+    mockedGetIsFormattingActivated.mockReturnValueOnce(true)
 
     const expected = ENABLED_TEXT
     const actual = getStatusBarText()
@@ -16,7 +16,7 @@ describe('The `getStatusBarText` helper', () => {
   })
 
   it(`should return \`${DISABLED_TEXT}\` if the formatting is disabled`, () => {
-    mockedIsFormattingActivated.mockReturnValueOnce(false)
+    mockedGetIsFormattingActivated.mockReturnValueOnce(false)
 
     const expected = DISABLED_TEXT
     const actual = getStatusBarText()

src/registerCommand.ts

@@ -5,7 +5,7 @@ import {
   DEFAULT_AFFECTS_CONFIGURATION
 } from './constants'
 import getConfiguration from './helpers/getConfiguration'
-import isFormattingActivated from './helpers/isFormattingActivated'
+import getIsFormattingActivated from './helpers/getIsFormattingActivated'
 
 const registerCommand = () =>
   commands.registerCommand(COMMAND_NAME, () => {
@@ -15,15 +15,15 @@ const registerCommand = () =>
       'affects',
       DEFAULT_AFFECTS_CONFIGURATION
     )
-    const shouldDisableFormatting = isFormattingActivated()
+    const isFormattingActivated = getIsFormattingActivated()
 
     // Updating the configuration will trigger the `onDidChangeConfiguration`
     // handler which will correctly update the text and icon in the status bar.
     FORMATTING_SETTINGS.forEach(setting => {
       if (affectsConfiguration.includes(setting)) {
         editorConfiguration.update(
           setting,
-          !shouldDisableFormatting,
+          !isFormattingActivated,
           ConfigurationTarget.Global
         )
       }