Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

refactor: reduces anonymous top level functions #703

Merged
merged 1 commit into from Dec 23, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
2 changes: 1 addition & 1 deletion src/cli/format.js
Expand Up @@ -10,7 +10,7 @@ const io = require("./utl/io");
* @param {import("../../types/dependency-cruiser").IFormatOptions} pOptions
* @returns {Number} an exitCode
*/
module.exports = async (pResultFile, pOptions) => {
module.exports = async function format(pResultFile, pOptions) {
const lOptions = normalizeOptions(pOptions);

if (pResultFile !== "-") {
Expand Down
5 changes: 2 additions & 3 deletions src/cli/index.js
Expand Up @@ -119,7 +119,6 @@ function runCruise(pFileDirectoryArray, pCruiseOptions) {
bus.emit("progress", "cli: writing results");
bus.emit("write-start");
io.write(lCruiseOptions.outputTo, lReportingResult.output);
bus.emit("end");

return lReportingResult.exitCode;
}
Expand All @@ -131,7 +130,7 @@ function runCruise(pFileDirectoryArray, pCruiseOptions) {
* @returns {number}
*/
module.exports = function executeCli(pFileDirectoryArray, pCruiseOptions) {
let lCruiseOptions = cloneDeep(pCruiseOptions || {});
let lCruiseOptions = pCruiseOptions || {};
let lExitCode = 0;

try {
Expand Down Expand Up @@ -170,6 +169,6 @@ module.exports = function executeCli(pFileDirectoryArray, pCruiseOptions) {
bus.emit("end");
lExitCode = 1;
}

bus.emit("end");
return lExitCode;
};
2 changes: 1 addition & 1 deletion src/cli/init-config/index.js
Expand Up @@ -72,7 +72,7 @@ function manifestIsUpdateable(pNormalizedInitConfig) {
);
}

module.exports = (pInit) => {
module.exports = function initConfig(pInit) {
/* c8 ignore start */
if (pInit === true) {
getUserInput()
Expand Down
2 changes: 1 addition & 1 deletion src/config-utl/extract-depcruise-config/read-config.js
Expand Up @@ -2,7 +2,7 @@ const fs = require("fs");
const path = require("path");
const json5 = require("json5");

module.exports = (pConfigFileName) => {
module.exports = function readConfig(pConfigFileName) {
if ([".js", ".cjs", ""].includes(path.extname(pConfigFileName))) {
/* eslint node/global-require:0, security/detect-non-literal-require:0, import/no-dynamic-require:0 */
return require(pConfigFileName);
Expand Down
2 changes: 1 addition & 1 deletion src/config-utl/make-absolute.js
@@ -1,6 +1,6 @@
const path = require("path");

module.exports = (pFilename) => {
module.exports = function makeAbsolute(pFilename) {
let lReturnValue = pFilename;

if (!path.isAbsolute(pFilename)) {
Expand Down
2 changes: 1 addition & 1 deletion src/enrich/add-validations.js
Expand Up @@ -20,7 +20,7 @@ function addDependencyViolations(pModule, pDependency, pRuleSet, pValidate) {
* of them added whether or not it is
* valid and if not which rules were violated
*/
module.exports = (pModules, pRuleSet, pValidate) => {
module.exports = function addValidations(pModules, pRuleSet, pValidate) {
return pModules.map((pModule) => ({
...pModule,
...(pValidate ? validate.module(pRuleSet, pModule) : { valid: true }),
Expand Down
5 changes: 3 additions & 2 deletions src/enrich/derive/orphan/index.js
@@ -1,7 +1,8 @@
const isOrphan = require("./is-orphan");

module.exports = (pModules) =>
pModules.map((pModule) => ({
module.exports = function deriveOrphans(pModules) {
return pModules.map((pModule) => ({
...pModule,
orphan: isOrphan(pModule, pModules),
}));
};
2 changes: 1 addition & 1 deletion src/enrich/derive/orphan/is-orphan.js
@@ -1,6 +1,6 @@
const { isDependent } = require("../module-utl");

module.exports = (pModule, pGraph) => {
module.exports = function isOrphan(pModule, pGraph) {
if (pModule.dependencies.length > 0) {
return false;
}
Expand Down
2 changes: 1 addition & 1 deletion src/enrich/derive/reachable/index.js
Expand Up @@ -169,7 +169,7 @@ function addReachabilityToGraph(pGraph, pReachableRule) {
});
}

module.exports = (pGraph, pRuleSet) => {
module.exports = function deriveReachables(pGraph, pRuleSet) {
const lReachableRules = pRuleSet ? getReachableRules(pRuleSet) : [];

return lReachableRules.reduce(
Expand Down
10 changes: 6 additions & 4 deletions src/graph-utl/consolidate-module-dependencies.js
Expand Up @@ -47,7 +47,9 @@ function consolidateDependencies(pDependencies) {
return lReturnValue;
}

module.exports = (pModule) => ({
...pModule,
dependencies: consolidateDependencies(pModule.dependencies),
});
module.exports = function consolidateModuleDependencies(pModule) {
return {
...pModule,
dependencies: consolidateDependencies(pModule.dependencies),
};
};
2 changes: 1 addition & 1 deletion src/graph-utl/consolidate-modules.js
Expand Up @@ -34,7 +34,7 @@ function mergeModules(pSourceString, pModules) {
);
}

module.exports = (pModules) => {
module.exports = function consolidateModules(pModules) {
let lModules = clone(pModules);
let lReturnValue = [];

Expand Down
5 changes: 3 additions & 2 deletions src/graph-utl/consolidate-to-folder.js
Expand Up @@ -17,7 +17,8 @@ function squashModuleToDirectory(pModule) {
};
}

module.exports = (pModules) =>
consolidateModules(pModules.map(squashModuleToDirectory)).map(
module.exports = function consolidateToFolder(pModules) {
return consolidateModules(pModules.map(squashModuleToDirectory)).map(
consolidateModuleDependencies
);
};
18 changes: 10 additions & 8 deletions src/report/baseline.js
Expand Up @@ -10,11 +10,13 @@ const DEFAULT_JSON_INDENT = 2;
* output: some stats on modules and dependencies in json format
* exitCode: 0
*/
module.exports = (pCruiseResult) => ({
output: JSON.stringify(
pCruiseResult.summary.violations,
null,
DEFAULT_JSON_INDENT
),
exitCode: 0,
});
module.exports = function baseline(pCruiseResult) {
return {
output: JSON.stringify(
pCruiseResult.summary.violations,
null,
DEFAULT_JSON_INDENT
),
exitCode: 0,
};
};
10 changes: 6 additions & 4 deletions src/report/csv.js
Expand Up @@ -27,7 +27,9 @@ function report(pModules) {
* the output of a dependency-cruise adhering to ../../schema/cruise-result.schema.json
* @returns {import("../../types/dependency-cruiser").IReporterOutput}
*/
module.exports = (pResults) => ({
output: report(dependencyToIncidenceTransformer(pResults.modules)),
exitCode: 0,
});
module.exports = function csv(pResults) {
return {
output: report(dependencyToIncidenceTransformer(pResults.modules)),
exitCode: 0,
};
};
22 changes: 12 additions & 10 deletions src/report/dot/index.js
Expand Up @@ -130,17 +130,19 @@ function normalizeDotReporterOptions(
* @param {string} pGranularity - either "module" (for fine grained module
* level) or "folder" (for a report consolidated
* to folders)
* @returns {(pResults, pDotReporterOptions) => import("../../../types/dependency-cruiser").IReporterOutput}
* @returns {(pResults, pDotReporterOptions) => import("../../..").IReporterOutput}
*/
module.exports = (pGranularity) => (pResults, pDotReporterOptions) => {
const lDotReporterOptions = normalizeDotReporterOptions(
pDotReporterOptions,
pGranularity,
pResults
);
module.exports = function produceDotReporter(pGranularity) {
return function dot(pResults, pDotReporterOptions) {
const lDotReporterOptions = normalizeDotReporterOptions(
pDotReporterOptions,
pGranularity,
pResults
);

return {
output: report(pResults, pGranularity, lDotReporterOptions),
exitCode: 0,
return {
output: report(pResults, pGranularity, lDotReporterOptions),
exitCode: 0,
};
};
};
7 changes: 6 additions & 1 deletion src/report/dot/prepare-custom-level.js
Expand Up @@ -4,7 +4,12 @@ const compare = require("../../graph-utl/compare");
const stripSelfTransitions = require("../../graph-utl/strip-self-transitions");
const moduleUtl = require("./module-utl");

module.exports = (pResults, pTheme, pCollapsePattern, pShowMetrics) => {
module.exports = function prepareCustomLevel(
pResults,
pTheme,
pCollapsePattern,
pShowMetrics
) {
return (
pCollapsePattern
? consolidateToPattern(pResults.modules, pCollapsePattern)
Expand Down
2 changes: 1 addition & 1 deletion src/report/dot/prepare-flat-level.js
Expand Up @@ -2,7 +2,7 @@ const get = require("lodash/get");
const compare = require("../../graph-utl/compare");
const moduleUtl = require("./module-utl");

module.exports = (pResults, pTheme, _, pShowMetrics) => {
module.exports = function prepareFlatLevel(pResults, pTheme, _, pShowMetrics) {
return pResults.modules
.sort(compare.modules)
.map(moduleUtl.flatLabel(pShowMetrics))
Expand Down
7 changes: 6 additions & 1 deletion src/report/dot/prepare-folder-level.js
Expand Up @@ -3,7 +3,12 @@ const compare = require("../../graph-utl/compare");
const stripSelfTransitions = require("../../graph-utl/strip-self-transitions");
const moduleUtl = require("./module-utl");

module.exports = (pResults, pTheme, _, pShowMetrics) => {
module.exports = function prepareFolderLevel(
pResults,
pTheme,
_,
pShowMetrics
) {
return consolidateToFolder(pResults.modules)
.sort(compare.modules)
.map(moduleUtl.extractFirstTransgression)
Expand Down
10 changes: 6 additions & 4 deletions src/report/error-html/index.js
Expand Up @@ -30,7 +30,9 @@ function report(pResults) {
* @returns {import("../../../types/dependency-cruiser").IReporterOutput} - output: an html program showing the summary & the violations (if any)
* exitCode: 0
*/
module.exports = (pResults) => ({
output: report(pResults),
exitCode: 0,
});
module.exports = function errorHtml(pResults) {
return {
output: report(pResults),
exitCode: 0,
};
};
10 changes: 6 additions & 4 deletions src/report/error.js
Expand Up @@ -156,7 +156,9 @@ function report(pResults, pLong) {
* @returns {import("../../types/dependency-cruiser").IReporterOutput} - output: the formatted text in a string
* exitCode: the number of errors found
*/
module.exports = (pResults, pOptions) => ({
output: report(pResults, (pOptions || {}).long),
exitCode: pResults.summary.error,
});
module.exports = function error(pResults, pOptions) {
return {
output: report(pResults, (pOptions || {}).long),
exitCode: pResults.summary.error,
};
};
10 changes: 6 additions & 4 deletions src/report/html/index.js
Expand Up @@ -28,7 +28,9 @@ function report(pResults) {
* @param {import("../../../types/cruise-result").ICruiseResult} pResults
* @returns {import("../../../types/dependency-cruiser").IReporterOutput}
*/
module.exports = (pResults) => ({
output: report(pResults),
exitCode: 0,
});
module.exports = function html(pResults) {
return {
output: report(pResults),
exitCode: 0,
};
};
10 changes: 6 additions & 4 deletions src/report/identity.js
Expand Up @@ -4,7 +4,9 @@
* @param {import("../../types/cruise-result").ICruiseResult} pResults
* @returns {import("../../types/dependency-cruiser").IReporterOutput}
*/
module.exports = (pResults) => ({
output: pResults,
exitCode: 0,
});
module.exports = function identity(pResults) {
return {
output: pResults,
exitCode: 0,
};
};
10 changes: 6 additions & 4 deletions src/report/json.js
Expand Up @@ -4,7 +4,9 @@
* @param {import("../../types/cruise-result").ICruiseResult} pResults
* @returns {import("../../types/dependency-cruiser").IReporterOutput}
*/
module.exports = (pResults) => ({
output: JSON.stringify(pResults, null, " "),
exitCode: 0,
});
module.exports = function json(pResults) {
return {
output: JSON.stringify(pResults, null, " "),
exitCode: 0,
};
};
10 changes: 6 additions & 4 deletions src/report/markdown.js
Expand Up @@ -166,7 +166,9 @@ function report(pResults, pOptions) {
* @param {import("../../types/reporter-options").IMarkdownReporterOptions} pOptions
* @returns {import("../../types/dependency-cruiser").IReporterOutput}
*/
module.exports = (pResults, pOptions) => ({
output: report(pResults, pOptions),
exitCode: 0,
});
module.exports = function markdown(pResults, pOptions) {
return {
output: report(pResults, pOptions),
exitCode: 0,
};
};
10 changes: 6 additions & 4 deletions src/report/mermaid.js
Expand Up @@ -163,7 +163,9 @@ ${focusHighlights(pCruiseResult.modules, lNamesHashMap)}`;
* @param {import("../../types/reporter-options").IMermaidReporterOptions} pOptions
* @return {import('../../types/dependency-cruiser').IReporterOutput}
*/
module.exports = (pCruiseResult, pOptions) => ({
output: renderMermaidSource(pCruiseResult, pOptions),
exitCode: 0,
});
module.exports = function mermaid(pCruiseResult, pOptions) {
return {
output: renderMermaidSource(pCruiseResult, pOptions),
exitCode: 0,
};
};
2 changes: 1 addition & 1 deletion src/report/metrics.js
Expand Up @@ -117,7 +117,7 @@ function transformMetricsToTable(
* @param {import("../../types/reporter-options").IMetricsReporterOptions} pReporterOptions
* @return {import('../../types/dependency-cruiser').IReporterOutput} -
*/
module.exports = (pCruiseResult, pReporterOptions) => {
module.exports = function metrics(pCruiseResult, pReporterOptions) {
const lReporterOptions = pReporterOptions || {};
if (pCruiseResult.folders) {
return {
Expand Down
2 changes: 1 addition & 1 deletion src/report/teamcity.js
Expand Up @@ -143,7 +143,7 @@ function reportViolations(pViolations, pIgnoredCount) {
* @param {import("../../types/dependency-cruiser").ICruiseResult} pResults
* @returns {import("../../types/dependency-cruiser").IReporterOutput}
*/
module.exports = (pResults) => {
module.exports = function teamcity(pResults) {
// this is the documented way to get tsm to emit strings
// Alternatively we could've used the 'low level API', which
// involves creating new `Message`s and stringifying those.
Expand Down
10 changes: 6 additions & 4 deletions src/report/text.js
Expand Up @@ -84,7 +84,9 @@ function report(pResults, pOptions) {
* @param {import("../../types/reporter-options").ITextReporterOptions} pOptions
* @returns {import("../../types/dependency-cruiser").IReporterOutput}
*/
module.exports = (pResults, pOptions) => ({
output: report(pResults, pOptions || {}),
exitCode: 0,
});
module.exports = function text(pResults, pOptions) {
return {
output: report(pResults, pOptions || {}),
exitCode: 0,
};
};
5 changes: 3 additions & 2 deletions src/report/utl/dependency-to-incidence-transformer.js
Expand Up @@ -45,5 +45,6 @@ function addIncidences(pFromList) {
/*

*/
module.exports = (pFromList) =>
pFromList.sort(compareOnSource).map(addIncidences(pFromList));
module.exports = function transformDependenciesToIncidences(pFromList) {
return pFromList.sort(compareOnSource).map(addIncidences(pFromList));
};