@schoero/configs 0.0.0-beta.0

package/README.md

@@ -0,0 +1,149 @@
+# Shared configuration files
+
+This repository contains shared configuration files used to configure my personal development environment and projects.
+
+- eslint
+- cspell
+- markdownlint
+- vite
+- tsconfig
+- unwritten
+- changelogen
+
+### Installation
+
+```sh
+npm i --save-dev @schoero/configs
+```
+
+### VSCode
+
+```jsonc
+// .vscode/settings.json
+{
+
+  // eslint
+  "[javascript]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[json]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[json5]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[jsonc]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "[typescript]": {
+    "editor.defaultFormatter": "dbaeumer.vscode-eslint"
+  },
+  "eslint.validate": ["javascript", "typescript", "json", "jsonc", "json5", "yaml"],
+
+  // markdown
+  "[markdown]": {
+    "editor.defaultFormatter": "DavidAnson.vscode-markdownlint",
+    "editor.rulers": [
+      40,
+      80,
+      119
+    ],
+    "editor.wordWrapColumn": 119
+  },
+
+  // prettier
+  "prettier.enable": false,
+
+  // vscode
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "explicit",
+    "source.fixAll.markdownlint": "explicit",
+    "source.organizeImports": "never"
+  },
+  "editor.formatOnSave": false,
+  "editor.rulers": [
+    119
+  ],
+  "search.exclude": {
+    "lib": true
+  },
+
+  // file nesting
+  "explorer.fileNesting.enabled": true,
+  "explorer.fileNesting.expand": false,
+  "explorer.fileNesting.patterns": {
+    "*.js": "$(capture).test.js,$(capture).cjs,$(capture).mjs,$(capture).d.ts,$(capture).d.ts.map,$(capture).js.map",
+    "*.ts": "$(capture).test.ts,$(capture).test.snap,$(capture).test-d.ts"
+  },
+
+  "typescript.preferences.autoImportFileExcludePatterns": [
+    "@types/node/test.d.ts"
+  ],
+
+  // es module import
+  "typescript.preferences.importModuleSpecifier": "non-relative",
+  "typescript.preferences.importModuleSpecifierEnding": "minimal",
+  "typescript.preferences.useAliasesForRenames": true,
+
+  // typescript
+  "typescript.tsdk": "node_modules/typescript/lib"
+}
+```
+
+```jsonc
+// .vscode/extensions.json
+{
+  "recommendations": [
+    "dbaeumer.vscode-eslint",
+    "DavidAnson.vscode-markdownlint",
+    "streetsidesoftware.code-spell-checker"
+  ]
+}
+```
+
+
+### Scripts
+
+```jsonc
+// package.json
+{
+  "scripts": {
+    // vite
+    "build": "vite build",
+    "prebuild": "npm run typecheck && npm run lint && npm run spellcheck",
+    "typecheck": "tsc --noEmit",
+
+    // eslint
+    "eslint": "eslint --ext .ts,.tsx,.js,.jsx,.json,.jsonc,.yml,.md .",
+    "eslint:ci": "npm run eslint -- --max-warnings 0",
+    "eslint:fix": "npm run eslint -- --fix",
+    "lint": "npm run eslint && npm run markdownlint",
+    "lint:ci": "npm run eslint:ci && npm run markdownlint:ci",
+    "lint:fix": "npm run eslint:fix && npm run markdownlint:fix",
+
+    // markdownlint
+    "markdownlint": "markdownlint-cli2 '**/*.md' '#node_modules'",
+    "markdownlint:ci": "npm run markdownlint",
+    "markdownlint:fix": "npm run markdownlint -- --fix",
+
+    // changelogen
+    "postrelease:alpha": "npm run postrelease",
+    "postrelease:beta": "npm run postrelease",
+    "postrelease:latest": "eslint --fix package.json &&  markdownlint-cli2-fix 'CHANGELOG.md'",
+    "prerelease:alpha": "npm run test -- --run && npm run build",
+    "prerelease:beta": "npm run test -- --run && npm run build",
+    "prerelease:latest": "npm run test -- --run && npm run build",
+    "publish:alpha": "npm run publish:latest -- --publishTag alpha",
+    "publish:beta": "npm run publish:latest -- --publishTag beta",
+    "publish:latest": "changelogen gh release && changelogen --publish",
+    "release:alpha": "npm run release -- --prerelease alpha",
+    "release:beta": "npm run release -- --prerelease beta",
+    "release:latest": "changelogen --bump --output --no-tag",
+
+    // cspell
+    "spellcheck": "cspell .",
+    "spellcheck:ci": "npm run spellcheck -- --no-progress",
+    "test": "vitest -c ./vite.config.ts"
+  }
+}
+```

