@dvukovic/style-guide 0.1.0

package/src/eslint/plugins/typescript-eslint.js

@@ -0,0 +1,183 @@
+/** @type {import("@types/eslint").ESLint.ConfigData} */
+module.exports = {
+    plugins: ["@typescript-eslint"],
+    rules: {
+        "@typescript-eslint/adjacent-overload-signatures": "error",
+        "@typescript-eslint/array-type": "error",
+        "@typescript-eslint/await-thenable": "error",
+        "@typescript-eslint/ban-ts-comment": "error",
+        "@typescript-eslint/ban-tslint-comment": "error",
+        "@typescript-eslint/ban-types": "error",
+        "@typescript-eslint/class-literal-property-style": "error",
+        "@typescript-eslint/consistent-generic-constructors": "error",
+        "@typescript-eslint/consistent-indexed-object-style": "error",
+        "@typescript-eslint/consistent-type-assertions": [
+            "error",
+            {
+                assertionStyle: "as",
+                objectLiteralTypeAssertions: "never",
+            },
+        ],
+        "@typescript-eslint/consistent-type-definitions": ["error", "type"],
+        "@typescript-eslint/consistent-type-exports": "error",
+        "@typescript-eslint/consistent-type-imports": [
+            "error",
+            {
+                fixStyle: "inline-type-imports",
+                prefer: "type-imports",
+            },
+        ],
+        "default-param-last": "off",
+        "@typescript-eslint/default-param-last": "error",
+        "dot-notation": "off",
+        "@typescript-eslint/dot-notation": "error",
+        "@typescript-eslint/explicit-member-accessibility": [
+            "error",
+            {
+                accessibility: "explicit",
+                overrides: {
+                    accessors: "explicit",
+                    constructors: "no-public",
+                    methods: "explicit",
+                    parameterProperties: "explicit",
+                    properties: "explicit",
+                },
+            },
+        ],
+        "max-params": "off",
+        "@typescript-eslint/max-params": ["error", { max: 2 }],
+        "@typescript-eslint/method-signature-style": "error",
+        "no-array-constructor": "off",
+        "@typescript-eslint/no-array-constructor": "error",
+        "@typescript-eslint/no-array-delete": "error",
+        "@typescript-eslint/no-base-to-string": "error",
+        "@typescript-eslint/no-confusing-non-null-assertion": "error",
+        "@typescript-eslint/no-confusing-void-expression": "error",
+        "@typescript-eslint/no-duplicate-enum-values": "error",
+        "@typescript-eslint/no-duplicate-type-constituents": "error",
+        "@typescript-eslint/no-dynamic-delete": "error",
+        "no-empty-function": "off",
+        "@typescript-eslint/no-empty-function": "error",
+        "@typescript-eslint/no-empty-interface": "error",
+        "@typescript-eslint/no-empty-object-type": "error",
+        "@typescript-eslint/no-explicit-any": "error",
+        "@typescript-eslint/no-extra-non-null-assertion": "error",
+        "@typescript-eslint/no-extraneous-class": "error",
+        "@typescript-eslint/no-floating-promises": "error",
+        "@typescript-eslint/no-for-in-array": "error",
+        "no-implied-eval": "off",
+        "@typescript-eslint/no-implied-eval": "error",
+        "@typescript-eslint/no-import-type-side-effects": "error",
+        "@typescript-eslint/no-inferrable-types": "error",
+        "@typescript-eslint/no-invalid-void-type": "error",
+        "no-loop-func": "off",
+        "@typescript-eslint/no-loop-func": "error",
+        "no-loss-of-precision": "off",
+        "@typescript-eslint/no-loss-of-precision": "error",
+        "@typescript-eslint/no-meaningless-void-operator": [
+            "error",
+            {
+                checkNever: true,
+            },
+        ],
+        "@typescript-eslint/no-misused-new": "error",
+        "@typescript-eslint/no-mixed-enums": "error",
+        "@typescript-eslint/no-namespace": "error",
+        "@typescript-eslint/no-non-null-asserted-nullish-coalescing": "error",
+        "@typescript-eslint/no-non-null-asserted-optional-chain": "error",
+        "@typescript-eslint/no-non-null-assertion": "error",
+        "no-redeclare": "off",
+        "@typescript-eslint/no-redeclare": "error",
+        "@typescript-eslint/no-redundant-type-constituents": "error",
+        "no-shadow": "off",
+        "@typescript-eslint/no-shadow": "error",
+        "@typescript-eslint/no-this-alias": "error",
+        "@typescript-eslint/no-unnecessary-boolean-literal-compare": "error",
+        "@typescript-eslint/no-unnecessary-condition": "error",
+        "@typescript-eslint/no-unnecessary-parameter-property-assignment":
+            "error",
+        "@typescript-eslint/no-unnecessary-qualifier": "error",
+        "@typescript-eslint/no-unnecessary-template-expression": "error",
+        "@typescript-eslint/no-unnecessary-type-arguments": "error",
+        "@typescript-eslint/no-unnecessary-type-assertion": "error",
+        "@typescript-eslint/no-unnecessary-type-constraint": "error",
+        "@typescript-eslint/no-unnecessary-type-parameters": "error",
+        "@typescript-eslint/no-unsafe-argument": "error",
+        "@typescript-eslint/no-unsafe-assignment": "error",
+        "@typescript-eslint/no-unsafe-call": "error",
+        "@typescript-eslint/no-unsafe-declaration-merging": "error",
+        "@typescript-eslint/no-unsafe-enum-comparison": "error",
+        "@typescript-eslint/no-unsafe-member-access": "error",
+        "@typescript-eslint/no-unsafe-return": "error",
+        "@typescript-eslint/no-unsafe-unary-minus": "error",
+        "no-unused-expressions": "off",
+        "@typescript-eslint/no-unused-expressions": "error",
+        "no-useless-constructor": "off",
+        "@typescript-eslint/no-useless-constructor": "error",
+        "@typescript-eslint/no-useless-empty-export": "error",
+        "@typescript-eslint/non-nullable-type-assertion-style": "error",
+        "no-throw-literal": "off",
+        "@typescript-eslint/only-throw-error": "error",
+        "@typescript-eslint/prefer-as-const": "error",
+        "@typescript-eslint/prefer-enum-initializers": "error",
+        "@typescript-eslint/prefer-find": "error",
+        "@typescript-eslint/prefer-for-of": "error",
+        "@typescript-eslint/prefer-function-type": "error",
+        "@typescript-eslint/prefer-includes": "error",
+        "@typescript-eslint/prefer-literal-enum-member": "error",
+        "@typescript-eslint/prefer-namespace-keyword": "error",
+        "@typescript-eslint/prefer-nullish-coalescing": "error",
+        "@typescript-eslint/prefer-optional-chain": "error",
+        "prefer-promise-reject-errors": "off",
+        "@typescript-eslint/prefer-promise-reject-errors": "error",
+        "@typescript-eslint/prefer-readonly": "error",
+        "@typescript-eslint/prefer-reduce-type-parameter": "error",
+        "@typescript-eslint/prefer-regexp-exec": "error",
+        "@typescript-eslint/prefer-return-this-type": "error",
+        "@typescript-eslint/prefer-string-starts-ends-with": "error",
+        "@typescript-eslint/promise-function-async": "error",
+        "@typescript-eslint/require-array-sort-compare": "error",
+        "require-await": "off",
+        "@typescript-eslint/require-await": "error",
+        "@typescript-eslint/unified-signatures": "error",
+        "@typescript-eslint/no-misused-promises": "error",
+        "@typescript-eslint/no-unused-vars": [
+            "error",
+            {
+                args: "all",
+                argsIgnorePattern: "^_",
+                caughtErrors: "all",
+                caughtErrorsIgnorePattern: "^_",
+                destructuredArrayIgnorePattern: "^_",
+                varsIgnorePattern: "^_",
+                ignoreRestSiblings: true,
+            },
+        ],
+        "no-use-before-define": "off",
+        "@typescript-eslint/no-use-before-define": "error",
+        "@typescript-eslint/restrict-plus-operands": "error",
+        "@typescript-eslint/restrict-template-expressions": [
+            "error",
+            {
+                allowAny: false,
+                allowBoolean: false,
+                allowNullish: false,
+                allowNumber: false,
+                allowRegExp: false,
+                allowNever: false,
+            },
+        ],
+        "no-return-await": "off",
+        "@typescript-eslint/return-await": "error",
+        "@typescript-eslint/strict-boolean-expressions": "error",
+        "@typescript-eslint/switch-exhaustiveness-check": [
+            "error",
+            {
+                allowDefaultCaseForExhaustiveSwitch: true,
+                requireDefaultForNonUnion: false,
+            },
+        ],
+        "@typescript-eslint/triple-slash-reference": "error",
+        "@typescript-eslint/use-unknown-in-catch-callback-variable": "error",
+    },
+}

