chore: update and apply prettier

Christoph Werner · Christoph Werner · commit b2292ef902a7 · 2023-09-22T20:12:35.000+02:00
diff --git a/.prettierrc b/.prettierrc
@@ -1,5 +1,5 @@
 {
-  "allowParens": "always",
+  "arrowParens": "always",
   "singleQuote": true,
   "trailingComma": "es5",
   "parser": "typescript",
diff --git a/package.json b/package.json
@@ -71,7 +71,7 @@
     "jest-watch-typeahead": "^2.2.2",
     "lint-staged": "^12.3.5",
     "memory-fs": "^0.5.0",
-    "prettier": "^2.1.1",
+    "prettier": "^3.0.3",
     "ts-jest": "^29.1.1",
     "ts-loader": "^9.4.4",
     "tslint": "^5.11.0",
diff --git a/src/LicenseFileWriter.ts b/src/LicenseFileWriter.ts
@@ -16,10 +16,10 @@ export default class LicenseFileWriter {
     options: IPluginOptions
   ): Promise<void> {
     const moduleDirs = this.getModuleDirs(filenames)
-    const includePackages = await options.includePackages();
-    const licenseMeta = await this.licenseMetaAggregator.aggregateMeta(
-      [...new Set([...moduleDirs, ...includePackages])]
-    )
+    const includePackages = await options.includePackages()
+    const licenseMeta = await this.licenseMetaAggregator.aggregateMeta([
+      ...new Set([...moduleDirs, ...includePackages]),
+    ])
 
     const fileContents = JSON.stringify(licenseMeta, null, 2)
     this.assetManager.addFile(options.outputFilename, fileContents)
@@ -33,7 +33,7 @@ export default class LicenseFileWriter {
   public getModuleDirs(filenames: string[]): string[] {
     return uniq(
       compact(
-        filenames.map(filename => {
+        filenames.map((filename) => {
           return this.moduleDirectoryLocator.getModuleDir(filename)
         })
       )
diff --git a/src/LicenseIdentifier.ts b/src/LicenseIdentifier.ts
@@ -36,7 +36,7 @@ export default class LicenseIdentifier {
     } else if (Array.isArray(meta.licenses) && meta.licenses.length > 0) {
       // handle deprecated `licenses` field
       license =
-        this.findPreferredLicense(meta.licenses.map(l => l.type)) ||
+        this.findPreferredLicense(meta.licenses.map((l) => l.type)) ||
         meta.licenses[0].type
     } else if (typeof meta.licenses === 'string') {
       // handle invalid string values for deprecated `licenses` field
diff --git a/src/WebpackModuleFileIterator.ts b/src/WebpackModuleFileIterator.ts
@@ -2,7 +2,12 @@ import IWebpackChunkModule from './types/IWebpackChunkModule'
 
 export default class WebpackModuleFileIterator {
   public iterateFiles(
-    {resource, rootModule, fileDependencies, dependencies}: IWebpackChunkModule,
+    {
+      resource,
+      rootModule,
+      fileDependencies,
+      dependencies,
+    }: IWebpackChunkModule,
     callback: (filename: string) => void
   ): void {
     if (resource) {
@@ -12,11 +17,11 @@ export default class WebpackModuleFileIterator {
     }
 
     if (fileDependencies) {
-      fileDependencies.forEach(dep => callback(dep))
+      fileDependencies.forEach((dep) => callback(dep))
     }
 
     if (dependencies) {
-      dependencies.forEach(({originModule, _parentModule}) => {
+      dependencies.forEach(({ originModule, _parentModule }) => {
         if (originModule?.resource) {
           callback(originModule.resource)
         }
diff --git a/src/defaultOptions.ts b/src/defaultOptions.ts
@@ -7,7 +7,7 @@ const defaultOptions: IPluginOptions = {
   replenishDefaultLicenseTexts: false,
   unacceptableLicenseTest: () => false,
   excludedPackageTest: () => false,
-  includePackages: () => []
+  includePackages: () => [],
 }
 
 export default defaultOptions
diff --git a/test/e2e/example/src/index.js b/test/e2e/example/src/index.js
@@ -1,6 +1,6 @@
 import React from 'react'
 import ReactDOM from 'react-dom'
-import {format} from 'date-fns'
+import { format } from 'date-fns'
 
 ReactDOM.render(
   React.createElement('h1', {}, ['Hello world']),
diff --git a/test/unit/DefaultLicenseTextProvider.test.ts b/test/unit/DefaultLicenseTextProvider.test.ts
@@ -39,7 +39,10 @@ describe('fetch', () => {
     const okResult = await fetch(okUrl)
     const notFoundResult = await fetch(notFoundUrl)
 
-    expect(needle.mock.calls).toEqual([['get', okUrl], ['get', notFoundUrl]])
+    expect(needle.mock.calls).toEqual([
+      ['get', okUrl],
+      ['get', notFoundUrl],
+    ])
     expect(notFoundResult).toBe(null)
     expect(okResult).toBe('body content')
   })
diff --git a/test/unit/LicenseFileWriter.test.ts b/test/unit/LicenseFileWriter.test.ts
@@ -7,10 +7,10 @@ import IModuleDirectoryLocator from '../../src/types/IModuleDirectoryLocator'
 const AssetManager = jest.fn<IAssetManager, any[]>(() => ({
   addFile: jest.fn(),
 }))
-const DirectoryLocator = jest.fn<IModuleDirectoryLocator, any[]>(impl => ({
+const DirectoryLocator = jest.fn<IModuleDirectoryLocator, any[]>((impl) => ({
   getModuleDir: jest.fn(impl),
 }))
-const MetaAggregator = jest.fn<ILicenseMetaAggregator, any[]>(impl => ({
+const MetaAggregator = jest.fn<ILicenseMetaAggregator, any[]>((impl) => ({
   aggregateMeta: jest.fn(impl),
 }))
 
@@ -19,7 +19,7 @@ describe('LicenseFileWriter', () => {
     test('returns module dirs', () => {
       const instance = new LicenseFileWriter(
         new AssetManager(),
-        new DirectoryLocator(d => `dir-${d}`),
+        new DirectoryLocator((d) => `dir-${d}`),
         new MetaAggregator(() => undefined)
       )
 
@@ -29,7 +29,7 @@ describe('LicenseFileWriter', () => {
     test('only returns unique module dirs', () => {
       const instance = new LicenseFileWriter(
         new AssetManager(),
-        new DirectoryLocator(d => `dir-${d}`),
+        new DirectoryLocator((d) => `dir-${d}`),
         new MetaAggregator(() => undefined)
       )
 
@@ -41,7 +41,7 @@ describe('LicenseFileWriter', () => {
     test('returns module dirs without null values', () => {
       const instance = new LicenseFileWriter(
         new AssetManager(),
-        new DirectoryLocator(d => (d === 'a.js' ? 'module' : null)),
+        new DirectoryLocator((d) => (d === 'a.js' ? 'module' : null)),
         new MetaAggregator(() => undefined)
       )
 
@@ -54,7 +54,7 @@ describe('LicenseFileWriter', () => {
       const assetManager = new AssetManager()
       const instance = new LicenseFileWriter(
         assetManager,
-        new DirectoryLocator(d => `dir-${d}`),
+        new DirectoryLocator((d) => `dir-${d}`),
         new MetaAggregator(() => ({ foo: 'bar' }))
       )
 
@@ -71,7 +71,7 @@ describe('LicenseFileWriter', () => {
       const assetManager = new AssetManager()
       const instance = new LicenseFileWriter(
         assetManager,
-        new DirectoryLocator(d => `dir-${d}`),
+        new DirectoryLocator((d) => `dir-${d}`),
         new MetaAggregator(() => ({ foo: 'bar' }))
       )
 
@@ -91,16 +91,16 @@ describe('LicenseFileWriter', () => {
       const assetManager = new AssetManager()
       const instance = new LicenseFileWriter(
         assetManager,
-        new DirectoryLocator(d => `dir-${d}`),
+        new DirectoryLocator((d) => `dir-${d}`),
         new MetaAggregator(() => ({ foo: 'bar' }))
       )
 
       await instance.writeLicenseFiles([], {
         ...defaultOptions,
         additionalFiles: {
-          'bom.json': o => `bom${JSON.stringify(o)}`,
-          'bom_async.json': async o => `bom_async${JSON.stringify(o)}`,
-          'bom_promise.json': o =>
+          'bom.json': (o) => `bom${JSON.stringify(o)}`,
+          'bom_async.json': async (o) => `bom_async${JSON.stringify(o)}`,
+          'bom_promise.json': (o) =>
             Promise.resolve(`bom_promise${JSON.stringify(o)}`),
         },
       })
diff --git a/test/unit/LicenseIdentifier.test.ts b/test/unit/LicenseIdentifier.test.ts
@@ -1,7 +1,7 @@
 import LicenseIdentifier from '../../src/LicenseIdentifier'
 import IAlertAggregator from '../../src/types/IAlertAggregator'
 
-const MockAlertAggregator = jest.fn<IAlertAggregator, any[]>(i => i)
+const MockAlertAggregator = jest.fn<IAlertAggregator, any[]>((i) => i)
 
 describe('LicenseIdentifier', () => {
   describe('identifyLicense', () => {
diff --git a/test/unit/LicenseMetaAggregator.test.ts b/test/unit/LicenseMetaAggregator.test.ts
@@ -4,12 +4,12 @@ import ILicenseIdentifier from '../../src/types/ILicenseIdentifier'
 import ILicenseTextReader from '../../src/types/ILicenseTextReader'
 import IPackageJsonReader from '../../src/types/IPackageJsonReader'
 
-const MockLicenseIdentifier = jest.fn<ILicenseIdentifier, any[]>(i => i)
-const MockLicenseTextReader = jest.fn<ILicenseTextReader, any[]>(i => i)
-const MockPackageJsonReader = jest.fn<IPackageJsonReader, any[]>(i => i)
+const MockLicenseIdentifier = jest.fn<ILicenseIdentifier, any[]>((i) => i)
+const MockLicenseTextReader = jest.fn<ILicenseTextReader, any[]>((i) => i)
+const MockPackageJsonReader = jest.fn<IPackageJsonReader, any[]>((i) => i)
 
 const mockPackageJsonReader = new MockPackageJsonReader({
-  readPackageJson: name => ({
+  readPackageJson: (name) => ({
     name,
     version: '16.6.0',
     author: '@iamdevloper',
@@ -37,15 +37,14 @@ describe('LicenseMetaAggregator', () => {
     )
   })
 
-
   describe('aggregateMeta', () => {
     test('read repository string syntax', async () => {
       const instance = new LicenseMetaAggregator(
         null,
         null,
         defaultOptions,
         new MockPackageJsonReader({
-          readPackageJson: name => ({
+          readPackageJson: (name) => ({
             name,
             version: '16.6.0',
             author: '@iamdevloper',
diff --git a/test/unit/LicenseTextReader.test.ts b/test/unit/LicenseTextReader.test.ts
@@ -20,14 +20,14 @@ const DefaultLicenseTextProvider = jest.fn<IDefaultLicenseTextProvider, any[]>(
   })
 )
 
-const MockAlertAggregator = jest.fn<IAlertAggregator, any[]>(i => i)
+const MockAlertAggregator = jest.fn<IAlertAggregator, any[]>((i) => i)
 
 describe('LicenseTextReader', () => {
   describe('getLicenseFilename', () => {
     test('returns null if the license is undefined', async () => {
       const instance = new LicenseTextReader(
         new MockAlertAggregator(),
-        new FileSystem({ listPaths: d => ['index.js'] }),
+        new FileSystem({ listPaths: (d) => ['index.js'] }),
         defaultOptions
       )
 
@@ -43,7 +43,7 @@ describe('LicenseTextReader', () => {
     test('returns null if no license file is found', () => {
       const instance = new LicenseTextReader(
         new MockAlertAggregator(),
-        new FileSystem({ listPaths: d => ['index.js'] }),
+        new FileSystem({ listPaths: (d) => ['index.js'] }),
         defaultOptions
       )
 
@@ -53,7 +53,7 @@ describe('LicenseTextReader', () => {
     test('returns null if no license file is found', () => {
       const instance = new LicenseTextReader(
         new MockAlertAggregator(),
-        new FileSystem({ listPaths: d => ['index.js', 'LICENSE'] }),
+        new FileSystem({ listPaths: (d) => ['index.js', 'LICENSE'] }),
         defaultOptions
       )
 
@@ -68,7 +68,7 @@ describe('LicenseTextReader', () => {
       const instance = new LicenseTextReader(
         new MockAlertAggregator(),
         new FileSystem({
-          readFile: p => `license text in ${p}`,
+          readFile: (p) => `license text in ${p}`,
         }),
         defaultOptions
       )
@@ -85,8 +85,8 @@ describe('LicenseTextReader', () => {
         new MockAlertAggregator(),
         new FileSystem({
           join: (d, f) => `${d}/${f}`,
-          listPaths: d => ['index.js', 'LICENSE'],
-          readFile: p => `license in ${p}`,
+          listPaths: (d) => ['index.js', 'LICENSE'],
+          readFile: (p) => `license in ${p}`,
         }),
         defaultOptions
       )
@@ -105,7 +105,7 @@ describe('LicenseTextReader', () => {
     test('returns `null` when no license file was found', async () => {
       const instance = new LicenseTextReader(
         new MockAlertAggregator(),
-        new FileSystem({ listPaths: d => ['index.js'] }),
+        new FileSystem({ listPaths: (d) => ['index.js'] }),
         defaultOptions
       )
 
@@ -124,7 +124,7 @@ describe('LicenseTextReader', () => {
       })
       const instance = new LicenseTextReader(
         new MockAlertAggregator(),
-        new FileSystem({ listPaths: d => ['index.js'] }),
+        new FileSystem({ listPaths: (d) => ['index.js'] }),
         { ...defaultOptions, replenishDefaultLicenseTexts: true },
         licenseTextProvider
       )
@@ -147,8 +147,8 @@ describe('LicenseTextReader', () => {
       const instance = new LicenseTextReader(
         new MockAlertAggregator(),
         new FileSystem({
-          listPaths: d => ['index.js', 'foo.md'],
-          readFile: p => `foo in ${p}`,
+          listPaths: (d) => ['index.js', 'foo.md'],
+          readFile: (p) => `foo in ${p}`,
         }),
         defaultOptions
       )
@@ -169,8 +169,8 @@ describe('LicenseTextReader', () => {
       const instance = new LicenseTextReader(
         new MockAlertAggregator({ addError }),
         new FileSystem({
-          listPaths: d => ['index.js', 'foo.md'],
-          readFile: p => {
+          listPaths: (d) => ['index.js', 'foo.md'],
+          readFile: (p) => {
             throw new Error('fail')
           },
         }),
diff --git a/test/unit/ModuleDirectoryLocator.test.ts b/test/unit/ModuleDirectoryLocator.test.ts
@@ -2,7 +2,7 @@ import ModuleDirectoryLocator from '../../src/ModuleDirectoryLocator'
 import IFileSystem from '../../src/types/IFileSystem'
 import IPackageJsonReader from '../../src/types/IPackageJsonReader'
 
-const MockPackageJsonReader = jest.fn<IPackageJsonReader, any[]>(i => i)
+const MockPackageJsonReader = jest.fn<IPackageJsonReader, any[]>((i) => i)
 
 const FileSystem = jest.fn<IFileSystem, any[]>(
   ({ join, pathExists, resolve }) => ({
@@ -21,7 +21,7 @@ describe('ModuleDirectoryLocator', () => {
     test('finds module dir', () => {
       const instance = new ModuleDirectoryLocator(
         new FileSystem({
-          pathExists: p => {
+          pathExists: (p) => {
             return [
               ...(isWin
                 ? [
@@ -39,7 +39,7 @@ describe('ModuleDirectoryLocator', () => {
         }),
         isWin ? 'C:\\project' : '/project',
         new MockPackageJsonReader({
-          readPackageJson: path => {
+          readPackageJson: (path) => {
             if (path.endsWith('noname')) {
               return { version: '1.0.0' }
             } else if (path.endsWith('noversion')) {
@@ -65,13 +65,13 @@ describe('ModuleDirectoryLocator', () => {
     test('returns null for own sources', () => {
       const instance = new ModuleDirectoryLocator(
         new FileSystem({
-          pathExists: p =>
+          pathExists: (p) =>
             p ===
             (isWin ? 'C:\\project\\package.json' : '/project/package.json'),
         }),
         isWin ? 'C:\\project' : '/project',
         new MockPackageJsonReader({
-          readPackageJson: name => ({ name, version: '1.0.0' }),
+          readPackageJson: (name) => ({ name, version: '1.0.0' }),
         })
       )
 
@@ -85,11 +85,11 @@ describe('ModuleDirectoryLocator', () => {
     test('returns null for files outside of a module directory', () => {
       const instance = new ModuleDirectoryLocator(
         new FileSystem({
-          pathExists: p => false,
+          pathExists: (p) => false,
         }),
         isWin ? 'C:\\project' : '/project',
         new MockPackageJsonReader({
-          readPackageJson: name => ({ name, version: '1.0.0' }),
+          readPackageJson: (name) => ({ name, version: '1.0.0' }),
         })
       )
 
diff --git a/test/unit/OptionsProvider.test.ts b/test/unit/OptionsProvider.test.ts
@@ -2,7 +2,7 @@ import defaultOptions from '../../src/defaultOptions'
 import OptionsProvider from '../../src/OptionsProvider'
 import IAlertAggregator from '../../src/types/IAlertAggregator'
 
-const MockAlertAggregator = jest.fn<IAlertAggregator, any[]>(i => i)
+const MockAlertAggregator = jest.fn<IAlertAggregator, any[]>((i) => i)
 
 describe('OptionsProvider', () => {
   describe('getOptions', () => {
diff --git a/test/unit/WebpackAssetManager.test.ts b/test/unit/WebpackAssetManager.test.ts
@@ -1,7 +1,7 @@
 import webpack from 'webpack'
 import WebpackAssetManager from '../../src/WebpackAssetManager'
 
-const MockCompilation = jest.fn<webpack.Compilation, any[]>(i => i)
+const MockCompilation = jest.fn<webpack.Compilation, any[]>((i) => i)
 
 describe('WebpackAssetManager', () => {
   describe('addFile', () => {
diff --git a/test/unit/WebpackChunkIterator.test.ts b/test/unit/WebpackChunkIterator.test.ts
diff --git a/test/unit/WebpackChunkModuleIterator.test.ts b/test/unit/WebpackChunkModuleIterator.test.ts
diff --git a/test/unit/WebpackFileSystem.test.ts b/test/unit/WebpackFileSystem.test.ts
diff --git a/test/unit/WebpackModuleFileIterator.test.ts b/test/unit/WebpackModuleFileIterator.test.ts
diff --git a/tsconfig.json b/tsconfig.json

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "allowParens": "always",`
	`2`	`+ "arrowParens": "always",`
`3`	`3`	`"singleQuote": true,`
`4`	`4`	`"trailingComma": "es5",`
`5`	`5`	`"parser": "typescript",`
Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@ const defaultOptions: IPluginOptions = {`
`7`	`7`	`replenishDefaultLicenseTexts: false,`
`8`	`8`	`unacceptableLicenseTest: () => false,`
`9`	`9`	`excludedPackageTest: () => false,`
`10`		`- includePackages: () => []`
	`10`	`+ includePackages: () => [],`
`11`	`11`	`}`
`12`	`12`
`13`	`13`	`export default defaultOptions`