package/changelogen/changelog.js

@@ -0,0 +1,27 @@
+/** @type { import('changelogen').ChangelogConfig } */
+export default {
+  excludeAuthors: [
+    "Roger Schönbächler",
+  ],
+  output: "CHANGELOG.md",
+  scopeMap: {},
+  templates: {
+    commitMessage: "chore(release): v{{newVersion}}",
+    tagBody: "v{{newVersion}}",
+    tagMessage: "v{{newVersion}}",
+  },
+  types: {
+    build: { semver: "patch", title: "Build" },
+    chore: { title: "Chore" },
+    ci: { title: "CI" },
+    docs: { semver: "patch", title: "Documentation" },
+    examples: { title: "Examples" },
+    feat: { semver: "minor", title: "Features" },
+    fix: { semver: "patch", title: "Fixes" },
+    perf: { semver: "patch", title: "Performance" },
+    refactor: { semver: "patch", title: "Refactors" },
+    style: { title: "Styles" },
+    test: { title: "Tests" },
+    types: { semver: "patch", title: "Types" },
+  },
+};

package/cspell/cspell.json

@@ -0,0 +1,338 @@
+{
+    "dictionaries": [
+        "css.txt",
+        "html.txt",
+        "names.txt",
+        "npm.txt",
+        "svg.txt",
+        "vscode.txt",
+        "networking-terms",
+        "lorem-ipsum"
+    ],
+    "dictionaryDefinitions": [
+        {
+            "addWords": false,
+            "name": "custom",
+            "path": "./dist/css.txt"
+        },
+        {
+            "addWords": false,
+            "name": "custom",
+            "path": "./dist/html.txt"
+        },
+        {
+            "addWords": false,
+            "name": "custom",
+            "path": "./dist/names.txt"
+        },
+        {
+            "addWords": false,
+            "name": "custom",
+            "path": "./dist/npm.txt"
+        },
+        {
+            "addWords": false,
+            "name": "custom",
+            "path": "./dist/svg.txt"
+        },
+        {
+            "addWords": false,
+            "name": "custom",
+            "path": "./dist/vscode.txt"
+        }
+    ],
+    "files": [
+        "**/{*,.*}/**/*"
+    ],
+    "ignorePaths": [
+        "**/node_modules/**",
+        "**/vscode-extension/**",
+        "**/.git/**",
+        "**/.vscode/**",
+        "**/lib/**",
+        "**/__snapshots__/**",
+        "**/*.snap",
+        "package-lock.json",
+        "yarn.lock",
+        "pnpm-lock.yaml"
+    ],
+    "ignoreRegExpList": [
+        "SpellCheckerDisable",
+        "SpellCheckerIgnoreInDocSetting",
+        "Urls",
+        "Email",
+        "RsaCert",
+        "SshRsa",
+        "Base64MultiLine",
+        "Base64SingleLine",
+        "CommitHash",
+        "CommitHashLink",
+        "CStyleHexValue",
+        "CSSHexValue",
+        "SHA",
+        "HashStrings",
+        "UnicodeRef",
+        "UUID",
+        "\\[.*\\]\\(.*#(.*)\\)",
+        "@[a-zA-Z0-9-]+"
+    ],
+    "import": [
+        "@cspell/dict-en_us/cspell-ext.json",
+        "@cspell/dict-de-ch/cspell-ext.json",
+        "@cspell/dict-typescript/cspell-ext.json",
+        "@cspell/dict-html/cspell-ext.json",
+        "@cspell/dict-html-symbol-entities/cspell-ext.json",
+        "@cspell/dict-bash/cspell-ext.json",
+        "@cspell/dict-npm/cspell-ext.json",
+        "@cspell/dict-node/cspell-ext.json",
+        "@cspell/dict-lorem-ipsum/cspell-ext.json",
+        "@cspell/dict-css/cspell-ext.json",
+        "@cspell/dict-markdown/cspell-ext.json",
+        "@cspell/dict-software-terms/cspell-ext.json",
+        "@cspell/dict-public-licenses/cspell-ext.json",
+        "@cspell/dict-fullstack/cspell-ext.json",
+        "@cspell/dict-companies/cspell-ext.json",
+        "@cspell/dict-fr-fr/cspell-ext.json",
+        "@cspell/dict-it-it/cspell-ext.json"
+    ],
+    "language": "en, de",
+    "loadDefaultConfiguration": false,
+    "maxNumberOfProblems": 10000,
+    "numSuggestions": 10,
+    "overrides": [
+        {
+            "caseSensitive": false,
+            "filename": [
+                "**/locales/**/*.json"
+            ],
+            "language": "en, de, fr, it"
+        }
+    ],
+    "patterns": [
+        {
+            "name": "CommitHash",
+            "pattern": "/\\b(?![a-f]+\\b)(?:0x)?[0-9a-f]{7,}\\b/gi"
+        },
+        {
+            "name": "CommitHashLink",
+            "pattern": "/\\[[0-9a-f]{7,}\\]/gi"
+        },
+        {
+            "name": "CStyleHexValue",
+            "pattern": "/\\b0x[0-9a-f]+\\b/gi"
+        },
+        {
+            "name": "CSSHexValue",
+            "pattern": "/#[0-9a-f]{3,8}\\b/gi"
+        },
+        {
+            "name": "Urls",
+            "pattern": "/(?:https?|ftp):\\/\\/[^\\s\"]+/gi"
+        },
+        {
+            "name": "HexValues",
+            "pattern": "/(?:#[0-9a-f]{3,8})|(?:0x[0-9a-f]+)|(?:\\\\u[0-9a-f]{4})|(?:\\\\x\\{[0-9a-f]{4}\\})/gi"
+        },
+        {
+            "name": "SpellCheckerDisable",
+            "pattern": [
+                "/(\\bc?spell(?:-?checker)?::?)\\s*disable(?!-line|-next)\\b(?!-)[\\s\\S]*?((?:\\1\\s*enable\\b)|$)/gi",
+                "/^.*\\bc?spell(?:-?checker)?::?\\s*disable-line\\b.*/gim",
+                "/\\bc?spell(?:-?checker)?::?\\s*disable-next\\b.*\\s\\s?.*/gi"
+            ]
+        },
+        {
+            "name": "PublicKey",
+            "pattern": "/-{5}BEGIN\\s+((?:RSA\\s+)?PUBLIC\\s+KEY)[\\w=+\\-/=\\\\\\s]+?END\\s+\\1-{5}/g"
+        },
+        {
+            "name": "RsaCert",
+            "pattern": "/-{5}BEGIN\\s+(CERTIFICATE|(?:RSA\\s+)?(?:PRIVATE|PUBLIC)\\s+KEY)[\\w=+\\-/=\\\\\\s]+?END\\s+\\1-{5}/g"
+        },
+        {
+            "name": "SshRsa",
+            "pattern": "/ssh-rsa\\s+[a-z0-9/+]{28,}={0,3}(?![a-z0-9/+=])/gi"
+        },
+        {
+            "name": "EscapeCharacters",
+            "pattern": "/\\\\(?:[anrvtbf]|[xu][a-f0-9]+)/gi"
+        },
+        {
+            "name": "Base64",
+            "pattern": "/(?<![A-Za-z0-9/+])(?:[A-Za-z0-9/+]{40,})(?:\\s^\\s*[A-Za-z0-9/+]{40,})*(?:\\s^\\s*[A-Za-z0-9/+]+=*)?(?![A-Za-z0-9/+=])/gm"
+        },
+        {
+            "name": "Base64SingleLine",
+            "pattern": "/(?<![A-Za-z0-9/+])(?=[^/]|[/][A-Za-z0-9/+]+?[=+])(?![A-Za-z/]+(?![A-Za-z0-9/+=]))(?=[A-Za-z0-9/+=]*?(?:[A-Z]{2}|[0-9]{2}))(?:[A-Za-z0-9/+]{4}){10,}(?:[A-Za-z0-9/+]{3}={1}|[A-Za-z0-9/+]{2}={2}|[A-Za-z0-9/+]{1}={3})?(?![A-Za-z0-9/+=])(?=$|[:.,\"'\\\\)])/gm"
+        },
+        {
+            "name": "Base64MultiLine",
+            "pattern": "/(?<![A-Za-z0-9/+])[\"']?(?:[A-Za-z0-9/+]{40,})[\"']?(?:\\s^\\s*[\"']?[A-Za-z0-9/+]{40,}[\"']?)+(?:\\s^\\s*[\"']?[A-Za-z0-9/+]+={0,3}[\"']?)?(?![A-Za-z0-9/+=])/gm"
+        },
+        {
+            "name": "Email",
+            "pattern": "/<?\\b[\\w.\\-+]{1,128}@\\w{1,63}(\\.\\w{1,63}){1,4}\\b>?/gi"
+        },
+        {
+            "name": "SHA",
+            "pattern": "/\\bsha\\d+-[a-z0-9+/]{25,}={0,3}/gi"
+        },
+        {
+            "name": "HashStrings",
+            "pattern": "/(?:\\b(?:sha\\d+|md5|base64|crypt|bcrypt|scrypt|security-token|assertion)[-,:$=]|#code[/])[-\\w/+%.]{25,}={0,3}(?:(['\"])\\s*\\+?\\s*\\1?[-\\w/+%.]+={0,3})*(?![-\\w/+=%.])/gi"
+        },
+        {
+            "name": "UnicodeRef",
+            "pattern": "/\\bU\\+[0-9a-f]{4,5}(?:-[0-9a-f]{4,5})?/gi"
+        },
+        {
+            "name": "UUID",
+            "pattern": "/\\b[0-9a-fx]{8}-[0-9a-fx]{4}-[0-9a-fx]{4}-[0-9a-fx]{4}-[0-9a-fx]{12}\\b/gi"
+        },
+        {
+            "name": "href",
+            "pattern": "/\\bhref\\s*=\\s*\".*?\"/gi"
+        },
+        {
+            "name": "SpellCheckerDisableBlock",
+            "pattern": "/(\\bc?spell(?:-?checker)?::?)\\s*disable(?!-line|-next)\\b(?!-)[\\s\\S]*?((?:\\1\\s*enable\\b)|$)/gi"
+        },
+        {
+            "name": "SpellCheckerDisableLine",
+            "pattern": "/^.*\\bc?spell(?:-?checker)?::?\\s*disable-line\\b.*/gim"
+        },
+        {
+            "name": "SpellCheckerDisableNext",
+            "pattern": "/\\bc?spell(?:-?checker)?::?\\s*disable-next\\b.*\\s\\s?.*/gi"
+        },
+        {
+            "name": "SpellCheckerIgnoreInDocSetting",
+            "pattern": "/\\bc?spell(?:-?checker)?::?\\s*ignoreRegExp.*/gim"
+        },
+        {
+            "name": "PhpHereDoc",
+            "pattern": "/<<<['\"]?(\\w+)['\"]?[\\s\\S]+?^\\1;/gm"
+        },
+        {
+            "name": "string",
+            "pattern": "/(?:(['\"]).*?(?<![^\\\\]\\\\(\\\\\\\\)*)\\1)|(?:`[\\s\\S]*?(?<![^\\\\]\\\\(\\\\\\\\)*)`)/g"
+        },
+        {
+            "name": "CStyleComment",
+            "pattern": "/(?<!\\w:)(?:\\/\\/.*)|(?:\\/\\*[\\s\\S]*?\\*\\/)/g"
+        },
+        {
+            "name": "Everything",
+            "pattern": ".*"
+        },
+        {
+            "name": "HTML-id",
+            "pattern": "/\\bid=\"[^\"]*\"/gi"
+        },
+        {
+            "name": "HTML-src",
+            "pattern": "/\\bsrc=\"[^\"]*\"/gi"
+        },
+        {
+            "name": "HTML-class",
+            "pattern": "/\\bclass=\"[^\"]*\"/gi"
+        },
+        {
+            "name": "HTML-IDREF-aria-activedescendant",
+            "pattern": "/\\baria-activedescendant=\"[^\"]*\"/gi"
+        },
+        {
+            "name": "HTML-IDREF-aria-controls",
+            "pattern": "/\\baria-controls=\"[^\"]*\"/gi"
+        },
+        {
+            "name": "HTML-IDREF-aria-describedby",
+            "pattern": "/\\baria-describedby=\"[^\"]*\"/gi"
+        },
+        {
+            "name": "HTML-IDREF-aria-details",
+            "pattern": "/\\baria-details=\"[^\"]*\"/gi"
+        },
+        {
+            "name": "HTML-IDREF-aria-errormessage",
+            "pattern": "/\\baria-errormessage=\"[^\"]*\"/gi"
+        },
+        {
+            "name": "HTML-IDREF-aria-flowto",
+            "pattern": "/\\baria-flowto=\"[^\"]*\"/gi"
+        },
+        {
+            "name": "HTML-IDREF-aria-labelledby",
+            "pattern": "/\\baria-labelledby=\"[^\"]*\"/gi"
+        },
+        {
+            "name": "HTML-IDREF-aria-owns",
+            "pattern": "/\\baria-owns=\"[^\"]*\"/gi"
+        },
+        {
+            "name": "HTML-IDREF-for",
+            "pattern": "/\\bfor=\"[^\"]*\"/gi"
+        },
+        {
+            "name": "java-statement-import",
+            "description": "Matches the import statement",
+            "pattern": "/^\\s*import\\s+[\\w.]+/gm"
+        },
+        {
+            "name": "java-member-function",
+            "description": "Ignore member functions etc, these are checked by the compiler.",
+            "pattern": "/(\\.\\w+)+(?=\\()/g"
+        },
+        {
+            "name": "sql-hex-number",
+            "pattern": "/0x[a-f0-9]*/gi"
+        },
+        {
+            "name": "sql-unicode-string-prefix",
+            "pattern": "/\\bN'/g"
+        },
+        {
+            "name": "js-hex-escape",
+            "pattern": "/\\\\x[a-f0-9]{2}/gi",
+            "description": "JavaScript String Hexadecimal Escape sequence."
+        },
+        {
+            "name": "js-unicode-escape",
+            "pattern": "/\\\\u[a-f0-9]{4}/gi",
+            "description": "JavaScript String Unicode Escape sequence."
+        },
+        {
+            "name": "js-regexp-flags",
+            "pattern": "/\\/[dgimsuy]{1,7}\\b(?=(?:\\.flags\\b)|\\s*$|[;),])/g",
+            "description": "JavaScript Match Regular Expression Flags"
+        },
+        {
+            "name": "HTML-symbol-entity",
+            "description": "Matches on HTML symbols like `&clubs;`",
+            "pattern": {}
+        },
+        {
+            "name": "MARKDOWN-link-reference",
+            "description": "Markdown reference link: `[This is a link][reference]`, matches `[reference]`",
+            "pattern": {}
+        },
+        {
+            "name": "MARKDOWN-link-footer",
+            "description": "Markdown referenced link: `[reference]: https://www.google.com`, matches the entire reference.",
+            "pattern": {}
+        },
+        {
+            "name": "MARKDOWN-link",
+            "description": "Markdown link: `[link text](link)`, matches `link`",
+            "pattern": {}
+        },
+        {
+            "name": "MARKDOWN-anchor",
+            "description": "Markdown Anchors: `<a id=\"my_link\"></a>`, matches `my_link`",
+            "pattern": {}
+        }
+    ],
+    "suggestionNumChanges": 3,
+    "suggestionsTimeout": 500,
+    "version": "0.2"
+}