package/src/eslint/plugins/unicorn.js

@@ -0,0 +1,155 @@
+/** @type {import("@types/eslint").ESLint.ConfigData} */
+module.exports = {
+    plugins: ["unicorn"],
+    rules: {
+        "unicorn/better-regex": "error",
+        "unicorn/catch-error-name": "error",
+        "unicorn/consistent-destructuring": "error",
+        "unicorn/consistent-empty-array-spread": "error",
+        "unicorn/consistent-function-scoping": "error",
+        "unicorn/custom-error-definition": "error",
+        "unicorn/empty-brace-spaces": "error",
+        "unicorn/error-message": "error",
+        "unicorn/escape-case": "error",
+        "unicorn/explicit-length-check": "error",
+        "unicorn/filename-case": [
+            "error",
+            {
+                cases: {
+                    camelCase: true,
+                    pascalCase: true,
+                    kebabCase: true,
+                },
+            },
+        ],
+        "unicorn/new-for-builtins": "error",
+        "unicorn/no-abusive-eslint-disable": "error",
+        "unicorn/no-anonymous-default-export": "error",
+        "unicorn/no-array-callback-reference": "error",
+        "unicorn/no-array-method-this-argument": "error",
+        "unicorn/no-array-push-push": "error",
+        "unicorn/no-array-reduce": "error",
+        "unicorn/no-await-expression-member": "error",
+        "unicorn/no-await-in-promise-methods": "error",
+        "unicorn/no-console-spaces": "error",
+        "unicorn/no-document-cookie": "error",
+        "unicorn/no-empty-file": "error",
+        "unicorn/no-for-loop": "error",
+        "unicorn/no-instanceof-array": "error",
+        "unicorn/no-invalid-fetch-options": "error",
+        "unicorn/no-invalid-remove-event-listener": "error",
+        // "unicorn/no-length-as-slice-end": "error", NOTE: not released yet
+        "unicorn/no-lonely-if": "error",
+        "unicorn/no-magic-array-flat-depth": "error",
+        "unicorn/no-negation-in-equality-check": "error",
+        "no-nested-ternary": "off",
+        "unicorn/no-nested-ternary": "error",
+        "unicorn/no-new-array": "error",
+        "unicorn/no-new-buffer": "error",
+        "unicorn/no-object-as-default-parameter": "error",
+        "unicorn/no-process-exit": "error",
+        "unicorn/no-single-promise-in-promise-methods": "error",
+        "unicorn/no-static-only-class": "error",
+        "unicorn/no-thenable": "error",
+        "unicorn/no-this-assignment": "error",
+        "unicorn/no-typeof-undefined": "error",
+        "unicorn/no-unnecessary-await": "error",
+        "unicorn/no-unnecessary-polyfills": "error",
+        "unicorn/no-unreadable-array-destructuring": "error",
+        "unicorn/no-unreadable-iife": "error",
+        "unicorn/no-unused-properties": "error",
+        "unicorn/no-useless-fallback-in-spread": "error",
+        "unicorn/no-useless-length-check": "error",
+        "unicorn/no-useless-promise-resolve-reject": "error",
+        "unicorn/no-useless-switch-case": "error",
+        "unicorn/no-useless-undefined": "error",
+        "unicorn/no-zero-fractions": "error",
+        "unicorn/number-literal-case": "error",
+        "unicorn/numeric-separators-style": "error",
+        "unicorn/prefer-array-find": "error",
+        "unicorn/prefer-array-flat": "error",
+        "unicorn/prefer-array-flat-map": "error",
+        "unicorn/prefer-array-index-of": "error",
+        "unicorn/prefer-array-some": "error",
+        "unicorn/prefer-at": "error",
+        "unicorn/prefer-blob-reading-methods": "error",
+        "unicorn/prefer-code-point": "error",
+        "unicorn/prefer-date-now": "error",
+        "unicorn/prefer-default-parameters": "error",
+        "unicorn/prefer-dom-node-append": "error",
+        "unicorn/prefer-dom-node-dataset": "error",
+        "unicorn/prefer-dom-node-remove": "error",
+        "unicorn/prefer-dom-node-text-content": "error",
+        "unicorn/prefer-event-target": "error",
+        "unicorn/prefer-export-from": ["error", { ignoreUsedVariables: true }],
+        "unicorn/prefer-includes": "error",
+        "unicorn/prefer-json-parse-buffer": "error",
+        "unicorn/prefer-keyboard-event-key": "error",
+        "unicorn/prefer-logical-operator-over-ternary": "error",
+        "unicorn/prefer-math-trunc": "error",
+        "unicorn/prefer-modern-dom-apis": "error",
+        "unicorn/prefer-modern-math-apis": "error",
+        "unicorn/prefer-native-coercion-functions": "error",
+        "unicorn/prefer-negative-index": "error",
+        "unicorn/prefer-node-protocol": "error",
+        "unicorn/prefer-number-properties": "error",
+        "unicorn/prefer-object-from-entries": "error",
+        "unicorn/prefer-optional-catch-binding": "error",
+        "unicorn/prefer-prototype-methods": "error",
+        "unicorn/prefer-query-selector": "error",
+        "unicorn/prefer-reflect-apply": "error",
+        "unicorn/prefer-regexp-test": "error",
+        "unicorn/prefer-set-has": "error",
+        "unicorn/prefer-set-size": "error",
+        "unicorn/prefer-spread": "error",
+        "unicorn/prefer-string-raw": "error",
+        "unicorn/prefer-string-replace-all": "error",
+        "unicorn/prefer-string-slice": "error",
+        "unicorn/prefer-string-starts-ends-with": "error",
+        "unicorn/prefer-string-trim-start-end": "error",
+        "unicorn/prefer-structured-clone": "error",
+        "unicorn/prefer-switch": "error",
+        "unicorn/prefer-ternary": "error",
+        "unicorn/prefer-top-level-await": "error",
+        "unicorn/prefer-type-error": "error",
+        "unicorn/relative-url-style": ["error", "always"],
+        "unicorn/require-array-join-separator": "error",
+        "unicorn/require-number-to-fixed-digits-argument": "error",
+        "unicorn/require-post-message-target-origin": "error",
+        "unicorn/switch-case-braces": ["error", "always"],
+        "unicorn/template-indent": [
+            "warn",
+            {
+                indent: 4,
+            },
+        ],
+        "unicorn/text-encoding-identifier-case": "error",
+        "unicorn/throw-new-error": "error",
+        "unicorn/prevent-abbreviations": [
+            "error",
+            {
+                allowList: {
+                    Arg: true,
+                    Args: true,
+                    Param: true,
+                    Params: true,
+                    Prev: true,
+                    Prop: true,
+                    Props: true,
+                    Ref: true,
+                    Refs: true,
+                    arg: true,
+                    args: true,
+                    env: true,
+                    param: true,
+                    params: true,
+                    prev: true,
+                    prop: true,
+                    props: true,
+                    ref: true,
+                    refs: true,
+                },
+            },
+        ],
+    },
+}

