lint-config-sq11y 0.0.0

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+import tslint from "typescript-eslint";
+declare const _default: tslint.FlatConfig.Config | tslint.FlatConfig.Config[];
+export default _default;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAeA,OAAO,MAAM,MAAM,mBAAmB,CAAC;;AAsFvC,wBAEkD"}

package/dist/index.js

@@ -0,0 +1,77 @@
+import { globalIgnores } from "eslint/config";
+import { defineConfigWithVueTs, vueTsConfigs } from "@vue/eslint-config-typescript";
+import { jsdoc } from "eslint-plugin-jsdoc";
+import pluginVue from "eslint-plugin-vue";
+import pluginOxlint from "eslint-plugin-oxlint";
+import pluginStylistic from "@stylistic/eslint-plugin";
+import pluginVueA11y from "eslint-plugin-vuejs-accessibility";
+import skipFormatting from "eslint-config-prettier/flat";
+import jslint from "@eslint/js";
+import tslint from "typescript-eslint";
+import requireComment from "./require-comment.js";
+import isVueProject from "./is-vue-project.js";
+const vueConfig = [
+    ...pluginVue.configs["flat/recommended"],
+    ...pluginVueA11y.configs["flat/recommended"],
+    vueTsConfigs.recommendedTypeChecked,
+    {
+        name: "sq11y/vue",
+        files: ["**/*.vue"],
+        plugins: {
+            sq11y: {
+                /* eslint-disable-next-line @typescript-eslint/no-unsafe-assignment */
+                rules: requireComment,
+            },
+        },
+        rules: {
+            "vue/multi-word-component-names": "off",
+            "vue/attributes-order": "error",
+            "vue/require-explicit-slots": "error",
+            "vue/define-emits-declaration": ["error", "type-based"],
+            "vue/require-prop-comment": "error",
+            "vue/block-order": ["error", { order: [["template", "script[setup]", "style"]] }],
+            "sq11y/require-emit-comment": "error",
+            "sq11y/require-slot-comment": "error",
+        },
+    },
+];
+const config = (isVueProject) => [
+    globalIgnores(["**/dist/**", "**/node_modules/**", ".git"]),
+    pluginStylistic.configs.recommended,
+    jslint.configs.recommended,
+    jsdoc({ config: "flat/recommended" }),
+    ...tslint.configs.recommendedTypeChecked,
+    ...pluginOxlint.buildFromOxlintConfigFile(".oxlintrc.json"),
+    ...(isVueProject ? vueConfig : []),
+    skipFormatting,
+    {
+        languageOptions: {
+            parserOptions: {
+                projectService: {
+                    allowDefaultProject: ["eslint.config.js", "stylelint.config.mjs"],
+                },
+            },
+        },
+    },
+    {
+        name: "sq11y/shared",
+        files: ["**/*.{vue,ts}"],
+        plugins: {
+            "@stylistic": pluginStylistic,
+        },
+        rules: {
+            "default-case": "error",
+            "default-case-last": "error",
+            "max-lines-per-function": ["error", { max: 80, skipComments: true }],
+            "prefer-destructuring": "error",
+            "no-dupe-class-members": "error",
+            "no-duplicate-case": "error",
+            "@typescript-eslint/consistent-type-imports": ["error"],
+            "@typescript-eslint/no-unused-vars": ["error", { argsIgnorePattern: "^_" }],
+            "@stylistic/spaced-comment": "error",
+        },
+    },
+];
+export default isVueProject
+    ? defineConfigWithVueTs(...config(true))
+    : config(false);

package/dist/is-vue-project.d.ts

@@ -0,0 +1,3 @@
+declare const _default: boolean;
+export default _default;
+//# sourceMappingURL=is-vue-project.d.ts.map

package/dist/is-vue-project.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-vue-project.d.ts","sourceRoot":"","sources":["../src/is-vue-project.ts"],"names":[],"mappings":";AA+BA,wBAAoC"}

package/dist/is-vue-project.js