package/cspell/dict/css.txt

@@ -0,0 +1,9 @@
+vmin
+vmax
+lvmin
+lvmax
+svmin
+svmax
+dvmin
+dvmax
+nowrap

package/cspell/dict/html.txt

@@ -0,0 +1,4 @@
+srcset
+tabindex
+iframe
+javascript

package/cspell/dict/names.txt

@@ -0,0 +1,28 @@
+Anson
+dbaeumer
+schoero
+Schönbächler
+typecheck
+volta
+markdownlint
+vite
+vitest
+ncpa
+shellcheck
+JSDelivr
+tsdoc
+qwik
+Qwik
+unwritten
+vercel
+github
+tailwindcss
+shiki
+stackblitz
+changelogen
+minimatch
+jsdoc
+tsdoc
+rollup
+rolldown
+browserify

package/cspell/dict/npm.txt

@@ -0,0 +1,32 @@
+prerelease
+postrelease
+prepublish
+postpublish
+preversion
+postversion
+pretest
+posttest
+preinstall
+postinstall
+pretypecheck
+posttypecheck
+prebuild
+postbuild
+prelint
+postlint
+preschema
+postschema
+preeslint
+posteslint
+precompress
+postcompress
+prepack
+postpack
+preprepare
+postprepare
+predependencies
+postdependencies
+prerestart
+postrestart
+prestart
+poststart

package/cspell/dict/svg.txt

@@ -0,0 +1,6 @@
+ideographic
+mathematical
+nonzero
+evenodd
+tspan
+dasharray

package/cspell/dict/vscode.txt

@@ -0,0 +1,4 @@
+extname
+parens
+readwrite
+ansi

package/eslint/ignore.js

@@ -0,0 +1,19 @@
+/** @type {import("eslint").Linter.FlatConfig[]} */
+export const ignore = [
+    {
+        ignores: [
+            '**/.git/**',
+            '**/node_modules/**',
+            '**/dist/**',
+            '**/lib/**',
+            '**/build/**',
+            '**/.vercel/**',
+            '**/__snapshots__/**',
+            '**/*.snap',
+            '**/package-lock.json',
+            '**/yarn.lock',
+            '**/pnpm-lock.yaml',
+            '**/bun.lockb'
+        ],
+    },
+]