@brnshkr/config 0.0.1-beta.3 → 0.0.1-beta.4

package/conf/vscode-settings.dist.jsonc

@@ -0,0 +1,338 @@
+{
+  ////////////////////////
+  /// Project specific ///
+  ////////////////////////
+
+  // CSS
+  "stylelint.configFile": "./conf/stylelint.dist.mjs",
+  "stylelint.configBasedir": "./",
+
+  // JS/TS
+  "js/ts.tsdk.path": "./node_modules/typescript/lib",
+  "eslint.options": {
+    "overrideConfigFile": "./conf/eslint.dist.mjs"
+  },
+  "eslint.workingDirectories": ["."],
+
+  // Markdown
+  "markdownlint.configFile": "./conf/markdownlint.dist.mjs",
+  "markdownlint.configPointer": "/config",
+
+  // PHP
+  "php-cs-fixer.config": "./conf/php-cs-fixer.php;./conf/php-cs-fixer.dist.php",
+  "php-cs-fixer.executablePath": "${workspaceFolder}/vendor/bin/php-cs-fixer",
+  "php-cs-fixer.executablePathWindows": "${workspaceFolder}\\vendor\\bin\\php-cs-fixer.bat",
+  "phpstan.binPath": "./vendor/bin/phpstan",
+  "phpstan.configFile": "./conf/phpstan.php,./conf/phpstan.dist.php",
+
+  ///////////////
+  /// General ///
+  ///////////////
+
+  // Functional
+  "files.trimFinalNewlines": true,
+  "files.associations": {
+    ".env{,.*}": "properties",
+    "*.neon": "yaml",
+    "LICENSE": "plaintext"
+  },
+  "emmet.includeLanguages": {
+    "twig": "html"
+  },
+  "workbench.editorAssociations": {
+    "*.svg": "default"
+  },
+  "todo-tree.general.tags": [
+    "BUG",
+    "HACK",
+    "FIXME",
+    "NOTICE",
+    "TODO"
+  ],
+
+  // Visual
+  "diffEditor.ignoreTrimWhitespace": false,
+  "todo-tree.highlights.defaultHighlight": {
+    "background": "#0000"
+  },
+
+  // Formatters
+  "[css]": {
+    "editor.defaultFormatter": "aeschli.vscode-css-formatter"
+  },
+  "[html]": {
+    "editor.defaultFormatter": "vscode.html-language-features"
+  },
+  "[javascript]": {
+    "editor.defaultFormatter": "vscode.typescript-language-features"
+  },
+  "[json]": {
+    "editor.defaultFormatter": "vscode.json-language-features"
+  },
+  "[jsonc]": {
+    "editor.defaultFormatter": "vscode.json-language-features"
+  },
+  "[markdown]": {
+    "editor.defaultFormatter": "yzhang.markdown-all-in-one"
+  },
+  "[php]": {
+    "editor.defaultFormatter": "junstyle.php-cs-fixer"
+  },
+  "[twig]": {
+    "editor.defaultFormatter": "mblode.twig-language-2"
+  },
+  "[typescript]": {
+    "editor.defaultFormatter": "vscode.typescript-language-features"
+  },
+  "[xml]": {
+    "editor.defaultFormatter": "redhat.vscode-xml"
+  },
+  "[yaml]": {
+    "editor.defaultFormatter": "redhat.vscode-yaml"
+  },
+
+  // Telemetry
+  "gitlens.telemetry.enabled": false,
+  "partialDiff.enableTelemetry": false,
+  "redhat.telemetry.enabled": false,
+  "telemetry.telemetryLevel": "off", // NOTICE: Can only be turned off in the default settings
+  "intelephense.telemetry.enabled": false,
+
+  // Copilot
+  "github.copilot.enable": {
+    "*": true,
+    "plaintext": false,
+    "properties": false,
+    "markdown": false,
+    "scminput": false
+  },
+
+  // Excludes
+  "explorer.autoRevealExclude": {
+    "**/.cache/**": true,
+    "**/.changeset/**": true,
+    "**/.git/**": true,
+    "**/.hg/store/**": true,
+    "**/.history/**": true,
+    "**/.idea/**": true,
+    "**/.next/**": true,
+    "**/.nuxt/**": true,
+    "**/.output/**": true,
+    "**/.svelte-kit/**": true,
+    "**/.temp/**": true,
+    "**/.tmp/**": true,
+    "**/.vercel/**": true,
+    "**/.vite-inspect/**": true,
+    "**/.vitepress/cache/**": true,
+    "**/.vscode/**": true,
+    "**/.yarn/**": true,
+    "**/__snapshots__/**": true,
+    "**/*.code-search": true,
+    "**/*.min.*": true,
+    "**/bower_components/**": true,
+    "**/bun.lock": true,
+    "**/composer.lock": true,
+    "**/coverage/**": true,
+    "**/dist/**": true,
+    "**/node_modules/**": true,
+    "**/output/**": true,
+    "**/package-lock.json": true,
+    "**/pnpm-lock.yaml": true,
+    "**/temp/**": true,
+    "**/tests/**/fixtures/**": true,
+    "**/tmp/**": true,
+    "**/vendor/**": true,
+    "**/vite.config.*.timestamp-*": true,
+    "**/yarn.lock": true
+  },
+  "search.exclude": {
+    "**/.cache/**": true,
+    "**/.changeset/**": true,
+    "**/.git/**": true,
+    "**/.hg/store/**": true,
+    "**/.history/**": true,
+    "**/.idea/**": true,
+    "**/.next/**": true,
+    "**/.nuxt/**": true,
+    "**/.output/**": true,
+    "**/.svelte-kit/**": true,
+    "**/.temp/**": true,
+    "**/.tmp/**": true,
+    "**/.vercel/**": true,
+    "**/.vite-inspect/**": true,
+    "**/.vitepress/cache/**": true,
+    "**/.vscode/**": true,
+    "**/.yarn/**": true,
+    "**/__snapshots__/**": true,
+    "**/*.code-search": true,
+    "**/*.min.*": true,
+    "**/bower_components/**": true,
+    "**/bun.lock": true,
+    "**/composer.lock": true,
+    "**/coverage/**": true,
+    "**/dist/**": true,
+    "**/node_modules/**": true,
+    "**/output/**": true,
+    "**/package-lock.json": true,
+    "**/pnpm-lock.yaml": true,
+    "**/temp/**": true,
+    "**/tests/**/fixtures/**": true,
+    "**/tmp/**": true,
+    "**/vendor/**": true,
+    "**/vite.config.*.timestamp-*": true,
+    "**/yarn.lock": true
+  },
+  "files.watcherExclude": {
+    "**/.cache/**": true,
+    "**/.changeset/**": true,
+    "**/.git/**": true,
+    "**/.hg/store/**": true,
+    "**/.history/**": true,
+    "**/.idea/**": true,
+    "**/.next/**": true,
+    "**/.nuxt/**": true,
+    "**/.output/**": true,
+    "**/.svelte-kit/**": true,
+    "**/.temp/**": true,
+    "**/.tmp/**": true,
+    "**/.vercel/**": true,
+    "**/.vite-inspect/**": true,
+    "**/.vitepress/cache/**": true,
+    "**/.vscode/**": true,
+    "**/.yarn/**": true,
+    "**/__snapshots__/**": true,
+    "**/*.code-search": true,
+    "**/*.example": true,
+    "**/*.min.*": true,
+    "**/bower_components/**": true,
+    "**/bun.lock": true,
+    "**/composer.lock": true,
+    "**/coverage/**": true,
+    "**/dist/**": true,
+    "**/node_modules/**": true,
+    "**/output/**": true,
+    "**/package-lock.json": true,
+    "**/pnpm-lock.yaml": true,
+    "**/temp/**": true,
+    "**/tests/**/fixtures/**": true,
+    "**/tmp/**": true,
+    "**/vendor/**": true,
+    "**/vite.config.*.timestamp-*": true,
+    "**/yarn.lock": true
+  },
+  "todo-tree.filtering.excludeGlobs": [
+    "**/__snapshots__/**",
+    "**/.cache/**",
+    "**/.changeset/**",
+    "**/.git/**",
+    "**/.hg/store/**",
+    "**/.history/**",
+    "**/.idea/**",
+    "**/.next/**",
+    "**/.nuxt/**",
+    "**/.output/**",
+    "**/.svelte-kit/**",
+    "**/.temp/**",
+    "**/.tmp/**",
+    "**/.vercel/**",
+    "**/.vite-inspect/**",
+    "**/.vitepress/cache/**",
+    "**/.vscode/**",
+    "**/.yarn/**",
+    "**/*.code-search",
+    "**/*.example",
+    "**/*.min.*",
+    "**/bower_components/**",
+    "**/bun.lock",
+    "**/composer.lock",
+    "**/coverage/**",
+    "**/dist/**",
+    "**/node_modules/**",
+    "**/output/**",
+    "**/package-lock.json",
+    "**/pnpm-lock.yaml",
+    "**/temp/**",
+    "**/tests/**/fixtures/**",
+    "**/tmp/**",
+    "**/vendor/**",
+    "**/vite.config.*.timestamp-*",
+    "**/yarn.lock"
+  ],
+
+  /////////////////////////
+  /// Language specific ///
+  /////////////////////////
+
+  // CSS
+  "css.customData": [
+    "./.vscode/css-custom-data.json"
+  ],
+  "tailwindCSS.emmetCompletions": true,
+  "css.lint.unknownAtRules": "ignore",
+  "css.validate": false,
+  "scss.lint.unknownAtRules": "ignore",
+  "scss.validate": false,
+  "stylelint.validate": [
+    "css",
+    "html",
+    "less",
+    "scss",
+    "svelte",
+    "vue-html",
+    "vue",
+    "xml"
+  ],
+
+  // JS/TS
+  "js/ts.updateImportsOnFileMove.enabled": "always",
+  "js/ts.preferences.importModuleSpecifier": "non-relative",
+  "js/ts.preferences.quoteStyle": "single",
+  "svelte.enable-ts-plugin": true,
+  "eslint.validate": [
+    "css",
+    "html",
+    "javascript",
+    "javascriptreact",
+    "json",
+    "json5",
+    "jsonc",
+    "markdown",
+    "svelte",
+    "toml",
+    "typescript",
+    "typescriptreact",
+    "vue",
+    "xml",
+    "yaml"
+  ],
+
+  // PHP
+  "phpstan.enableStatusBar": false,
+  "phpstan.showTypeOnHover": true,
+  // "phpstan.singleFileMode": true, // Turn single file mode on if you are encountering performance issues
+
+  // JSON
+  "json.schemas": [
+    {
+      "url": "https://getcomposer.org/schema.json",
+      "fileMatch": [
+        "composer.json",
+        "*.composer.json"
+      ]
+    },
+    {
+      "url": "https://json.schemastore.org/package",
+      "fileMatch": [
+        "package.json",
+        "*.package.json"
+      ]
+    },
+    {
+      "url": "https://json.schemastore.org/tsconfig",
+      "fileMatch": [
+        "tsconfig.json",
+        "*.tsconfig.json"
+      ]
+    }
+  ]
+}