package/src/eslint/plugins/unused-imports.js

@@ -0,0 +1,7 @@
+/** @type {import("@types/eslint").ESLint.ConfigData} */
+module.exports = {
+    plugins: ["unused-imports"],
+    rules: {
+        "unused-imports/no-unused-imports": "error",
+    },
+}

package/src/prettier/configs/core.js

@@ -0,0 +1,19 @@
+const { prettierPluginEmbed } = require("../plugins/embed.js")
+const { prettierPluginSql } = require("../plugins/sql.js")
+const { prettierPlugin } = require("../plugins/prettier.js")
+
+/** @type {import("prettier").Config} */
+module.exports = {
+    plugins: [
+        "@prettier/plugin-xml",
+        "prettier-plugin-prisma",
+        "prettier-plugin-sql",
+        "prettier-plugin-embed",
+        "prettier-plugin-jsdoc",
+        "prettier-plugin-packagejson",
+        "prettier-plugin-sh",
+    ],
+    ...prettierPlugin,
+    ...prettierPluginSql,
+    ...prettierPluginEmbed,
+}

package/src/prettier/plugins/embed.js

@@ -0,0 +1,8 @@
+/** @type {import("prettier-plugin-embed").PrettierPluginEmbedOptions} */
+const prettierPluginEmbed = {
+    embeddedSqlTags: ["sql"],
+}
+
+module.exports = {
+    prettierPluginEmbed,
+}

