[core] Bugfix/consistent naming (#53)

* doc: improved code styling in readme

* infra: uninstalled react-dom

* chore: cleaned up

* infra: extracted supported from hook in useMediaCapabilities

* doc: cleaned code snippet for useMediaCapabilities in README

* [chore] updated initialStatus argument naming in hooks

Author: anton-karlovskiy

README.md

@@ -100,12 +100,12 @@ const MyComponent = () => {
 
 `saveData` values can be `true` or `false`.
 
-This hook accepts an optional `initialSaveDataStatus` boolean argument, which can be used to provide a `saveData` state value when the user's browser does not support the relevant [NetworkInformation API](https://wicg.github.io/netinfo/). Passing an initial value can also prove useful for server-side rendering, where the developer can pass a server [Save-Data Client Hint](https://developers.google.com/web/fundamentals/performance/optimizing-content-efficiency/client-hints#save-data) that has been converted to a boolean to detect the user's data saving preference.
+This hook accepts an optional `initialSaveData` boolean argument, which can be used to provide a `saveData` state value when the user's browser does not support the relevant [NetworkInformation API](https://wicg.github.io/netinfo/). Passing an initial value can also prove useful for server-side rendering, where the developer can pass a server [Save-Data Client Hint](https://developers.google.com/web/fundamentals/performance/optimizing-content-efficiency/client-hints#save-data) that has been converted to a boolean to detect the user's data saving preference.
 
 ```js
 // Inside of a functional React component
-const initialSaveDataStatus = true;
-const { saveData } = useSaveData(initialSaveDataStatus);
+const initialSaveData = true;
+const { saveData } = useSaveData(initialSaveData);
 ```
 
 ### CPU Cores / Hardware Concurrency

package.json

@@ -34,4 +34,4 @@
     "react",
     "performance"
   ]
-}
+}

save-data/index.js

@@ -1,34 +1,34 @@
-/*
- * Copyright 2019 Google LLC
- *
- * Licensed under the Apache License, Version 2.0 (the "License");
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an "AS IS" BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-let unsupported;
-
-const useSaveData = (initialSaveDataStatus = null) => {
-  if (typeof navigator !== 'undefined' && 'connection' in navigator && 'saveData' in navigator.connection) {
-    unsupported = false;
-  } else {
-    unsupported = true;
-  }
-
-  return {
-    unsupported,
-    saveData: unsupported
-      ? initialSaveDataStatus
-      : navigator.connection.saveData === true
-  };
-};
-
-export { useSaveData };
+/*
+ * Copyright 2019 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+let unsupported;
+
+const useSaveData = (initialSaveData = null) => {
+  if (typeof navigator !== 'undefined' && 'connection' in navigator && 'saveData' in navigator.connection) {
+    unsupported = false;
+  } else {
+    unsupported = true;
+  }
+
+  return {
+    unsupported,
+    saveData: unsupported
+      ? initialSaveData
+      : navigator.connection.saveData === true
+  };
+};
+
+export { useSaveData };

save-data/save-data.test.js

@@ -1,75 +1,75 @@
-/*
- * Copyright 2019 Google LLC
- *
- * Licensed under the Apache License, Version 2.0 (the 'License');
- * you may not use this file except in compliance with the License.
- * You may obtain a copy of the License at
- *
- *     https://www.apache.org/licenses/LICENSE-2.0
- *
- * Unless required by applicable law or agreed to in writing, software
- * distributed under the License is distributed on an 'AS IS' BASIS,
- * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- * See the License for the specific language governing permissions and
- * limitations under the License.
- */
-
-import { renderHook, act } from '@testing-library/react-hooks';
-
-afterEach(function() {
-  // Reload hook for every test
-  jest.resetModules();
-});
-
-describe('useSaveData', () => {
-  test(`should return "true" for unsupported case`, () => {
-    const { useSaveData } = require('./');
-    const { result } = renderHook(() => useSaveData());
-
-    expect(result.current.unsupported).toBe(true);
-    expect(result.current.saveData).toEqual(null);
-  });
-
-  test('should return initialSaveDataStatus for unsupported case', () => {
-    const initialSaveDataStatus = true;
-    const { useSaveData } = require('./');
-    const { result } = renderHook(() => useSaveData(initialSaveDataStatus));
-
-    expect(result.current.unsupported).toBe(true);
-    expect(result.current.saveData).toBe(initialSaveDataStatus);
-  });
-
-  test(`should return "true" for enabled save data`, () => {
-    global.navigator.connection = {
-      saveData: true
-    };
-    const { useSaveData } = require('./');
-    const { result } = renderHook(() => useSaveData());
-
-    expect(result.current.unsupported).toBe(false);
-    expect(result.current.saveData).toEqual(navigator.connection.saveData);
-  });
-
-  test(`should return "false" for disabled save data`, () => {
-    global.navigator.connection = {
-      saveData: false
-    };
-    const { useSaveData } = require('./');
-    const { result } = renderHook(() => useSaveData());
-
-    expect(result.current.unsupported).toBe(false);
-    expect(result.current.saveData).toEqual(navigator.connection.saveData);
-  });
-
-  test('should not return initialSaveDataStatus for supported case', () => {
-    const initialSaveDataStatus = false;
-    global.navigator.connection = {
-      saveData: true
-    };
-    const { useSaveData } = require('./');
-    const { result } = renderHook(() => useSaveData(initialSaveDataStatus));
-
-    expect(result.current.unsupported).toBe(false);
-    expect(result.current.saveData).toEqual(navigator.connection.saveData);
-  });
-});
+/*
+ * Copyright 2019 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the 'License');
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     https://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an 'AS IS' BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { renderHook, act } from '@testing-library/react-hooks';
+
+afterEach(function() {
+  // Reload hook for every test
+  jest.resetModules();
+});
+
+describe('useSaveData', () => {
+  test(`should return "true" for unsupported case`, () => {
+    const { useSaveData } = require('./');
+    const { result } = renderHook(() => useSaveData());
+
+    expect(result.current.unsupported).toBe(true);
+    expect(result.current.saveData).toEqual(null);
+  });
+
+  test('should return initialSaveData for unsupported case', () => {
+    const initialSaveData = true;
+    const { useSaveData } = require('./');
+    const { result } = renderHook(() => useSaveData(initialSaveData));
+
+    expect(result.current.unsupported).toBe(true);
+    expect(result.current.saveData).toBe(initialSaveData);
+  });
+
+  test(`should return "true" for enabled save data`, () => {
+    global.navigator.connection = {
+      saveData: true
+    };
+    const { useSaveData } = require('./');
+    const { result } = renderHook(() => useSaveData());
+
+    expect(result.current.unsupported).toBe(false);
+    expect(result.current.saveData).toEqual(navigator.connection.saveData);
+  });
+
+  test(`should return "false" for disabled save data`, () => {
+    global.navigator.connection = {
+      saveData: false
+    };
+    const { useSaveData } = require('./');
+    const { result } = renderHook(() => useSaveData());
+
+    expect(result.current.unsupported).toBe(false);
+    expect(result.current.saveData).toEqual(navigator.connection.saveData);
+  });
+
+  test('should not return initialSaveData for supported case', () => {
+    const initialSaveData = false;
+    global.navigator.connection = {
+      saveData: true
+    };
+    const { useSaveData } = require('./');
+    const { result } = renderHook(() => useSaveData(initialSaveData));
+
+    expect(result.current.unsupported).toBe(false);
+    expect(result.current.saveData).toEqual(navigator.connection.saveData);
+  });
+});