Skip to content

update eslint rule on array-type #320

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
7 changes: 7 additions & 0 deletions .eslintrc.js
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,13 @@ module.exports = {
},
plugins: ["@typescript-eslint"],
rules: {
"@typescript-eslint/array-type": [
"error",
{
default: "array-simple",
readonly: "array-simple",
},
],
"@typescript-eslint/consistent-type-definitions": ["error", "type"],
"@typescript-eslint/explicit-function-return-type": "off",
"@typescript-eslint/generic-type-naming": "off",
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@
"url": "github:typescript-eslint/tslint-to-eslint-config"
},
"scripts": {
"fix": "eslint \"./src/*.ts\" \"./src/**/*.ts\" --report-unused-disable-directives --fix",
"eslint": "eslint \"./src/*.ts\" \"./src/**/*.ts\" --report-unused-disable-directives",
"prettier": "prettier \"./src/*.{js,json,ts,xml,yaml}\" \"./src/**/*.{js,json,ts,xml,yaml}\" --ignore-path .prettierignore",
"prettier:write": "npm run prettier -- --write",
Expand Down
2 changes: 1 addition & 1 deletion src/cli/runCli.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { convertConfig } from "../conversion/convertConfig";
import { ResultStatus, ResultWithStatus, TSLintToESLintSettings } from "../types";

export type RunCliDependencies = {
convertConfigs: SansDependencies<typeof convertConfig>[];
convertConfigs: Array<SansDependencies<typeof convertConfig>>;
logger: Logger;
};

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ const prepareTestRule = (
},
],
]);
const extensions: Partial<ESLintConfiguration>[] = [
const extensions: Array<Partial<ESLintConfiguration>> = [
{
rules: {
[ruleName]: extensionConfiguration,
Expand Down
4 changes: 2 additions & 2 deletions src/creation/simplification/removeExtendsDuplicatedRules.ts
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ import { ESLintRuleOptions } from "../../rules/types";

export const removeExtendsDuplicatedRules = (
allRules: Map<string, ESLintRuleOptions>,
extensions: Partial<ESLintConfiguration>[],
extensions: Array<Partial<ESLintConfiguration>>,
): Map<string, ESLintRuleOptions> => {
const differentRules = new Map<string, ESLintRuleOptions>();
const mergedExtensionRules = mergeExtensions(extensions);
Expand All @@ -23,7 +23,7 @@ export const removeExtendsDuplicatedRules = (
return differentRules;
};

const mergeExtensions = (extensions: Partial<ESLintConfiguration>[]) => {
const mergeExtensions = (extensions: Array<Partial<ESLintConfiguration>>) => {
const mergedRules = new Map<string, ESLintRuleOptions>();

for (const extension of extensions) {
Expand Down
4 changes: 2 additions & 2 deletions src/creation/simplification/retrieveExtendsValues.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ export type RetrieveExtendsValuesDependencies = {

export type RetrievedExtensionValues = {
configurationErrors: ConfigurationError[];
importedExtensions: Partial<ESLintConfiguration>[];
importedExtensions: Array<Partial<ESLintConfiguration>>;
};

const builtInExtensions = new Map([
Expand Down Expand Up @@ -40,7 +40,7 @@ export const retrieveExtendsValues = async (
dependencies: RetrieveExtendsValuesDependencies,
rawExtensionNames: string | string[],
): Promise<RetrievedExtensionValues> => {
const importedExtensions: Partial<ESLintConfiguration>[] = [];
const importedExtensions: Array<Partial<ESLintConfiguration>> = [];
const configurationErrors: ConfigurationError[] = [];
const extensionNames = resolveExtensionNames(rawExtensionNames);

Expand Down
4 changes: 2 additions & 2 deletions src/editorSettings/convertEditorSettings.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ export type ConvertEditorSettingsDependencies = {
export type EditorSettingConversionResults = {
converted: Map<string, EditorSetting>;
failed: ErrorSummary[];
missing: Pick<EditorSetting, "editorSettingName">[];
missing: Array<Pick<EditorSetting, "editorSettingName">>;
};

// The entire editor configuration of any keys and values.
Expand All @@ -25,7 +25,7 @@ export const convertEditorSettings = (
): EditorSettingConversionResults => {
const converted = new Map<string, EditorSetting>();
const failed: ConversionError[] = [];
const missing: Pick<EditorSetting, "editorSettingName">[] = [];
const missing: Array<Pick<EditorSetting, "editorSettingName">> = [];

for (const [configurationName, value] of Object.entries(rawEditorConfiguration)) {
// Configurations other than editor settings will be ignored.
Expand Down
2 changes: 1 addition & 1 deletion src/rules/converters/import-blacklist.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ type ESLintOptionPath = {
};
type ESLintSimpleOption = string[];
type ESLintComplexOption = RequireAtLeastOne<{
paths: (string | ESLintOptionPath)[];
paths: Array<string | ESLintOptionPath>;
patterns: string[];
}>;
type ESLintOptions = ESLintSimpleOption | ESLintComplexOption;
Expand Down
2 changes: 1 addition & 1 deletion src/rules/converters/no-shadowed-variable.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ const UNDERSCORE_DISABLE_NOTICE =
"provide specific variable names you want to disable the rule for.";

export const convertNoShadowedVariable: RuleConverter = tslintRule => {
const ruleArguments: { hoist: "all" | "never" }[] = [];
const ruleArguments: Array<{ hoist: "all" | "never" }> = [];
const notices: string[] = [];

if (tslintRule.ruleArguments.length === 0 || !(tslintRule.ruleArguments[0] instanceof Object)) {
Expand Down
2 changes: 1 addition & 1 deletion src/rules/converters/no-trailing-whitespace.ts
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
import { RuleConverter } from "../converter";

export const convertNoTrailingWhitespace: RuleConverter = tslintRule => {
const ruleArguments: Partial<Record<"ignoreComments" | "skipBlankLines", boolean>>[] = [];
const ruleArguments: Array<Partial<Record<"ignoreComments" | "skipBlankLines", boolean>>> = [];
const notices: string[] = [];

if (tslintRule.ruleArguments.includes("ignore-comments")) {
Expand Down
2 changes: 1 addition & 1 deletion src/rules/mergers/member-delimiter-style.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ export const mergeNoMemberDelimiterStyle: RuleMerger = (existingOptions, newOpti
return [merge((existingOptions ?? [])[0] ?? {}, (newOptions ?? [])[0] ?? {})];
};

const merge = (...objs: Record<string, any>[]) =>
const merge = (...objs: Array<Record<string, any>>) =>
[...objs].reduce(
(acc, obj) => ({
...acc,
Expand Down
2 changes: 1 addition & 1 deletion src/utils.ts
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ export type RequireAtLeastOne<T, Keys extends keyof T = keyof T> = Pick<T, Exclu
[K in Keys]-?: Required<Pick<T, K>> & Partial<Pick<T, Exclude<Keys, K>>>;
}[Keys];

export const uniqueFromSources = <T>(...sources: (T | T[] | undefined)[]) => {
export const uniqueFromSources = <T>(...sources: Array<T | T[] | undefined>) => {
const items: T[] = [];

for (const source of sources) {
Expand Down