@nordicsemiconductor/pc-nrfconnect-shared 60.0.0-pre1 → 60.0.0-pre2

package/scripts/prepare-shared-release.ts

@@ -1,122 +0,0 @@
-#!/usr/bin/env ts-node
-
-/*
- * Copyright (c) 2023 Nordic Semiconductor ASA
- *
- * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
- */
-
-/*
-  A script to prepare a new version of shared.
-
-  Requirement for this script: Have [the GitHub CLI tool `gh`](https://cli.github.com)
-  installed and authenticate in it (run `gh auth login`).
-
-  Run
-     npm run prepare-shared-release
-  to update the version in `package.json` and the header of the latest entry
-  in `Changelog.md`.
-*/
-import { spawnSync } from 'node:child_process';
-import { readFileSync, writeFileSync } from 'node:fs';
-
-import { getNextReleaseNumber } from './release-shared';
-
-const parseJson = <Result>(jsonString: string) =>
-    JSON.parse(jsonString) as Result;
-
-const npmCommand = process.platform === 'win32' ? 'npm.cmd' : 'npm';
-const npm = (...commands) =>
-    spawnSync(npmCommand, commands, {
-        stdio: ['inherit', 'pipe', 'inherit'],
-        encoding: 'utf-8',
-    }).stdout;
-
-const updatePackageJson = (nextReleaseNumber: number) => {
-    const nextVersionString = `${nextReleaseNumber}.0.0`;
-    const currentVersion = parseJson<string>(npm('pkg', 'get', 'version'));
-
-    if (nextVersionString === currentVersion) {
-        console.log(
-            `- The version in \`package.json\` is already \`${currentVersion}\`, no need to change it.`
-        );
-        return false;
-    }
-
-    npm('pkg', 'set', `version=${nextVersionString}`);
-    console.log(
-        `- Updated the version in \`package.json\` to \`${nextVersionString}\`.`
-    );
-
-    return true;
-};
-
-const withoutTime = (date: Date) => date.toISOString().split('T')[0];
-
-const updateChangelog = (nextReleaseNumber: number) => {
-    const changelog = readFileSync('Changelog.md', { encoding: 'utf-8' });
-
-    const match = changelog.match(
-        /(?<beginning>.*?)^## (?<header>.*?)$(?<ending>.*)/ms
-    );
-
-    if (match?.groups == null) {
-        console.error(
-            'x Unable to correctly parse `Changelog.md`, to play it safe I am not changing it.'
-        );
-        return { updated: false, error: true };
-    }
-
-    const { beginning, header, ending } = match.groups;
-
-    const correctHeader = `${nextReleaseNumber} - ${withoutTime(new Date())}`;
-    if (header === correctHeader) {
-        console.log(
-            `- The latest entry in \`Changelog.md\` already has the header \`${header}\`, no need to change it.`
-        );
-        return { updated: false, error: false };
-    }
-
-    if (
-        header === 'Unreleased' ||
-        header === `${nextReleaseNumber} - Unreleased`
-    ) {
-        writeFileSync(
-            'Changelog.md',
-            `${beginning}## ${correctHeader}${ending}`,
-            { encoding: 'utf-8' }
-        );
-        console.log(
-            `- Updated the header of the latest entry in \`Changelog.md\` to \`${correctHeader}\`.`
-        );
-
-        return { updated: true, error: false };
-    }
-
-    console.error(
-        `x The latest entry in \`Changelog.md\` is not named \`Unreleased\` or \`${nextReleaseNumber} - Unreleased\`, to play it safe I am not changing it.`
-    );
-
-    return { updated: false, error: true };
-};
-
-const main = () => {
-    const nextReleaseNumber = getNextReleaseNumber();
-
-    const updatedPackageJson = updatePackageJson(nextReleaseNumber);
-    const { updated: updatedChangelog, error } =
-        updateChangelog(nextReleaseNumber);
-
-    if (!updatedPackageJson && !updatedChangelog) {
-        console.log('\nEverything already up-to-date.');
-    } else if (!error) {
-        console.log(
-            '\nUpdated everything needed. You still need to bring these changes into main.'
-        );
-    }
-};
-
-const runAsScript = require.main === module;
-if (runAsScript) {
-    main();
-}