package/src/prettier/plugins/prettier.js

@@ -0,0 +1,23 @@
+/** @type {import("prettier").Config} */
+const prettierPlugin = {
+    printWidth: 80,
+    tabWidth: 4,
+    useTabs: false,
+    semi: false,
+    singleQuote: false,
+    quoteProps: "as-needed",
+    jsxSingleQuote: false,
+    trailingComma: "all",
+    bracketSpacing: true,
+    bracketSameLine: false,
+    arrowParens: "always",
+    proseWrap: "always",
+    htmlWhitespaceSensitivity: "css",
+    endOfLine: "lf",
+    singleAttributePerLine: true,
+    embeddedLanguageFormatting: "auto",
+}
+
+module.exports = {
+    prettierPlugin,
+}

package/src/prettier/plugins/sql.js

@@ -0,0 +1,9 @@
+/** @type {import("prettier-plugin-sql").SqlBaseOptions} */
+const prettierPluginSql = {
+    language: "postgresql",
+    keywordCase: "upper",
+}
+
+module.exports = {
+    prettierPluginSql,
+}

package/src/stylelint/configs/core.js

@@ -0,0 +1,16 @@
+const { stylelint } = require("../plugins/stylelint")
+const { stylelintOrder } = require("../plugins/order")
+
+/** @type {import("stylelint").Config} */
+module.exports = {
+    defaultSeverity: "error",
+    reportDescriptionlessDisables: true,
+    reportInvalidScopeDisables: true,
+    reportNeedlessDisables: true,
+    allowEmptyInput: true,
+    plugins: ["stylelint-order"],
+    rules: {
+        ...stylelint.rules,
+        ...stylelintOrder.rules,
+    },
+}