@@ -0,0 +1,21 @@
+import fs from "node:fs";
+import path from "node:path";
+const hasPackageJSON = (root) => {
+    return fs.existsSync(path.resolve(root, "package.json"));
+};
+const searchForPackageRoot = (current, root = current) => {
+    if (hasPackageJSON(current)) {
+        return path.resolve(root, "package.json");
+    }
+    const dir = path.dirname(current);
+    if (!dir || dir === current) {
+        return path.resolve(root, "package.json");
+    }
+    return searchForPackageRoot(dir, root);
+};
+const hasDependency = (name) => {
+    const pkgPath = searchForPackageRoot(process.cwd());
+    const pkg = JSON.parse(fs.readFileSync(pkgPath, "utf-8"));
+    return !!pkg.dependencies?.[name] || !!pkg.devDependencies?.[name];
+};
+export default hasDependency("vue");

package/dist/require-comment.d.ts

@@ -0,0 +1,3 @@
+declare const _default: any;
+export default _default;
+//# sourceMappingURL=require-comment.d.ts.map

package/dist/require-comment.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"require-comment.d.ts","sourceRoot":"","sources":["../src/require-comment.ts"],"names":[],"mappings":"wBAuFK,GAAG;AAJR,wBAIS"}

package/dist/require-comment.js

@@ -0,0 +1,61 @@
+import { TSESTree } from "@typescript-eslint/utils";
+import { getPropertySignatureName, findTypeDefinition } from "./utils.js";
+const requireCommentRule = (signature, prop) => ({
+    name: `require-${prop}-comment`,
+    meta: {
+        type: "suggestion",
+        schema: [],
+        docs: {
+            description: `Enforce comments for each ${prop}.`,
+        },
+        messages: {
+            default: `The ${prop} "{{ name }}" should have a JSDoc comment`,
+        },
+    },
+    create(context) {
+        const { sourceCode } = context;
+        const checkForComments = (node) => {
+            const comments = sourceCode.getCommentsBefore(node);
+            if (comments.length === 0) {
+                context.report({
+                    node: node.key,
+                    messageId: "default",
+                    data: {
+                        name: getPropertySignatureName(sourceCode, node),
+                    },
+                });
+            }
+        };
+        const PropertySignature = `CallExpression[callee.name="${signature}"] > TSTypeParameterInstantiation > TSTypeLiteral > TSPropertySignature`;
+        const TypeReference = `CallExpression[callee.name="${signature}"] > TSTypeParameterInstantiation > TSTypeReference`;
+        return {
+            [PropertySignature](node) {
+                checkForComments(node);
+            },
+            [TypeReference](node) {
+                const typeDefinition = findTypeDefinition(sourceCode, node);
+                if (!typeDefinition) {
+                    return;
+                }
+                let typeElements = [];
+                if (typeDefinition.type === TSESTree.AST_NODE_TYPES.TSInterfaceDeclaration) {
+                    typeElements = typeDefinition.body.body;
+                }
+                else if (typeDefinition.type === TSESTree.AST_NODE_TYPES.TSTypeAliasDeclaration &&
+                    typeDefinition.typeAnnotation.type === TSESTree.AST_NODE_TYPES.TSTypeLiteral) {
+                    typeElements = typeDefinition.typeAnnotation.members;
+                }
+                typeElements.forEach((typeElement) => {
+                    if (typeElement.type === TSESTree.AST_NODE_TYPES.TSPropertySignature) {
+                        checkForComments(typeElement);
+                    }
+                });
+            },
+        };
+    },
+});
+export default {
+    "require-emit-comment": requireCommentRule("defineEmits", "emit"),
+    "require-slot-comment": requireCommentRule("defineSlots", "slot"),
+    /* eslint-disable-next-line @typescript-eslint/no-explicit-any */
+};

package/dist/utils.d.ts