package/scripts/release-shared.test.ts

@@ -1,132 +0,0 @@
-/*
- * Copyright (c) 2023 Nordic Semiconductor ASA
- *
- * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
- */
-
-import {
-    changelogIsCorrect,
-    getLatestEntry,
-    getNextReleaseNumber,
-    latestEntryIsNotEmpty,
-    latestHeaderIsCorrect,
-    packageJsonIsCorrect,
-} from './release-shared';
-
-const noop = () => {};
-
-test('determinding the next release number', () => {
-    expect(getNextReleaseNumber('v34', { log: noop })).toBe(35);
-});
-
-describe('checking package.json', () => {
-    test('no errors', () => {
-        expect(
-            packageJsonIsCorrect(34, {
-                fail: noop,
-                packageJson: '{"version": "34.0.0"}',
-            })
-        ).toBe(true);
-    });
-    test('version is wrong', () => {
-        expect(
-            packageJsonIsCorrect(34, {
-                fail: noop,
-                packageJson: '{"version": "33.0.0"}',
-            })
-        ).toBe(false);
-    });
-    test('format is wrong', () => {
-        expect(
-            packageJsonIsCorrect(34, {
-                fail: noop,
-                packageJson: '{"version": "34"}',
-            })
-        ).toBe(false);
-    });
-});
-
-describe('checking Changelod.md', () => {
-    test('no errors', () => {
-        const correctChangelog = `# Changelog
-
-All notable changes to this project will be documented in this file.
-
-## 34 - 2022-03-10
-
-### Changed
-
--   Something`;
-
-        expect(
-            changelogIsCorrect(34, {
-                fail: noop,
-                now: new Date('2022-03-10T12:38:37.267Z'),
-                changelog: correctChangelog,
-            })
-        ).toBe(true);
-    });
-
-    test('Unreleased entry', () => {
-        const outdatedChangelog = `# Changelog
-
-All notable changes to this project will be documented in this file.
-
-## 33 - 2022-02-01
-
-### Changed
-
--   Something`;
-
-        expect(
-            latestHeaderIsCorrect(34, {
-                fail: noop,
-                now: new Date('2022-03-10T12:38:37.267Z'),
-                changelog: outdatedChangelog,
-            })
-        ).toBe(false);
-    });
-
-    test('Empty entry', () => {
-        const emptyLatestEntry = `# Changelog
-
-All notable changes to this project will be documented in this file.
-
-## 34 - 2022-03-10
-
-## 33 - 2022-02-01`;
-
-        expect(
-            latestEntryIsNotEmpty({
-                fail: noop,
-                changelog: emptyLatestEntry,
-            })
-        ).toBe(false);
-    });
-});
-
-describe('Parsing Changelog.md', () => {
-    const changelog = `# Changelog
-
-All notable changes to this project will be documented in this file.
-
-## 34 - 2023-04-20
-
-### Changed
-
--   Something
-
-## 33 - 2023-04-19
-
-### Added
-
--   Something else
-`;
-
-    test('Extracting the latest entry', () => {
-        expect(getLatestEntry(changelog)).toMatchObject({
-            header: '34 - 2023-04-20',
-            content: '### Changed\n\n-   Something',
-        });
-    });
-});

package/scripts/release-shared.ts