package/dist/commitlint/index.d.mts

@@ -0,0 +1,72 @@
+import { UserConfig } from "@commitlint/types";
+import { TenseOptions } from "commitlint-plugin-tense/dist/library/ensure-tense";
+//#region ../src/js/commitlint/types/config.d.ts
+type Config = { [Key in keyof UserConfig as string extends Key ? never : Key]: UserConfig[Key]; };
+//#endregion
+//#region ../src/js/commitlint/types/options.d.ts
+interface ConfigOptions {
+  /**
+   * Enables `@commitlint/config-conventional`.
+   *
+   * @default `Enabled when "@commitlint/config-conventional" is installed.`
+   *
+   * @see https://github.com/conventional-changelog/commitlint
+   */
+  conventional: boolean;
+  /**
+   * Enables `commitlint-plugin-function-rules`.
+   *
+   * @default `Enabled when "commitlint-plugin-function-rules" is installed.`
+   *
+   * @see https://github.com/gabrielcolson/commitlint-plugin-function-rules
+   */
+  functions: boolean;
+  /**
+   * Enables `commitlint-plugin-tense`.
+   *
+   * @default `Enabled when "commitlint-plugin-tense" is installed.`
+   *
+   * @see https://github.com/actuallyleon/commitlint-plugin-tense
+   */
+  tense: boolean | Partial<TenseOptions>;
+}
+type UserOptions = Partial<ConfigOptions> & Config;
+//#endregion
+//#region ../src/js/commitlint/index.d.ts
+/**
+ * Build the `@brnshkr` commitlint config object.
+ *
+ * Every preset is optional and enabled only when it is installed, so a project gets the organization's rules
+ * whether or not it has the conventional preset.
+ *
+ * @api
+ *
+ * @param optionsAndGlobalConfig per-module toggles and global commitlint fields merged with the defaults
+ * @param additionalConfigs extra config entries merged after the built-in ones
+ *
+ * @returns final commitlint config ready to be consumed by commitlint
+ *
+ * @see https://github.com/brnshkr/config/blob/master/docs/js/commitlint.md
+ *
+ * @example
+ * ```js
+ * import { getConfig } from '@brnshkr/config/commitlint';
+ *
+ * getConfig(undefined);
+ * getConfig({});
+ *
+ * getConfig({
+ *   conventional: false,
+ *   rules: { 'scope-min-length': [2, 'always', 3] },
+ * });
+ * ```
+ */
+export declare const getConfig: (optionsAndGlobalConfig?: UserOptions, ...additionalConfigs: Config[]) => Config;
+/**
+ * Default-exported pre-built config for direct re-export from a commitlint config file.
+ *
+ * @api
+ */
+declare const _default: Config;
+//#endregion
+export { _default as default };

