@dvukovic/style-guide 0.1.0

package/.eslintrc.js

@@ -0,0 +1,26 @@
+/** @type {import("@types/eslint").ESLint.ConfigData} */
+module.exports = {
+    root: true,
+    parser: "@typescript-eslint/parser",
+    ignorePatterns: ["node_modules"],
+    extends: [
+        "./src/eslint/configs/core.js",
+        "./src/eslint/configs/node.js",
+        "./src/eslint/configs/mobx.js",
+        "./src/eslint/configs/react.js",
+        "./src/eslint/configs/next.js",
+    ],
+    parserOptions: {
+        project: "./tsconfig.json",
+    },
+    overrides: [
+        {
+            files: ["*.ts", ".js"],
+            extends: ["./src/eslint/configs/react-typescript.js"],
+        },
+        {
+            files: ["*.test.ts", "*.test.js"],
+            extends: ["./src/eslint/configs/jest.js"],
+        },
+    ],
+}

package/.github/workflows/defalt.yml

@@ -0,0 +1,49 @@
+name: Default
+
+on:
+    push:
+        branches:
+            - master
+    pull_request:
+    workflow_dispatch:
+
+jobs:
+    lint:
+        name: Lint
+        runs-on: ubuntu-latest
+        steps:
+            - name: Enable Corepack
+              run: corepack enable
+            - uses: actions/checkout@v4
+            - uses: actions/setup-node@v4
+              with:
+                  registry-url: "https://registry.npmjs.org"
+                  node-version: 20.x
+                  cache: yarn
+            - run: yarn
+            - run: yarn lint
+
+    release:
+        name: Release
+        needs: [lint]
+        if: github.ref == 'refs/heads/master'
+        runs-on: ubuntu-latest
+        steps:
+            - name: Enable Corepack
+              run: corepack enable
+            - uses: actions/checkout@v4
+            - uses: actions/setup-node@v4
+              with:
+                  registry-url: "https://registry.npmjs.org"
+                  node-version: 20.x
+                  cache: yarn
+            - name: git config
+              run: |
+                  git config user.name "${GITHUB_ACTOR}"
+                  git config user.email "${GITHUB_ACTOR}@users.noreply.github.com"
+            - run: yarn
+            - run: yarn release --ci
+              env:
+                  NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+                  NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+                  GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

package/.prettierignore

@@ -0,0 +1 @@
+CHANGELOG.md

package/.prettierrc.js

@@ -0,0 +1,4 @@
+/** @type {import("prettier").Config} */
+module.exports = {
+    ...require("./src/prettier/configs/core"),
+}

package/.release-it.json

@@ -0,0 +1,15 @@
+{
+    "$schema": "https://unpkg.com/release-it/schema/release-it.json",
+    "github": {
+        "release": true
+    },
+    "plugins": {
+        "@release-it/conventional-changelog": {
+            "infile": "CHANGELOG.md",
+            "header": "# Changelog",
+            "preset": {
+                "name": "conventionalcommits"
+            }
+        }
+    }
+}

package/.stylelintrc.js

@@ -0,0 +1,4 @@
+/** @type {import("stylelint").Config} */
+module.exports = {
+    extends: ["./src/stylelint/configs/core.js"],
+}

package/.yarnrc.yml

@@ -0,0 +1 @@
+nodeLinker: node-modules

package/CHANGELOG.md

