@tsofist/web-buddy 1.22.0 → 2.0.0-next.2

package/lib/semantic-release/configuration-bootstrap.d.ts

@@ -0,0 +1,84 @@
+/**
+ * @internal
+ */
+export declare function bootstrapSemanticReleaseConfig(platform: SemanticReleasePlatform, branchesFlow?: SemanticReleaseBranchesFlow): {
+    branches: SemanticReleaseBranchDef[];
+    plugins: (string | (string | {
+        assets: string[];
+        message: string;
+    })[])[];
+};
+export type SemanticReleasePlatform = 'github' | 'gitlab';
+export type SemanticReleaseBranchesFlow = {
+    /**
+     * ### Defaults:
+     * - __Channel name__: `maintenance`
+     * - __Branch name template:__ `maintenance/+([0-9])?(.{+([0-9]),x}).x`
+     */
+    maintenance?: ReleaseBranchFlowParams;
+    /**
+     * ### Defaults:
+     * - __Channel name__: `draft`
+     * - __Branch name template:__ `draft/*`
+     */
+    draft?: ReleaseBranchFlowParams;
+};
+export type ReleaseBranchFlowParams = {
+    branchPrefix?: string;
+    releaseChannel?: string;
+};
+/**
+ * @see https://semantic-release.gitbook.io/semantic-release/usage/configuration#branches Branches | semantic-release
+ * @see https://semantic-release.gitbook.io/semantic-release/usage/workflow-configuration#workflow-configuration Workflow | semantic-release
+ */
+type SemanticReleaseBranchDef = SemanticReleaseBranchDistributionChannel | SemanticReleaseBranchPreRelease | SemanticReleaseBranchMaintenance;
+/**
+ * Prerelease branch definition
+ * ---
+ *
+ * @example
+ * ```TypeScript
+ *   // `prerelease` is set to `true` as it is the value of `name`
+ *   { name: "master", prerelease: true }
+ *   // `prerelease` is built with the template `${name.replace(/^pre\\//g, "")}`
+ *   { name: "pre/rc", channel: "pre/rc", prerelease: "rc" }
+ *   // `prerelease` is set to `beta` as it is the value of `name`
+ *   { name: "beta", channel: "beta", prerelease: true }
+ *   // `prerelease` is built with the template `${name.replace(/^wip\\//, 'wip.')}`
+ *   { name: "wip", channel: "wip", prerelease: "${name.replace(/^wip\\//, 'wip.')}" }
+ * ```
+ *
+ * @see https://semantic-release.gitbook.io/semantic-release/usage/workflow-configuration#workflow-configuration#pre-release-branches Pre-release branches | semantic-release
+ * @see https://semantic-release.gitbook.io/semantic-release/recipes/release-workflow/pre-releases Workflow: Pre-releases | semantic-release
+ */
+type SemanticReleaseBranchPreRelease = {
+    name: string;
+    prerelease: true | string;
+    channel?: string;
+};
+/**
+ * Maintenance branch definition
+ * ---
+ *
+ * @example
+ * ```TypeScript
+ *   { name: "maintenance/+([0-9])?(.{+([0-9]),x}).x", channel: "maintenance" }
+ *   // `channel` is built with the template `channel-${name}`
+ *   {name: "next", channel: "channel-${name}"}
+ *   // only after the `1.x` is created in the repo
+ *   { name: "1.x", channel: "1.x", range: "1.x" },
+ * ```
+ *
+ * @see https://semantic-release.gitbook.io/semantic-release/usage/workflow-configuration#workflow-configuration#maintenance-branches Maintenance branches | semantic-release
+ * @see https://semantic-release.gitbook.io/semantic-release/recipes/release-workflow/maintenance-releases Workflow: Maintenance releases | semantic-release
+ */
+type SemanticReleaseBranchMaintenance = {
+    name: string;
+    channel: string;
+    range?: string;
+};
+/**
+ * @see https://semantic-release.gitbook.io/semantic-release/recipes/release-workflow/distribution-channels Workflow: Distribution channels | semantic-release
+ */
+type SemanticReleaseBranchDistributionChannel = string;
+export {};

