feat: support using custom registry #70

.cspell.json

@@ -24,6 +24,7 @@
     "lcov",
     "toolbelt",
     "Conosla",
+    "libnpmconfig",
     "packument"
   ],
   "ignorePaths": [

.gitignore

@@ -71,5 +71,6 @@ typings/
 # stryker temp files
 .stryker-tmp
 /reports
+!@types/**
 !/tools
 

@types/libnpmconfig/index.d.ts

@@ -0,0 +1,3 @@
+declare module 'libnpmconfig' {
+  export function read(): Record<string, any>;
+}

package.json

@@ -89,6 +89,7 @@
     "@types/jest-when": "^2.7.1",
     "@types/node": "^13.13.5",
     "@types/node-fetch": "^2.5.7",
+    "@types/npm-registry-fetch": "^8.0.0",
     "@types/pacote": "^11.1.0",
     "@types/semver": "^7.1.0",
     "@types/shell-quote": "^1.6.1",
@@ -98,9 +99,9 @@
     "@typescript-eslint/parser": "^2.31.0",
     "all-contributors-cli": "^6.14.2",
     "cspell": "^4.0.61",
-    "eslint": "^6.8.0",
+    "eslint": "^7.0.0",
     "eslint-config-prettier": "^6.11.0",
-    "eslint-plugin-jest": "^23.9.0",
+    "eslint-plugin-jest": "^23.10.0",
     "eslint-plugin-prefer-arrow": "^1.2.1",
     "eslint-plugin-prettier": "^3.1.3",
     "expect": "^26.0.1",
@@ -113,12 +114,12 @@
     "lint-staged": "^10.2.2",
     "mock-spawn": "^0.2.6",
     "node-fetch": "^2.6.0",
-    "npm-check-updates": "^4.1.2",
+    "npm-check-updates": "^5.0.0",
     "prettier": "^2.0.5",
     "semver": "^7.3.2",
-    "ts-jest": "^25.5.0",
+    "ts-jest": "^25.5.1",
     "ts-node": "^8.10.1",
-    "ts-toolbelt": "^6.6.2",
+    "ts-toolbelt": "^6.7.2",
     "typescript": "^3.8.3"
   },
   "dependencies": {
@@ -129,6 +130,7 @@
     "cross-spawn": "~7.0.2",
     "figures": "~3.2.0",
     "inversify": "~5.0.1",
+    "libnpmconfig": "^1.2.1",
     "moment": "~2.25.3",
     "pacote": "~11.1.9",
     "reflect-metadata": "~0.1.13",

src/container/nodeModulesContainer.ts

@@ -3,10 +3,12 @@ import * as fs from 'fs';
 import * as pacote from 'pacote';
 import * as simpleGit from 'simple-git/promise';
 import * as spawn from 'cross-spawn';
+import * as libnpmconfig from 'libnpmconfig';
 import axios from 'axios';
 import { interfaces } from 'inversify';
 import Bind = interfaces.Bind;
 
+export type LibNpmConfig = typeof libnpmconfig;
 export type Spawn = typeof spawn;
 export type Axios = typeof axios;
 export type Pacote = typeof pacote;
@@ -20,6 +22,7 @@ export const TYPES = {
   Spawn: Symbol.for(`Spawn`),
   SimpleGit: Symbol.for(`SimpleGit`),
   Axios: Symbol.for(`Axios`),
+  LibNpmConfig: Symbol.for(`LibNpmConfig`),
 };
 
 export const nodeModulesBinder = (bind: Bind): void => {
@@ -29,4 +32,5 @@ export const nodeModulesBinder = (bind: Bind): void => {
   bind<Spawn>(TYPES.Spawn).toConstantValue(spawn);
   bind<SimpleGitFn>(TYPES.SimpleGit).toConstantValue(simpleGit);
   bind<Axios>(TYPES.Axios).toConstantValue(axios);
+  bind<LibNpmConfig>(TYPES.LibNpmConfig).toConstantValue(libnpmconfig);
 };

src/utils/packageInfo/impl/configRetriever.ts

@@ -0,0 +1,50 @@
+import { inject, injectable } from 'inversify';
+import { ILogger } from '../../logger/interfaces/ILogger';
+import { LibNpmConfig, TYPES } from '../../../container/nodeModulesContainer';
+import { ILoggerFactory } from '../../logger';
+import { INpmConfig, INpmConfigRetriever } from '../interfaces/INpmConfigRetriever';
+import { isBoolean, isString } from 'ts-type-guards';
+
+const coerceBoolean = (value: undefined | string | boolean): boolean => {
+  if (value === undefined || value === null) {
+    return false;
+  }
+  if (isBoolean(value)) {
+    return value;
+  }
+  return value.toLowerCase() === `true`;
+};
+
+@injectable()
+export class NpmConfigRetriever extends INpmConfigRetriever {
+  private readonly logger: ILogger;
+
+  constructor(@inject(TYPES.LibNpmConfig) private readonly libnpmconfig: LibNpmConfig, loggerFactory: ILoggerFactory) {
+    super();
+    this.logger = loggerFactory.getLogger(`Npm Config Retriever`);
+  }
+
+  async retrieve(): Promise<INpmConfig> {
+    this.logger.info(`Reading npm config`);
+    const result = this.libnpmconfig.read();
+    const npmConfig: INpmConfig = {};
+    result.forEach((value: any, key: string) => {
+      if (isString(value) && key.indexOf(`:`) > 0) {
+        npmConfig[key] = value;
+      }
+    });
+    npmConfig[`always-auth`] = coerceBoolean(result[`always-auth`]);
+    npmConfig.strictSSL = coerceBoolean(result[`strict-ssl`]);
+    npmConfig.alwaysAuth = coerceBoolean(result.alwaysAuth);
+    npmConfig.registry = result.registry;
+    npmConfig.username = result.username;
+    npmConfig.password = result.password;
+    npmConfig.token = result.token;
+    // eslint-disable-next-line no-underscore-dangle
+    npmConfig._authToken = result._authToken;
+    // eslint-disable-next-line no-underscore-dangle
+    npmConfig._auth = result._auth;
+    npmConfig.email = result.email;
+    return npmConfig;
+  }
+}

src/utils/packageInfo/impl/npmConfigRetriever.ts

@@ -0,0 +1,50 @@
+import { inject, injectable } from 'inversify';
+import { ILogger } from '../../logger/interfaces/ILogger';
+import { LibNpmConfig, TYPES } from '../../../container/nodeModulesContainer';
+import { ILoggerFactory } from '../../logger';
+import { INpmConfig, INpmConfigRetriever } from '../interfaces/INpmConfigRetriever';
+import { isBoolean, isString } from 'ts-type-guards';
+
+const coerceBoolean = (value: undefined | string | boolean): boolean => {
+  if (value === undefined || value === null) {
+    return false;
+  }
+  if (isBoolean(value)) {
+    return value;
+  }
+  return value.toLowerCase() === `true`;
+};
+
+@injectable()
+export class NpmConfigRetriever extends INpmConfigRetriever {
+  private readonly logger: ILogger;
+
+  constructor(@inject(TYPES.LibNpmConfig) private readonly libnpmconfig: LibNpmConfig, loggerFactory: ILoggerFactory) {
+    super();
+    this.logger = loggerFactory.getLogger(`Npm Config Retriever`);
+  }
+
+  async retrieve(): Promise<INpmConfig> {
+    this.logger.info(`Reading npm config`);
+    const result = this.libnpmconfig.read();
+    const npmConfig: INpmConfig = {};
+    result.forEach((value: any, key: string) => {
+      if (isString(value) && key.indexOf(`:`) > 0) {
+        npmConfig[key] = value;
+      }
+    });
+    npmConfig[`always-auth`] = coerceBoolean(result[`always-auth`]);
+    npmConfig.strictSSL = coerceBoolean(result[`strict-ssl`]);
+    npmConfig.alwaysAuth = coerceBoolean(result.alwaysAuth);
+    npmConfig.registry = result.registry;
+    npmConfig.username = result.username;
+    npmConfig.password = result.password;
+    npmConfig.token = result.token;
+    // eslint-disable-next-line no-underscore-dangle
+    npmConfig._authToken = result._authToken;
+    // eslint-disable-next-line no-underscore-dangle
+    npmConfig._auth = result._auth;
+    npmConfig.email = result.email;
+    return npmConfig;
+  }
+}

src/utils/packageInfo/index.ts

@@ -2,9 +2,13 @@ import { IPackageInfo } from './interfaces/IPackageInfo';
 import { PackageInfo } from './impl/packageInfo';
 import { interfaces } from 'inversify';
 import Bind = interfaces.Bind;
+import { NpmConfigRetriever } from './impl/npmConfigRetriever';
+import { INpmConfigRetriever } from './interfaces/INpmConfigRetriever';
 
 export const packageInfoModulesBinder = (bind: Bind): void => {
+  bind<INpmConfigRetriever>(INpmConfigRetriever).to(NpmConfigRetriever).inSingletonScope();
   bind<IPackageInfo>(IPackageInfo).to(PackageInfo).inSingletonScope();
 };
 
 export * from './interfaces/IPackageInfo';
+export * from './interfaces/INpmConfigRetriever';

src/utils/packageInfo/interfaces/INpmConfigRetriever.ts

@@ -0,0 +1,7 @@
+import { Options } from 'npm-registry-fetch';
+
+export type INpmConfig = Options;
+
+export abstract class INpmConfigRetriever {
+  public abstract async retrieve(): Promise<INpmConfig>;
+}

test/src/container/nodeModulesContainer.spec.ts

@@ -6,6 +6,7 @@ import * as spawn from 'cross-spawn';
 import axios from 'axios';
 import { BindingTypes, testBindings } from '../../common/testers/bindingTester';
 import { nodeModulesBinder, TYPES } from '../../../src/container/nodeModulesContainer';
+import * as libnpmconfig from 'libnpmconfig';
 
 testBindings({
   name: `node module container`,
@@ -41,5 +42,10 @@ testBindings({
       binded: axios,
       type: BindingTypes.CONSTANT,
     },
+    {
+      binder: TYPES.LibNpmConfig,
+      binded: libnpmconfig,
+      type: BindingTypes.CONSTANT,
+    },
   ],
 });

test/src/utils/packageInfo/impl/npmConfigRetriever.spec.ts

@@ -0,0 +1,12 @@
+import * as libnpmconfig from 'libnpmconfig';
+import { loggerFactory } from '../../../../common/logger';
+import { NpmConfigRetriever } from '../../../../../src/utils/packageInfo/impl/npmConfigRetriever';
+
+describe(`npm config retriever`, () => {
+  const npmConfigRetriever = new NpmConfigRetriever(libnpmconfig, loggerFactory);
+
+  it(`should return npm config`, async () => {
+    const result = await npmConfigRetriever.retrieve();
+    expect(result).toEqual({});
+  });
+});

test/src/utils/packageInfo/index.spec.ts

@@ -1,11 +1,17 @@
 import { BindingTypes, testBindings } from '../../../common/testers/bindingTester';
-import { IPackageInfo, packageInfoModulesBinder } from '../../../../src/utils/packageInfo';
+import { INpmConfigRetriever, IPackageInfo, packageInfoModulesBinder } from '../../../../src/utils/packageInfo';
 import { PackageInfo } from '../../../../src/utils/packageInfo/impl/packageInfo';
+import { NpmConfigRetriever } from '../../../../src/utils/packageInfo/impl/npmConfigRetriever';
 
 testBindings({
   name: `package info module container`,
   binderFn: packageInfoModulesBinder,
   bindings: [
+    {
+      binder: INpmConfigRetriever,
+      binded: NpmConfigRetriever,
+      type: BindingTypes.SINGELTON,
+    },
     {
       binder: IPackageInfo,
       binded: PackageInfo,

testE2E/src/utils/packageInfo/impl/packageInfo.spec.ts

@@ -7,8 +7,8 @@ describe(`package info e2e`, () => {
 
   it(`should resolve package version properly`, async () => {
     const result = await packageInfo.resolvePackageVersion({
-      name: `squiss-ts`,
-      semver: `~3.0.0`,
+      name: `@pruvo/common`,
+      semver: `~1.0.0`,
     });
     expect(result).toEqual(`3.0.1`);
   }, 30000);

tsconfig.build.json

@@ -6,5 +6,5 @@
     "declaration": true,
     "outDir": "dist"
   },
-  "include": ["src"]
+  "include": ["src", "@types/**/*.d.ts"]
 }

tsconfig.json

@@ -27,5 +27,5 @@
     "experimentalDecorators": true,
     "emitDecoratorMetadata": true
   },
-  "include": ["src", "test", "testE2E", "testInteg", "tools"]
+  "include": ["src", "test", "testE2E", "testInteg", "tools", "@types/**/*.d.ts"]
 }