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

package/dist/markdownlint/index.mjs

@@ -0,0 +1,440 @@
+import { E as objectKeys, f as createModuleState, g as resolvePackagesSharedSynchronously, m as isModuleEnabledByDefault, u as GLOB_IGNORES, w as objectEntries, y as MARKDOWNLINT_PACKAGES } from "../shared.mjs";
+import { resolveModule } from "local-pkg";
+//#region ../src/js/markdownlint/utils/config.ts
+/**
+* @internal @brnshkr/config/markdownlint
+*/
+const resolveCustomRule = (id) => resolveModule(id) ?? id;
+const isValidGlobalAdditionalConfigKey = (key) => [
+	"$schema",
+	"config",
+	"customRules",
+	"fix",
+	"frontMatter",
+	"gitignore",
+	"globs",
+	"ignores",
+	"markdownItPlugins",
+	"modulePaths",
+	"noBanner",
+	"noInlineConfig",
+	"noProgress",
+	"outputFormatters",
+	"overrides",
+	"showFound"
+].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.$schema !== void 0) config.$schema = configToInclude.$schema;
+		if (configToInclude.config !== void 0) config.config = {
+			...config.config,
+			...configToInclude.config
+		};
+		if (configToInclude.customRules !== void 0) config.customRules = [.../* @__PURE__ */ new Set([...config.customRules ?? [], ...configToInclude.customRules])];
+		if (configToInclude.fix !== void 0) config.fix = configToInclude.fix;
+		if (configToInclude.frontMatter !== void 0) config.frontMatter = configToInclude.frontMatter;
+		if (configToInclude.gitignore !== void 0) config.gitignore = configToInclude.gitignore;
+		if (configToInclude.globs !== void 0) config.globs = [.../* @__PURE__ */ new Set([...config.globs ?? [], ...configToInclude.globs])];
+		if (configToInclude.ignores !== void 0) config.ignores = [.../* @__PURE__ */ new Set([...config.ignores ?? [], ...configToInclude.ignores])];
+		if (configToInclude.markdownItPlugins !== void 0) config.markdownItPlugins = configToInclude.markdownItPlugins;
+		if (configToInclude.modulePaths !== void 0) config.modulePaths = [.../* @__PURE__ */ new Set([...config.modulePaths ?? [], ...configToInclude.modulePaths])];
+		if (configToInclude.noBanner !== void 0) config.noBanner = configToInclude.noBanner;
+		if (configToInclude.noInlineConfig !== void 0) config.noInlineConfig = configToInclude.noInlineConfig;
+		if (configToInclude.noProgress !== void 0) config.noProgress = configToInclude.noProgress;
+		if (configToInclude.outputFormatters !== void 0) config.outputFormatters = configToInclude.outputFormatters;
+		if (configToInclude.overrides !== void 0) config.overrides = [...config.overrides ?? [], ...configToInclude.overrides.map((override) => ({
+			combine: "merge",
+			...override
+		}))];
+		if (configToInclude.showFound !== void 0) config.showFound = configToInclude.showFound;
+	}
+};
+//#endregion
+//#region ../src/js/markdownlint/utils/module.ts
+/**
+* @internal @brnshkr/config/markdownlint
+*/
+const MODULES = {
+	github: {
+		name: "github",
+		packages: { requiredAll: [MARKDOWNLINT_PACKAGES.MARKDOWNLINT_GITHUB] }
+	},
+	links: {
+		name: "links",
+		packages: { requiredAny: [MARKDOWNLINT_PACKAGES.MARKDOWNLINT_RULE_RELATIVE_LINKS, MARKDOWNLINT_PACKAGES.MARKDOWNLINT_RULE_NO_TRAILING_SLASH_IN_LINKS] }
+	},
+	search: {
+		name: "search",
+		packages: { requiredAll: [MARKDOWNLINT_PACKAGES.MARKDOWNLINT_RULE_SEARCH_REPLACE] }
+	},
+	style: {
+		name: "style",
+		packages: { requiredAll: [MARKDOWNLINT_PACKAGES.MARKDOWNLINT_RULES] }
+	},
+	tables: {
+		name: "tables",
+		packages: { requiredAll: [MARKDOWNLINT_PACKAGES.MARKDOWNLINT_RULE_TABLE_FORMAT] }
+	}
+};
+const resolvePackages = resolvePackagesSharedSynchronously;
+const { isModuleEnabled, setModuleEnabled } = createModuleState();
+//#endregion
+//#region ../src/js/markdownlint/configs/github.ts
+/**
+* @internal @brnshkr/config/markdownlint
+*/
+const github = () => {
+	const { requiredAll: [isMarkdownlintGithubInstalled] } = resolvePackages(MODULES.github);
+	if (!isMarkdownlintGithubInstalled) return [];
+	return [{
+		customRules: [resolveCustomRule(MARKDOWNLINT_PACKAGES.MARKDOWNLINT_GITHUB)],
+		config: { "no-empty-alt-text": true }
+	}];
+};
+//#endregion
+//#region ../src/js/markdownlint/configs/ignores.ts
+/**
+* @internal @brnshkr/config/markdownlint
+*/
+const ignores = () => [{
+	gitignore: true,
+	ignores: GLOB_IGNORES
+}];
+//#endregion
+//#region ../src/js/markdownlint/configs/links.ts
+/**
+* @internal @brnshkr/config/markdownlint
+*/
+const NO_TRAILING_SLASH_IN_LINKS_RULE = `${MARKDOWNLINT_PACKAGES.MARKDOWNLINT_RULE_NO_TRAILING_SLASH_IN_LINKS}/src/no-trailing-slash-in-links.js`;
+const links = () => {
+	const { requiredAny: [isMarkdownlintRuleRelativeLinksInstalled, isMarkdownlintRuleNoTrailingSlashInLinksInstalled] } = resolvePackages(MODULES.links);
+	const customRules = [...isMarkdownlintRuleRelativeLinksInstalled ? [MARKDOWNLINT_PACKAGES.MARKDOWNLINT_RULE_RELATIVE_LINKS] : [], ...isMarkdownlintRuleNoTrailingSlashInLinksInstalled ? [NO_TRAILING_SLASH_IN_LINKS_RULE] : []];
+	if (customRules.length === 0) return [];
+	return [{
+		customRules: customRules.map((id) => resolveCustomRule(id)),
+		config: { ...isMarkdownlintRuleRelativeLinksInstalled ? { "relative-links": { root_path: "." } } : void 0 }
+	}];
+};
+//#endregion
+//#region ../src/js/markdownlint/utils/constants.ts
+/**
+* @internal @brnshkr/config/markdownlint
+*/
+const TABLE_STYLE = "compact";
+//#endregion
+//#region ../src/js/markdownlint/configs/markdown.ts
+/**
+* @internal @brnshkr/config/markdownlint
+*/
+const markdown = () => [{ config: {
+	default: true,
+	"code-block-style": { style: "fenced" },
+	"code-fence-style": { style: "backtick" },
+	"emphasis-style": { style: "underscore" },
+	"heading-style": { style: "atx" },
+	"hr-style": { style: "---" },
+	"line-length": {
+		line_length: 120,
+		code_blocks: false,
+		headings: false,
+		tables: false
+	},
+	"no-duplicate-heading": { siblings_only: true },
+	"no-inline-html": { allowed_elements: [
+		"a",
+		"br",
+		"dd",
+		"del",
+		"details",
+		"div",
+		"dl",
+		"dt",
+		"h1",
+		"img",
+		"ins",
+		"kbd",
+		"p",
+		"q",
+		"rp",
+		"rt",
+		"ruby",
+		"samp",
+		"sub",
+		"summary",
+		"sup",
+		"var"
+	] },
+	"ol-prefix": { style: "ordered" },
+	"strong-style": { style: "asterisk" },
+	"table-column-style": { style: TABLE_STYLE },
+	"table-pipe-style": { style: "leading_and_trailing" },
+	"ul-style": { style: "dash" }
+} }, { overrides: [{
+	filter: [
+		"**/.github/PULL_REQUEST_TEMPLATE.md",
+		"**/.github/ISSUE_TEMPLATE/**",
+		"**/profile/README.md",
+		"**/AGENTS.md",
+		"**/CLAUDE.md"
+	],
+	config: { "first-line-heading": { allow_preamble: true } }
+}, {
+	filter: ["**/README.md"],
+	config: { "heading-sentence-case": false }
+}] }];
+//#endregion
+//#region ../src/js/markdownlint/configs/search.ts
+/**
+* @internal @brnshkr/config/markdownlint
+*/
+const RULES = [
+	{
+		name: "ellipsis",
+		message: "Use an ellipsis rather than three dots.",
+		searchPattern: String.raw`/(?<!\]\([^)]*)\.\.\./gu`,
+		replace: "…",
+		searchScope: "text"
+	},
+	{
+		name: "em-dash",
+		message: "Use an em dash rather than two hyphens.",
+		searchPattern: "/(?<= )--(?= )/gu",
+		replace: "—",
+		searchScope: "text"
+	},
+	{
+		name: "https",
+		message: "Link over `https`.",
+		searchPattern: String.raw`/http:\/\/(?!(?:www\.)?w3\.org\/|localhost|127\.0\.0\.1)/gu`,
+		replace: "https://",
+		searchScope: "text"
+	},
+	{
+		name: "no-non-breaking-space",
+		message: "Use a regular space.",
+		searchPattern: String.raw`/\u00A0/gu`,
+		replace: " ",
+		searchScope: "all"
+	},
+	{
+		name: "no-todo-comments",
+		message: "Open work belongs in a backlog, not in a comment.",
+		searchPattern: String.raw`/\b(?:TODO|FIXME|XXX|HACK)\b/gu`,
+		searchScope: "text"
+	},
+	{
+		name: "no-zero-width-characters",
+		message: "Remove the zero-width character.",
+		searchPattern: String.raw`/[\u200B-\u200D\uFEFF]/gu`,
+		replace: "",
+		searchScope: "all"
+	},
+	{
+		name: "relative-link-prefix",
+		message: "Prefix a relative link with `./`.",
+		searchPattern: String.raw`/\]\((?![.#/]|[a-z][a-z0-9+.-]*:)/gu`,
+		replace: "](./",
+		searchScope: "text"
+	},
+	{
+		name: "scoped-package-names",
+		message: "Name an organization package by its scope.",
+		searchPattern: String.raw`/(?<![\w/@])brnshkr\/(?=[a-z])/gu`,
+		replace: "@brnshkr/",
+		searchScope: "text"
+	},
+	{
+		name: "straight-double-quotes",
+		message: "Use straight double quotes.",
+		searchPattern: "/[“”]/gu",
+		replace: "\"",
+		searchScope: "text"
+	},
+	{
+		name: "straight-single-quotes",
+		message: "Use straight single quotes.",
+		searchPattern: "/[‘’]/gu",
+		replace: "'",
+		searchScope: "text"
+	},
+	{
+		name: "tool-names",
+		message: "Spell a tool the way its own project spells it.",
+		search: [
+			"Javascript",
+			"Typescript",
+			"Github",
+			"Gitlab",
+			"Eslint",
+			"StyleLint",
+			"Markdownlint",
+			"Commitlint",
+			"Phpstan",
+			"PHPstan",
+			"Phpunit",
+			"PHPunit",
+			"VSCode",
+			"Vscode",
+			"Nodejs"
+		],
+		replace: [
+			"JavaScript",
+			"TypeScript",
+			"GitHub",
+			"GitLab",
+			"ESLint",
+			"Stylelint",
+			"markdownlint",
+			"commitlint",
+			"PHPStan",
+			"PHPStan",
+			"PHPUnit",
+			"PHPUnit",
+			"VS Code",
+			"VS Code",
+			"Node.js"
+		],
+		searchScope: "text"
+	}
+];
+const search = () => {
+	const { requiredAll: [isMarkdownlintRuleSearchReplaceInstalled] } = resolvePackages(MODULES.search);
+	if (!isMarkdownlintRuleSearchReplaceInstalled) return [];
+	return [{
+		customRules: [resolveCustomRule(MARKDOWNLINT_PACKAGES.MARKDOWNLINT_RULE_SEARCH_REPLACE)],
+		config: { "search-replace": { rules: RULES } }
+	}];
+};
+//#endregion
+//#region ../src/js/markdownlint/configs/style.ts
+/**
+* @internal @brnshkr/config/markdownlint
+*/
+const style = () => {
+	const { requiredAll: [isMarkdownlintRulesInstalled] } = resolvePackages(MODULES.style);
+	if (!isMarkdownlintRulesInstalled) return [];
+	return [{
+		customRules: [resolveCustomRule(MARKDOWNLINT_PACKAGES.MARKDOWNLINT_RULES)],
+		config: {
+			"list-item-marker-space": false,
+			"fenced-code-fence-length": false,
+			"reference-link-section-placement": false,
+			"heading-sentence-case": { allowed_words: [
+				"Composer",
+				"Doctrine",
+				"ESLint",
+				"Laravel",
+				"Makefile",
+				"PHPStan",
+				"PHPUnit",
+				"Pest",
+				"Rector",
+				"Stylelint",
+				"Symfony",
+				"Tempest",
+				"Twig",
+				"Xdebug"
+			] }
+		}
+	}];
+};
+//#endregion
+//#region ../src/js/markdownlint/configs/tables.ts
+/**
+* @internal @brnshkr/config/markdownlint
+*/
+const tables = () => {
+	const { requiredAll: [isMarkdownlintRuleTableFormatInstalled] } = resolvePackages(MODULES.tables);
+	if (!isMarkdownlintRuleTableFormatInstalled) return [];
+	return [{
+		customRules: [resolveCustomRule(MARKDOWNLINT_PACKAGES.MARKDOWNLINT_RULE_TABLE_FORMAT)],
+		config: { "table-format": { style: TABLE_STYLE } }
+	}];
+};
+//#endregion
+//#region ../src/js/markdownlint/configs/index.ts
+/**
+* @internal @brnshkr/config/markdownlint
+*/
+const configs = {
+	github,
+	ignores,
+	links,
+	markdown,
+	search,
+	style,
+	tables
+};
+//#endregion
+//#region ../src/js/markdownlint/index.ts
+/**
+* Build the `@brnshkr` markdownlint config object.
+*
+* The result is the shape `markdownlint-cli2` reads rather than the plain rule set, because `ignores` and
+* `globs` exist only at that level — which is why a consumer needs a config file of its own instead of
+* extending a shared rule set.
+*
+* @api
+*
+* @param optionsAndGlobalConfig per-module toggles and global markdownlint-cli2 fields merged with the defaults
+* @param additionalConfigs extra config entries merged after the built-in ones
+*
+* @returns final config ready to be consumed by markdownlint-cli2
+*
+* @see https://github.com/brnshkr/config/blob/master/docs/js/markdownlint.md
+*
+* @example
+* ```js
+* import { getConfig } from '@brnshkr/config/markdownlint';
+*
+* getConfig(undefined);
+* getConfig({});
+*
+* getConfig({
+*   links: false,
+*   ignores: ['CHANGELOG.md'],
+* }, {
+*   config: { 'no-bare-urls': false },
+* });
+* ```
+*/
+const getConfig = (optionsAndGlobalConfig, ...additionalConfigs) => {
+	const resolvedOptions = {
+		github: isModuleEnabledByDefault(MODULES.github),
+		links: isModuleEnabledByDefault(MODULES.links),
+		search: isModuleEnabledByDefault(MODULES.search),
+		style: isModuleEnabledByDefault(MODULES.style),
+		tables: isModuleEnabledByDefault(MODULES.tables),
+		...optionsAndGlobalConfig
+	};
+	setModuleEnabled(MODULES.github, resolvedOptions.github);
+	setModuleEnabled(MODULES.links, resolvedOptions.links);
+	setModuleEnabled(MODULES.search, resolvedOptions.search);
+	setModuleEnabled(MODULES.style, resolvedOptions.style);
+	setModuleEnabled(MODULES.tables, resolvedOptions.tables);
+	const config = {};
+	includeConfigs(config, configs.ignores());
+	if (isModuleEnabled(MODULES.github)) includeConfigs(config, configs.github());
+	if (isModuleEnabled(MODULES.links)) includeConfigs(config, configs.links());
+	if (isModuleEnabled(MODULES.search)) includeConfigs(config, configs.search());
+	if (isModuleEnabled(MODULES.style)) includeConfigs(config, configs.style());
+	if (isModuleEnabled(MODULES.tables)) includeConfigs(config, configs.tables());
+	includeConfigs(config, configs.markdown());
+	includeConfigs(config, getUserConfigs(resolvedOptions, additionalConfigs));
+	return config;
+};
+/**
+* Default-exported pre-built config for direct re-export from a Markdownlint config file.
+*
+* @api
+*/
+var markdownlint_default = getConfig();
+//#endregion
+export { markdownlint_default as default, getConfig };