@@ -1,207 +0,0 @@
-#!/usr/bin/env ts-node
-
-/*
- * Copyright (c) 2023 Nordic Semiconductor ASA
- *
- * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
- */
-
-/*
-  A script to release a new version of shared.
-
-  Requirement for this script: Have [the GitHub CLI tool `gh`](https://cli.github.com)
-  installed and authenticate in it (run `gh auth login`).
-
-  Run
-     npm run release-shared -- --dry-run
-  to check whether the script thinks you can release a new version of shared.
-
-  Run
-     npm run release-shared
-  to actually do the release.
-
-  This script checks the contents in the branch `origin/main`.
-  So if locally looks everything fine, please check `origin/main`.
-*/
-import { execSync, spawnSync } from 'node:child_process';
-
-import { PackageJson } from '../src/utils/AppTypes';
-
-const logError = (message: string) => {
-    console.error(message);
-};
-
-const parseJson = <Result>(jsonString: string) =>
-    JSON.parse(jsonString) as Result;
-
-const git = (...commands) =>
-    spawnSync('git', commands, {
-        stdio: ['inherit', 'pipe', 'inherit'],
-        encoding: 'utf-8',
-    }).stdout;
-
-const getLatestReleaseName = () =>
-    parseJson<{ tagName: string }>(
-        execSync(`gh release view --json tagName`, { encoding: 'utf-8' })
-    ).tagName;
-
-export const getNextReleaseNumber = (
-    latestReleaseName = getLatestReleaseName(),
-    { log } = { log: console.log }
-) => {
-    const latestReleaseNumber = Number(
-        /^v(?<versionNumber>\d+)$/.exec(latestReleaseName)?.groups
-            ?.versionNumber
-    );
-
-    const nextReleaseNumber = latestReleaseNumber + 1;
-
-    log(
-        `The currently released version is ${latestReleaseNumber}, so the next one will be ${nextReleaseNumber}.\n`
-    );
-
-    return nextReleaseNumber;
-};
-
-const equality = <T>(
-    expected: T,
-    actual: T,
-    errorMessage: string,
-    fail: typeof logError
-) => {
-    if (expected !== actual) {
-        fail(
-            `${errorMessage}:\n  Expected: ${expected}\n  Actual:   ${actual}\n`
-        );
-    }
-
-    return expected === actual;
-};
-
-const getLatestPackageJson = () => git('show', 'origin/main:package.json');
-
-export const packageJsonIsCorrect = (
-    expectedVersionNumber: number,
-    { fail, packageJson } = {
-        fail: logError,
-        packageJson: getLatestPackageJson(),
-    }
-) => {
-    const expectedVersionString = `${expectedVersionNumber}.0.0`;
-    const actualVersionString = parseJson<PackageJson>(packageJson).version;
-
-    return equality(
-        expectedVersionString,
-        actualVersionString,
-        'Version number in `package.json` is not as expected',
-        fail
-    );
-};
-
-const getLatestChangelog = () => git('show', 'origin/main:Changelog.md');
-
-export const getLatestEntry = (changelog: string) => {
-    const latestEntry = changelog.split('\n## ')[1];
-
-    const header = latestEntry.split('\n')[0];
-    const content = latestEntry.replace(/[^\n]*/, '').trim();
-
-    return { header, content };
-};
-
-export const latestEntryIsNotEmpty = ({
-    fail,
-    changelog,
-}: {
-    fail: (message: string) => void;
-    changelog: string;
-}) => {
-    const correct = getLatestEntry(changelog).content.length > 0;
-
-    if (!correct) {
-        fail('Latest entry in `Changelog.md` does not contain anything.');
-    }
-
-    return correct;
-};
-
-const withoutTime = (date: Date) => date.toISOString().split('T')[0];
-
-export const latestHeaderIsCorrect = (
-    expectedVersionNumber: number,
-    { fail, now, changelog } = {
-        fail: logError,
-        now: new Date(),
-        changelog: getLatestChangelog(),
-    }
-) => {
-    const expectedHeaderline = `${expectedVersionNumber} - ${withoutTime(now)}`;
-    const actualHeaderline = getLatestEntry(changelog).header;
-
-    return equality(
-        expectedHeaderline,
-        actualHeaderline,
-        'Latest entry in `Changelog.md` is not as expected',
-        fail
-    );
-};
-
-export const changelogIsCorrect = (
-    expectedVersionNumber: number,
-    { fail, now, changelog } = {
-        fail: logError,
-        now: new Date(),
-        changelog: getLatestChangelog(),
-    }
-) =>
-    latestEntryIsNotEmpty({ fail, changelog }) &&
-    latestHeaderIsCorrect(expectedVersionNumber, { fail, now, changelog });
-
-const doRelease = (nextReleaseNumber: number) => {
-    const nextReleaseName = `v${nextReleaseNumber}`;
-    const latestChangelogEntry = getLatestEntry(getLatestChangelog()).content;
-
-    const dryRun = process.argv.includes('--dry-run');
-    if (dryRun) {
-        console.log(
-            `Would create a release ${nextReleaseName} now, with this description:\n${latestChangelogEntry}`
-        );
-    } else {
-        console.log(`Creating release ${nextReleaseName} now:`);
-        const result = spawnSync(
-            'gh',
-            [
-                'release',
-                'create',
-                nextReleaseName,
-                '--title',
-                nextReleaseName,
-                '--notes',
-                latestChangelogEntry,
-            ],
-            {
-                stdio: 'inherit',
-                encoding: 'utf-8',
-            }
-        );
-        process.exitCode = result.status ?? 1;
-    }
-};
-
-const main = () => {
-    console.log(git('fetch'));
-    const nextReleaseNumber = getNextReleaseNumber();
-
-    const noErrors =
-        packageJsonIsCorrect(nextReleaseNumber) &&
-        changelogIsCorrect(nextReleaseNumber);
-
-    if (noErrors) {
-        doRelease(nextReleaseNumber);
-    }
-};
-
-const runAsScript = require.main === module;
-if (runAsScript) {
-    main();
-}