package/lib/semantic-release/configuration-bootstrap.js

@@ -0,0 +1,53 @@
+/**
+ * @internal
+ */
+export function bootstrapSemanticReleaseConfig(platform, branchesFlow = DEF_BRANCHES_FLOW) {
+    const branches = [
+        'main',
+        'master',
+        { name: 'next', prerelease: true },
+        { name: 'stage', prerelease: true },
+        { name: 'dev', prerelease: true },
+        { name: 'beta', prerelease: true },
+        { name: 'alpha', prerelease: true },
+    ];
+    if (branchesFlow.maintenance) {
+        const prefix = branchesFlow.maintenance.branchPrefix ?? DEF_BRANCHES_FLOW.maintenance.branchPrefix;
+        const channel = branchesFlow.maintenance.releaseChannel ?? DEF_BRANCHES_FLOW.maintenance.releaseChannel;
+        const name = `${prefix}/+([0-9])?(.{+([0-9]),x}).x`;
+        branches.push({ name, channel });
+    }
+    if (branchesFlow.draft) {
+        const prefix = branchesFlow.draft.branchPrefix ?? DEF_BRANCHES_FLOW.draft.branchPrefix;
+        const channel = branchesFlow.draft.releaseChannel ?? DEF_BRANCHES_FLOW.draft.releaseChannel;
+        const name = `${prefix}/*`;
+        const prerelease = `\${name.replace(/^${channel}\\//, '${channel}.')}`;
+        branches.push({ name, channel, prerelease });
+    }
+    return {
+        branches,
+        plugins: [
+            '@semantic-release/commit-analyzer',
+            '@semantic-release/release-notes-generator',
+            `@semantic-release/${platform}`,
+            '@semantic-release/npm',
+            [
+                '@semantic-release/git',
+                {
+                    assets: ['package.json', 'package-lock.json'],
+                    message: 'chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}',
+                },
+            ],
+        ],
+    };
+}
+const DEF_BRANCHES_FLOW = {
+    maintenance: {
+        releaseChannel: 'maintenance',
+        branchPrefix: 'maintenance',
+    },
+    draft: {
+        releaseChannel: 'draft',
+        branchPrefix: 'draft',
+    },
+};

package/lib/stricter-mode.d.ts

@@ -0,0 +1 @@
+export declare const WebBuddyStricterMode: boolean;

package/lib/stricter-mode.js

@@ -0,0 +1,2 @@
+import { env } from 'node:process';
+export const WebBuddyStricterMode = (env.WEB_BUDDY_LINT_STRICTER ?? '1') === '1';

package/lib/stylelint/config.d.ts

@@ -0,0 +1,11 @@
+export declare const WebBuddyStylelintConfig: {
+    defaultSeverity: string;
+    extends: string[];
+    plugins: string[];
+    overrides: {
+        files: string[];
+        customSyntax: string;
+    }[];
+    rules: import("../types.js").StylelintRuleSet;
+};
+export default WebBuddyStylelintConfig;

package/lib/stylelint/config.js

@@ -0,0 +1,21 @@
+import { WebBuddyStylelintRules } from './rules.js';
+export const WebBuddyStylelintConfig = {
+    defaultSeverity: 'error',
+    extends: [
+        'stylelint-config-html',
+        'stylelint-config-standard',
+        'stylelint-config-standard-vue',
+        'stylelint-config-standard-scss',
+        'stylelint-config-standard-vue/scss',
+        'stylelint-prettier',
+    ],
+    plugins: ['stylelint-prettier', 'stylelint-scss', 'stylelint-order'],
+    overrides: [
+        {
+            files: ['*.html'],
+            customSyntax: 'postcss-html',
+        },
+    ],
+    rules: WebBuddyStylelintRules,
+};
+export default WebBuddyStylelintConfig;

package/lib/stylelint/rules.d.ts