@@ -0,0 +1,5 @@
+import { TSESTree } from "@typescript-eslint/utils";
+import type { TSESLint } from "@typescript-eslint/utils";
+export declare const findTypeDefinition: (sourceCode: TSESLint.SourceCode, node: TSESTree.TSTypeReference) => TSESTree.TSTypeReference | TSESTree.TSPropertySignatureComputedName | TSESTree.TSPropertySignatureNonComputedName | TSESTree.BlockStatement | TSESTree.CatchClause | TSESTree.ArrayExpression | TSESTree.ArrayPattern | TSESTree.ArrowFunctionExpressionWithBlockBody | TSESTree.ArrowFunctionExpressionWithExpressionBody | TSESTree.AssignmentExpression | TSESTree.AwaitExpression | TSESTree.PrivateInExpression | TSESTree.SymmetricBinaryExpression | TSESTree.CallExpression | TSESTree.ChainExpression | TSESTree.ClassExpression | TSESTree.ConditionalExpression | TSESTree.FunctionExpression | TSESTree.Identifier | TSESTree.ImportExpression | TSESTree.JSXElement | TSESTree.JSXFragment | TSESTree.BigIntLiteral | TSESTree.BooleanLiteral | TSESTree.NullLiteral | TSESTree.NumberLiteral | TSESTree.RegExpLiteral | TSESTree.StringLiteral | TSESTree.TemplateLiteral | TSESTree.LogicalExpression | TSESTree.MemberExpressionComputedName | TSESTree.MemberExpressionNonComputedName | TSESTree.MetaProperty | TSESTree.NewExpression | TSESTree.ObjectExpression | TSESTree.ObjectPattern | TSESTree.SequenceExpression | TSESTree.Super | TSESTree.TaggedTemplateExpression | TSESTree.ThisExpression | TSESTree.TSAsExpression | TSESTree.TSInstantiationExpression | TSESTree.TSNonNullExpression | TSESTree.TSSatisfiesExpression | TSESTree.TSTypeAssertion | TSESTree.UnaryExpressionBitwiseNot | TSESTree.UnaryExpressionDelete | TSESTree.UnaryExpressionMinus | TSESTree.UnaryExpressionNot | TSESTree.UnaryExpressionPlus | TSESTree.UnaryExpressionTypeof | TSESTree.UnaryExpressionVoid | TSESTree.UpdateExpression | TSESTree.YieldNoStarExpression | TSESTree.YieldStarExpression | TSESTree.ClassBody | TSESTree.ClassDeclarationWithOptionalName | TSESTree.StaticBlock | TSESTree.TSConditionalType | TSESTree.ForInStatement | TSESTree.ForOfStatement | TSESTree.ForStatement | TSESTree.BreakStatement | TSESTree.ContinueStatement | TSESTree.DebuggerStatement | TSESTree.DoWhileStatement | TSESTree.EmptyStatement | TSESTree.ExportAllDeclaration | TSESTree.ExportDefaultDeclaration | TSESTree.ExportNamedDeclarationWithoutSourceWithMultiple | TSESTree.ExportNamedDeclarationWithoutSourceWithSingle | TSESTree.ExportNamedDeclarationWithSource | TSESTree.ExpressionStatement | TSESTree.FunctionDeclarationWithName | TSESTree.IfStatement | TSESTree.ImportDeclaration | TSESTree.LabeledStatement | TSESTree.ReturnStatement | TSESTree.SwitchStatement | TSESTree.ThrowStatement | TSESTree.TryStatement | TSESTree.TSDeclareFunctionNoDeclare | TSESTree.TSDeclareFunctionWithDeclare | TSESTree.TSEnumDeclaration | TSESTree.TSExportAssignment | TSESTree.TSImportEqualsNamespaceDeclaration | TSESTree.TSImportEqualsRequireDeclaration | TSESTree.TSInterfaceDeclaration | TSESTree.TSModuleDeclarationGlobal | TSESTree.TSModuleDeclarationModuleWithIdentifierId | TSESTree.TSModuleDeclarationModuleWithStringIdDeclared | TSESTree.TSModuleDeclarationModuleWithStringIdNotDeclared | TSESTree.TSModuleDeclarationNamespace | TSESTree.TSNamespaceExportDeclaration | TSESTree.TSTypeAliasDeclaration | TSESTree.ConstDeclaration | TSESTree.LetOrVarDeclaredDeclaration | TSESTree.LetOrVarNonDeclaredDeclaration | TSESTree.UsingInForOfDeclaration | TSESTree.UsingInNormalContextDeclaration | TSESTree.WhileStatement | TSESTree.WithStatement | TSESTree.FunctionDeclarationWithOptionalName | TSESTree.TSEmptyBodyFunctionExpression | TSESTree.TSCallSignatureDeclaration | TSESTree.TSConstructorType | TSESTree.TSConstructSignatureDeclaration | TSESTree.TSFunctionType | TSESTree.TSMethodSignatureComputedName | TSESTree.TSMethodSignatureNonComputedName | TSESTree.TSInterfaceBody | TSESTree.TSTypeLiteral | TSESTree.AccessorPropertyComputedName | TSESTree.AccessorPropertyNonComputedName | TSESTree.AssignmentPattern | TSESTree.Decorator | TSESTree.ExportSpecifierWithStringOrLiteralLocal | TSESTree.ImportAttribute | TSESTree.ImportDefaultSpecifier | TSESTree.ImportNamespaceSpecifier | TSESTree.ImportSpecifier | TSESTree.JSXAttribute | TSESTree.JSXClosingElement | TSESTree.JSXClosingFragment | TSESTree.JSXEmptyExpression | TSESTree.JSXExpressionContainer | TSESTree.JSXIdentifier | TSESTree.JSXMemberExpression | TSESTree.JSXNamespacedName | TSESTree.JSXOpeningElement | TSESTree.JSXOpeningFragment | TSESTree.JSXSpreadAttribute | TSESTree.JSXSpreadChild | TSESTree.JSXText | TSESTree.MethodDefinitionComputedName | TSESTree.MethodDefinitionNonComputedName | TSESTree.PrivateIdentifier | TSESTree.PropertyComputedName | TSESTree.PropertyNonComputedName | TSESTree.PropertyDefinitionComputedName | TSESTree.PropertyDefinitionNonComputedName | TSESTree.RestElement | TSESTree.SpreadElement | TSESTree.SwitchCase | TSESTree.TemplateElement | TSESTree.TSAbstractAccessorPropertyComputedName | TSESTree.TSAbstractAccessorPropertyNonComputedName | TSESTree.TSAbstractKeyword | TSESTree.TSAbstractMethodDefinitionComputedName | TSESTree.TSAbstractMethodDefinitionNonComputedName | TSESTree.TSAbstractPropertyDefinitionComputedName | TSESTree.TSAbstractPropertyDefinitionNonComputedName | TSESTree.TSAnyKeyword | TSESTree.TSArrayType | TSESTree.TSAsyncKeyword | TSESTree.TSBigIntKeyword | TSESTree.TSBooleanKeyword | TSESTree.TSClassImplements | TSESTree.TSDeclareKeyword | TSESTree.TSEnumBody | TSESTree.TSEnumMember | TSESTree.TSExportKeyword | TSESTree.TSExternalModuleReference | TSESTree.TSImportType | TSESTree.TSIndexedAccessType | TSESTree.TSIndexSignature | TSESTree.TSInferType | TSESTree.TSInterfaceHeritage | TSESTree.TSIntersectionType | TSESTree.TSIntrinsicKeyword | TSESTree.TSLiteralType | TSESTree.TSMappedType | TSESTree.TSModuleBlock | TSESTree.TSNamedTupleMember | TSESTree.TSNeverKeyword | TSESTree.TSNullKeyword | TSESTree.TSNumberKeyword | TSESTree.TSObjectKeyword | TSESTree.TSOptionalType | TSESTree.TSParameterProperty | TSESTree.TSPrivateKeyword | TSESTree.TSProtectedKeyword | TSESTree.TSPublicKeyword | TSESTree.TSQualifiedName | TSESTree.TSReadonlyKeyword | TSESTree.TSRestType | TSESTree.TSStaticKeyword | TSESTree.TSStringKeyword | TSESTree.TSSymbolKeyword | TSESTree.TSTemplateLiteralType | TSESTree.TSThisType | TSESTree.TSTupleType | TSESTree.TSTypeAnnotation | TSESTree.TSTypeOperator | TSESTree.TSTypeParameter | TSESTree.TSTypeParameterDeclaration | TSESTree.TSTypeParameterInstantiation | TSESTree.TSTypePredicateNoAsserts | TSESTree.TSTypePredicateWithAsserts | TSESTree.TSTypeQuery | TSESTree.TSUndefinedKeyword | TSESTree.TSUnionType | TSESTree.TSUnknownKeyword | TSESTree.TSVoidKeyword | TSESTree.VariableDeclaratorDefiniteAssignment | TSESTree.VariableDeclaratorMaybeInit | undefined;
+export declare const getPropertySignatureName: (sourceCode: TSESLint.SourceCode, node: TSESTree.TSPropertySignature) => string;
+//# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAEpD,OAAO,KAAK,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAEzD,eAAO,MAAM,kBAAkB,GAC7B,YAAY,QAAQ,CAAC,UAAU,EAC/B,MAAM,QAAQ,CAAC,eAAe,06MAiB/B,CAAC;AAEF,eAAO,MAAM,wBAAwB,GACnC,YAAY,QAAQ,CAAC,UAAU,EAC/B,MAAM,QAAQ,CAAC,mBAAmB,WAYnC,CAAC"}