package/dist/commitlint/index.mjs

@@ -0,0 +1,239 @@
+import { E as objectKeys, _ as COMMITLINT_PACKAGES, f as createModuleState, g as resolvePackagesSharedSynchronously, m as isModuleEnabledByDefault, w as objectEntries } from "../shared.mjs";
+//#region ../src/js/commitlint/configs/commit.ts
+/**
+* @internal @brnshkr/config/commitlint
+*/
+const SCOPE_MIN_LENGTH = 2;
+const SUBJECT_MIN_LENGTH = 5;
+const commit = () => [{
+	helpUrl: "https://github.com/brnshkr/config/blob/master/README.md#-commit-style",
+	rules: {
+		"body-case": [
+			2,
+			"always",
+			"sentence-case"
+		],
+		"body-leading-blank": [2, "always"],
+		"breaking-change-exclamation-mark": [2, "always"],
+		"footer-leading-blank": [2, "always"],
+		"header-case": [
+			2,
+			"always",
+			"lower-case"
+		],
+		"scope-case": [
+			2,
+			"always",
+			"lower-case"
+		],
+		"scope-delimiter-style": [
+			2,
+			"always",
+			["/"]
+		],
+		"scope-empty": [2, "never"],
+		"scope-min-length": [
+			2,
+			"always",
+			SCOPE_MIN_LENGTH
+		],
+		"subject-min-length": [
+			2,
+			"always",
+			SUBJECT_MIN_LENGTH
+		]
+	}
+}];
+//#endregion
+//#region ../src/js/commitlint/utils/module.ts
+/**
+* @internal @brnshkr/config/commitlint
+*/
+const MODULES = {
+	conventional: {
+		name: "conventional",
+		packages: { requiredAll: [COMMITLINT_PACKAGES.COMMITLINT_CONFIG_CONVENTIONAL] }
+	},
+	functions: {
+		name: "functions",
+		packages: { requiredAll: [COMMITLINT_PACKAGES.COMMITLINT_PLUGIN_FUNCTION_RULES] }
+	},
+	tense: {
+		name: "tense",
+		packages: { requiredAll: [COMMITLINT_PACKAGES.COMMITLINT_PLUGIN_TENSE] }
+	}
+};
+const resolvePackages = resolvePackagesSharedSynchronously;
+const { isModuleEnabled, setModuleEnabled } = createModuleState();
+//#endregion
+//#region ../src/js/commitlint/configs/conventional.ts
+/**
+* @internal @brnshkr/config/commitlint
+*/
+const conventional = () => {
+	const { requiredAll: [isCommitlintConfigConventionalInstalled] } = resolvePackages(MODULES.conventional);
+	if (!isCommitlintConfigConventionalInstalled) return [];
+	return [{ extends: COMMITLINT_PACKAGES.COMMITLINT_CONFIG_CONVENTIONAL }];
+};
+//#endregion
+//#region ../src/js/commitlint/configs/functions.ts
+/**
+* @internal @brnshkr/config/commitlint
+*/
+const functions = () => {
+	const { requiredAll: [isCommitlintPluginFunctionRulesInstalled] } = resolvePackages(MODULES.functions);
+	if (!isCommitlintPluginFunctionRulesInstalled) return [];
+	return [{ plugins: [COMMITLINT_PACKAGES.COMMITLINT_PLUGIN_FUNCTION_RULES] }];
+};
+//#endregion
+//#region ../src/js/commitlint/configs/tense.ts
+/**
+* @internal @brnshkr/config/commitlint
+*/
+const ALLOWLIST = [
+	"announce",
+	"called",
+	"console",
+	"cover",
+	"covers",
+	"decide",
+	"dismantle",
+	"excludes",
+	"harden",
+	"hoist",
+	"measure",
+	"missing",
+	"non-empty-string",
+	"pad",
+	"promote",
+	"spell",
+	"throw",
+	"widen"
+];
+const tense = (options) => {
+	const { requiredAll: [isCommitlintPluginTenseInstalled] } = resolvePackages(MODULES.tense);
+	if (!isCommitlintPluginTenseInstalled) return [];
+	const { allowlist = [], ...tenseOptions } = options ?? {};
+	return [{
+		plugins: [COMMITLINT_PACKAGES.COMMITLINT_PLUGIN_TENSE],
+		rules: { "tense/subject-tense": [
+			2,
+			"always",
+			{
+				allowedTenses: ["present-imperative"],
+				firstOnly: true,
+				...tenseOptions,
+				allowlist: [...ALLOWLIST, ...allowlist]
+			}
+		] }
+	}];
+};
+//#endregion
+//#region ../src/js/commitlint/configs/index.ts
+/**
+* @internal @brnshkr/config/commitlint
+*/
+const configs = {
+	commit,
+	conventional,
+	functions,
+	tense
+};
+//#endregion
+//#region ../src/js/commitlint/utils/config.ts
+/**
+* @internal @brnshkr/config/commitlint
+*/
+const isValidGlobalAdditionalConfigKey = (key) => [
+	"extends",
+	"formatter",
+	"rules",
+	"parserPreset",
+	"ignores",
+	"defaultIgnores",
+	"plugins",
+	"helpUrl",
+	"prompt"
+].includes(key);
+const getGlobalAdditionalConfig = (options) => {
+	const config = {};
+	for (const [key, value] of objectEntries(options)) if (isValidGlobalAdditionalConfigKey(key)) config[key] = value;
+	if (objectKeys(config).length === 0) return;
+	return config;
+};
+const getUserConfigs = (resolvedOptions, additionalConfigs) => [getGlobalAdditionalConfig(resolvedOptions), ...additionalConfigs].filter(Boolean);
+const includeConfigs = (config, configsToInclude) => {
+	for (const configToInclude of configsToInclude) {
+		if (configToInclude.extends !== void 0) config.extends = [.../* @__PURE__ */ new Set([...Array.isArray(config.extends) ? config.extends ?? [] : [config.extends].filter(Boolean), ...Array.isArray(configToInclude.extends) ? configToInclude.extends ?? [] : [configToInclude.extends].filter(Boolean)])];
+		if (configToInclude.formatter !== void 0) config.formatter = configToInclude.formatter;
+		if (configToInclude.rules !== void 0) config.rules = {
+			...config.rules,
+			...configToInclude.rules
+		};
+		if (configToInclude.parserPreset !== void 0) config.parserPreset = configToInclude.parserPreset;
+		if (configToInclude.ignores !== void 0) config.ignores = [.../* @__PURE__ */ new Set([...config.ignores ?? [], ...configToInclude.ignores])];
+		if (configToInclude.defaultIgnores !== void 0) config.defaultIgnores = configToInclude.defaultIgnores;
+		if (configToInclude.plugins !== void 0) config.plugins = [.../* @__PURE__ */ new Set([...config.plugins ?? [], ...configToInclude.plugins])];
+		if (configToInclude.helpUrl !== void 0) config.helpUrl = configToInclude.helpUrl;
+		if (configToInclude.prompt !== void 0) config.prompt = {
+			...config.prompt,
+			...configToInclude.prompt
+		};
+	}
+};
+//#endregion
+//#region ../src/js/commitlint/index.ts
+/**
+* Build the `@brnshkr` commitlint config object.
+*
+* Every preset is optional and enabled only when it is installed, so a project gets the organization's rules
+* whether or not it has the conventional preset.
+*
+* @api
+*
+* @param optionsAndGlobalConfig per-module toggles and global commitlint fields merged with the defaults
+* @param additionalConfigs extra config entries merged after the built-in ones
+*
+* @returns final commitlint config ready to be consumed by commitlint
+*
+* @see https://github.com/brnshkr/config/blob/master/docs/js/commitlint.md
+*
+* @example
+* ```js
+* import { getConfig } from '@brnshkr/config/commitlint';
+*
+* getConfig(undefined);
+* getConfig({});
+*
+* getConfig({
+*   conventional: false,
+*   rules: { 'scope-min-length': [2, 'always', 3] },
+* });
+* ```
+*/
+const getConfig = (optionsAndGlobalConfig, ...additionalConfigs) => {
+	const resolvedOptions = {
+		conventional: isModuleEnabledByDefault(MODULES.conventional),
+		functions: isModuleEnabledByDefault(MODULES.functions),
+		tense: isModuleEnabledByDefault(MODULES.tense),
+		...optionsAndGlobalConfig
+	};
+	setModuleEnabled(MODULES.conventional, resolvedOptions.conventional);
+	setModuleEnabled(MODULES.functions, resolvedOptions.functions);
+	setModuleEnabled(MODULES.tense, resolvedOptions.tense !== false);
+	const config = {};
+	includeConfigs(config, configs.commit());
+	if (isModuleEnabled(MODULES.conventional)) includeConfigs(config, configs.conventional());
+	if (isModuleEnabled(MODULES.functions)) includeConfigs(config, configs.functions());
+	if (isModuleEnabled(MODULES.tense)) includeConfigs(config, configs.tense(typeof resolvedOptions.tense === "object" ? resolvedOptions.tense : void 0));
+	includeConfigs(config, getUserConfigs(resolvedOptions, additionalConfigs));
+	return config;
+};
+/**
+* Default-exported pre-built config for direct re-export from a commitlint config file.
+*
+* @api
+*/
+var commitlint_default = getConfig();
+//#endregion
+export { commitlint_default as default, getConfig };