@@ -0,0 +1,8 @@
+# Changelog
+
+## 0.1.0 (2024-07-26)
+
+
+### Features
+
+* add release it changelog plugin ([2fcb601](https://github.com/vuki656/style-guide/commit/2fcb601483fb4365b7e9a4fd96fa33eaa9679b0f))

package/README.md

@@ -0,0 +1,5 @@
+# Style Guide
+
+## Prettier
+
+Add `"lint:prettier": "prettier --log-level=warn --check .",` to scripts

package/cspell.config.js

@@ -0,0 +1,17 @@
+/** @type {import("cspell").FileSettings} */
+module.exports = {
+    useGitignore: true,
+    cache: {
+        useCache: true,
+        cacheLocation: "./node_modules/.cache/cspell",
+    },
+    dictionaryDefinitions: [
+        {
+            name: "shared",
+            path: "./src/cspell/base.txt",
+        },
+    ],
+    caseSensitive: false,
+    ignorePaths: ["./src/cspell/base.txt"],
+    dictionaries: ["shared"],
+}

package/package.json

@@ -0,0 +1,67 @@
+{
+    "name": "@dvukovic/style-guide",
+    "scripts": {
+        "lint": "yarn lint:prettier && yarn lint:eslint && yarn lint:stylelint && yarn lint:spell",
+        "lint:eslint": "eslint . --ext .js,.ts,.tsx",
+        "lint:fix": "yarn lint:prettier --write && yarn lint:stylelint --fix && yarn lint:eslint --fix",
+        "lint:prettier": "prettier --log-level=warn --check .",
+        "lint:spell": "cspell --no-progress --no-summary --unique '**'",
+        "lint:stylelint": "stylelint ./**/*.css",
+        "release": "release-it"
+    },
+    "dependencies": {
+        "@eslint-community/eslint-plugin-eslint-comments": "^4.3.0",
+        "@next/eslint-plugin-next": "^14.2.5",
+        "@prettier/plugin-xml": "^3.4.1",
+        "@typescript-eslint/parser": "^7.17.0",
+        "eslint-plugin-etc": "^2.0.3",
+        "eslint-plugin-import-x": "^3.1.0",
+        "eslint-plugin-jest": "^28.6.0",
+        "eslint-plugin-jest-formatting": "^3.1.0",
+        "eslint-plugin-mobx": "^0.0.10",
+        "eslint-plugin-n": "^17.9.0",
+        "eslint-plugin-promise": "^7.0.0",
+        "eslint-plugin-react": "^7.35.0",
+        "eslint-plugin-react-hooks": "^4.6.2",
+        "eslint-plugin-security-node": "^1.1.4",
+        "eslint-plugin-sonarjs": "^1.0.4",
+        "eslint-plugin-unicorn": "^54.0.0",
+        "eslint-plugin-unused-imports": "^4.0.1",
+        "prettier-plugin-embed": "^0.4.15",
+        "prettier-plugin-jsdoc": "^1.3.0",
+        "prettier-plugin-packagejson": "^2.5.1",
+        "prettier-plugin-prisma": "^5.0.0",
+        "prettier-plugin-sh": "^0.14.0",
+        "prettier-plugin-sql": "^0.18.1",
+        "stylelint-order": "^6.0.4",
+        "typescript-eslint": "^7.17.0"
+    },
+    "devDependencies": {
+        "@release-it/conventional-changelog": "^8.0.1",
+        "@total-typescript/tsconfig": "^1.0.4",
+        "@types/eslint": "^8.56.11",
+        "@types/jest": "^29.5.12",
+        "@types/node": "^20.14.12",
+        "@types/react": "^18.3.3",
+        "cspell": "^8.12.1",
+        "eslint": "^8.57.0",
+        "jest": "^29.7.0",
+        "prettier": "^3.3.3",
+        "react": "^18.3.1",
+        "release-it": "^17.6.0",
+        "stylelint": "^16.7.0",
+        "typescript": "^5.5.4"
+    },
+    "peerDependencies": {
+        "cspell": "8",
+        "eslint": "8.57",
+        "prettier": "3",
+        "stylelint": "16"
+    },
+    "packageManager": "yarn@4.3.1",
+    "publishConfig": {
+        "access": "public",
+        "registry": "https://registry.npmjs.org"
+    },
+    "version": "0.1.0"
+}

package/src/__tests__/Dockerfile

@@ -0,0 +1,8 @@
+# Base Stage
+FROM node:20.12.0-alpine AS base
+
+RUN yarn workspaces focus --production --all
+
+ENV WORKSPACE=${WORKSPACE}
+
+CMD yarn workspace $WORKSPACE start

package/src/__tests__/component.tsx

@@ -0,0 +1,14 @@
+import React from "react"
+
+export const Test = () => {
+    const foo = {
+        bar: 1,
+    }
+
+    return (
+        <>
+            <div>{foo.bar === 3 ? foo.bar : null}</div>
+            <div />
+        </>
+    )
+}

package/src/__tests__/db.sql

@@ -0,0 +1,4 @@
+SELECT
+    *
+FROM
+    "table"

package/src/__tests__/schema.prisma

@@ -0,0 +1,14 @@
+generator client {
+    provider = "prisma-client-js"
+}
+
+datasource db {
+    provider = "postgresql"
+    url      = ""
+}
+
+model Site {
+    id      String @id @default(dbgenerated("gen_random_uuid()")) @db.Uuid
+    name    String
+    address String
+}

package/src/__tests__/script.js

@@ -0,0 +1,6 @@
+const value = Date.now() - 30
+let some = Date.now()
+
+if (value === some) {
+    some = "test"
+}

package/src/__tests__/script.sh

@@ -0,0 +1,3 @@
+#!/bin/sh
+
+echo "Hello world"

package/src/__tests__/script.test.js

@@ -0,0 +1,13 @@
+describe("This", () => {
+    it("should test that", () => {
+        expect(1).toBe(3)
+    })
+
+    it("should test", () => {
+        expect(1).toBe(1)
+    })
+
+    it("should test another", () => {
+        expect(1).toBe(2)
+    })
+})

package/src/__tests__/structure.xml

@@ -0,0 +1,7 @@
+<note>
+<script />
+<to>Tove</to>
+<from>Jani</from>
+<heading>Reminder</heading>
+<body>Don't forget me this weekend!</body>
+</note>

package/src/__tests__/style.css

@@ -0,0 +1,74 @@
+:root {
+    --orange-1: #ffa500;
+    --yellow-1: #f9b916;
+    --black: #000000;
+    --gray-1: #c6c6c6;
+    --gray-2: #515151;
+    --gray-3: #e5e5e5;
+    --gray-4: #f2f4f4;
+    --gray-5: #767676;
+    --green-1: #2aa83f;
+    --blue-1: #307cff;
+    --pink-1: #f6eeff;
+    --purple-1: #be16f9;
+    --purple-2: #7e30f5;
+    --purple-3: #312665;
+    --purple-4: #f6eeff;
+    --red-1: #fc3e1c;
+    --white: #ffffff;
+    --shadow-1: 0 4px 4px 0 rgb(0 0 0 / 8%);
+}
+
+.container {
+    display: flex;
+    flex-direction: column;
+    padding: 25px;
+    row-gap: 23px;
+    width: 100%;
+}
+
+.title {
+    font-size: 1.25rem;
+    font-weight: 500;
+}
+
+.infoContainer {
+    font-weight: 400;
+}
+
+.infoLink {
+    color: var(--gray-2);
+    text-decoration: underline;
+}
+
+.header {
+    align-items: center;
+    display: flex;
+    justify-content: space-between;
+}
+
+.headerLeftSection {
+    align-items: center;
+    column-gap: 20px;
+    display: flex;
+    justify-content: flex-start;
+}
+
+.map {
+    height: 550px;
+    width: 100%;
+}
+
+.mapContainer {
+    background-color: var(--white);
+    padding: 13px;
+}
+
+.itemsContainer {
+    background-color: var(--white);
+    min-height: 200px;
+}
+
+a {
+    color: #ffffff;
+}

package/src/__tests__/typed.ts

@@ -0,0 +1,5 @@
+export const file = {
+    greet: (): string => {
+        return "hi"
+    },
+}

package/src/cspell/base.txt

@@ -0,0 +1,73 @@
+rimac
+highcharts
+tabler
+bbox
+typecheck
+dataseries
+corepack
+toastify
+eslintconfigpath
+tweens
+hookz
+prepending
+popperjs
+tweenjs
+autorun
+keycloak
+eslintcache
+nextjs
+mqtt
+hookform
+mkcert
+uplot
+preconnect
+dedupe
+autostream
+pinst
+titillium
+nvmrc
+releaserc
+yarnrc
+packagerc
+loglevel
+stylelint
+stylelintcache
+stylelintrc
+quantico
+dockerignore
+commitlint
+typesafe
+pininfarina
+supercluster
+rimac
+automobili
+comlink
+mapbox
+cooldown
+battista
+webp
+lcov
+testlog
+rgba
+classname
+dvukovic
+sonarjs
+datasource
+dbgenerated
+unspaced
+packagejson
+tove
+jani
+nonconstructor
+nonoctal
+polyfillio
+multilines
+textnodes
+setstate
+exrpress
+nosql
+multiplestatements
+httpsrequest
+missconfiguration
+mischeck
+descriptionless

package/src/eslint/configs/core.js

@@ -0,0 +1,14 @@
+/** @type {import("@types/eslint").ESLint.ConfigData} */
+module.exports = {
+    extends: [
+        "../plugins/eslint.js",
+        "../plugins/typescript-eslint.js",
+        "../plugins/eslint-comments.js",
+        "../plugins/promise.js",
+        "../plugins/unicorn.js",
+        "../plugins/unused-imports.js",
+        "../plugins/import-x.js",
+        "../plugins/sonarjs.js",
+        "../plugins/etc.js",
+    ],
+}

package/src/eslint/configs/jest.js

@@ -0,0 +1,4 @@
+/** @type {import("@types/eslint").ESLint.ConfigData} */
+module.exports = {
+    extends: ["../plugins/jest.js", "../plugins/jest-formatting.js"],
+}

package/src/eslint/configs/mobx.js

@@ -0,0 +1,4 @@
+/** @type {import("@types/eslint").ESLint.ConfigData} */
+module.exports = {
+    extends: ["../plugins/mobx.js"],
+}

package/src/eslint/configs/next.js

@@ -0,0 +1,4 @@
+/** @type {import("@types/eslint").ESLint.ConfigData} */
+module.exports = {
+    extends: ["../plugins/next.js"],
+}

package/src/eslint/configs/node.js

@@ -0,0 +1,4 @@
+/** @type {import("@types/eslint").ESLint.ConfigData} */
+module.exports = {
+    extends: ["../plugins/n.js", "../plugins/security-node.js"],
+}

package/src/eslint/configs/react-typescript.js

@@ -0,0 +1,6 @@
+/** @type {import("@types/eslint").ESLint.ConfigData} */
+module.exports = {
+    rules: {
+        "@typescript-eslint/explicit-module-boundary-types": "error",
+    },
+}

package/src/eslint/configs/react.js

@@ -0,0 +1,4 @@
+/** @type {import("@types/eslint").ESLint.ConfigData} */
+module.exports = {
+    extends: ["../plugins/react.js", "../plugins/react-hooks.js"],
+}

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

@@ -0,0 +1,19 @@
+/** @type {import("@types/eslint").ESLint.ConfigData} */
+module.exports = {
+    plugins: ["@eslint-community/eslint-comments"],
+    rules: {
+        "@eslint-community/eslint-comments/disable-enable-pair": [
+            "error",
+            { allowWholeFile: true },
+        ],
+        "@eslint-community/eslint-comments/no-aggregating-enable": "error",
+        "@eslint-community/eslint-comments/no-duplicate-disable": "error",
+        "@eslint-community/eslint-comments/no-unlimited-disable": "error",
+        "@eslint-community/eslint-comments/no-unused-disable": "error",
+        "@eslint-community/eslint-comments/no-unused-enable": "error",
+        "@eslint-community/eslint-comments/require-description": [
+            "error",
+            { ignore: [] },
+        ],
+    },
+}