@joshuafolkken/kit 1.872.0

package/scripts/init/init-logic-sonar.ts

@@ -0,0 +1,197 @@
+const SONAR_PROJECT_KEY_PLACEHOLDER = '{{PROJECT_KEY}}'
+const SONAR_ORGANIZATION_PLACEHOLDER = '{{ORGANIZATION}}'
+const SONAR_TEMPLATE_SRC = 'templates/sonar-project.properties'
+const SONAR_TEMPLATE_DEST = 'sonar-project.properties'
+const PROPERTY_LINE_PATTERN = /^([\w.]+)=/u
+const MULTICRITERIA_KEY = 'sonar.issue.ignore.multicriteria'
+const MULTICRITERIA_LINE_PATTERN = /^sonar\.issue\.ignore\.multicriteria=(.*)$/mu
+
+interface SonarIdentifiers {
+	project_key: string
+	organization: string
+}
+
+function apply_sonar_template(content: string, project_key: string, organization: string): string {
+	return content
+		.replaceAll(SONAR_PROJECT_KEY_PLACEHOLDER, () => project_key)
+		.replaceAll(SONAR_ORGANIZATION_PLACEHOLDER, () => organization)
+}
+
+function derive_sonar_identifiers(name_with_owner: string): SonarIdentifiers {
+	const [organization, repository, ...extra] = name_with_owner.trim().split('/')
+
+	if (!organization || !repository || extra.length > 0) {
+		throw new Error(`Invalid GitHub repository nameWithOwner: ${name_with_owner}`)
+	}
+
+	return {
+		organization,
+		project_key: `${organization}_${repository}`,
+	}
+}
+
+function get_sonar_template_source(): string {
+	return SONAR_TEMPLATE_SRC
+}
+
+function get_sonar_template_destination(): string {
+	return SONAR_TEMPLATE_DEST
+}
+
+function extract_properties_keys(content: string): Set<string> {
+	const keys = new Set<string>()
+
+	for (const line of content.split('\n')) {
+		const match = PROPERTY_LINE_PATTERN.exec(line)
+		if (match?.[1] !== undefined) keys.add(match[1])
+	}
+
+	return keys
+}
+
+function get_multicriteria_value(content: string): string | undefined {
+	return MULTICRITERIA_LINE_PATTERN.exec(content)?.[1]
+}
+
+function get_multicriteria_ids(content: string): Array<string> {
+	return (get_multicriteria_value(content) ?? '')
+		.split(',')
+		.map((id) => id.trim())
+		.filter(Boolean)
+}
+
+function get_property_value(content: string, key: string): string | undefined {
+	return content
+		.split('\n')
+		.find((line) => line.startsWith(`${key}=`))
+		?.slice(key.length + 1)
+}
+
+function has_criterion_conflict(existing: string, template: string, id: string): boolean {
+	return ['ruleKey', 'resourceKey'].some((field) => {
+		const key = `${MULTICRITERIA_KEY}.${id}.${field}`
+		const existing_value = get_property_value(existing, key)
+		const template_value = get_property_value(template, key)
+
+		return (
+			existing_value !== undefined &&
+			template_value !== undefined &&
+			existing_value !== template_value
+		)
+	})
+}
+
+function criterion_matches(
+	existing: string,
+	template: string,
+	existing_id: string,
+	template_id: string,
+): boolean {
+	const template_prefix = `${MULTICRITERIA_KEY}.${template_id}`
+	const existing_prefix = `${MULTICRITERIA_KEY}.${existing_id}`
+	const rule = get_property_value(template, `${template_prefix}.ruleKey`)
+	const resource = get_property_value(template, `${template_prefix}.resourceKey`)
+	if (rule === undefined || resource === undefined) return false
+
+	return (
+		rule === get_property_value(existing, `${existing_prefix}.ruleKey`) &&
+		resource === get_property_value(existing, `${existing_prefix}.resourceKey`)
+	)
+}
+
+function allocate_criterion_id(used_ids: Set<string>): string {
+	let next_index = 1
+
+	for (const id of used_ids) {
+		const numeric_id = /^e(\d+)$/u.exec(id)?.[1]
+		if (numeric_id !== undefined) next_index = Math.max(next_index, Number(numeric_id) + 1)
+	}
+
+	return `e${next_index.toString()}`
+}
+
+function rename_criterion(template: string, id: string, replacement_id: string): string {
+	const ids = get_multicriteria_ids(template).map((entry) =>
+		entry === id ? replacement_id : entry,
+	)
+	const updated_list = template.replace(
+		MULTICRITERIA_LINE_PATTERN,
+		() => `${MULTICRITERIA_KEY}=${ids.join(',')}`,
+	)
+
+	return updated_list.replaceAll(
+		`${MULTICRITERIA_KEY}.${id}.`,
+		() => `${MULTICRITERIA_KEY}.${replacement_id}.`,
+	)
+}
+
+function find_matching_criterion(
+	existing: string,
+	template: string,
+	ids: Array<string>,
+	id: string,
+): string | undefined {
+	return ids.find((candidate) => criterion_matches(existing, template, candidate, id))
+}
+
+function resolve_multicriteria_conflicts(existing: string, template: string): string {
+	const existing_ids = get_multicriteria_ids(existing)
+	const template_ids = get_multicriteria_ids(template)
+	const reusable_ids = existing_ids.filter((id) => !template_ids.includes(id))
+	let resolved = template
+
+	for (const id of template_ids) {
+		if (!existing_ids.includes(id) || !has_criterion_conflict(existing, resolved, id)) continue
+		const matching_id = find_matching_criterion(existing, resolved, reusable_ids, id)
+		const replacement_id =
+			matching_id ??
+			allocate_criterion_id(new Set([...existing_ids, ...get_multicriteria_ids(resolved)]))
+
+		resolved = rename_criterion(resolved, id, replacement_id)
+	}
+
+	return resolved
+}
+
+function merge_multicriteria_ids(existing: string, template_content: string): string {
+	const existing_value = get_multicriteria_value(existing)
+	if (existing_value === undefined) return existing
+	const template_value = get_multicriteria_value(template_content)
+	if (template_value === undefined) return existing
+
+	const existing_ids = get_multicriteria_ids(existing)
+	const template_ids = get_multicriteria_ids(template_content)
+	const merged_ids = [...new Set([...existing_ids, ...template_ids])]
+	if (merged_ids.join(',') === existing_value) return existing
+
+	return existing.replace(
+		MULTICRITERIA_LINE_PATTERN,
+		() => `${MULTICRITERIA_KEY}=${merged_ids.join(',')}`,
+	)
+}
+
+function merge_sonar_properties(existing: string, template_content: string): string {
+	const resolved_template = resolve_multicriteria_conflicts(existing, template_content)
+	const merged_existing = merge_multicriteria_ids(existing, resolved_template)
+	const existing_keys = extract_properties_keys(merged_existing)
+	const lines_to_add = resolved_template.split('\n').filter((line) => {
+		const key = PROPERTY_LINE_PATTERN.exec(line)?.[1]
+
+		return key !== undefined && !existing_keys.has(key)
+	})
+	if (lines_to_add.length === 0) return merged_existing
+	const normalized = merged_existing.endsWith('\n') ? merged_existing : `${merged_existing}\n`
+
+	return `${normalized}\n${lines_to_add.join('\n')}\n`
+}
+
+const init_logic_sonar = {
+	apply_sonar_template,
+	derive_sonar_identifiers,
+	get_sonar_template_source,
+	get_sonar_template_destination,
+	merge_sonar_properties,
+}
+
+export { init_logic_sonar }
+export type { SonarIdentifiers }