@@ -0,0 +1,2 @@
+import type { StylelintRuleSet } from '../types.js';
+export declare const WebBuddyStylelintRules: StylelintRuleSet;

package/lib/stylelint/rules.js

@@ -0,0 +1,19 @@
+const VuePseudoClasses = [
+    'deep',
+    'slotted',
+    'global',
+    // legacy ->
+    'v-deep',
+    'v-slotted',
+    'v-global',
+];
+export const WebBuddyStylelintRules = {
+    'prettier/prettier': true,
+    'order/properties-alphabetical-order': true,
+    'no-empty-source': null,
+    'declaration-property-value-no-unknown': true,
+    'selector-pseudo-class-no-unknown': [true, { ignorePseudoClasses: VuePseudoClasses }],
+    'selector-pseudo-element-no-unknown': [true, { ignorePseudoElements: VuePseudoClasses }],
+    'scss/at-rule-no-unknown': null,
+    'scss/comment-no-empty': null,
+};

package/lib/tsconfig/config.base.json

@@ -0,0 +1,18 @@
+{
+    "compilerOptions": {
+        "declaration": true,
+        "forceConsistentCasingInFileNames": true,
+        "importHelpers": true,
+        "newLine": "lf",
+        "noEmitHelpers": true,
+        "noEmitOnError": true,
+        "noFallthroughCasesInSwitch": true,
+        "noImplicitOverride": true,
+        "noImplicitReturns": true,
+        "noUnusedLocals": true,
+        "noUnusedParameters": true,
+        "resolveJsonModule": true,
+        "strict": true,
+        "useDefineForClassFields": true
+    }
+}

package/lib/tsconfig/config.isomorphic.json

@@ -0,0 +1,6 @@
+{
+    "extends": "./config.base.json",
+    "compilerOptions": {
+        "incremental": true
+    }
+}

package/lib/tsconfig/config.web.json

@@ -0,0 +1,11 @@
+{
+    "extends": "./config.base.json",
+    "compilerOptions": {
+        "isolatedModules": true,
+        "verbatimModuleSyntax": false
+    },
+    "vueCompilerOptions": {
+        "allowImplicitTemplateReturnType": false,
+        "strictTemplates": true
+    }
+}

package/lib/types.d.ts

@@ -0,0 +1,14 @@
+import type { Linter } from 'eslint';
+import type { defineConfig } from 'eslint/config';
+export type WebBuddyESLintConfig = RO<ReturnType<ESLintDefineConfig>>;
+export type ESLintRuleSet = Record<string, Linter.RuleEntry>;
+export type ESLintConfigChainElement = Parameters<ESLintDefineConfig>[number];
+export type ESLintConfigChain = readonly ESLintConfigChainElement[];
+export type StylelintRuleSet = {
+    [rule in string]: null | boolean | [boolean, object];
+};
+type ESLintDefineConfig = typeof defineConfig;
+type RO<T> = T extends Function ? T : T extends object ? {
+    readonly [K in keyof T]: RO<T[K]>;
+} : T;
+export {};

package/lib/types.js

@@ -0,0 +1 @@
+export {};

package/package.json

