Skip to content

Split dependencies into their owning functions' files #819

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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions docs/Dependencies.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# TODO: REWRITE IF CHANGES DEEMED ACCEPTABLE
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@KingDarBoja do you have any thoughts on the changes here?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I have nothing against it, as long as there aren't API changes but only moving those dependency definitions into each owning directories. Based on that, pretty much point out that now eachdependency lives on the same file as the function fiels. ⭐


# Dependencies

Functions are created using a variant of [Dependency Injection](http://en.wikipedia.org/wiki/Dependency_Injection).
Expand Down
6 changes: 4 additions & 2 deletions src/api/createESLintConfigurationStandalone.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
import { createESLintConfiguration } from "../converters/lintConfigs/createESLintConfiguration";
import {
createESLintConfiguration,
createESLintConfigurationDependencies,
} from "../converters/lintConfigs/createESLintConfiguration";
import { ESLintConfiguration } from "../input/findESLintConfiguration";
import {
AllOriginalConfigurations,
Expand All @@ -7,7 +10,6 @@ import {
import { PackagesConfiguration } from "../input/findPackagesConfiguration";
import { TSLintConfiguration } from "../input/findTSLintConfiguration";
import { TypeScriptConfiguration } from "../input/findTypeScriptConfiguration";
import { createESLintConfigurationDependencies } from "./dependencies";

export type AllOriginalConfigurationsOptionally = {
eslint?: Partial<OriginalConfigurations<ESLintConfiguration>>;
Expand Down
218 changes: 0 additions & 218 deletions src/api/dependencies.ts

This file was deleted.

6 changes: 4 additions & 2 deletions src/api/findOriginalConfigurationsStandalone.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
import { findOriginalConfigurations } from "../input/findOriginalConfigurations";
import {
findOriginalConfigurations,
findOriginalConfigurationsDependencies,
} from "../input/findOriginalConfigurations";
import { ConfigurationLocations } from "../types";
import { findOriginalConfigurationsDependencies } from "./dependencies";

/**
* Retrieves the raw and computed contents of original configuration files.
Expand Down
3 changes: 1 addition & 2 deletions src/cli/main.ts
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
import { EOL } from "os";

import { processLogger } from "../adapters/processLogger";
import { runCliDependencies } from "../api/dependencies";
import { runCli } from "../cli/runCli";
import { runCli, runCliDependencies } from "../cli/runCli";

export const main = async (argv: string[]) => {
try {
Expand Down
29 changes: 28 additions & 1 deletion src/cli/runCli.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,25 @@ import { EOL } from "os";

import { version } from "../../package.json";
import { Logger } from "../adapters/logger";
import { SansDependencies } from "../binding";
import { processLogger } from "../adapters/processLogger";
import { bind, SansDependencies } from "../binding";
import {
convertComments,
convertCommentsDependencies,
} from "../converters/comments/convertComments";
import {
convertEditorConfigs,
convertEditorConfigsDependencies,
} from "../converters/editorConfigs/convertEditorConfigs";
import {
convertLintConfig,
convertLintConfigDependencies,
} from "../converters/lintConfigs/convertLintConfig";
import { Converter } from "../converters/types";
import {
AllOriginalConfigurations,
findOriginalConfigurations,
findOriginalConfigurationsDependencies,
} from "../input/findOriginalConfigurations";
import { logErrorResult } from "../reporting";
import { ResultStatus, ResultWithStatus, TSLintToESLintSettings } from "../types";
Expand All @@ -19,6 +33,19 @@ export type RunCliDependencies = {
logger: Logger;
};

export const runCliDependencies: RunCliDependencies = {
converters: [
bind(convertLintConfig, convertLintConfigDependencies),
bind(convertEditorConfigs, convertEditorConfigsDependencies),
bind(convertComments, convertCommentsDependencies),
],
findOriginalConfigurations: bind(
findOriginalConfigurations,
findOriginalConfigurationsDependencies,
),
logger: processLogger,
};

/**
* @see `/docs/Architecture/README.md` for documentation.
*/
Expand Down
7 changes: 6 additions & 1 deletion src/comments/collectCommentFileNames.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { SansDependencies } from "../binding";
import { bind, SansDependencies } from "../binding";
import { findConfigurationDependencies } from "../input/dependencies";
import {
findTypeScriptConfiguration,
TypeScriptConfiguration,
Expand All @@ -9,6 +10,10 @@ export type CollectCommentFileNamesDependencies = {
findTypeScriptConfiguration: SansDependencies<typeof findTypeScriptConfiguration>;
};

export const collectCommentFileNamesDependencies: CollectCommentFileNamesDependencies = {
findTypeScriptConfiguration: bind(findTypeScriptConfiguration, findConfigurationDependencies),
};

export type CommentFileNames = {
exclude?: string[];
include: string[];
Expand Down
23 changes: 18 additions & 5 deletions src/converters/comments/convertComments.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,17 @@
import { SansDependencies } from "../../binding";
import { collectCommentFileNames } from "../../comments/collectCommentFileNames";
import { bind, SansDependencies } from "../../binding";
import {
collectCommentFileNames,
collectCommentFileNamesDependencies,
} from "../../comments/collectCommentFileNames";
import { AllOriginalConfigurations } from "../../input/findOriginalConfigurations";
import { ResultWithDataStatus, ResultStatus, TSLintToESLintSettings } from "../../types";
import { isError } from "../../utils";
import { convertFileComments } from "./convertFileComments";
import { extractGlobPaths } from "./extractGlobPaths";
import { reportCommentResults } from "./reporting/reportCommentResults";
import { convertFileComments, convertFileCommentsDependencies } from "./convertFileComments";
import { extractGlobPaths, extractGlobPathsDependencies } from "./extractGlobPaths";
import {
reportCommentResults,
reportCommentResultsDependencies,
} from "./reporting/reportCommentResults";

export type ConvertCommentsDependencies = {
collectCommentFileNames: SansDependencies<typeof collectCommentFileNames>;
Expand All @@ -14,6 +20,13 @@ export type ConvertCommentsDependencies = {
reportCommentResults: SansDependencies<typeof reportCommentResults>;
};

export const convertCommentsDependencies: ConvertCommentsDependencies = {
collectCommentFileNames: bind(collectCommentFileNames, collectCommentFileNamesDependencies),
convertFileComments: bind(convertFileComments, convertFileCommentsDependencies),
extractGlobPaths: bind(extractGlobPaths, extractGlobPathsDependencies),
reportCommentResults: bind(reportCommentResults, reportCommentResultsDependencies),
};

/**
* Root-level driver to convert a tslint:disable comments to eslint-disables.
* @see `/docs/Architecture/Comments.md` for documentation.
Expand Down
7 changes: 7 additions & 0 deletions src/converters/comments/convertFileComments.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,7 @@
import { FileSystem } from "../../adapters/fileSystem";
import { fsFileSystem } from "../../adapters/fsFileSystem";
import { RuleConverter } from "../lintConfigs/rules/ruleConverter";
import { ruleConverters } from "../lintConfigs/rules/ruleConverters";
import { parseFileComments } from "./parseFileComments";
import { replaceFileComments } from "./replaceFileComments";

Expand All @@ -8,6 +10,11 @@ export type ConvertFileCommentsDependencies = {
fileSystem: Pick<FileSystem, "readFile" | "writeFile">;
};

export const convertFileCommentsDependencies: ConvertFileCommentsDependencies = {
converters: ruleConverters,
fileSystem: fsFileSystem,
};

export const convertFileComments = async (
dependencies: ConvertFileCommentsDependencies,
filePath: string,
Expand Down
Loading