package/scripts/init/init-logic-templates.ts

@@ -0,0 +1,142 @@
+import { readFileSync } from 'node:fs'
+import { package_path } from './init-paths'
+
+const ESLINT_VANILLA = `import { create_vanilla_config } from '@joshuafolkken/kit/eslint/vanilla'
+
+export default create_vanilla_config({
+\tgitignore_path: new URL('./.gitignore', import.meta.url),
+\ttsconfig_root_dir: import.meta.dirname,
+})
+`
+
+const DEFAULT_TAILWIND_STYLESHEET = './src/routes/layout.css'
+const TAILWIND_STYLESHEET_PATTERN = /tailwindStylesheet"?:\s*['"]([^'"]+)['"]/u
+
+const KIT_ESLINT_IMPORT_MARKER = '@joshuafolkken/kit/eslint/'
+const VANILLA_ESLINT_MARKERS: ReadonlyArray<string> = [
+	'js.configs.recommended',
+	'ts.configs.recommended',
+	'svelte.configs.recommended',
+]
+const RULES_BLOCK_PATTERN = /rules\s*:\s*\{/gu
+const RULES_INDENT_DEPTH = 3
+const RULES_INDENT = '\t'.repeat(RULES_INDENT_DEPTH)
+
+const PLAYWRIGHT_TEMPLATE_PATH = package_path('playwright.config.ts')
+
+const VANILLA_WITH_RULES_TPL = `import { create_vanilla_config } from '@joshuafolkken/kit/eslint/vanilla'
+
+export default [
+\t...create_vanilla_config({
+\t\tgitignore_path: new URL('./.gitignore', import.meta.url),
+\t\ttsconfig_root_dir: import.meta.dirname,
+\t}),
+\t{
+\t\trules: {
+$RULES
+\t\t},
+\t},
+]
+`
+
+const RULES_PLACEHOLDER = '$RULES'
+const NOT_FOUND = -1
+
+function generate_eslint_config(): string {
+	return ESLINT_VANILLA
+}
+
+function is_vanilla_eslint_config(existing: string): boolean {
+	if (existing.includes(KIT_ESLINT_IMPORT_MARKER)) return false
+
+	return VANILLA_ESLINT_MARKERS.some((marker) => existing.includes(marker))
+}
+
+function update_brace_depth(char: string | undefined, depth: number): number {
+	if (char === '{') return depth + 1
+	if (char === '}') return depth - 1
+
+	return depth
+}
+
+function find_matching_close_brace(source: string, open_index: number): number {
+	let depth = 0
+
+	for (let index = open_index; index < source.length; index += 1) {
+		depth = update_brace_depth(source[index], depth)
+		if (depth === 0 && source[index] === '}') return index
+	}
+
+	return NOT_FOUND
+}
+
+function extract_block_from_open(source: string, open_index: number): string | undefined {
+	const close = find_matching_close_brace(source, open_index)
+	if (close === NOT_FOUND) return undefined
+	const inner = source.slice(open_index + 1, close).trim()
+
+	return inner.length > 0 ? inner : undefined
+}
+
+function extract_rules_inner_blocks(existing: string): ReadonlyArray<string> {
+	const blocks: Array<string> = []
+
+	for (const match of existing.matchAll(RULES_BLOCK_PATTERN)) {
+		const open = match.index + match[0].length - 1
+		const inner = extract_block_from_open(existing, open)
+		if (inner !== undefined) blocks.push(inner)
+	}
+
+	return blocks
+}
+
+function indent_block(text: string, indent: string): string {
+	return text
+		.split('\n')
+		.map((line) => (line.length === 0 ? line : `${indent}${line.trimStart()}`))
+		.join('\n')
+}
+
+function apply_rules_template(rules_body: string): string {
+	const rules_block = indent_block(rules_body, RULES_INDENT)
+
+	return VANILLA_WITH_RULES_TPL.replace(RULES_PLACEHOLDER, () => rules_block)
+}
+
+function merge_eslint_config(existing: string): string {
+	if (!is_vanilla_eslint_config(existing)) return existing
+	const rules_blocks = extract_rules_inner_blocks(existing)
+	if (rules_blocks.length === 0) return generate_eslint_config()
+
+	return apply_rules_template(rules_blocks.join(',\n'))
+}
+
+function generate_prettier_config(stylesheet: string = DEFAULT_TAILWIND_STYLESHEET): string {
+	return `import { config } from '@joshuafolkken/kit/prettier'
+
+export default {
+\t...config,
+\ttailwindStylesheet: '${stylesheet}',
+}
+`
+}
+
+function merge_prettier_config(existing: string): string {
+	const match = TAILWIND_STYLESHEET_PATTERN.exec(existing)
+
+	return generate_prettier_config(match?.[1] ?? DEFAULT_TAILWIND_STYLESHEET)
+}
+
+function generate_playwright_config(): string {
+	return readFileSync(PLAYWRIGHT_TEMPLATE_PATH, 'utf8')
+}
+
+const init_logic_templates = {
+	generate_eslint_config,
+	merge_eslint_config,
+	generate_prettier_config,
+	merge_prettier_config,
+	generate_playwright_config,
+}
+
+export { init_logic_templates }

package/scripts/init/init-logic-workspace.ts

@@ -0,0 +1,59 @@
+function extract_yaml_top_level_keys(content: string): Array<string> {
+	return content.split('\n').flatMap((line) => {
+		const key = /^([a-zA-Z][a-zA-Z0-9_-]*):/u.exec(line)?.[1]
+
+		return key ? [key] : []
+	})
+}
+
+function extract_yaml_block(content: string, key: string): string {
+	const pattern = new RegExp(String.raw`(^${key}:[^\n]*\n(?:(?:[ \t][^\n]*|)\n)*)`, 'mu')
+
+	return pattern.exec(content)?.[1]?.trimEnd() ?? ''
+}
+
+function append_user_blocks(base: string, user_keys: Array<string>, existing: string): string {
+	const user_blocks = user_keys
+		.map((k) => extract_yaml_block(existing, k))
+		.filter(Boolean)
+		.join('\n')
+	const normalized = base.endsWith('\n') ? base : `${base}\n`
+
+	return `${normalized}\n${user_blocks}\n`
+}
+
+const DEPRECATED_KEYS = new Set(['onlyBuiltDependencies'])
+
+function remove_deprecated_yaml_key(content: string, key: string): string {
+	const block = extract_yaml_block(content, key)
+	if (block.length === 0) return content
+	const removed = content.replaceAll(`${block}\n`, '')
+
+	return removed.replaceAll(/\n{3,}/gu, '\n\n')
+}
+
+function remove_deprecated_yaml_keys(content: string): string {
+	let result = content
+
+	for (const key of DEPRECATED_KEYS) {
+		result = remove_deprecated_yaml_key(result, key)
+	}
+
+	return `${result.trimEnd()}\n`
+}
+
+function merge_workspace_yaml(existing: string, template: string): string {
+	if (!existing.trim()) return template
+	const normalized = existing.endsWith('\n') ? existing : `${existing}\n`
+	const without_deprecated = remove_deprecated_yaml_keys(normalized)
+	if (!without_deprecated.trim()) return template
+	const existing_keys = new Set(extract_yaml_top_level_keys(without_deprecated))
+	const new_keys = extract_yaml_top_level_keys(template).filter((k) => !existing_keys.has(k))
+	if (new_keys.length === 0) return without_deprecated
+
+	return append_user_blocks(without_deprecated, new_keys, template)
+}
+
+const init_logic_workspace = { merge_workspace_yaml }
+
+export { init_logic_workspace }

package/scripts/init/init-logic-yaml-merge.ts

@@ -0,0 +1,57 @@
+import { config_merge } from '#scripts/config-merge/index'
+import { kit_base_preset } from './kit-base-preset'
+
+const CSPELL_IMPORT_FIELD = 'import'
+const LEFTHOOK_EXTENDS_FIELD = 'extends'
+// cspell config places the `import` block right after the `version` line; emit double-quoted
+// scalars so the output matches what the VSCode cspell extension writes, avoiding quote churn.
+const CSPELL_IMPORT_POSITION = { after: 'version' } as const
+const CSPELL_QUOTE_STYLE = 'double' as const
+
+// Add `value` to a YAML list field (creating it at the front when absent), preserving the other
+// keys. Thin wrapper over the shared config-merge library so the ensure semantics are single-
+// sourced; kept for the lefthook `extends` caller whose new field goes to the front of the file.
+function merge_yaml_list_entry(content: string, key: string, value: string): string {
+	return config_merge.patch_yaml_list_field(content, {
+		field: key,
+		ensure: [value],
+		position: 'front',
+	})
+}
+
+// Ensure kit's lefthook base preset is in the `extends` list — UNLESS an `@joshuafolkken/*`
+// lefthook preset (kit's own, or an app-kit / game-kit framework preset that already extends kit
+// base) is present. Adding kit's `vanilla.yml` alongside such a preset would extend
+// `lefthook/base.yml` twice, which lefthook rejects with a hard "possible recursion in extends"
+// crash. See joshuafolkken/kit#660.
+function merge_lefthook_extends(content: string, value: string): string {
+	const entries = config_merge.read_yaml_list_field(content, LEFTHOOK_EXTENDS_FIELD)
+	if (kit_base_preset.is_lefthook_base_present(entries)) return content
+
+	return merge_yaml_list_entry(content, LEFTHOOK_EXTENDS_FIELD, value)
+}
+
+// Ensure kit's base dictionary is in the cspell `import` list — UNLESS an `@joshuafolkken/*` cspell
+// preset (kit's own base, or an app-kit / game-kit framework preset that already imports kit's
+// cspell base) is present. Adding kit's base alongside such a preset is a redundant double import.
+// kit owns this dedup because there is no downstream overlay in kit's `josh sync` path — every
+// consumer drives the sync through kit's CLI, so the check must live here. See joshuafolkken/kit#660.
+function merge_cspell_import(content: string, value: string): string {
+	const entries = config_merge.read_yaml_list_field(content, CSPELL_IMPORT_FIELD)
+	if (kit_base_preset.is_cspell_base_present(entries)) return content
+
+	return config_merge.patch_yaml_list_field(content, {
+		field: CSPELL_IMPORT_FIELD,
+		ensure: [value],
+		position: CSPELL_IMPORT_POSITION,
+		quote_style: CSPELL_QUOTE_STYLE,
+	})
+}
+
+const init_logic_yaml_merge = {
+	merge_yaml_list_entry,
+	merge_lefthook_extends,
+	merge_cspell_import,
+}
+
+export { init_logic_yaml_merge }