Merge pull request #2 from heap-code/develop

Add configuration presets

Author: HugoMendes98

.eslintrc.json

@@ -208,7 +208,7 @@
 			}
 		},
 		{
-			"files": ["jest.config.ts", "src/index.ts"],
+			"files": ["jest.config.ts", "src/index.ts", "src/configs/*.ts"],
 			"rules": {
 				"import/no-default-export": "off"
 			}

README.md

@@ -54,7 +54,24 @@ The different rules can be defined as follows:
 }
 ```
 
-> All these configuration can be done on a `override` section:
+Or simply extends a configuration preset:
+
+```json
+{
+  "extends": ["plugin:sort-decorators/recommended"]
+}
+```
+
+### Configuration presets
+
+| Name                                 | Description                                                    |
+|:-------------------------------------|:---------------------------------------------------------------|
+| `plugin:sort-decorators/recommended` | Enables all rules with a `warn` security level.                |
+| `plugin:sort-decorators/strict`      | Enables all rules with a `error` security level and `autoFix`. |
+
+---
+
+> All this configuration can be done on a `override` section:
 > <https://eslint.org/docs/latest/use/configure/configuration-files#how-do-overrides-work>
 
 ## Rules
@@ -72,3 +89,7 @@ The different rules can be defined as follows:
 | [sort-on-properties](docs/rules/sort-on-properties.md) | Enforces order of properties decorators | 🔧 |
 
 <!-- end auto-generated rules list -->
+
+## Releases
+
+See information about breaking changes and release notes [here](https://github.com/heap-code/eslint-plugin-sort-decorators/blob/HEAD/CHANGELOG.md).

jest.config.ts

@@ -2,7 +2,11 @@ import * as path from "path";
 import { JestConfigWithTsJest } from "ts-jest";
 
 export default {
-	collectCoverageFrom: ["<rootDir>/src/**/*.ts", "!<rootDir>/src/**/index.ts"],
+	collectCoverageFrom: [
+		"<rootDir>/src/**/*.ts",
+		"!<rootDir>/src/**/index.ts",
+		"!<rootDir>/src/configs/*.ts"
+	],
 	coverageThreshold: { global: { branches: 75, functions: 75, lines: 75, statements: 75 } },
 	moduleFileExtensions: ["js", "ts"],
 	setupFilesAfterEnv: [path.resolve(__dirname, "./tools/jest/jest-extended.ts")],

src/configs/common.ts

@@ -0,0 +1,31 @@
+import { TSESLint } from "@typescript-eslint/utils";
+import { Linter } from "eslint";
+
+import { SortRuleOptions } from "../lib/sort-rule";
+import {
+	SORT_ON_ACCESSORS_NAME,
+	SORT_ON_CLASSES_NAME,
+	SORT_ON_METHODS_NAME,
+	SORT_ON_PARAMETERS_NAME,
+	SORT_ON_PROPERTIES_NAME
+} from "../rules";
+
+export const PLUGIN_NAME = "sort-decorators";
+
+/**
+ * @param ruleEntry the rule entry to set to all rules
+ * @returns A configuration with all its rules set with the given entry
+ */
+export function createConfiguration(ruleEntry: Linter.RuleEntry<[SortRuleOptions]>) {
+	return {
+		parser: "@typescript-eslint/parser",
+		plugins: [PLUGIN_NAME],
+		rules: {
+			[`${PLUGIN_NAME}/${SORT_ON_ACCESSORS_NAME}`]: ruleEntry,
+			[`${PLUGIN_NAME}/${SORT_ON_CLASSES_NAME}`]: ruleEntry,
+			[`${PLUGIN_NAME}/${SORT_ON_METHODS_NAME}`]: ruleEntry,
+			[`${PLUGIN_NAME}/${SORT_ON_PARAMETERS_NAME}`]: ruleEntry,
+			[`${PLUGIN_NAME}/${SORT_ON_PROPERTIES_NAME}`]: ruleEntry
+		}
+	} as const satisfies TSESLint.Linter.Config;
+}

src/configs/index.ts

@@ -0,0 +1,2 @@
+export { recommended } from "./recommended";
+export { strict } from "./strict";

src/configs/recommended.ts

@@ -0,0 +1,3 @@
+import { createConfiguration } from "./common";
+
+export const recommended = createConfiguration("warn");

src/configs/strict.ts

@@ -0,0 +1,3 @@
+import { createConfiguration } from "./common";
+
+export const strict = createConfiguration(["error", { autoFix: true }]);

src/index.ts

@@ -1,5 +1,6 @@
 import { TSESLint } from "@typescript-eslint/utils";
 
+import * as configs from "./configs";
 import {
 	SORT_ON_ACCESSORS_NAME,
 	SORT_ON_CLASSES_NAME,
@@ -14,6 +15,10 @@ import {
 } from "./rules";
 
 export default {
+	configs: {
+		recommended: configs.recommended,
+		strict: configs.strict
+	},
 	rules: {
 		[SORT_ON_ACCESSORS_NAME]: sortOnAccessors,
 		[SORT_ON_CLASSES_NAME]: sortOnClasses,