@nordicsemiconductor/pc-nrfconnect-shared 60.0.0-pre1

package/scripts/nrfconnect-license.ts

@@ -0,0 +1,277 @@
+#!/usr/bin/env ts-node
+
+/*
+ * Copyright (c) 2021 Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */
+
+import glob from 'fast-glob';
+import { existsSync, readFileSync, writeFileSync } from 'fs';
+
+const SHEBANG_LINE = /^#!.*?(\r?\n)+/;
+const SPECIAL_REGEXP_CHARACTERS = /([.*+\\(){}[\]])/g;
+const LINE_ENDINGS = /\r?\n/g;
+
+const correctLicense = `Copyright (c) __YEAR__ Nordic Semiconductor ASA
+All rights reserved.
+
+SPDX-License-Identifier: Nordic-4-Clause
+
+Use in source and binary forms, redistribution in binary form only, with
+or without modification, are permitted provided that the following conditions
+are met:
+
+1. Redistributions in binary form, except as embedded into a Nordic
+   Semiconductor ASA integrated circuit in a product or a software update for
+   such product, must reproduce the above copyright notice, this list of
+   conditions and the following disclaimer in the documentation and/or other
+   materials provided with the distribution.
+
+2. Neither the name of Nordic Semiconductor ASA nor the names of its
+   contributors may be used to endorse or promote products derived from this
+   software without specific prior written permission.
+
+3. This software, with or without modification, must only be used with a Nordic
+   Semiconductor ASA integrated circuit.
+
+4. Any software provided in binary form under this license must not be reverse
+   engineered, decompiled, modified and/or disassembled.
+
+THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS OR
+IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
+TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.`;
+
+const correctHeader = `/*
+ * Copyright (c) __YEAR__ Nordic Semiconductor ASA
+ *
+ * SPDX-License-Identifier: LicenseRef-Nordic-4-Clause
+ */`;
+
+const outdatedLicense = `/* Copyright (c) __YEARS__, Nordic Semiconductor ASA
+ *
+ * All rights reserved.
+ *
+ * Use in source and binary forms, redistribution in binary form only, with
+ * or without modification, are permitted provided that the following conditions
+ * are met:
+ *
+ * 1. Redistributions in binary form, except as embedded into a Nordic
+ *    Semiconductor ASA integrated circuit in a product or a software update for
+ *    such product, must reproduce the above copyright notice, this list of
+ *    conditions and the following disclaimer in the documentation and/or other
+ *    materials provided with the distribution.
+ *
+ * 2. Neither the name of Nordic Semiconductor ASA nor the names of its
+ *    contributors may be used to endorse or promote products derived from this
+ *    software without specific prior written permission.
+ *
+ * 3. This software, with or without modification, must only be used with a Nordic
+ *    Semiconductor ASA integrated circuit.
+ *
+ * 4. Any software provided in binary form under this license must not be reverse
+ *    engineered, decompiled, modified and/or disassembled.
+ *
+ * THIS SOFTWARE IS PROVIDED BY NORDIC SEMICONDUCTOR ASA "AS IS" AND ANY EXPRESS OR
+ * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
+ * MERCHANTABILITY, NONINFRINGEMENT, AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL NORDIC SEMICONDUCTOR ASA OR CONTRIBUTORS BE LIABLE
+ * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+ * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+ * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+ * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR
+ * TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+ * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ */`;
+
+const fail = (message: string) => {
+    console.error(message);
+    process.exit(1);
+};
+
+const asRegexp = (string: string) =>
+    RegExp(
+        `^${string
+            .replace(SPECIAL_REGEXP_CHARACTERS, '\\$1')
+            .replace(LINE_ENDINGS, '\\r?\\n') // Because reference string and input string could have different EOLs
+            .replace('__YEAR__', '\\d{4}')
+            .replace('__YEARS__', '(?<oldStartingYear>\\d{4})( - \\d{4})?')}`
+    );
+
+const checkLicense = () => {
+    if (!existsSync('./LICENSE')) {
+        fail(`Missing file 'LICENSE' in the root of the project.`);
+    }
+
+    const actualLicense = readFileSync('./LICENSE', {
+        encoding: 'utf8',
+    }).trim();
+    if (!actualLicense.match(asRegexp(correctLicense))) {
+        fail(`The file 'LICENSE' does not contain the correct license.`);
+    }
+};
+
+const removeTrailingSlashes = (entry: string) => entry.replace(/\/$/, '');
+
+// Replace entries like '/node_modules' with something like 'node_modules/**'
+const replaceRootEntries = (entry: string) => entry.replace(/^\/(.*)/, '$1/**');
+
+const entriesInGitignore = readFileSync('.gitignore', { encoding: 'utf8' })
+    .trim()
+    .split(/\r?\n/)
+    .map(removeTrailingSlashes)
+    .map(replaceRootEntries);
+
+const allSourceFiles = () =>
+    glob.sync(
+        [
+            '*.js',
+            '*.jsx',
+            '*.mjs',
+            '*.ts',
+            '*.tsx',
+            '*.css',
+            '*.scss',
+            '*.sass',
+        ],
+        {
+            ignore: [
+                ...entriesInGitignore,
+                'scripts/nordic-publish.js',
+                'typings/generated',
+                '.git',
+            ],
+            baseNameMatch: true,
+        }
+    );
+
+const missesCorrectHeader = (file: string) =>
+    !readFileSync(file, { encoding: 'utf8' })
+        .replace(SHEBANG_LINE, '')
+        .trim()
+        .match(asRegexp(correctHeader));
+
+const checkHeaders = () => {
+    const filesWithoutCorrectHeader =
+        allSourceFiles().filter(missesCorrectHeader);
+
+    if (filesWithoutCorrectHeader.length > 0) {
+        const runningInShared = existsSync('./scripts/nrfconnect-license.ts');
+        const nrfconnectLicenseScript = runningInShared
+            ? './scripts/nrfconnect-license.ts update'
+            : 'nrfconnect-license update';
+
+        const listOfFiles = filesWithoutCorrectHeader
+            .map(file => `- ${file}\n`)
+            .join('');
+
+        fail(
+            `These files do not contain the correct license, try fixing this` +
+                ` with running 'npx ${nrfconnectLicenseScript}':\n${listOfFiles}`
+        );
+    }
+};
+
+const check = () => {
+    checkLicense();
+    checkHeaders();
+};
+
+const firstLineEnding = (content: string) => {
+    const lineEndingMatch = content.match(LINE_ENDINGS);
+
+    return lineEndingMatch?.[0] ?? '\n';
+};
+
+const splitOffShebangLine = (content: string) => {
+    const shebangLineMatch = content.match(SHEBANG_LINE);
+    if (shebangLineMatch) {
+        const shebangLine = shebangLineMatch[0];
+        return {
+            shebangLine,
+            contentWithoutShebang: content.replace(SHEBANG_LINE, ''),
+        };
+    }
+
+    return {
+        shebangLine: '',
+        contentWithoutShebang: content,
+    };
+};
+
+const removeOutdatedLicense = (content: string) => {
+    const hadOutdatedLicense = content.match(asRegexp(outdatedLicense)) != null;
+    const oldStartYear = content.match(asRegexp(outdatedLicense))?.groups
+        ?.oldStartingYear;
+    const remainingContent = content
+        .replace(asRegexp(outdatedLicense), '')
+        .trimStart();
+
+    return {
+        hadOutdatedLicense,
+        oldStartYear,
+        remainingContent,
+    };
+};
+
+const updateHeader = (file: string) => {
+    if (!missesCorrectHeader(file)) {
+        return;
+    }
+
+    const originalContent = readFileSync(file, { encoding: 'utf8' });
+
+    const lineEnding = firstLineEnding(originalContent);
+
+    const { shebangLine, contentWithoutShebang } =
+        splitOffShebangLine(originalContent);
+    const { hadOutdatedLicense, oldStartYear, remainingContent } =
+        removeOutdatedLicense(contentWithoutShebang);
+
+    const COMMENT_START = '/*';
+    if (!hadOutdatedLicense && remainingContent.startsWith(COMMENT_START)) {
+        console.warn(
+            `The file '${file}' has a comment at the beginning which is not a known outdated license. Not touching this file.`
+        );
+        return;
+    }
+
+    const currentYear = String(new Date().getFullYear());
+    const newHeader = correctHeader
+        .replace(/\r?\n/g, lineEnding)
+        .replace('__YEAR__', oldStartYear ?? currentYear);
+
+    writeFileSync(
+        file,
+        shebangLine + newHeader + lineEnding + lineEnding + remainingContent
+    );
+    console.log(
+        `${
+            hadOutdatedLicense ? 'Updated' : 'Added'
+        } license header in file '${file}'`
+    );
+};
+
+const update = () => {
+    allSourceFiles().forEach(updateHeader);
+};
+
+const script = process.argv[2];
+
+switch (script) {
+    case 'check':
+        check();
+        break;
+    case 'update':
+        update();
+        break;
+    default:
+        fail(`Must provide either 'check' or 'update' as a parameter.`);
+}

package/scripts/prepare-shared-release.ts

@@ -0,0 +1,122 @@
+#!/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

@@ -0,0 +1,132 @@
+/*
+ * 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',
+        });
+    });
+});