@shayanthenerd/eslint-config 0.4.5 → 0.4.6

package/dist/utils/options/defaultOptions.js

@@ -0,0 +1,168 @@
+//#region src/utils/options/defaultOptions.ts
+const defaultOptions = {
+	autoDetectDeps: true,
+	gitignore: ".gitignore",
+	env: "node",
+	packageDir: ".",
+	tsConfig: false,
+	global: {
+		basePath: ".",
+		ignores: [],
+		linterOptions: {
+			noInlineConfig: false,
+			reportUnusedInlineConfigs: "warn",
+			reportUnusedDisableDirectives: "warn"
+		},
+		globals: {
+			node: true,
+			commonjs: false,
+			browser: true,
+			worker: true,
+			serviceworker: false,
+			webextension: false,
+			custom: {}
+		},
+		settings: {},
+		rules: {}
+	},
+	configs: {
+		oxlint: "./.oxlintrc.json",
+		base: {
+			maxDepth: 3,
+			maxNestedCallbacks: 3,
+			preferNamedExports: true,
+			functionStyle: "declaration",
+			overrides: {}
+		},
+		stylistic: {
+			semi: "always",
+			trailingComma: "always-multiline",
+			memberDelimiterStyle: "comma",
+			quotes: "single",
+			jsxQuotes: "prefer-double",
+			arrowParens: "always",
+			useTabs: true,
+			indent: 2,
+			maxConsecutiveEmptyLines: 1,
+			maxLineLength: 120,
+			maxAttributesPerLine: 3,
+			selfCloseVoidHTMLElements: "always",
+			overrides: {}
+		},
+		html: {
+			useBaseline: false,
+			idNamingConvention: "snake_case",
+			overrides: {}
+		},
+		css: {
+			useBaseline: false,
+			allowedRelativeFontUnits: ["rem", "em"],
+			overrides: {}
+		},
+		tailwind: {
+			multilineSort: true,
+			ignoredUnregisteredClasses: [],
+			config: "",
+			entryPoint: "",
+			overrides: {}
+		},
+		typescript: {
+			allowedDefaultProjects: [],
+			methodSignatureStyle: "method",
+			typeDefinitionStyle: "interface",
+			overrides: {}
+		},
+		importX: {
+			removeUnusedImports: true,
+			requireFileExtension: true,
+			overrides: {}
+		},
+		perfectionist: {
+			sortType: "line-length",
+			overrides: {}
+		},
+		vue: {
+			accessibility: {
+				imageComponents: ["NuxtImg"],
+				anchorComponents: [
+					"RouterLink",
+					"NuxtLink",
+					"ULink"
+				],
+				accessibleChildComponents: [
+					"img",
+					"picture",
+					"NuxtImg",
+					"NuxtPicture"
+				]
+			},
+			blocksOrder: [
+				"script:not([setup])",
+				"script[setup]",
+				"template",
+				"i18n[locale=en]",
+				"i18n:not([locale=en])",
+				"style:not([scoped])",
+				"style[scoped]",
+				"docs"
+			],
+			macrosOrder: [
+				"definePage",
+				"defineOptions",
+				"defineModel",
+				"defineProps",
+				"defineEmits",
+				"defineSlots",
+				"defineCustom",
+				"defineExpose"
+			],
+			attributesOrder: [
+				"DEFINITION",
+				"CONDITIONALS",
+				"RENDER_MODIFIERS",
+				"LIST_RENDERING",
+				"UNIQUE",
+				"GLOBAL",
+				"TWO_WAY_BINDING",
+				"SLOT",
+				"CONTENT",
+				"OTHER_DIRECTIVES",
+				"EVENTS",
+				"ATTR_SHORTHAND_BOOL",
+				"ATTR_DYNAMIC",
+				"ATTR_STATIC"
+			],
+			attributeHyphenation: "never",
+			preferVBindSameNameShorthand: "always",
+			preferVBindTrueShorthand: "always",
+			allowedStyleAttributes: ["scoped", "module"],
+			blockLang: {
+				script: "js",
+				style: "implicit"
+			},
+			destructureProps: "always",
+			componentNameCaseInTemplate: "PascalCase",
+			vForDelimiterStyle: "in",
+			vOnHandlerStyle: ["method", "inline-function"],
+			restrictedElements: [],
+			restrictedStaticAttributes: [],
+			ignoredUndefinedComponents: [],
+			overrides: {}
+		},
+		nuxt: {
+			image: false,
+			ui: { prefix: "U" }
+		},
+		test: {
+			storybook: { overrides: {} },
+			vitest: { overrides: {} },
+			playwright: { overrides: {} },
+			cypress: { overrides: {} },
+			testFunction: "test",
+			maxNestedDescribe: 1
+		}
+	}
+};
+
+//#endregion
+export { defaultOptions };

package/dist/utils/options/enableDetectedConfigs.js

