Merge pull request #1256 from opencomponents/noUnusedParameters-noImplicitReturns

ricardo-devis-agullo · web-flow · commit 0901a76da231 · 2021-10-22T18:16:33.000+02:00
[INTERNAL] enable noUnusedParameters and noImplicitReturns rules. fix problems
diff --git a/src/cli/domain/get-mocked-plugins.ts b/src/cli/domain/get-mocked-plugins.ts
@@ -37,8 +37,8 @@ const isMockValid = (
 };
 
 const defaultRegister = (
-  options: unknown,
-  dependencies: unknown,
+  _options: unknown,
+  _dependencies: unknown,
   next: () => void
 ) => {
   next();
diff --git a/src/cli/domain/mock.ts b/src/cli/domain/mock.ts
@@ -8,7 +8,7 @@ export default function mock() {
     params: { targetType: string; targetValue: string; targetName: string },
     callback: (err: Error) => void
   ): void {
-    fs.readJson(settings.configFile.src, (err, localConfig) => {
+    fs.readJson(settings.configFile.src, (_err, localConfig) => {
       localConfig = localConfig || {};
 
       const mockType = params.targetType + 's';
diff --git a/src/cli/facade/publish.ts b/src/cli/facade/publish.ts
@@ -49,10 +49,10 @@ const publish =
 
       logger.warn(strings.messages.cli.ENTER_USERNAME);
 
-      read({}, (err, username) => {
+      read({}, (_err, username) => {
         logger.warn(strings.messages.cli.ENTER_PASSWORD);
 
-        read({ silent: true }, (err, password) => {
+        read({ silent: true }, (_err, password) => {
           cb(null, { username, password });
         });
       });
@@ -110,7 +110,7 @@ const publish =
 
             logger.warn(strings.messages.cli.REGISTRY_CREDENTIALS_REQUIRED);
 
-            return getCredentials((err, credentials) => {
+            return getCredentials((_err, credentials) => {
               putComponentToRegistry(_.extend(options, credentials), cb);
             });
           } else if ((err as any).code === 'cli_version_not_valid') {
diff --git a/src/cli/facade/registry-ls.ts b/src/cli/facade/registry-ls.ts
@@ -4,7 +4,7 @@ import { Logger } from '../logger';
 
 const registryLs =
   ({ registry, logger }: { logger: Logger; registry: RegistryCli }) =>
-  (opts: unknown, callback: Callback<string[], string>): void => {
+  (_opts: unknown, callback: Callback<string[], string>): void => {
     registry.get((err, registries) => {
       if (err) {
         logger.err(strings.errors.generic(err));
diff --git a/src/cli/facade/registry.ts b/src/cli/facade/registry.ts
@@ -1,6 +1,6 @@
 const registry =
   () =>
-  (opts: unknown, callback: Callback<'ok'>): void => {
+  (_opts: unknown, callback: Callback<'ok'>): void => {
     callback(null, 'ok');
   };
 
diff --git a/src/registry/domain/options-sanitiser.ts b/src/registry/domain/options-sanitiser.ts
@@ -13,7 +13,7 @@ export default function optionsSanitiser(input: Input): Config {
   const options = _.clone(input);
 
   if (!options.publishAuth) {
-    (options as Config).beforePublish = (req, res, next) => next();
+    (options as Config).beforePublish = (_req, _res, next) => next();
   } else {
     (options as Config).beforePublish = auth.middleware(options.publishAuth);
   }
diff --git a/src/registry/domain/repository.ts b/src/registry/domain/repository.ts
@@ -382,7 +382,7 @@ export default function repository(conf: Config): Repository {
 
       repository.getComponentVersions(
         componentName,
-        (err, componentVersions) => {
+        (_err, componentVersions) => {
           if (
             !versionHandler.validateNewVersion(
               componentVersion,
diff --git a/src/registry/middleware/cors.ts b/src/registry/middleware/cors.ts
@@ -1,7 +1,7 @@
 import { NextFunction, Request, Response } from 'express';
 
 export default function cors(
-  req: Request,
+  _req: Request,
   res: Response,
   next: NextFunction
 ): void {
diff --git a/src/registry/middleware/file-uploads.ts b/src/registry/middleware/file-uploads.ts
@@ -19,7 +19,7 @@ export default function fileUpload(
     },
     storage: multer.diskStorage({
       destination: res.conf.tempDir,
-      filename: (req, file, cb) =>
+      filename: (_req, file, cb) =>
         cb(null, `${normaliseFileName(file.originalname)}-${Date.now()}.tar.gz`)
     })
   });
diff --git a/src/registry/middleware/index.ts b/src/registry/middleware/index.ts
@@ -20,7 +20,7 @@ export const bind = (app: Express, options: Config): Express => {
   app.set('port', options.port);
   app.set('json spaces', 0);
 
-  app.use((req, res, next) => {
+  app.use((_req, res, next) => {
     res.conf = options;
     next();
   });
diff --git a/src/registry/router.ts b/src/registry/router.ts
@@ -31,7 +31,7 @@ export function create(
   const prefix = conf.prefix;
 
   if (prefix !== '/') {
-    app.get('/', (req, res) => res.redirect(prefix));
+    app.get('/', (_req, res) => res.redirect(prefix));
     app.get(prefix.substr(0, prefix.length - 1), routes.index);
   }
 
diff --git a/src/registry/routes/component-info.ts b/src/registry/routes/component-info.ts
@@ -43,10 +43,11 @@ function componentInfo(
   req: Request,
   res: Response,
   component: Component
-) {
+): void {
   if (err) {
     res.errorDetails = (err as any).registryError || err;
-    return res.status(404).json(err);
+    res.status(404).json(err);
+    return;
   }
 
   const isHtmlRequest =
@@ -63,7 +64,7 @@ function componentInfo(
       typeof component.repository === 'string' ? component.repository : null
     );
 
-    isUrlDiscoverable(href, (err, result) => {
+    isUrlDiscoverable(href, (_err, result) => {
       if (!result.isDiscoverable) {
         href = `//${req.headers.host}${res.conf.prefix}`;
       }
diff --git a/src/registry/routes/component-preview.ts b/src/registry/routes/component-preview.ts
@@ -14,7 +14,8 @@ function componentPreview(
   if (err) {
     res.errorDetails = err.registryError || err;
     res.errorCode = 'NOT_FOUND';
-    return res.status(404).json(err);
+    res.status(404).json(err);
+    return;
   }
 
   let liveReload = '';
@@ -26,7 +27,7 @@ function componentPreview(
     !!req.headers.accept && req.headers.accept.indexOf('text/html') >= 0;
 
   if (isHtmlRequest && !!res.conf.discovery) {
-    return res.send(
+    res.send(
       previewView({
         component,
         href: res.conf.baseUrl,
diff --git a/src/registry/routes/components.ts b/src/registry/routes/components.ts
@@ -34,7 +34,7 @@ export default function components(
     const registryErrors = strings.errors.registry;
 
     const returnError = function (message: string) {
-      return res.status(400).json({
+      res.status(400).json({
         code: registryErrors.BATCH_ROUTE_BODY_NOT_VALID_CODE,
         error: registryErrors.BATCH_ROUTE_BODY_NOT_VALID(message)
       });
@@ -51,9 +51,9 @@ export default function components(
     if (!_.isEmpty(components)) {
       const errors = _.compact(
         _.map(components, (component, index) => {
-          if (!component.name) {
-            return registryErrors.BATCH_ROUTE_COMPONENT_NAME_MISSING(index);
-          }
+          return !component.name
+            ? registryErrors.BATCH_ROUTE_COMPONENT_NAME_MISSING(index)
+            : '';
         })
       );
 
diff --git a/src/registry/routes/dependencies.ts b/src/registry/routes/dependencies.ts
@@ -3,7 +3,7 @@ import { Config } from '../../types';
 import getAvailableDependencies from './helpers/get-available-dependencies';
 
 export default function dependencies(conf: Config) {
-  return function (req: Request, res: Response): void {
+  return function (_req: Request, res: Response): void {
     if (res.conf.discovery) {
       const dependencies = getAvailableDependencies(conf.dependencies).map(
         ({ core, name, version }) => {
diff --git a/src/registry/routes/helpers/get-component.ts b/src/registry/routes/helpers/get-component.ts
@@ -375,7 +375,7 @@ export default function getComponent(conf: Config, repository: Repository) {
               repository.getCompiledView(
                 component.name,
                 component.version,
-                (err, templateText) => {
+                (_err, templateText) => {
                   let ocTemplate;
 
                   try {
diff --git a/src/registry/routes/helpers/is-url-discoverable.ts b/src/registry/routes/helpers/is-url-discoverable.ts
@@ -9,7 +9,7 @@ export default function isUrlDiscoverable(
       url,
       headers: { accept: 'text/html' }
     },
-    (err, body, details) => {
+    (err, _body, details) => {
       const isHtml = () =>
         details.response.headers['content-type'].indexOf('text/html') >= 0;
 
diff --git a/src/registry/routes/index.ts b/src/registry/routes/index.ts
@@ -34,7 +34,8 @@ export default function (repository: Repository) {
     repository.getComponents((err, components) => {
       if (err) {
         res.errorDetails = 'cdn not available';
-        return res.status(404).json({ error: res.errorDetails });
+        res.status(404).json({ error: res.errorDetails });
+        return;
       }
 
       const baseResponse = {
diff --git a/src/registry/routes/plugins.ts b/src/registry/routes/plugins.ts
@@ -2,7 +2,7 @@ import { Request, Response } from 'express';
 import { Config } from '../../types';
 
 export default function plugins(conf: Config) {
-  return (req: Request, res: Response): void => {
+  return (_req: Request, res: Response): void => {
     if (res.conf.discovery) {
       const plugins = Object.entries(conf.plugins).map(
         ([pluginName, pluginFn]) => ({
diff --git a/src/registry/routes/publish.ts b/src/registry/routes/publish.ts
@@ -56,9 +56,8 @@ export default function publish(repository: Repository) {
     extractPackage(files, (err, pkgDetails) => {
       if (err) {
         res.errorDetails = `Package is not valid: ${err}`;
-        return res
-          .status(500)
-          .json({ error: 'package is not valid', details: err });
+        res.status(500).json({ error: 'package is not valid', details: err });
+        return;
       }
 
       repository.publishComponent(
@@ -85,7 +84,7 @@ export default function publish(repository: Repository) {
             }
           }
 
-          res.status(200).json({ ok: true });
+          return res.status(200).json({ ok: true });
         }
       );
     });
diff --git a/tsconfig.json b/tsconfig.json
@@ -85,9 +85,9 @@
     "useUnknownInCatchVariables": true /* Type catch clause variables as 'unknown' instead of 'any'. */,
     "alwaysStrict": true /* Ensure 'use strict' is always emitted. */,
     "noUnusedLocals": true /* Enable error reporting when a local variables aren't read. */,
-    // "noUnusedParameters": true /* Raise an error when a function parameter isn't read */,
+    "noUnusedParameters": true /* Raise an error when a function parameter isn't read */,
     // "exactOptionalPropertyTypes": true /* Interpret optional property types as written, rather than adding 'undefined'. */,
-    // "noImplicitReturns": true /* Enable error reporting for codepaths that do not explicitly return in a function. */,
+    "noImplicitReturns": true /* Enable error reporting for codepaths that do not explicitly return in a function. */,
     "noFallthroughCasesInSwitch": true /* Enable error reporting for fallthrough cases in switch statements. */,
     // "noUncheckedIndexedAccess": true /* Include 'undefined' in index signature results */,
     "noImplicitOverride": true /* Ensure overriding members in derived classes are marked with an override modifier. */,

Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ export default function optionsSanitiser(input: Input): Config {`
`13`	`13`	`const options = _.clone(input);`
`14`	`14`
`15`	`15`	`if (!options.publishAuth) {`
`16`		`- (options as Config).beforePublish = (req, res, next) => next();`
	`16`	`+ (options as Config).beforePublish = (_req, _res, next) => next();`
`17`	`17`	`} else {`
`18`	`18`	`(options as Config).beforePublish = auth.middleware(options.publishAuth);`
`19`	`19`	`}`