@nordicsemiconductor/pc-nrfconnect-shared 140.0.0 → 141.0.0

package/Changelog.md

@@ -7,6 +7,18 @@ This project does _not_ adhere to
 [Semantic Versioning](https://semver.org/spec/v2.0.0.html) but contrary to it
 every new version is a new major version.
 
+## 141.0.0 - 2023-12-12
+
+### Added
+
+-   `isLogVisible` state is not persisted per App.
+
+### Changed
+
+-   `showLogByDefault` will not be used if `isLogVisible` is set.
+-   Run eslint or prettier on all Markdown (.md) files except the ones in `docs`
+    folder.
+
 ## 140.0.0 - 2023-12-07
 
 ### Changed

package/config/eslintrc.js

@@ -23,7 +23,7 @@ module.exports = {
         'prettier',
     ],
     ignorePatterns: [
-        '*/**.md',
+        'docs/',
         'package-lock.json',
         'scripts/nordic-publish.js',
         'typings/generated',

package/config/prettier.config.js

@@ -5,7 +5,6 @@
  */
 
 module.exports = {
-    ignore: ['*/**.md'],
     singleQuote: true,
     tabWidth: 4,
     arrowParens: 'avoid',

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@nordicsemiconductor/pc-nrfconnect-shared",
-    "version": "140.0.0",
+    "version": "141.0.0",
     "description": "Shared commodities for developing pc-nrfconnect-* packages",
     "repository": {
         "type": "git",

package/src/App/App.tsx

@@ -30,7 +30,10 @@ import LogViewer from '../Log/LogViewer';
 import logger from '../logging';
 import NavBar from '../NavBar/NavBar';
 import classNames from '../utils/classNames';
-import { getPersistedCurrentPane } from '../utils/persistentStore';
+import {
+    getPersistedCurrentPane,
+    getPersistedLogVisible,
+} from '../utils/persistentStore';
 import usageData from '../utils/usageData';
 import useHotKey from '../utils/useHotKey';
 import {
@@ -38,8 +41,8 @@ import {
     isLogVisible as isLogVisibleSelector,
     isSidePanelVisible as isSidePanelVisibleSelector,
     setCurrentPane,
+    setLogVisible,
     setPanes,
-    toggleLogVisible,
 } from './appLayout';
 import ConnectedToStore from './ConnectedToStore';
 import VisibilityBar from './VisibilityBar';
@@ -115,8 +118,15 @@ const ConnectedApp: FC<ConnectedAppProps> = ({
     }, [dispatch, autoReselectByDefault]);
 
     useEffect(() => {
-        if (!showLogByDefault) {
-            dispatch(toggleLogVisible());
+        const persistedLogVisible = getPersistedLogVisible();
+        // If they are equal, the current setting is already correct
+        // getPersistedLogVisible is used to initialise the redux state
+        if (showLogByDefault !== getPersistedLogVisible()) {
+            if (persistedLogVisible !== undefined) {
+                dispatch(setLogVisible(persistedLogVisible));
+            } else {
+                dispatch(setLogVisible(showLogByDefault));
+            }
         }
     }, [dispatch, showLogByDefault]);
 

package/src/App/VisibilityBar.tsx

@@ -18,7 +18,7 @@ import useHotKey from '../utils/useHotKey';
 import {
     isLogVisible as isLogVisibleSelector,
     isSidePanelVisible as isSidePanelVisibleSelector,
-    toggleLogVisible,
+    setLogVisible,
     toggleSidePanelVisible,
 } from './appLayout';
 
@@ -48,7 +48,7 @@ export default ({ isSidePanelEnabled }: { isSidePanelEnabled: boolean }) => {
         hotKey: 'ctrl+l',
         title: 'Show log',
         isGlobal: true,
-        action: () => dispatch(toggleLogVisible()),
+        action: () => dispatch(setLogVisible(!isLogVisible)),
     });
 
     return (
@@ -93,7 +93,7 @@ export default ({ isSidePanelEnabled }: { isSidePanelEnabled: boolean }) => {
                     id="visibility-bar-show-log"
                     label="Show log"
                     title="ctrl+l"
-                    onToggle={() => dispatch(toggleLogVisible())}
+                    onToggle={() => dispatch(setLogVisible(!isLogVisible))}
                     isToggled={isLogVisible}
                     variant="secondary"
                 />

package/src/App/appLayout.ts

@@ -7,7 +7,11 @@
 import { createSlice, PayloadAction } from '@reduxjs/toolkit';
 
 import type { RootState } from '../store';
-import { persistCurrentPane } from '../utils/persistentStore';
+import {
+    getPersistedLogVisible,
+    persistCurrentPane,
+    persistLogVisible,
+} from '../utils/persistentStore';
 
 export interface AppLayout {
     isSidePanelVisible: boolean;
@@ -18,7 +22,7 @@ export interface AppLayout {
 
 const initialState: AppLayout = {
     isSidePanelVisible: true,
-    isLogVisible: true,
+    isLogVisible: !!getPersistedLogVisible(),
     currentPane: 0,
     paneNames: [],
 };
@@ -40,8 +44,9 @@ const slice = createSlice({
     name: 'appLayout',
     initialState,
     reducers: {
-        toggleLogVisible: state => {
-            state.isLogVisible = !state.isLogVisible;
+        setLogVisible: (state, action: PayloadAction<boolean>) => {
+            state.isLogVisible = action.payload;
+            persistLogVisible(action.payload);
         },
         toggleSidePanelVisible: state => {
             state.isSidePanelVisible = !state.isSidePanelVisible;
@@ -76,7 +81,7 @@ export const {
     actions: {
         setCurrentPane,
         setPanes,
-        toggleLogVisible,
+        setLogVisible,
         toggleSidePanelVisible,
         switchToNextPane,
         switchToPreviousPane,

package/src/utils/persistentStore.ts

@@ -144,6 +144,7 @@ let appSpecificStore: Store | undefined;
 
 interface SharedAppSpecificStoreSchema {
     currentPane?: number;
+    isLogVisible?: boolean;
 }
 
 export const getAppSpecificStore = <
@@ -175,3 +176,10 @@ export const persistCurrentPane = (currentPane: number) =>
     );
 export const getPersistedCurrentPane = () =>
     getAppSpecificStore<SharedAppSpecificStoreSchema>().get(`currentPane`);
+export const persistLogVisible = (visible: boolean) =>
+    getAppSpecificStore<SharedAppSpecificStoreSchema>().set(
+        `isLogVisible`,
+        visible
+    );
+export const getPersistedLogVisible = () =>
+    getAppSpecificStore<SharedAppSpecificStoreSchema>().get(`isLogVisible`);

package/typings/generated/src/App/App.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"App.d.ts","sourceRoot":"","sources":["../../../../src/App/App.tsx"],"names":[],"mappings":"AAMA,OAAO,eAAe,CAAC;AAEvB,OAAO,KAAK,EAAE,EAAE,EAAE,EAAE,SAAS,EAA8B,MAAM,OAAO,CAAC;AAIzE,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAchC,OAAqB,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAoB3E,OAAO,YAAY,CAAC;AACpB,OAAO,eAAe,CAAC;AACvB,OAAO,gBAAgB,CAAC;AAExB,MAAM,WAAW,SAAS;IACtB,MAAM,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,IAAI;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC;IACpB,SAAS,CAAC,EAAE,EAAE,CAAC;CAClB;AAED,UAAU,iBAAiB;IACvB,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,aAAa,CAAC,EAAE,SAAS,EAAE,CAAC;IAC5B,QAAQ,CAAC,EAAE,OAAO,GAAG,iBAAiB,CAAC;IACvC,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACnC;;;;AA6HD,wBASE;AAiDF,eAAO,MAAM,MAAM,QAAS,MAAM,YAAY,SAM7C,CAAC"}
+{"version":3,"file":"App.d.ts","sourceRoot":"","sources":["../../../../src/App/App.tsx"],"names":[],"mappings":"AAMA,OAAO,eAAe,CAAC;AAEvB,OAAO,KAAK,EAAE,EAAE,EAAE,EAAE,SAAS,EAA8B,MAAM,OAAO,CAAC;AAIzE,OAAO,EAAE,OAAO,EAAE,MAAM,OAAO,CAAC;AAchC,OAAqB,EAAE,iBAAiB,EAAE,MAAM,0BAA0B,CAAC;AAuB3E,OAAO,YAAY,CAAC;AACpB,OAAO,eAAe,CAAC;AACvB,OAAO,gBAAgB,CAAC;AAExB,MAAM,WAAW,SAAS;IACtB,MAAM,EAAE,OAAO,CAAC;CACnB;AAED,MAAM,WAAW,IAAI;IACjB,IAAI,EAAE,MAAM,CAAC;IACb,IAAI,EAAE,EAAE,CAAC,SAAS,CAAC,CAAC;IACpB,SAAS,CAAC,EAAE,EAAE,CAAC;CAClB;AAED,UAAU,iBAAiB;IACvB,YAAY,CAAC,EAAE,SAAS,CAAC;IACzB,KAAK,EAAE,IAAI,EAAE,CAAC;IACd,SAAS,CAAC,EAAE,SAAS,CAAC;IACtB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,aAAa,CAAC,EAAE,SAAS,EAAE,CAAC;IAC5B,QAAQ,CAAC,EAAE,OAAO,GAAG,iBAAiB,CAAC;IACvC,QAAQ,CAAC,EAAE,SAAS,CAAC;IACrB,qBAAqB,CAAC,EAAE,OAAO,CAAC;CACnC;;;;AAoID,wBASE;AAiDF,eAAO,MAAM,MAAM,QAAS,MAAM,YAAY,SAM7C,CAAC"}

package/typings/generated/src/App/appLayout.d.ts

@@ -8,7 +8,7 @@ export interface AppLayout {
 interface PaneSpec {
     name: string;
 }
-export declare const reducer: import("redux").Reducer<AppLayout, import("redux").AnyAction>, setCurrentPane: import("@reduxjs/toolkit").ActionCreatorWithPayload<number, "appLayout/setCurrentPane">, setPanes: import("@reduxjs/toolkit").ActionCreatorWithPayload<PaneSpec[], "appLayout/setPanes">, toggleLogVisible: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"appLayout/toggleLogVisible">, toggleSidePanelVisible: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"appLayout/toggleSidePanelVisible">, switchToNextPane: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"appLayout/switchToNextPane">, switchToPreviousPane: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"appLayout/switchToPreviousPane">;
+export declare const reducer: import("redux").Reducer<AppLayout, import("redux").AnyAction>, setCurrentPane: import("@reduxjs/toolkit").ActionCreatorWithPayload<number, "appLayout/setCurrentPane">, setPanes: import("@reduxjs/toolkit").ActionCreatorWithPayload<PaneSpec[], "appLayout/setPanes">, setLogVisible: import("@reduxjs/toolkit").ActionCreatorWithPayload<boolean, "appLayout/setLogVisible">, toggleSidePanelVisible: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"appLayout/toggleSidePanelVisible">, switchToNextPane: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"appLayout/switchToNextPane">, switchToPreviousPane: import("@reduxjs/toolkit").ActionCreatorWithoutPayload<"appLayout/switchToPreviousPane">;
 export declare const isSidePanelVisible: (state: RootState) => boolean;
 export declare const isLogVisible: (state: RootState) => boolean;
 export declare const paneNames: (state: RootState) => string[];

package/typings/generated/src/App/appLayout.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"appLayout.d.ts","sourceRoot":"","sources":["../../../../src/App/appLayout.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAG1C,MAAM,WAAW,SAAS;IACtB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,YAAY,EAAE,OAAO,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,EAAE,CAAC;CACvB;AAkBD,UAAU,QAAQ;IACd,IAAI,EAAE,MAAM,CAAC;CAChB;AAqCD,eAAO,MACH,OAAO,iEAEH,cAAc,2FACd,QAAQ,yFACR,gBAAgB,wFAChB,sBAAsB,8FACtB,gBAAgB,wFAChB,oBAAoB,0FAEnB,CAAC;AAEV,eAAO,MAAM,kBAAkB,UAAW,SAAS,YACb,CAAC;AACvC,eAAO,MAAM,YAAY,UAAW,SAAS,YAAiC,CAAC;AAC/E,eAAO,MAAM,SAAS,UAAW,SAAS,aAA8B,CAAC;AAEzE,eAAO,MAAM,WAAW,kBAAmB,SAAS,WAGrB,CAAC"}
+{"version":3,"file":"appLayout.d.ts","sourceRoot":"","sources":["../../../../src/App/appLayout.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,UAAU,CAAC;AAO1C,MAAM,WAAW,SAAS;IACtB,kBAAkB,EAAE,OAAO,CAAC;IAC5B,YAAY,EAAE,OAAO,CAAC;IACtB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,EAAE,CAAC;CACvB;AAkBD,UAAU,QAAQ;IACd,IAAI,EAAE,MAAM,CAAC;CAChB;AAsCD,eAAO,MACH,OAAO,iEAEH,cAAc,2FACd,QAAQ,yFACR,aAAa,2FACb,sBAAsB,8FACtB,gBAAgB,wFAChB,oBAAoB,0FAEnB,CAAC;AAEV,eAAO,MAAM,kBAAkB,UAAW,SAAS,YACb,CAAC;AACvC,eAAO,MAAM,YAAY,UAAW,SAAS,YAAiC,CAAC;AAC/E,eAAO,MAAM,SAAS,UAAW,SAAS,aAA8B,CAAC;AAEzE,eAAO,MAAM,WAAW,kBAAmB,SAAS,WAGrB,CAAC"}

package/typings/generated/src/utils/persistentStore.d.ts

@@ -31,9 +31,12 @@ export declare const persistIsLoggingVerbose: (value: boolean) => void;
 export declare const getIsLoggingVerbose: () => boolean;
 interface SharedAppSpecificStoreSchema {
     currentPane?: number;
+    isLogVisible?: boolean;
 }
 export declare const getAppSpecificStore: <StoreSchema extends Record<string, any>>(options?: Store.Options<any>) => Store<StoreSchema & SharedAppSpecificStoreSchema>;
 export declare const persistCurrentPane: (currentPane: number) => void;
 export declare const getPersistedCurrentPane: () => number | undefined;
+export declare const persistLogVisible: (visible: boolean) => void;
+export declare const getPersistedLogVisible: () => boolean | undefined;
 export {};
 //# sourceMappingURL=persistentStore.d.ts.map

package/typings/generated/src/utils/persistentStore.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"persistentStore.d.ts","sourceRoot":"","sources":["../../../../src/utils/persistentStore.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,KAAK,MAAM,gBAAgB,CAAC;AACnC,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAInD,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAIpD,MAAM,WAAW,cAAc;IAC3B,iBAAiB,EAAE,IAAI,CAAC,qBAAqB,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC,CAAC;IACxE,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,gBAAgB;IAC7B,QAAQ,EAAE,OAAO,CAAC;IAClB,WAAW,EAAE,OAAO,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,OAAO,CAAC;CACxB;AAYD,eAAO,MAAM,eAAe,iBAAkB,MAAM,YAAY,MAAM,SACjB,CAAC;AACtD,eAAO,MAAM,oBAAoB,iBAAkB,MAAM,WACA,CAAC;AAE1D,eAAO,MAAM,iBAAiB,iBAAkB,MAAM,SAAS,OAAO,SACrB,CAAC;AAClD,eAAO,MAAM,sBAAsB,iBAAkB,MAAM,YACC,CAAC;AAE7D,eAAO,MAAM,aAAa,YAAmB,MAAM,UAAU,MAAM,kBAQlE,CAAC;AACF,eAAO,MAAM,kBAAkB,YAAmB,MAAM,oBAcvD,CAAC;AAEF,eAAO,MAAM,yBAAyB,iBACpB,MAAM,sBACA,KAAK,cAAc,EAAE,aAAa,CAAC,SAKrD,CAAC;AACP,eAAO,MAAM,8BAA8B,iBACzB,MAAM,KACrB,cAAc,GAAG,SAMnB,CAAC;AACF,eAAO,MAAM,uBAAuB,WACxB,MAAM,aACH,MAAM,oBACC,gBAAgB,SAQrC,CAAC;AACF,eAAO,MAAM,4BAA4B,WAC7B,MAAM,aACH,MAAM,KAClB,gBAAgB,GAAG,SAUrB,CAAC;AAEF,eAAO,MAAM,yBAAyB,UAAW,OAAO,SACR,CAAC;AACjD,eAAO,MAAM,qBAAqB,2BACyC,CAAC;AAC5E,eAAO,MAAM,wBAAwB,YACO,CAAC;AAS7C,eAAO,MAAM,oBAAoB,cACwB,CAAC;AAE1D,eAAO,MAAM,uBAAuB,UAAW,OAAO,SACR,CAAC;AAC/C,eAAO,MAAM,mBAAmB,eACc,CAAC;AAM/C,UAAU,4BAA4B;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,eAAO,MAAM,mBAAmB,sDAKlB,MAAM,OAAO,CAAC,GAAG,CAAC,sDAe/B,CAAC;AAEF,eAAO,MAAM,kBAAkB,gBAAiB,MAAM,SAIjD,CAAC;AACN,eAAO,MAAM,uBAAuB,0BACsC,CAAC"}
+{"version":3,"file":"persistentStore.d.ts","sourceRoot":"","sources":["../../../../src/utils/persistentStore.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,0BAA0B,CAAC;AAChE,OAAO,KAAK,MAAM,gBAAgB,CAAC;AACnC,OAAO,EAAE,qBAAqB,EAAE,MAAM,YAAY,CAAC;AAInD,OAAO,EAAE,KAAK,MAAM,EAAE,MAAM,uBAAuB,CAAC;AAIpD,MAAM,WAAW,cAAc;IAC3B,iBAAiB,EAAE,IAAI,CAAC,qBAAqB,CAAC,eAAe,CAAC,EAAE,MAAM,CAAC,CAAC;IACxE,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,gBAAgB;IAC7B,QAAQ,EAAE,OAAO,CAAC;IAClB,WAAW,EAAE,OAAO,CAAC;IACrB,UAAU,EAAE,MAAM,CAAC;IACnB,WAAW,EAAE,OAAO,CAAC;CACxB;AAYD,eAAO,MAAM,eAAe,iBAAkB,MAAM,YAAY,MAAM,SACjB,CAAC;AACtD,eAAO,MAAM,oBAAoB,iBAAkB,MAAM,WACA,CAAC;AAE1D,eAAO,MAAM,iBAAiB,iBAAkB,MAAM,SAAS,OAAO,SACrB,CAAC;AAClD,eAAO,MAAM,sBAAsB,iBAAkB,MAAM,YACC,CAAC;AAE7D,eAAO,MAAM,aAAa,YAAmB,MAAM,UAAU,MAAM,kBAQlE,CAAC;AACF,eAAO,MAAM,kBAAkB,YAAmB,MAAM,oBAcvD,CAAC;AAEF,eAAO,MAAM,yBAAyB,iBACpB,MAAM,sBACA,KAAK,cAAc,EAAE,aAAa,CAAC,SAKrD,CAAC;AACP,eAAO,MAAM,8BAA8B,iBACzB,MAAM,KACrB,cAAc,GAAG,SAMnB,CAAC;AACF,eAAO,MAAM,uBAAuB,WACxB,MAAM,aACH,MAAM,oBACC,gBAAgB,SAQrC,CAAC;AACF,eAAO,MAAM,4BAA4B,WAC7B,MAAM,aACH,MAAM,KAClB,gBAAgB,GAAG,SAUrB,CAAC;AAEF,eAAO,MAAM,yBAAyB,UAAW,OAAO,SACR,CAAC;AACjD,eAAO,MAAM,qBAAqB,2BACyC,CAAC;AAC5E,eAAO,MAAM,wBAAwB,YACO,CAAC;AAS7C,eAAO,MAAM,oBAAoB,cACwB,CAAC;AAE1D,eAAO,MAAM,uBAAuB,UAAW,OAAO,SACR,CAAC;AAC/C,eAAO,MAAM,mBAAmB,eACc,CAAC;AAM/C,UAAU,4BAA4B;IAClC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,YAAY,CAAC,EAAE,OAAO,CAAC;CAC1B;AAED,eAAO,MAAM,mBAAmB,sDAKlB,MAAM,OAAO,CAAC,GAAG,CAAC,sDAe/B,CAAC;AAEF,eAAO,MAAM,kBAAkB,gBAAiB,MAAM,SAIjD,CAAC;AACN,eAAO,MAAM,uBAAuB,0BACsC,CAAC;AAC3E,eAAO,MAAM,iBAAiB,YAAa,OAAO,SAI7C,CAAC;AACN,eAAO,MAAM,sBAAsB,2BACwC,CAAC"}