style: enforce member delimiter style (#3645)

* style: enforce member delimiter style

* chore: release eslint-config instead of esbuild-plugin-pnp

* style: use semi for multiline types

Author: paul-soporan

.eslintignore

@@ -14,4 +14,9 @@
 /packages/*/bin/**
 /packages/*/build/**
 /packages/**/*fixtures*/**
-packages/yarnpkg-libzip/artifacts/**
+/packages/yarnpkg-libzip/artifacts/**
+
+# Files generated by Gatsby
+/packages/gatsby/public/**
+# Files generated by TypeDoc
+/packages/gatsby/static/api/**

.yarn/versions/5a495b6a.yml

@@ -0,0 +1,28 @@
+releases:
+  "@yarnpkg/eslint-config": minor
+
+declined:
+  - "@yarnpkg/esbuild-plugin-pnp"
+  - "@yarnpkg/plugin-constraints"
+  - "@yarnpkg/plugin-essentials"
+  - "@yarnpkg/plugin-git"
+  - "@yarnpkg/plugin-interactive-tools"
+  - "@yarnpkg/plugin-nm"
+  - "@yarnpkg/plugin-npm"
+  - "@yarnpkg/plugin-npm-cli"
+  - "@yarnpkg/plugin-patch"
+  - "@yarnpkg/plugin-pnp"
+  - "@yarnpkg/plugin-pnpm"
+  - "@yarnpkg/plugin-stage"
+  - "@yarnpkg/plugin-typescript"
+  - "@yarnpkg/plugin-version"
+  - "@yarnpkg/core"
+  - "@yarnpkg/fslib"
+  - "@yarnpkg/json-proxy"
+  - "@yarnpkg/libui"
+  - "@yarnpkg/nm"
+  - "@yarnpkg/parsers"
+  - "@yarnpkg/pnp"
+  - "@yarnpkg/pnpify"
+  - "@yarnpkg/sdks"
+  - "@yarnpkg/shell"

packages/acceptance-tests/pkg-tests-core/sources/utils/tests.ts

@@ -45,7 +45,7 @@ export enum RequestType {
 
 export type Request = {
   type: RequestType.Login;
-  username: string,
+  username: string;
 } | {
   type: RequestType.PackageInfo;
   scope?: string;
@@ -57,7 +57,7 @@ export type Request = {
   version?: string;
 } | {
   type: RequestType.Whoami;
-  login: Login
+  login: Login;
 } | {
   type: RequestType.Repository;
 } | {
@@ -229,8 +229,8 @@ export const getPackageDirectoryPath = async (
 };
 
 const packageServerUrls: {
-  http: string | null,
-  https: string | null,
+  http: string | null;
+  https: string | null;
 } = {http: null, https: null};
 
 export const startPackageServer = ({type}: { type: keyof typeof packageServerUrls } = {type: `http`}): Promise<string> => {
@@ -592,18 +592,18 @@ export interface PackageDriver {
 export type RunFunction = (
   {path, run, source}:
   {
-    path: PortablePath,
-    run: (...args: Array<string> | [...Array<string>, Partial<RunDriverOptions>]) => Promise<ExecResult>,
-    source: (script: string, callDefinition?: Record<string, any>) => Promise<Record<string, any>>
+    path: PortablePath;
+    run: (...args: Array<string> | [...Array<string>, Partial<RunDriverOptions>]) => Promise<ExecResult>;
+    source: (script: string, callDefinition?: Record<string, any>) => Promise<Record<string, any>>;
   }
 ) => void;
 
 export const generatePkgDriver = ({
   getName,
   runDriver,
 }: {
-  getName: () => string,
-  runDriver: PackageRunDriver,
+  getName: () => string;
+  runDriver: PackageRunDriver;
 }): PackageDriver => {
   const withConfig = (definition: Record<string, any>): PackageDriver => {
     const makeTemporaryEnv: PackageDriver = (packageJson, subDefinition, fn) => {

packages/acceptance-tests/pkg-tests-specs/sources/exports.test.ts

@@ -20,8 +20,8 @@ export async function writeTestPackage(path: PortablePath, manifest: Manifest, f
 }
 
 export type Assertions = {
-  pass?: Array<[/*request: */string, /*resolved: */string]>,
-  fail?: Array<[/*request: */string, /*error: */string | {message: string, code?: string, pnpCode?: string}]>,
+  pass?: Array<[/*request: */string, /*resolved: */string]>;
+  fail?: Array<[/*request: */string, /*error: */string | {message: string, code?: string, pnpCode?: string}]>;
 };
 
 export function makeTemporaryExportsEnv(testPackageName: string, manifest: Omit<Manifest, 'name'>, files: Array<string>, {pass, fail}: Assertions) {

packages/esbuild-plugin-pnp/sources/index.ts

@@ -49,7 +49,7 @@ async function defaultOnLoad(args: OnLoadArgs): Promise<OnLoadResult> {
 
 type OnResolveParams = {
   resolvedPath: string | null;
-  watchFiles: Array<string>
+  watchFiles: Array<string>;
   error?: Error;
 };
 
@@ -81,11 +81,11 @@ async function defaultOnResolve(args: OnResolveArgs, {resolvedPath, error, watch
 }
 
 export type PluginOptions = {
-  baseDir?: string,
-  extensions?: Array<string>,
-  filter?: RegExp,
-  onResolve?: (args: OnResolveArgs, params: OnResolveParams) => Promise<OnResolveResult | null>,
-  onLoad?: (args: OnLoadArgs) => Promise<OnLoadResult>,
+  baseDir?: string;
+  extensions?: Array<string>;
+  filter?: RegExp;
+  onResolve?: (args: OnResolveArgs, params: OnResolveParams) => Promise<OnResolveResult | null>;
+  onLoad?: (args: OnLoadArgs) => Promise<OnLoadResult>;
 };
 
 export function pnpPlugin({

packages/eslint-config/rules/style.js

@@ -34,6 +34,28 @@ module.exports = {
       ignoredNodes: [`TSTypeParameterInstantiation`],
     }],
 
+    '@typescript-eslint/member-delimiter-style': [`error`, {
+      multiline: {
+        delimiter: `semi`,
+        requireLast: true,
+      },
+      singleline: {
+        requireLast: false,
+      },
+      overrides: {
+        interface: {
+          singleline: {
+            delimiter: `semi`,
+          },
+        },
+        typeLiteral: {
+          singleline: {
+            delimiter: `comma`,
+          },
+        },
+      },
+    }],
+
     '@typescript-eslint/quotes': [`error`, `backtick`],
 
     '@typescript-eslint/semi': 2,

packages/gatsby/src/types/queries.ts

@@ -1,13 +1,13 @@
 export type SiteMetadata = {
-  title: string,
-  description: string,
-  author: string,
+  title: string;
+  description: string;
+  author: string;
 };
 
 export type Site = {
-  siteMetadata: SiteMetadata,
+  siteMetadata: SiteMetadata;
 };
 
 export type Query = {
-  site: Site,
+  site: Site;
 };

packages/plugin-constraints/sources/Constraints.ts

@@ -12,16 +12,16 @@ import {linkProjectToSession}                                from './tauModule';
 plLists(pl);
 
 export type EnforcedDependency = {
-  workspace: Workspace,
-  dependencyIdent: Ident,
-  dependencyRange: string | null,
-  dependencyType: DependencyType,
+  workspace: Workspace;
+  dependencyIdent: Ident;
+  dependencyRange: string | null;
+  dependencyType: DependencyType;
 };
 
 export type EnforcedField = {
-  workspace: Workspace,
-  fieldPath: string,
-  fieldValue: string | null,
+  workspace: Workspace;
+  fieldPath: string;
+  fieldValue: string | null;
 };
 
 export enum DependencyType {

packages/plugin-essentials/sources/commands/entries/clipanion.ts

@@ -4,9 +4,9 @@ import {Cli, Definition as ClipanionDefinition} from 'clipanion';
 
 type ExtendedDefinition = ClipanionDefinition & {
   plugin: {
-    name: string,
-    isDefault: boolean,
-  },
+    name: string;
+    isDefault: boolean;
+  };
 };
 
 // eslint-disable-next-line arca/no-default-export

packages/plugin-essentials/sources/commands/explain/peerRequirements.ts

@@ -172,10 +172,10 @@ export async function explainPeerRequirements(peerRequirementsHash: string, proj
     const Mark = formatUtils.mark(configuration);
 
     const requirements: Array<{
-      stringifiedLocator: string,
-      prettyLocator: string,
-      prettyRange: string,
-      mark: string
+      stringifiedLocator: string;
+      prettyLocator: string;
+      prettyRange: string;
+      mark: string;
     }> = [];
 
     for (const {pkg, peerDependency} of miscUtils.sortMap(allRequesters, requester => structUtils.stringifyLocator(requester.pkg))) {

packages/plugin-essentials/sources/dedupeUtils.ts

@@ -3,14 +3,14 @@ import {formatUtils, structUtils, IdentHash, LocatorHash, MessageName, Fetcher,
 import micromatch                                                                                      from 'micromatch';
 
 export type Algorithm = (project: Project, patterns: Array<string>, opts: {
-  resolver: Resolver,
-  resolveOptions: ResolveOptions,
-  fetcher: Fetcher,
-  fetchOptions: FetchOptions,
+  resolver: Resolver;
+  resolveOptions: ResolveOptions;
+  fetcher: Fetcher;
+  fetchOptions: FetchOptions;
 }) => Promise<Array<Promise<{
-  descriptor: Descriptor,
-  currentPackage: Package,
-  updatedPackage: Package,
+  descriptor: Descriptor;
+  currentPackage: Package;
+  updatedPackage: Package;
 } | null>>>;
 
 export enum Strategy {
@@ -93,10 +93,10 @@ const DEDUPE_ALGORITHMS: Record<Strategy, Algorithm> = {
 };
 
 export type DedupeOptions = {
-  strategy: Strategy,
-  patterns: Array<string>,
-  cache: Cache,
-  report: Report,
+  strategy: Strategy;
+  patterns: Array<string>;
+  cache: Cache;
+  report: Report;
 };
 
 export async function dedupe(project: Project, {strategy, patterns, cache, report}: DedupeOptions) {

packages/plugin-essentials/sources/index.ts

@@ -51,26 +51,26 @@ export interface Hooks {
     target: suggestUtils.Target,
     descriptor: Descriptor,
     strategies: Array<suggestUtils.Strategy>
-  ) => Promise<void>,
+  ) => Promise<void>;
 
   afterWorkspaceDependencyReplacement?: (
     workspace: Workspace,
     target: suggestUtils.Target,
     fromDescriptor: Descriptor,
     toDescriptor: Descriptor,
-  ) => Promise<void>,
+  ) => Promise<void>;
 
   afterWorkspaceDependencyRemoval?: (
     workspace: Workspace,
     target: suggestUtils.Target,
     descriptor: Descriptor,
-  ) => Promise<void>,
+  ) => Promise<void>;
 
   fetchPackageInfo?: (
     pkg: Package,
     extra: Set<string>,
     registerData: (namespace: string, data: Array<formatUtils.Tuple> | {[key: string]: formatUtils.Tuple | undefined}) => void,
-  ) => Promise<void>,
+  ) => Promise<void>;
 }
 
 declare module '@yarnpkg/core' {

packages/plugin-essentials/sources/suggestUtils.ts

@@ -6,20 +6,20 @@ import semver
 const WORKSPACE_PROTOCOL = `workspace:`;
 
 export type Suggestion = {
-  descriptor: Descriptor,
-  name: string,
-  reason: string,
+  descriptor: Descriptor;
+  name: string;
+  reason: string;
 };
 
 export type NullableSuggestion = {
-  descriptor: Descriptor | null,
-  name: string,
-  reason: string,
+  descriptor: Descriptor | null;
+  name: string;
+  reason: string;
 };
 
 export type Results = {
-  suggestions: Array<NullableSuggestion>,
-  rejections: Array<Error>,
+  suggestions: Array<NullableSuggestion>;
+  rejections: Array<Error>;
 };
 
 export enum Target {
@@ -72,7 +72,7 @@ export enum Strategy {
   CACHE = `cache`,
 }
 
-export function getModifier(flags: {exact: boolean; caret: boolean; tilde: boolean}, project: Project): Modifier {
+export function getModifier(flags: {exact: boolean, caret: boolean, tilde: boolean}, project: Project): Modifier {
   if (flags.exact)
     return Modifier.EXACT;
   if (flags.caret)
@@ -118,8 +118,8 @@ export function makeWorkspaceDescriptor(workspace: Workspace, modifier: Modifier
 
 export async function findProjectDescriptors(ident: Ident, {project, target}: {project: Project, target: Target}) {
   const matches: Map<DescriptorHash, {
-    descriptor: Descriptor,
-    locators: Array<Locator>,
+    descriptor: Descriptor;
+    locators: Array<Locator>;
   }> = new Map();
 
   const getDescriptorEntry = (descriptor: Descriptor) => {

packages/plugin-git/sources/gitUtils.ts

@@ -46,12 +46,12 @@ export function isGitUrl(url: string): boolean {
 export type RepoUrlParts = {
   repo: string;
   treeish: {
-    protocol: TreeishProtocols | string | null,
-    request: string,
-  },
+    protocol: TreeishProtocols | string | null;
+    request: string;
+  };
   extra: {
-    [key: string]: string,
-  },
+    [key: string]: string;
+  };
 };
 
 export function splitRepoUrl(url: string): RepoUrlParts {
@@ -102,7 +102,7 @@ export function splitRepoUrl(url: string): RepoUrlParts {
       repo,
       treeish: {protocol, request},
       extra: extra as {
-        [key: string]: string,
+        [key: string]: string;
       },
     };
   } else {

packages/plugin-git/sources/index.ts

@@ -9,7 +9,7 @@ export interface Hooks {
     current: FetchResult | null,
     locator: Locator,
     opts: FetchOptions,
-  ) => Promise<FetchResult | null>,
+  ) => Promise<FetchResult | null>;
 }
 
 declare module '@yarnpkg/core' {