package/dist/utils.js

@@ -0,0 +1,24 @@
+import { TSESTree } from "@typescript-eslint/utils";
+export const findTypeDefinition = (sourceCode, node) => {
+    if (node.typeName.type !== TSESTree.AST_NODE_TYPES.Identifier) {
+        return;
+    }
+    let currentScope = sourceCode.getScope(node);
+    while (currentScope) {
+        const variable = currentScope.set.get(node.typeName.name);
+        if (variable && variable.defs && variable.defs.length > 0) {
+            return variable.defs[0]?.node;
+        }
+        currentScope = currentScope.upper;
+    }
+};
+export const getPropertySignatureName = (sourceCode, node) => {
+    switch (node.key.type) {
+        case TSESTree.AST_NODE_TYPES.Identifier:
+            return node.key.name;
+        case TSESTree.AST_NODE_TYPES.Literal:
+            return String(node.key.value);
+        default:
+            return sourceCode.getText(node.key);
+    }
+};

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "lint-config-sq11y",
+  "version": "0.0.0",
+  "homepage": "https://sq11y.github.io/lint-config/",
+  "repository": {
+    "type": "git",
+    "url": "github:sq11y/lint-config"
+  },
+  "files": [
+    "dist",
+    "stylelint.config.mjs"
+  ],
+  "type": "module",
+  "exports": {
+    "./eslint": "./dist/index.js",
+    "./stylelint": "./stylelint.config.mjs"
+  },
+  "devDependencies": {
+    "@eslint/js": "^10.0.1",
+    "@stylistic/eslint-plugin": "^5.10.0",
+    "@types/node": "^26.0.1",
+    "@typescript-eslint/utils": "^8.62.0",
+    "@vue/eslint-config-typescript": "^14.8.0",
+    "eslint-config-prettier": "^10.1.8",
+    "eslint-plugin-jsdoc": "^63.0.10",
+    "eslint-plugin-oxlint": "~1.69.0",
+    "eslint-plugin-vue": "~10.9.2",
+    "eslint-plugin-vuejs-accessibility": "^2.5.0",
+    "jiti": "^2.7.0",
+    "stylelint-config-recommended-vue": "^1.6.1",
+    "stylelint-config-standard": "^40.0.0",
+    "typescript": "^6.0.3",
+    "typescript-eslint": "^8.62.0"
+  },
+  "peerDependencies": {
+    "eslint": "^10.5.0",
+    "oxfmt": "^0.56.0",
+    "oxlint": "^1.71.0",
+    "stylelint": "^17.13.0"
+  },
+  "engines": {
+    "node": ">=24.18.0"
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.node.json"
+  }
+}

package/stylelint.config.mjs

@@ -0,0 +1,15 @@
+/** @type {import('stylelint').Config} */
+
+export default {
+  extends: ["stylelint-config-standard", "stylelint-config-recommended-vue"],
+
+  rules: {
+    "property-layout-mappings": "flow-relative",
+    "value-keyword-layout-mappings": "flow-relative",
+    "display-notation": "short",
+    "font-weight-notation": "numeric",
+    "declaration-no-important": true,
+    "max-nesting-depth": [2, { ignore: ["pseudo-classes", "blockless-at-rules"] }],
+    "selector-max-compound-selectors": 2,
+  },
+};