package/src/About/About.tsx

@@ -1,25 +0,0 @@
-/*
- * Copyright (c) 2015 Nordic Semiconductor ASA
- *
- * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
- */
-
-import React from 'react';
-
-import ApplicationCard from './ApplicationCard';
-import DeviceCard from './DeviceCard';
-import DocumentationCard from './DocumentationCard';
-import SupportCard from './SupportCard';
-
-import './about.scss';
-
-export default () => (
-    <div className="about">
-        <div className="about-inner">
-            <ApplicationCard />
-            <DeviceCard />
-            <DocumentationCard />
-            <SupportCard />
-        </div>
-    </div>
-);

package/src/About/AboutButton.tsx

@@ -1,28 +0,0 @@
-/*
- * Copyright (c) 2015 Nordic Semiconductor ASA
- *
- * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
- */
-
-import React, { FC } from 'react';
-
-import Button from '../Button/Button';
-import { openUrl } from '../utils/open';
-
-interface Props {
-    onClick?: () => void;
-    url?: string;
-    label: string;
-}
-
-const AboutButton: FC<Props> = ({ url, label, onClick }) => (
-    <Button
-        disabled={!url && !onClick}
-        onClick={onClick || (() => openUrl(url as string))}
-        variant="secondary"
-    >
-        {label}
-    </Button>
-);
-
-export default AboutButton;

package/src/About/ApplicationCard.tsx

