@nordicsemiconductor/pc-nrfconnect-shared 229.0.0 → 231.0.0

package/nrfutil/version/version.ts

@@ -33,15 +33,15 @@ export type DiscriminatedVersion =
     | StringVersion;
 
 export const isSemanticVersion = (
-    version?: DiscriminatedVersion
+    version?: DiscriminatedVersion,
 ): version is SemanticVersion => version?.versionFormat === 'semantic';
 
 export const isIncrementalVersion = (
-    version?: DiscriminatedVersion
+    version?: DiscriminatedVersion,
 ): version is IncrementalVersion => version?.versionFormat === 'incremental';
 
 export const isStringVersion = (
-    version?: DiscriminatedVersion
+    version?: DiscriminatedVersion,
 ): version is StringVersion => version?.versionFormat === 'string';
 
 export const versionToString = (version: DiscriminatedVersion) => {

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@nordicsemiconductor/pc-nrfconnect-shared",
-    "version": "229.0.0",
+    "version": "231.0.0",
     "description": "Shared commodities for developing pc-nrfconnect-* packages",
     "repository": {
         "type": "git",
@@ -53,8 +53,6 @@
         "@types/shasum": "1.0.0",
         "@types/triple-beam": "1.3.2",
         "@types/uuid": "8.3.4",
-        "@typescript-eslint/eslint-plugin": "5.57.1",
-        "@typescript-eslint/parser": "5.57.1",
         "@xterm/headless": "^5.5.0",
         "adm-zip": "^0.5.5",
         "applicationinsights": "^2.9.6",
@@ -67,14 +65,15 @@
         "esbuild": "0.19.2",
         "esbuild-sass-plugin": "2.13.0",
         "esbuild-style-plugin": "1.6.2",
-        "eslint": "8.37.0",
+        "eslint": "^8.57.1",
         "eslint-config-airbnb": "19.0.4",
         "eslint-config-prettier": "8.8.0",
         "eslint-import-resolver-typescript": "3.5.5",
         "eslint-plugin-import": "2.27.5",
+        "eslint-plugin-jsonc": "^2.20.1",
         "eslint-plugin-jsx-a11y": "6.7.1",
         "eslint-plugin-md": "^1.0.19",
-        "eslint-plugin-prettier": "^4.2.1",
+        "eslint-plugin-prettier": "^5.5.4",
         "eslint-plugin-react": "7.32.2",
         "eslint-plugin-react-hooks": "4.6.0",
         "eslint-plugin-simple-import-sort": "10.0.0",
@@ -93,7 +92,7 @@
         "nrf-intel-hex": "^1.4.0",
         "postcss": "8.4.24",
         "postcss-modules": "^6.0.0",
-        "prettier": "2.8.8",
+        "prettier": "^3.6.2",
         "prettier-plugin-tailwindcss": "^0.3.0",
         "prettysize": "2.0.0",
         "protobufjs": "^7.0.0",
@@ -117,7 +116,8 @@
         "tailwindcss": "3.3.2",
         "tree-kill-promise": "^3.0.14",
         "tsx": "^4.20.3",
-        "typescript": "4.9.5",
+        "typescript": "^5.9.2",
+        "typescript-eslint": "^8.45.0",
         "util": "0.12.5",
         "uuid": "8.3.2",
         "winston": "3.8.2",

package/release_notes.md

@@ -1,3 +1,22 @@
-### Fixed
+### Changed
 
--   Remove all event emitter listeners on shellParser `unregister`.
+- Updated Prettier 2.8.8 → 3.6.2
+- Updated typescript-eslint 5.57.1 → 8.45.0
+- Updated TypeScript 4.9.5 → 5.9.2
+
+### Steps to upgrade when using this package
+
+- The new version of prettier will lead to some formatting changes, especially
+  added commas and changed whitespaces, but most of those should be
+  automatically solvable by running `npm run check:lint -- --fix`.
+- Some linting rules slightly changed and you may need to update some
+  constructs. E.g. if in a `catch` block the exception is intentionally not
+  used, then you must now remove it: `try {…} catch (e) {/* Ignore */}` →
+  `try {…} catch {/* Ignore */}`.
+- Run `npm run check:types` to check if the new TypeScript version breaks the
+  type checks. As described at
+  https://www.typescriptlang.org/docs/handbook/release-notes/typescript-5-9.html#libdts-changes,
+  a typical problem occurs when you use `Buffer`. First run
+  `npm update @types/node --save-dev`, because that might already fix most
+  problems. For the rest, also first check what is written in the above linked
+  section of the release notes of TypeScript 5.9.

package/scripts/check-app-properties.ts

@@ -39,10 +39,10 @@ const mustBeEmpty = (array: string[], errorMessage: string) => {
 const mustContain = (
     existingEntries: readonly string[],
     mandatoryEntries: string[],
-    errorMessage: string
+    errorMessage: string,
 ) => {
     const missingFileEntries = mandatoryEntries.filter(
-        entry => !existingEntries.includes(entry)
+        entry => !existingEntries.includes(entry),
     );
 
     mustBeEmpty(missingFileEntries, errorMessage);
@@ -51,11 +51,11 @@ const mustContain = (
 const mustContainOneOf = (
     existingEntries: readonly string[],
     oneOfTheseEntriesIsMandatory: string[],
-    errorMessage: string
+    errorMessage: string,
 ) => {
     if (
         !oneOfTheseEntriesIsMandatory.some(entry =>
-            existingEntries.includes(entry)
+            existingEntries.includes(entry),
         )
     ) {
         fail(`${errorMessage}: ${format(oneOfTheseEntriesIsMandatory)}`);
@@ -84,7 +84,7 @@ const checkRepoUrl = (packageJson: PackageJsonApp) => {
 
     if (stripped(realGitUrl) !== stripped(declaredGitUrl)) {
         fail(
-            `package.json says the repository is located at \`${declaredGitUrl}\` but \`git remote get-url origin\` says it is at \`${realGitUrl}\`.`
+            `package.json says the repository is located at \`${declaredGitUrl}\` but \`git remote get-url origin\` says it is at \`${realGitUrl}\`.`,
         );
     }
 };
@@ -105,19 +105,19 @@ const checkFileProperty = (packageJson: PackageJsonApp) => {
     mustContain(
         packageJson.files ?? [],
         ['LICENSE', 'dist/', 'Changelog.md'],
-        'These entries are missing in the property `files` in package.json'
+        'These entries are missing in the property `files` in package.json',
     );
 
     mustContainOneOf(
         packageJson.files ?? [],
         ['resources/*', 'resources/icon.*', 'resources/'],
-        'One of these entries must be in the property `files` in package.json'
+        'One of these entries must be in the property `files` in package.json',
     );
 };
 
 const readAndCheckPackageJson = () => {
     const packageJsonResult = parsePackageJsonApp(
-        readFileSync('./package.json', 'utf8')
+        readFileSync('./package.json', 'utf8'),
     );
 
     if (!packageJsonResult.success) {
@@ -135,7 +135,7 @@ const readAndCheckPackageJson = () => {
 
 const checkChangelog = (
     packageJson: PackageJsonApp,
-    checkChangelogHasCurrentEntry: boolean
+    checkChangelogHasCurrentEntry: boolean,
 ) => {
     if (!existsSync('./Changelog.md')) {
         fail('The mandatory file `Changelog.md` is missing.');
@@ -149,7 +149,7 @@ const checkChangelog = (
         const latestChangelogEntry = getLatestEntry();
         if (!latestChangelogEntry.header.includes(packageJson.version)) {
             fail(
-                `Found no entry for the current version packageJson.version ${packageJson.version} in \`Changelog.md\`.`
+                `Found no entry for the current version packageJson.version ${packageJson.version} in \`Changelog.md\`.`,
             );
         }
     }
@@ -158,7 +158,7 @@ const checkChangelog = (
 const filesIn = (directory: string) => {
     try {
         return readdirSync(directory);
-    } catch (error) {
+    } catch {
         fail(`Unable to read directory \`${directory}\`.`);
         // Unreachable, but not understood by Typescript
         throw new Error();
@@ -169,7 +169,7 @@ const checkMandatoryResources = () => {
     mustContain(
         filesIn('./resources'),
         ['icon.svg', 'icon.icns', 'icon.ico', 'icon.png'],
-        'In the directory `resources` these files are missing'
+        'In the directory `resources` these files are missing',
     );
 };
 

package/scripts/check-for-typescript.ts

@@ -17,7 +17,7 @@ const launchNextCommand = () => {
         spawnSync(command, args, {
             shell: true,
             stdio: 'inherit',
-        }).status ?? undefined
+        }).status ?? undefined,
     );
 };
 
@@ -27,7 +27,7 @@ const assertNoTypeScriptFilesExist = () => {
     klaw('.', { filter: excludeNodeModules }).on('data', ({ path }) => {
         if (path.endsWith('.ts') || path.endsWith('.tsx')) {
             console.log(
-                "Your project contains TypeScript files (with the file ending .ts or .tsx), so it also must contain a file 'tsconfig.json'.\n"
+                "Your project contains TypeScript files (with the file ending .ts or .tsx), so it also must contain a file 'tsconfig.json'.\n",
             );
             process.exit(1);
         }

package/scripts/create-source.ts

@@ -33,12 +33,12 @@ const parseOptions = () =>
         .addOption(
             new Option('-a, --access-level <access level>', 'Access level')
                 .choices(validAccessLevels)
-                .makeOptionMandatory()
+                .makeOptionMandatory(),
         )
         .requiredOption('-n, --name <name>', 'Name, e.g. "Release Test"')
         .requiredOption(
             '-d, --description <description>',
-            'Longer description, e.g. "Versions we intend to release next"'
+            'Longer description, e.g. "Versions we intend to release next"',
         )
         .parse()
         .opts();

package/scripts/esbuild-renderer.ts

@@ -18,13 +18,13 @@ const packageJson = JSON.parse(fs.readFileSync('package.json', 'utf8'));
 
 const projectSpecificTailwindConfigPath = path.join(
     process.cwd(),
-    'tailwind.config.js'
+    'tailwind.config.js',
 );
 const tailwindConfig = () =>
     fs.existsSync(projectSpecificTailwindConfigPath)
         ? projectSpecificTailwindConfigPath
         : require.resolve(
-              '@nordicsemiconductor/pc-nrfconnect-shared/config/tailwind.config.js'
+              '@nordicsemiconductor/pc-nrfconnect-shared/config/tailwind.config.js',
           );
 
 type AdditionalOptions = Required<Pick<BuildOptions, 'entryPoints'>> &
@@ -37,7 +37,7 @@ const outfileOrDir = (additionalOptions: AdditionalOptions) =>
 
 const options = (
     additionalOptions: AdditionalOptions,
-    externalReact: boolean
+    externalReact: boolean,
 ) =>
     ({
         format: 'iife',
@@ -98,7 +98,7 @@ const options = (
                         const [, shortpath] = filter.exec(args.path)!; // eslint-disable-line @typescript-eslint/no-non-null-assertion
                         const resolvedPath = `${path.join(
                             args.resolveDir,
-                            shortpath
+                            shortpath,
                         )}r`;
                         return { path: resolvedPath };
                     });
@@ -107,7 +107,7 @@ const options = (
                         const filePath = args.path.replace('.svgr', '.svg');
                         const svg = await fs.promises.readFile(
                             filePath,
-                            'utf8'
+                            'utf8',
                         );
                         const plugins = ['@svgr/plugin-jsx'];
                         const contents = await svgr(svg, { plugins });
@@ -120,15 +120,15 @@ const options = (
             },
         ],
         ...additionalOptions,
-    } satisfies BuildOptions);
+    }) satisfies BuildOptions;
 
 export const build = async (
     additionalOptions: AdditionalOptions,
-    { externalReact = false } = {}
+    { externalReact = false } = {},
 ) => {
     if (process.argv.includes('--watch')) {
         const context = await esbuild.context(
-            options(additionalOptions, externalReact)
+            options(additionalOptions, externalReact),
         );
 
         await context.rebuild();

package/scripts/esbuild.ts

@@ -69,9 +69,9 @@ const copyFiles = () => {
 
         fs.copyFileSync(
             fileInShared(
-                'fw/bootloader/graviton_bootloader_v1.0.1-[nRF5_SDK_15.0.1-1.alpha_f76d012].zip'
+                'fw/bootloader/graviton_bootloader_v1.0.1-[nRF5_SDK_15.0.1-1.alpha_f76d012].zip',
             ),
-            './fw/graviton_bootloader_v1.0.1-[nRF5_SDK_15.0.1-1.alpha_f76d012].zip'
+            './fw/graviton_bootloader_v1.0.1-[nRF5_SDK_15.0.1-1.alpha_f76d012].zip',
         );
     }
 };

package/scripts/get-release-numbers.ts

@@ -18,7 +18,7 @@ const getLatestReleaseName = () => {
 export default (latestReleaseName = getLatestReleaseName()) => {
     const latest = Number(
         /^v(?<versionNumber>\d+)$/.exec(latestReleaseName)?.groups
-            ?.versionNumber
+            ?.versionNumber,
     );
 
     return { latest, next: latest + 1 };

package/scripts/is-releasable.ts

@@ -25,7 +25,7 @@ const fail = (message: string) => {
 const assertPackageJsonIsCorrect = (expectedVersionNumber: number) => {
     if (packageJson.version !== `${expectedVersionNumber}.0.0`) {
         fail(
-            `Version number in package.json must be '${expectedVersionNumber}.0.0' but is '${packageJson.version}'`
+            `Version number in package.json must be '${expectedVersionNumber}.0.0' but is '${packageJson.version}'`,
         );
     }
 };
@@ -44,7 +44,7 @@ const assertLatestHeaderIsCorrect = (expectedVersionNumber: number) => {
 
     if (expectedHeaderline !== actualHeaderline) {
         fail(
-            `Latest entry in Changelog.md is not as expected:\n  Expected: ${expectedHeaderline}\n  Actual:   ${actualHeaderline}`
+            `Latest entry in Changelog.md is not as expected:\n  Expected: ${expectedHeaderline}\n  Actual:   ${actualHeaderline}`,
         );
     }
 };
@@ -61,7 +61,7 @@ const main = () => {
     assertChangelogIsCorrect(releaseNumbers.next);
 
     console.log(
-        `The currently released version is ${releaseNumbers.latest}, so the next one will be ${releaseNumbers.next}.\n`
+        `The currently released version is ${releaseNumbers.latest}, so the next one will be ${releaseNumbers.next}.\n`,
     );
 };