lint-rules-alvin 1.0.0

package/.vscode/settings.json

@@ -0,0 +1,9 @@
+{
+	"editor.codeActionsOnSave": {
+		"source.fixAll.eslint": "explicit"
+	},
+	"eslint.codeAction.showDocumentation": {
+		"enable": true
+	},
+	"eslint.enable": true
+}

package/README.md

@@ -0,0 +1,13 @@
+# lint-rules-alvin
+
+[My](https://github.com/Ctrl-Shift-Alvin) personal repo containing configs for code linters. Some of my public repos use this, so it's public. A generalized config makes managaing configs much easier (once they're working, of course).
+
+All dependencies are optional, but you need to install the correct ones depending on which files you use.
+
+`eslint/configs` contains all different configs for each plugin. Sometimes there are multiple configs for the same plugin.
+
+`eslint/custom_rules` contains custom rules that are used by the `eslint/configs/custom.js` file.
+
+`eslint/presets` contains full configs that are mostly sets of configs from `eslint/configs`.
+
+Feel free to fork and customize. In case anybody is insane (or too lazy to change to another config) and actually uses this, please only submit actual issues, not style changes, since... you know... it's my personal repo.

package/eslint/configs/astro.js

@@ -0,0 +1,31 @@
+import eslintPluginAstro from 'eslint-plugin-astro';
+
+/**
+ * The `ESLint` Astro config.
+ *
+ * Extends `eslint-plugin-astro`'s `flat/base` config.
+ */
+export const astro = [
+	...eslintPluginAstro.configs['flat/base'],
+	{
+		name: 'eslint-plugin-astro',
+		rules: {
+			'astro/missing-client-only-directive-value': 'error',
+			'astro/no-conflict-set-directives': 'error',
+			'astro/no-deprecated-astro-canonicalurl': 'error',
+			'astro/no-deprecated-astro-fetchcontent': 'error',
+			'astro/no-deprecated-astro-resolve': 'error',
+			'astro/no-deprecated-getentrybyslug': 'error',
+			'astro/no-exports-from-components': 'error',
+			'astro/no-unused-define-vars-in-style': 'error',
+			'astro/valid-compile': 'error',
+			'astro/no-set-html-directive': 'warn',
+			'astro/no-set-text-directive': 'error',
+			'astro/no-unused-css-selector': 'error',
+			'astro/prefer-class-list-directive': 'error',
+			'astro/prefer-object-class-list': 'error',
+			'astro/prefer-split-class-list': 'off',
+			'astro/sort-attributes': 'off'
+		}
+	}
+];

package/eslint/configs/base.js

@@ -0,0 +1,22 @@
+import path from 'node:path';
+import { includeIgnoreFile } from '@eslint/compat';
+import { globalIgnores } from 'eslint/config';
+
+/**
+ * The `ESLint` base config. Includes base rules, ignore files and directives.
+ */
+export const base = [
+	includeIgnoreFile(path.join(
+		process.cwd(),
+		'.gitignore'
+	)),
+	globalIgnores([
+		'eslint.config.js',
+		'eslint.config.ts'
+	]),
+	{
+		name: 'base',
+		files: [ '**/*.{ts,tsx}' ],
+		rules: { 'no-undef': 'off' }
+	}
+];

package/eslint/configs/custom.js

@@ -0,0 +1,45 @@
+import { newlineBetweenImportsRule } from '../custom_rules/newline-between-imports.js';
+import { unnamedImportsLastRule } from '../custom_rules/unnamed-imports-last.js';
+import { jsxMultilinePropNewlineRule } from '../custom_rules/jsx-multiline-prop-newline.js';
+import { jsxNoSingleObjectCurlyNewlineRule } from '../custom_rules/jsx-no-single-object-curly-newline.js';
+import { maxChainPerLineRule } from '../custom_rules/max-chain-per-line.js';
+import { chainFirstOnNewlineRule } from '../custom_rules/chain-first-on-newline.js';
+import { multilineParenNewlineRule } from '../custom_rules/multiline-paren-newline.js';
+
+export const custom = {
+	plugins: {
+		custom: {
+			rules: {
+				'newline-between-imports': newlineBetweenImportsRule,
+				'unnamed-imports-last': unnamedImportsLastRule,
+				'jsx-multiline-prop-newline': jsxMultilinePropNewlineRule,
+				'jsx-no-single-object-curly-newline': jsxNoSingleObjectCurlyNewlineRule,
+				'max-chain-per-line': maxChainPerLineRule,
+				'chain-first-on-newline': chainFirstOnNewlineRule,
+				'multiline-paren-newline': multilineParenNewlineRule
+			}
+		}
+	},
+	rules: {
+		'custom/newline-between-imports': [
+			'error',
+			{ minItems: 2 }
+		],
+		'custom/unnamed-imports-last': 'error',
+		'custom/jsx-multiline-prop-newline': 'error',
+		'custom/jsx-no-single-object-curly-newline': 'error',
+		'custom/max-chain-per-line': [
+			'error',
+			{ maxChain: 2 }
+		],
+		'custom/chain-first-on-newline': [
+			'error',
+			'require'
+		],
+		'custom/multiline-paren-newline': [
+			'error',
+			{ singleArgument: true }
+		]
+	}
+};
+

package/eslint/configs/importX.js

@@ -0,0 +1,77 @@
+import { importX as eslintPluginImportX } from 'eslint-plugin-import-x';
+
+/**
+ * The `ESLint` import config.
+ */
+export const importX = {
+	name: 'eslint-plugin-import-x',
+	plugins: { 'import-x': eslintPluginImportX },
+	rules: {
+		'import-x/export': 'error',
+		'import-x/no-deprecated': 'error',
+		'import-x/no-empty-named-blocks': 'error',
+		'import-x/no-extraneous-dependencies': [
+			'error',
+			{
+				devDependencies: true,
+				optionalDependencies: true,
+				peerDependencies: true,
+				bundledDependencies: true
+			}
+		],
+		'import-x/no-mutable-exports': 'error',
+		'import-x/no-named-as-default': 'off',
+		'import-x/no-named-as-default-member': 'off',
+		'import-x/no-rename-default': 'off',
+
+		'import-x/no-amd': 'error',
+		'import-x/no-commonjs': 'error',
+		'import-x/no-import-module-exports': 'error',
+		'import-x/no-nodejs-modules': 'off',
+		'import-x/unambiguous': 'error',
+
+		'import-x/default': 'error',
+		'import-x/named': 'error',
+		'import-x/namespace': 'error',
+		'import-x/no-absolute-path': 'error',
+		'import-x/no-cycle': 'off',
+		'import-x/no-dynamic-require': 'error',
+		'import-x/no-internal-modules': 'off',
+		'import-x/no-relative-packages': 'error',
+		'import-x/no-relative-parent-imports': 'off',
+		'import-x/no-restricted-paths': 'off', // Allow the user to override
+		'import-x/no-self-import': 'error',
+		'import-x/no-unresolved': 'error',
+		'import-x/no-useless-path-segments': 'error',
+		'import-x/no-webpack-loader-syntax': 'error',
+
+		'import-x/consistent-type-specifier-style': [
+			'error',
+			'prefer-inline'
+		],
+		'import-x/dynamic-import-chunkname': 'off',
+		'import-x/export-last': 'off',
+		'import-x/extensions': 'off',
+		'import-x/first': 'error',
+		'import-x/group-exports': 'off',
+		'import-x/imports-first': 'off', // Replaced by 'import/first'
+		'import-x/max-dependencies': 'off',
+		'import-x/newline-after-import': [
+			'error',
+			{ considerComments: false }
+		],
+		'import-x/no-anonymous-default-export': 'off', // See next rule
+		'import-x/no-default-export': 'error',
+		'import-x/no-duplicates': 'error',
+		'import-x/no-named-default': 'off', // In favor of 'import/no-default-export'
+		'import-x/no-named-export': 'off',
+		'import-x/no-namespace': 'off',
+		'import-x/no-unassigned-import': [
+			'error',
+			{ allow: [ '**/*.css' ] }
+		],
+		'import-x/order': 'error',
+		'import-x/prefer-default-export': 'off',
+		'import-x/prefer-namespace-import': 'off'
+	}
+};

package/eslint/configs/importXTs.js

@@ -0,0 +1,22 @@
+import { importX as eslintPluginImportX } from 'eslint-plugin-import-x';
+import { importX } from './index.js';
+
+/**
+ * The `ESLint` import config with a TS resolver.
+ *
+ * Extends `eslint-plugin-import-x`'s `typescript` flat config.
+ */
+export const importXTs = {
+	...importX,
+	...eslintPluginImportX.flatConfigs.typescript,
+	settings: {
+		'import-x/resolver': {
+			typescript: true,
+			node: true
+		}
+	},
+	rules: {
+		...importX.rules,
+		'import-x/no-unresolved': 'error'
+	}
+};

package/eslint/configs/index.d.ts

@@ -0,0 +1,12 @@
+import { Linter } from 'eslint';
+
+export declare const astro: Linter.Config[];
+export declare const base: Linter.Config[];
+export declare const custom: Linter.Config;
+export declare const importX: Linter.Config;
+export declare const importXTs: Linter.Config;
+export declare const json: Linter.Config[];
+export declare const markdown: Linter.Config;
+export declare const reactHooks: Linter.Config;
+export declare const stylistic: Linter.Config;
+export declare const typescript: Linter.Config;

package/eslint/configs/index.js

@@ -0,0 +1,10 @@
+export { astro } from './astro.js';
+export { base } from './base.js';
+export { custom } from './custom.js';
+export { importX } from './importX.js';
+export { importXTs } from './importXTs.js';
+export { json } from './json.js';
+export { markdown } from './markdown.js';
+export { reactHooks } from './reactHooks.js';
+export { stylistic } from './stylistic.js';
+export { typescript } from './typescript.js';

package/eslint/configs/json.js

@@ -0,0 +1,22 @@
+import eslintPluginJsonc from 'eslint-plugin-jsonc';
+
+/**
+ * The `ESLint` JSON config. Supports JSON, JSONc an JSON5.
+ */
+export const json = [
+	{ // eslint-plugin-json
+		name: 'eslint-plugin-json',
+		files: [ '**/*.{json}' ],
+		...eslintPluginJsonc.configs['flat/recommended-with-json']
+	},
+	{ // eslint-plugin-jsonc
+		name: 'eslint-plugin-jsonc',
+		files: [ '**/*.{jsonc}' ],
+		...eslintPluginJsonc.configs['flat/recommended-with-jsonc']
+	},
+	{ // eslint-plugin-json5
+		name: 'eslint-plugin-json5',
+		files: [ '**/*.{json5}' ],
+		...eslintPluginJsonc.configs['flat/recommended-with-json5']
+	}
+];

package/eslint/configs/markdown.js

@@ -0,0 +1,10 @@
+import eslintPluginMarkdown from 'eslint-plugin-markdown';
+
+/**
+ * The `ESLint` markdown config.
+ */
+export const markdown = {
+	name: 'eslint-plugin-markdown',
+	files: [ '**/*.{md}' ],
+	...eslintPluginMarkdown.configs.recommended
+};

package/eslint/configs/reactHooks.js

@@ -0,0 +1,8 @@
+import eslintPluginReactHooks from 'eslint-plugin-react-hooks';
+
+export const reactHooks = {
+	name: 'eslint-plugin-react-hooks',
+	files: [ '**/*.{jsx,tsx}' ],
+	plugins: { 'react-hooks': eslintPluginReactHooks },
+	extends: [ 'react-hooks/recommended' ]
+};