@@ -0,0 +1,40 @@
+import { defaultOptions } from "./defaultOptions.js";
+import { isPackageDetected, logDetectedPackages } from "../isPackageDetected.js";
+
+//#region src/utils/options/enableDetectedConfigs.ts
+function enableDetectedConfigs(options) {
+	options.configs ??= {};
+	options.configs.test ??= {};
+	options.configs.html ??= false;
+	options.configs.css ??= false;
+	options.configs.tailwind ??= false;
+	options.configs.importX ??= true;
+	options.configs.stylistic ??= true;
+	options.configs.perfectionist ??= true;
+	options.configs.vue ??= isPackageDetected("vue", options);
+	options.configs.nuxt ??= isPackageDetected("nuxt", options);
+	options.configs.typescript ??= isPackageDetected("typescript", options);
+	options.configs.test.vitest ??= isPackageDetected("vitest", options);
+	options.configs.test.cypress ??= isPackageDetected("cypress", options);
+	options.configs.test.storybook ??= isPackageDetected("storybook", options);
+	options.configs.test.playwright ??= isPackageDetected("@playwright/test", options);
+	options.configs.oxlint ??= isPackageDetected("oxlint", options) ? defaultOptions.configs.oxlint : false;
+	options.tsConfig ??= options.configs.typescript ? {
+		rootDir: ".",
+		filename: "tsconfig.json"
+	} : false;
+	if (options.configs.typescript && options.configs.vue) {
+		options.configs.vue = options.configs.vue === true ? {} : options.configs.vue;
+		options.configs.vue.blockLang = { script: "ts" };
+	}
+	if (options.configs.nuxt) {
+		if (options.configs.nuxt === true) options.configs.nuxt = {};
+		options.configs.nuxt.ui ??= isPackageDetected("@nuxt/ui", options);
+		options.configs.nuxt.image ??= isPackageDetected("@nuxt/image", options);
+	}
+	if (options.autoDetectDeps === "verbose") logDetectedPackages();
+	return options;
+}
+
+//#endregion
+export { enableDetectedConfigs };

package/dist/utils/options/mergeWithDefaults.js

@@ -0,0 +1,21 @@
+import { defaultOptions } from "./defaultOptions.js";
+import { isEmptyString } from "../isEmptyString.js";
+import { enableDetectedConfigs } from "./enableDetectedConfigs.js";
+import { createDefu } from "defu";
+
+//#region src/utils/options/mergeWithDefaults.ts
+const mergeOptions = createDefu((object, key, value) => {
+	const isValueTrue = value === true;
+	const isDefaultValueFalse = object[key] === false;
+	const isValueEmptyString = isEmptyString(value);
+	const fallBackToDefault = isValueEmptyString || isValueTrue && !isDefaultValueFalse;
+	return fallBackToDefault;
+});
+function mergeWithDefaults(options) {
+	const optionsWithDetectedConfigs = enableDetectedConfigs(options);
+	const mergedOptions = mergeOptions(optionsWithDetectedConfigs, defaultOptions);
+	return mergedOptions;
+}
+
+//#endregion
+export { mergeWithDefaults };

package/dist/utils/vue/getRestrictedVueElements.js

@@ -0,0 +1,27 @@
+//#region src/utils/vue/getRestrictedVueElements.ts
+const alternativeComponents = {
+	kbd: "Kbd",
+	form: "Form",
+	input: "Input",
+	table: "Table",
+	dialog: "Modal",
+	hr: "Separator",
+	button: "Button",
+	select: "Select",
+	progress: "Progress",
+	textarea: "Textarea",
+	details: "Accordion",
+	datalist: "InputMenu"
+};
+const alternativeComponentPairs = Object.entries(alternativeComponents);
+function getRestrictedVueElements(prefix) {
+	const restrictedElements = [];
+	for (const [element, component] of alternativeComponentPairs) restrictedElements.push({
+		element,
+		message: `Use <${prefix}${component}>.`
+	});
+	return restrictedElements;
+}
+
+//#endregion
+export { getRestrictedVueElements };

package/dist/utils/vue/getRestrictedVueInputs.js

@@ -0,0 +1,23 @@
+//#region src/utils/vue/getRestrictedVueInputs.ts
+const alternativeComponents = {
+	range: "Slider",
+	date: "Calendar",
+	radio: "RadioGroup",
+	checkbox: "Checkbox",
+	color: "ColorPicker",
+	number: "InputNumber"
+};
+const alternativeComponentPairs = Object.entries(alternativeComponents);
+function getRestrictedVueInputs(prefix) {
+	const restrictedInputs = [];
+	for (const [input, component] of alternativeComponentPairs) restrictedInputs.push({
+		element: "input",
+		key: "type",
+		value: input,
+		message: `Use <${prefix}${component}>.`
+	});
+	return restrictedInputs;
+}
+
+//#endregion
+export { getRestrictedVueInputs };

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@shayanthenerd/eslint-config",
-	"version": "0.4.5",
+	"version": "0.4.6",
 	"license": "MIT",
 	"description": "A modern, flexible ESLint configuration for enforcing best practices and maintaining a consistent coding style",
 	"keywords": [
@@ -55,6 +55,7 @@
 	"packageManager": "bun@1.2.19",
 	"scripts": {
 		"prepare": "bun set:gitmessage && bunx simple-git-hooks && bun generate:types",
+		"prepublishOnly": "bun build:package",
 		"set:gitmessage": "git config --local commit.template \".gitmessage\"",
 		"inspect": "bunx @eslint/config-inspector",
 		"build:package": "tsdown --no-report",