@@ -1,83 +0,0 @@
-/*
- * Copyright (c) 2015 Nordic Semiconductor ASA
- *
- * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
- */
-
-import React, { useEffect, useState } from 'react';
-import { ipcRenderer } from 'electron';
-
-import Card from '../Card/Card';
-import FactoryResetButton from '../FactoryReset/FactoryResetButton';
-import AboutButton from './AboutButton';
-import Section from './Section';
-import ShortcutButton from './ShortcutButton';
-
-interface AppDetails {
-    coreVersion: string;
-    corePath: string;
-    homeDir: string;
-    tmpDir: string;
-}
-
-interface LauncerApp {
-    name?: string;
-    displayName?: string;
-    description?: string;
-    homepage?: string;
-    currentVersion?: string;
-    latestVersion?: string;
-    engineVersion?: string;
-    path?: string;
-    iconPath?: string;
-    shortcutIconPath?: string;
-    isOfficial?: string;
-    sharedVersion?: string;
-    source?: string;
-    url?: string;
-    releaseNote?: string;
-    upgradeAvailable?: string;
-    repositoryUrl?: string;
-}
-
-type DetailsFromLauncher = AppDetails & LauncerApp;
-
-export default () => {
-    const [appInfo, setAppInfo] = useState<DetailsFromLauncher>();
-
-    useEffect(() => {
-        ipcRenderer.once('app-details', (_, details: DetailsFromLauncher) => {
-            setAppInfo(details);
-        });
-        ipcRenderer.send('get-app-details');
-    }, [setAppInfo]);
-
-    if (appInfo == null) return null;
-
-    return (
-        <Card title="Application">
-            <Section title="Title">{appInfo.displayName}</Section>
-            <Section title="Purpose">{appInfo.description}</Section>
-            <Section title="Version">{appInfo.currentVersion}</Section>
-            <Section title="Source">{appInfo.source || 'local'}</Section>
-            <Section title="Supported engines">
-                nRF Connect {appInfo.engineVersion}
-            </Section>
-            <Section title="Current engine">
-                nRF Connect {appInfo.coreVersion}
-            </Section>
-            <Section>
-                <AboutButton
-                    url={appInfo.repositoryUrl}
-                    label="Get source code"
-                />
-            </Section>
-            <Section>
-                <FactoryResetButton label="Restore defaults..." />
-            </Section>
-            <Section>
-                <ShortcutButton label="Show shortcuts" />
-            </Section>
-        </Card>
-    );
-};

package/src/About/DeviceCard.tsx

@@ -1,74 +0,0 @@
-/*
- * Copyright (c) 2015 Nordic Semiconductor ASA
- *
- * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
- */
-
-import React from 'react';
-import { useSelector } from 'react-redux';
-
-import Card from '../Card/Card';
-import {
-    buyOnlineUrl,
-    deviceInfo,
-    productPageUrl,
-} from '../Device/deviceInfo/deviceInfo';
-import { selectedDevice } from '../Device/deviceSlice';
-import AboutButton from './AboutButton';
-import Section from './Section';
-
-const memorySize = (memoryInBytes: number) => {
-    if (memoryInBytes == null) {
-        return 'Unknown';
-    }
-
-    return `${memoryInBytes / 1024}KiB`;
-};
-
-export default () => {
-    const device = useSelector(selectedDevice);
-
-    if (device == null) {
-        return (
-            <Card title="Device">
-                <Section title="No device selected" />
-            </Card>
-        );
-    }
-
-    const pca = device.boardVersion;
-    const { name, cores } = deviceInfo(device);
-
-    return (
-        <Card title="Device">
-            <Section title="Name">{name || 'Unknown'}</Section>
-            <Section title="ID">{device.serialNumber}</Section>
-            <Section title="PCA">{pca || 'Unknown'}</Section>
-            <Section title="Cores">{cores || 'Unknown'}</Section>
-
-            {device.hwInfo && (
-                <>
-                    <Section title="RAM">
-                        {memorySize(device.hwInfo.ramSize)}
-                    </Section>
-                    <Section title="Flash">
-                        {memorySize(device.hwInfo.romSize)}
-                    </Section>
-                </>
-            )}
-
-            <Section>
-                <AboutButton
-                    url={buyOnlineUrl(device)}
-                    label="Find distributor"
-                />
-            </Section>
-            <Section>
-                <AboutButton
-                    url={productPageUrl(device)}
-                    label="Go to product page"
-                />
-            </Section>
-        </Card>
-    );
-};

package/src/About/DocumentationCard.tsx

@@ -1,18 +0,0 @@
-/*
- * Copyright (c) 2021 Nordic Semiconductor ASA
- *
- * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
- */
-
-import React from 'react';
-import { useSelector } from 'react-redux';
-
-import Card from '../Card/Card';
-import { documentationSections } from './documentationSlice';
-
-export default () => {
-    const sections = useSelector(documentationSections);
-    if (sections.length === 0) return null;
-
-    return <Card title="Documentation">{sections}</Card>;
-};