package/src/stylelint/plugins/order.js

@@ -0,0 +1,19 @@
+/** @type {import("stylelint").Config} */
+const stylelintOrder = {
+    rules: {
+        "order/order": [
+            "custom-properties",
+            "dollar-variables",
+            "at-variables",
+            "declarations",
+            "rules",
+            "at-rules",
+            "less-mixins",
+        ],
+        "order/properties-alphabetical-order": true,
+    },
+}
+
+module.exports = {
+    stylelintOrder,
+}

package/src/stylelint/plugins/stylelint.js

@@ -0,0 +1,93 @@
+/** @type {import("stylelint").Config} */
+const stylelint = {
+    rules: {
+        "no-descending-specificity": true,
+        "declaration-block-no-duplicate-properties": true,
+        "font-family-no-duplicate-names": true,
+        "keyframe-block-no-duplicate-selectors": true,
+        "no-duplicate-at-import-rules": true,
+        "no-duplicate-selectors": true,
+        "block-no-empty": true,
+        "comment-no-empty": true,
+        "no-empty-source": true,
+        "color-no-invalid-hex": true,
+        "function-calc-no-unspaced-operator": true,
+        "keyframe-declaration-no-important": true,
+        "media-query-no-invalid": true,
+        "named-grid-areas-no-invalid": true,
+        "no-invalid-double-slash-comments": true,
+        "no-invalid-position-at-import-rule": true,
+        "string-no-newline": true,
+        "no-irregular-whitespace": true,
+        "custom-property-no-missing-var-function": true,
+        "font-family-no-missing-generic-family-keyword": true,
+        "function-linear-gradient-no-nonstandard-direction": true,
+        "declaration-block-no-shorthand-property-overrides": true,
+        "selector-anb-no-unmatchable": true,
+        "annotation-no-unknown": true,
+        "at-rule-no-unknown": true,
+        "declaration-property-value-no-unknown": true,
+        "function-no-unknown": true,
+        "media-feature-name-no-unknown": true,
+        "media-feature-name-value-no-unknown": true,
+        "no-unknown-animations": true,
+        "no-unknown-custom-media": true,
+        "no-unknown-custom-properties": true,
+        "property-no-unknown": true,
+        "selector-pseudo-class-no-unknown": true,
+        "selector-pseudo-element-no-unknown": true,
+        "selector-type-no-unknown": true,
+        "unit-no-unknown": true,
+        "at-rule-no-vendor-prefix": true,
+        "color-hex-alpha": "never",
+        "color-named": "never",
+        "declaration-no-important": true,
+        "function-url-no-scheme-relative": true,
+        "length-zero-no-unit": true,
+        "media-feature-name-no-vendor-prefix": true,
+        "property-no-vendor-prefix": true,
+        "selector-no-vendor-prefix": true,
+        "unit-allowed-list": ["px", "rem", "%"],
+        "value-no-vendor-prefix": true,
+        "function-name-case": "lower",
+        "selector-type-case": "lower",
+        "value-keyword-case": "lower",
+        "at-rule-empty-line-before": [
+            "always",
+            { ignore: ["first-nested", "after-comment"] },
+        ],
+        "comment-empty-line-before": ["always", { except: ["first-nested"] }],
+        "custom-property-empty-line-before": "never",
+        "rule-empty-line-before": [
+            "always",
+            {
+                except: ["after-single-line-comment"],
+                ignore: ["first-nested", "after-comment"],
+            },
+        ],
+        "number-max-precision": 3,
+        "alpha-value-notation": "percentage",
+        "color-function-notation": "modern",
+        "color-hex-length": "long",
+        "font-weight-notation": "numeric",
+        "hue-degree-notation": "angle",
+        "import-notation": "string",
+        "keyframe-selector-notation": "percentage",
+        "lightness-notation": "percentage",
+        "media-feature-range-notation": "prefix",
+        "selector-not-notation": "complex",
+        "selector-pseudo-element-colon-notation": "single",
+        "font-family-name-quotes": "always-where-required",
+        "function-url-quotes": "always",
+        "selector-attribute-quotes": "always",
+        "shorthand-property-no-redundant-values": true,
+        "declaration-block-no-redundant-longhand-properties": [
+            true,
+            { ignoreShorthands: "grid-template" },
+        ],
+    },
+}
+
+module.exports = {
+    stylelint,
+}

package/tsconfig.json

@@ -0,0 +1,13 @@
+{
+    "compilerOptions": {
+        "jsx": "react",
+        "target": "es2016",
+        "module": "commonjs",
+        "esModuleInterop": true,
+        "noUncheckedIndexedAccess": true,
+        "forceConsistentCasingInFileNames": true,
+        "strict": true,
+        "skipLibCheck": true
+    },
+    "include": ["src/**/*", "*.js", ".*.js"]
+}