@@ -1,78 +1,78 @@
 {
   "name": "@tsofist/web-buddy",
-  "version": "1.22.0",
+  "version": "2.0.0-next.2",
   "description": "Configuration basics for Linters, TypeScript, Semantic Release and others",
+  "type": "module",
   "author": "Andrew Berdnikov <tsofistgudmen@gmail.com>",
-  "license": "MIT",
+  "license": "LGPL-3.0",
   "homepage": "https://github.com/tsofist/web-buddy/",
   "scripts": {
+    "build": "rm -rf lib && tsc -p tsconfig.build.json",
     "format": "npm run lint:code -- --fix && npm run lint:style -- --fix",
+    "test": "npm run build && npm run lint",
     "lint": "npm run lint:code && npm run lint:style",
-    "lint:code": "eslint . -c .eslintrc.yaml --cache --cache-location .lint-cache/",
-    "lint:style": "stylelint **/*.{htm,html,vue,css,scss,sass,pcss,postcss} --cache --cache-location .lint-cache/ --allow-empty-input",
+    "lint:code": "WEB_BUDDY_LINT_STRICTER=1 eslint . --cache --cache-location .cache/",
+    "lint:style": "stylelint **/*.{htm,html,vue,css,scss,sass,pcss,postcss} --cache --cache-location .cache/ --allow-empty-input",
     "pkg:publish": "semantic-release --no-ci",
     "pkg:publish-test": "semantic-release --no-ci --dry-run",
-    "pkg:clean": "rm -rf dist lib .coverage .*-cache .npm",
-    "pkg:purge": "npm run pkg:clean && rm -rf node_modules",
+    "pkg:clean": "rm -rf dist lib .coverage .cache",
+    "pkg:purge": "npm run pkg:clean && rm -rf .npm node_modules",
     "prepare": "husky"
   },
   "dependencies": {
+    "@eslint/js": "^10.0.1",
     "@semantic-release/git": "^10.0.1",
-    "@semantic-release/github": "^11.0.6",
-    "@semantic-release/gitlab": "^13.2.9",
-    "@semantic-release/npm": "^12.0.2",
-    "@typescript-eslint/eslint-plugin": "^7.18.0",
-    "@typescript-eslint/parser": "^7.18.0",
-    "@vue/eslint-config-prettier": "^9.0.0",
-    "@vue/eslint-config-typescript": "^13.0.0",
-    "eslint": "^8.57.1",
-    "eslint-config-prettier": "^9.1.2",
-    "eslint-plugin-decorator-position": "^6.0.0",
-    "eslint-plugin-import": "^2.32.0",
-    "eslint-plugin-json-format": "^2.0.1",
-    "eslint-plugin-prettier": "^5.2.6",
-    "eslint-plugin-prettier-vue": "^5.0.0",
-    "eslint-plugin-vue": "^9.33.0",
-    "eslint-plugin-yml": "^1.19.1",
+    "@semantic-release/github": "^12.0.6",
+    "@semantic-release/gitlab": "^13.3.2",
+    "@semantic-release/npm": "^13.1.5",
+    "@stylistic/eslint-plugin": "^5.10.0",
+    "@vue/eslint-config-prettier": "^10.2.0",
+    "@vue/eslint-config-typescript": "^14.7.0",
+    "eslint": "^10.3.0",
+    "eslint-import-resolver-typescript": "^4.4.4",
+    "eslint-plugin-decorator-position": "^6.1.0",
+    "eslint-plugin-import-x": "^4.16.2",
+    "eslint-plugin-jsonc": "^3.1.2",
+    "eslint-plugin-prettier": "^5.5.5",
+    "eslint-plugin-vue": "^10.9.1",
+    "eslint-plugin-yml": "^3.3.2",
+    "globals": "^17.6.0",
     "husky": "^9.1.7",
+    "npm": "^11.14.0",
     "postcss-html": "^1.8.1",
-    "prettier": "^3.4.2",
+    "prettier": "^3.8.3",
     "semantic-release": "^25.0.3",
-    "stylelint": "^16.12.0",
-    "stylelint-config-recommended-scss": "^14.1.0",
-    "stylelint-config-standard": "^36.0.1",
-    "stylelint-config-standard-scss": "^13.1.0",
+    "stylelint": "^17.11.0",
+    "stylelint-config-recommended-scss": "^17.0.1",
+    "stylelint-config-standard": "^40.0.0",
+    "stylelint-config-standard-scss": "^17.0.0",
     "stylelint-config-standard-vue": "^1.0.0",
-    "stylelint-order": "^6.0.4",
+    "stylelint-order": "^8.1.1",
     "stylelint-prettier": "^5.0.3",
-    "stylelint-scss": "^6.10.1",
-    "typescript": "~5.9.3"
+    "stylelint-scss": "^7.0.0",
+    "typescript": "~6.0.3",
+    "typescript-eslint": "^8.59.2",
+    "yaml-eslint-parser": "^2.0.0"
   },
   "devDependencies": {
+    "@types/node": "^22.19.17",
     "tslib": "^2.8.1"
   },
   "files": [
-    "eslint",
-    "tsconfig",
-    ".eslintrc.yaml",
-    ".stylelintrc.yaml",
-    ".releaserc-*.json",
-    ".editorconfig",
-    ".prettierrc.js",
+    "LICENSE",
     "README.md",
-    "LICENSE"
+    ".editorconfig",
+    "lib"
   ],
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
   },
   "engines": {
-    "node": ">=20"
+    "node": ">=22"
   },
   "release": {
-    "extends": [
-      "./.releaserc-github.json"
-    ]
+    "extends": "./lib/semantic-release/config.github.js"
   },
   "keywords": [
     "eslint",

package/.eslintrc.yaml

@@ -1,66 +0,0 @@
-env:
-  browser: true
-  node: true
-
-parserOptions:
-  ecmaVersion: 2020
-  extraFileExtensions:
-    - .vue
-
-ignorePatterns:
-  - 'package*.json'
-  - '*.scss'
-  - '*.css'
-  - '*.html'
-  - '*.htm'
-  - '!.*.yml'
-  - '!.*.yaml'
-  - '!.*.json'
-  - '!.gitlab-ci'
-  - '!.k8s'
-
-plugins:
-  - import
-  - vue
-  - '@typescript-eslint'
-  - decorator-position
-
-settings:
-  import/extensions: [.ts, .tsx, .vue, .js, .json]
-  import/parsers:
-    '@typescript-eslint/parser': [.ts, .tsx, .vue]
-  prettier-vue:
-    SFCBlocks:
-      template: false
-      style: true
-      script: true
-
-overrides:
-  - files: ['*.json']
-    parser: '@typescript-eslint/parser'
-    plugins:
-      - prettier
-    extends:
-      - prettier
-      - ./eslint/shared.yaml
-    rules:
-      prettier/prettier: error
-      quotes: off
-      quote-props: off
-
-  - files: ['*.yaml', '*.yml']
-    extends:
-      - ./eslint/yaml/common.yaml
-
-  - files: ['*.vue']
-    extends:
-      - ./eslint/vue/common.yaml
-
-  - files: ['*.ts', '*.tsx']
-    extends:
-      - ./eslint/typescript/common.yaml
-
-  # todo?
-  - files: ['*.js', '*.jsx']
-    extends:
-      - ./eslint/typescript/common.yaml

package/.releaserc-github.json

@@ -1,23 +0,0 @@
-{
-  "branches": [
-    "main",
-    "master",
-    { "name": "next", "prerelease": true },
-    { "name": "stage", "prerelease": true },
-    { "name": "dev", "prerelease": true },
-    { "name": "wip/*", "channel": "wip", "prerelease": "${name.replace(/^wip\\//, 'wip.')}" }
-  ],
-  "plugins": [
-    "@semantic-release/commit-analyzer",
-    "@semantic-release/release-notes-generator",
-    "@semantic-release/github",
-    "@semantic-release/npm",
-    [
-      "@semantic-release/git",
-      {
-        "assets": ["package.json", "package-lock.json"],
-        "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
-      }
-    ]
-  ]
-}

package/.releaserc-gitlab.json

@@ -1,23 +0,0 @@
-{
-  "branches": [
-    "main",
-    "master",
-    { "name": "next", "prerelease": true },
-    { "name": "stage", "prerelease": true },
-    { "name": "dev", "prerelease": true },
-    { "name": "wip/*", "channel": "wip", "prerelease": "${name.replace(/^wip\\//, 'wip.')}" }
-  ],
-  "plugins": [
-    "@semantic-release/commit-analyzer",
-    "@semantic-release/release-notes-generator",
-    "@semantic-release/gitlab",
-    "@semantic-release/npm",
-    [
-      "@semantic-release/git",
-      {
-        "assets": ["package.json", "package-lock.json"],
-        "message": "chore(release): ${nextRelease.version} [skip ci]\n\n${nextRelease.notes}"
-      }
-    ]
-  ]
-}

package/.stylelintrc.yaml

@@ -1,49 +0,0 @@
-defaultSeverity: error
-
-extends:
-  - stylelint-config-html
-  - stylelint-config-standard
-  - stylelint-config-standard-vue
-  - stylelint-config-standard-scss
-  - stylelint-config-standard-vue/scss
-  - stylelint-prettier
-
-plugins:
-  - stylelint-prettier
-  - stylelint-scss
-  - stylelint-order
-
-overrides:
-  - files:
-      - '*.html'
-    customSyntax: postcss-html
-
-rules:
-  prettier/prettier: true
-  order/properties-alphabetical-order: true
-  no-empty-source: null
-  declaration-property-value-no-unknown: true
-  selector-pseudo-class-no-unknown:
-    - true
-    - ignorePseudoClasses:
-        # for webpack
-        - v-deep
-        - v-slotted
-        - v-global
-        # for vite
-        - deep
-        - slotted
-        - global
-  selector-pseudo-element-no-unknown:
-    - true
-    - ignorePseudoElements:
-        # for webpack
-        - v-deep
-        - v-slotted
-        - v-global
-        # for vite
-        - deep
-        - slotted
-        - global
-  scss/at-rule-no-unknown: null
-  scss/comment-no-empty: null

package/eslint/shared.yaml

@@ -1,66 +0,0 @@
-rules:
-  prefer-const: error
-  one-var:
-    - error
-    - never
-  no-multi-spaces: error
-  no-multiple-empty-lines:
-    - error
-    - max: 1
-      maxEOF: 0
-      maxBOF: 0
-  object-curly-spacing:
-    - error
-    - always
-
-  import/newline-after-import: error
-  import/no-duplicates: warn
-  import/order:
-    - error
-    - newlines-between: never
-      alphabetize:
-        order: asc
-        caseInsensitive: false
-      groups:
-        - builtin
-        - external
-        - internal
-        - parent
-        - sibling
-        - index
-
-  no-restricted-imports:
-    - error
-    - paths:
-        - name: lodash
-          message: NEVER IMPORT lodash. Use ONLY DIRECT lodash-es/<SOME-TOOL>
-        - name: lodash-es
-          message: NEVER IMPORT lodash-es. Use ONLY lodash-es/<SOME-TOOL>
-
-  no-new-wrappers: error
-
-  quotes:
-    - error
-    - single
-    - allowTemplateLiterals: true
-      avoidEscape: true
-  quote-props:
-    - error
-    - consistent-as-needed
-
-  no-return-await: error
-
-  key-spacing:
-    - error
-  block-spacing:
-    - error
-  semi-spacing:
-    - error
-  keyword-spacing:
-    - error
-  space-before-blocks:
-    - error
-  brace-style:
-    - error
-  arrow-spacing:
-    - error

package/eslint/stricter.extends.yaml

@@ -1,10 +0,0 @@
-overrides:
-  - files: ['*.ts', '*.tsx']
-    extends:
-      - ./typescript/common.yaml
-      - ./typescript/stricter.rules.yaml
-
-  - files: ['*.vue']
-    extends:
-      - ./vue/common.yaml
-      - ./typescript/stricter.rules.yaml

package/eslint/typescript/common.yaml

@@ -1,20 +0,0 @@
-parser: '@typescript-eslint/parser'
-
-parserOptions:
-  extraFilesExtension:
-    - .vue
-  project: tsconfig.json
-  sourceType: module
-
-plugins:
-  - import
-  - prettier
-  - '@typescript-eslint'
-  - decorator-position
-
-extends:
-  - eslint:recommended
-  - plugin:import/typescript
-  - plugin:@typescript-eslint/strict-type-checked
-  - ./rules.yaml
-  - ../shared.yaml