From 04d895fa34cdc760561d6bbf650a710026d44b6b Mon Sep 17 00:00:00 2001 From: Josh Goldberg Date: Sun, 8 Nov 2020 11:53:04 -0500 Subject: [PATCH 1/3] Exported lint rule types for Node APIs --- src/converters/lintConfigs/rules/types.ts | 24 +++++++++++++++++++++++ src/index.ts | 8 ++++++++ 2 files changed, 32 insertions(+) diff --git a/src/converters/lintConfigs/rules/types.ts b/src/converters/lintConfigs/rules/types.ts index e0016d435..942033d51 100644 --- a/src/converters/lintConfigs/rules/types.ts +++ b/src/converters/lintConfigs/rules/types.ts @@ -1,15 +1,36 @@ +/** + * Severity level for an individual TSLint rule in a TSLint configuration file. + * + * @see https://palantir.github.io/tslint/usage/configuration + */ export type TSLintRuleSeverity = "warning" | "error" | "off"; +/** + * Rich descriptor and options for an individual TSLint rule. + */ export type TSLintRuleOptions = { ruleArguments: any[]; ruleName: string; ruleSeverity: TSLintRuleSeverity; }; +/** + * Possible reported severities for an ESLint rule's configuration. + * + * @see https://eslint.org/docs/user-guide/configuring#configuring-rules + */ export type ESLintRuleSeverity = "warn" | "error" | "off"; +/** + * Permitted severities for an ESLint rule's configuration. + * + * @see https://eslint.org/docs/user-guide/configuring#configuring-rules + */ export type RawESLintRuleSeverity = ESLintRuleSeverity | 0 | 1 | 2; +/** + * Output descriptor and options for a converted ESLint rule. + */ export type ESLintRuleOptions = { notices?: any[]; ruleArguments?: any[]; @@ -17,6 +38,9 @@ export type ESLintRuleOptions = { ruleSeverity: ESLintRuleSeverity; }; +/** + * Output descriptor and options for a converted ESLint rule, including arguments. + */ export type ESLintRuleOptionsWithArguments = ESLintRuleOptions & { ruleArguments: any[]; }; diff --git a/src/index.ts b/src/index.ts index 12bfb1a61..bcd4434c3 100644 --- a/src/index.ts +++ b/src/index.ts @@ -4,4 +4,12 @@ export { findOriginalConfigurationsStandalone as findOriginalConfigurations } fr export { findReportedConfigurationStandalone as findReportedConfiguration } from "./api/findReportedConfigurationStandalone"; export { formatOutput } from "./converters/lintConfigs/formatting/formatOutput"; export { joinConfigConversionResults } from "./converters/lintConfigs/joinConfigConversionResults"; +export { + ESLintRuleOptions, + ESLintRuleOptionsWithArguments, + ESLintRuleSeverity, + RawESLintRuleSeverity, + TSLintRuleOptions, + TSLintRuleSeverity, +} from "./converters/lintConfigs/rules/types"; export * from "./types"; From 726c0cad54a8bb0e4ab7e20d3839d1029e3920cb Mon Sep 17 00:00:00 2001 From: Josh Goldberg Date: Sun, 8 Nov 2020 11:56:34 -0500 Subject: [PATCH 2/3] Hmm, how did comma-dangle get in there... --- .eslintrc.js | 1 + 1 file changed, 1 insertion(+) diff --git a/.eslintrc.js b/.eslintrc.js index 127762fbe..fcbab5fdf 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -19,6 +19,7 @@ module.exports = { plugins: ["@typescript-eslint"], rules: { "@typescript-eslint/require-array-sort-compare": "off", + "@typescript-eslint/comma-dangle": "off", "@typescript-eslint/consistent-type-definitions": ["error", "type"], "@typescript-eslint/consistent-type-imports": "off", "@typescript-eslint/explicit-function-return-type": "off", From 3f4d5fc67029162425331af1683712eb06b87b8e Mon Sep 17 00:00:00 2001 From: Josh Goldberg Date: Sun, 8 Nov 2020 11:57:31 -0500 Subject: [PATCH 3/3] Meh, just export it all --- .eslintrc.js | 1 - src/index.ts | 9 +-------- 2 files changed, 1 insertion(+), 9 deletions(-) diff --git a/.eslintrc.js b/.eslintrc.js index fcbab5fdf..127762fbe 100644 --- a/.eslintrc.js +++ b/.eslintrc.js @@ -19,7 +19,6 @@ module.exports = { plugins: ["@typescript-eslint"], rules: { "@typescript-eslint/require-array-sort-compare": "off", - "@typescript-eslint/comma-dangle": "off", "@typescript-eslint/consistent-type-definitions": ["error", "type"], "@typescript-eslint/consistent-type-imports": "off", "@typescript-eslint/explicit-function-return-type": "off", diff --git a/src/index.ts b/src/index.ts index bcd4434c3..1de4fcb09 100644 --- a/src/index.ts +++ b/src/index.ts @@ -4,12 +4,5 @@ export { findOriginalConfigurationsStandalone as findOriginalConfigurations } fr export { findReportedConfigurationStandalone as findReportedConfiguration } from "./api/findReportedConfigurationStandalone"; export { formatOutput } from "./converters/lintConfigs/formatting/formatOutput"; export { joinConfigConversionResults } from "./converters/lintConfigs/joinConfigConversionResults"; -export { - ESLintRuleOptions, - ESLintRuleOptionsWithArguments, - ESLintRuleSeverity, - RawESLintRuleSeverity, - TSLintRuleOptions, - TSLintRuleSeverity, -} from "./converters/lintConfigs/rules/types"; +export * from "./converters/lintConfigs/rules/types"; export * from "./types";