refactor: move and document getNpmAuthenticationHeader

.eslintignore

@@ -15,6 +15,7 @@
 /packages/*/build/**
 /packages/**/*fixtures*/**
 /packages/yarnpkg-libzip/artifacts/**
+/packages/plugin-compat/extra/fsevents/fsevents-*.js
 
 # Files generated by Gatsby
 /packages/gatsby/public/**

.eslintrc.js

@@ -3,7 +3,25 @@ module.exports = {
     require.resolve(`@yarnpkg/eslint-config`),
     require.resolve(`@yarnpkg/eslint-config/react`),
   ],
-  ignorePatterns: [
-    `packages/plugin-compat/extra/fsevents/fsevents-*.js`,
+  overrides: [
+    {
+      files: [`!packages/*/sources/{index,Plugin}.ts`],
+      rules: {
+        '@typescript-eslint/naming-convention': [`error`, {
+          selector: `typeLike`,
+          format: [`PascalCase`],
+          custom: {
+            regex: `^Hooks$`,
+            match: false,
+          },
+        }],
+      },
+    },
+    {
+      files: [`packages/acceptance-tests/pkg-tests-specs/**/*.test.{js,ts}`],
+      globals: {
+        makeTemporaryEnv: `readonly`,
+      },
+    },
   ],
 };

.yarn/versions/36e6a0e0.yml

@@ -0,0 +1,9 @@
+releases:
+  "@yarnpkg/eslint-config": patch
+  "@yarnpkg/plugin-npm": patch
+
+declined:
+  - "@yarnpkg/plugin-compat"
+  - "@yarnpkg/plugin-npm-cli"
+  - "@yarnpkg/cli"
+  - "@yarnpkg/core"

packages/eslint-config/rules/errors.js

@@ -74,11 +74,5 @@ module.exports = {
         jest: true,
       },
     },
-    {
-      files: [`packages/acceptance-tests/pkg-tests-specs/**/*.test.{js,ts}`],
-      globals: {
-        makeTemporaryEnv: `readonly`,
-      },
-    },
   ],
 };

packages/plugin-npm/sources/index.ts

@@ -1,19 +1,30 @@
-import {Plugin, SettingsType, miscUtils} from '@yarnpkg/core';
+import {Plugin, SettingsType, miscUtils, Configuration, Ident} from '@yarnpkg/core';
 
-import {Hooks}                           from './Hooks';
-import {NpmHttpFetcher}                  from './NpmHttpFetcher';
-import {NpmRemapResolver}                from './NpmRemapResolver';
-import {NpmSemverFetcher}                from './NpmSemverFetcher';
-import {NpmSemverResolver}               from './NpmSemverResolver';
-import {NpmTagResolver}                  from './NpmTagResolver';
-import * as npmConfigUtils               from './npmConfigUtils';
-import * as npmHttpUtils                 from './npmHttpUtils';
-import * as npmPublishUtils              from './npmPublishUtils';
+import {NpmHttpFetcher}                                        from './NpmHttpFetcher';
+import {NpmRemapResolver}                                      from './NpmRemapResolver';
+import {NpmSemverFetcher}                                      from './NpmSemverFetcher';
+import {NpmSemverResolver}                                     from './NpmSemverResolver';
+import {NpmTagResolver}                                        from './NpmTagResolver';
+import * as npmConfigUtils                                     from './npmConfigUtils';
+import * as npmHttpUtils                                       from './npmHttpUtils';
+import * as npmPublishUtils                                    from './npmPublishUtils';
 
 export {npmConfigUtils};
 export {npmHttpUtils};
 export {npmPublishUtils};
-export type {Hooks};
+
+export interface Hooks {
+  /**
+   * Called when getting the authentication header for a request to the npm registry.
+   * You can use this mechanism to dynamically query a CLI for the credentials for a
+   * specific registry.
+   */
+  getNpmAuthenticationHeader?: (currentHeader: string | undefined, registry: string, {
+    configuration,
+    ident,
+  }: { configuration: Configuration, ident?: Ident }) => Promise<string | undefined>;
+}
+
 
 const authSettings = {
   npmAlwaysAuth: {

packages/plugin-npm/sources/npmHttpUtils.ts

@@ -3,7 +3,7 @@ import {MessageName, ReportError}        from '@yarnpkg/core';
 import {prompt}                          from 'enquirer';
 import {URL}                             from 'url';
 
-import {Hooks}                           from './Hooks';
+import {Hooks}                           from './index';
 import * as npmConfigUtils               from './npmConfigUtils';
 import {MapLike}                         from './npmConfigUtils';
 

scripts/extract-hooks.ts

@@ -27,6 +27,13 @@ async function processFile(file: ts.SourceFile) {
 
   const processNode = (node: ts.Node) => {
     switch (node.kind) {
+      case ts.SyntaxKind.TypeAliasDeclaration: {
+        const typeAliasNode = node as ts.TypeAliasDeclaration;
+        if (typeAliasNode.name.getText() === `Hooks`) {
+          throw new UsageError(`Hooks should only be declared using interfaces, not type aliases (in ${file.fileName})`);
+        }
+      } break;
+
       case ts.SyntaxKind.InterfaceDeclaration: {
         const interfaceNode = node as ts.InterfaceDeclaration;
         if (interfaceNode.name.getText() === `Hooks`) {