@cherepanov.pavel/shareable-config 2.0.6 → 2.0.8

package/.gitignore-get.js

@@ -72,5 +72,5 @@ try {
 		fileLabel: fileName,
 	});
 } catch (err) {
-	console.error("Ошибка:", err.message);
+	console.error(err.message);
 }

package/.vscode/.code-snippets-get.js

@@ -22,6 +22,10 @@ import {
 import {
 	eslintFiles,
 } from "../modules/shared/utils/lint.js";
+import {
+	getRecreatedMessage,
+	getUpdatedWithOverrideMessage,
+} from "../modules/shared/utils/messages.js";
 
 const fileNames = [
 	"vue.code-snippets",
@@ -59,11 +63,11 @@ try {
 		await outputFile(destFile, `${getHeader()}${result}`);
 		await eslintFiles(destFile);
 		if (isDestFileHaveOverride) {
-			console.info(`${fileName} обновлён с учётом override`);
+			console.info(getUpdatedWithOverrideMessage(fileName));
 		} else {
-			console.info(`${fileName} пересоздан`);
+			console.info(getRecreatedMessage(fileName));
 		}
 	});
 } catch (err) {
-	console.error("Ошибка:", err.message);
+	console.error(err.message);
 }

package/.vscode/extensions.json

@@ -7,9 +7,10 @@
 		// typescript
 		"yoavbls.pretty-ts-errors",
 		"vue.volar",
-		"ms-azuretools.vscode-containers",
-		// "redhat.vscode-yaml",
+		// astro
+		"astro-build.astro-vscode",
 		"savh.json5-kit",
+		"ms-azuretools.vscode-containers",
 
 		"editorconfig.editorconfig",
 		"dbaeumer.vscode-eslint",

package/.vscode/extensions.json-get.js

@@ -22,6 +22,10 @@ import {
 import {
 	eslintFiles,
 } from "../modules/shared/utils/lint.js";
+import {
+	getRecreatedMessage,
+	getUpdatedWithOverrideMessage,
+} from "../modules/shared/utils/messages.js";
 
 const fileName = "extensions.json";
 const destFile = path.join(process.cwd(), `.vscode/${fileName}`);
@@ -29,11 +33,13 @@ const destFile = path.join(process.cwd(), `.vscode/${fileName}`);
 try {
 	const {
 		isRepositoryUseTypescript: isTs,
+		repositoryFramework,
 	} = await getEnvs();
 	const srcFile = path.join(import.meta.dirname, fileName);
 	const srcFileData = await getSrcJSONFileData({
 		fileData: await readFile(srcFile, "utf8"),
 		isTs,
+		repositoryFramework,
 	});
 	let overrideContent;
 	try {
@@ -51,10 +57,10 @@ try {
 	await outputFile(destFile, `${getHeader()}${result}`);
 	await eslintFiles(destFile);
 	if (overrideContent) {
-		console.info(`${fileName} обновлён с учётом override`);
+		console.info(getUpdatedWithOverrideMessage(fileName));
 	} else {
-		console.info(`${fileName} пересоздан`);
+		console.info(getRecreatedMessage(fileName));
 	}
 } catch (err) {
-	console.error("Ошибка:", err.message);
+	console.error(err.message);
 }

package/.vscode/settings.json

@@ -49,4 +49,17 @@
 		"vue",
 	],
 	"cSpell.language": "en,ru",
+	"cSpell.words": [
+		"cherepanov",
+		"nuxt",
+		"pavel",
+	],
+	"cSpell.customDictionaries": {
+		"project-words": {
+			"name": "project-words",
+			"path": "./project-words.md",
+			"description": "Words used in this project",
+			"addWords": true,
+		},
+	},
 }

package/.vscode/settings.json-get.js

@@ -22,6 +22,10 @@ import {
 import {
 	eslintFiles,
 } from "../modules/shared/utils/lint.js";
+import {
+	getRecreatedMessage,
+	getUpdatedWithOverrideMessage,
+} from "../modules/shared/utils/messages.js";
 
 const fileName = "settings.json";
 const destFile = path.join(process.cwd(), `.vscode/${fileName}`);
@@ -51,10 +55,10 @@ try {
 	await outputFile(destFile, `${getHeader()}${result}`);
 	await eslintFiles(destFile);
 	if (overrideContent) {
-		console.info(`${fileName} обновлён с учётом override`);
+		console.info(getUpdatedWithOverrideMessage(fileName));
 	} else {
-		console.info(`${fileName} пересоздан`);
+		console.info(getRecreatedMessage(fileName));
 	}
 } catch (err) {
-	console.error("Ошибка:", err.message);
+	console.error(err.message);
 }

package/README.md

@@ -185,6 +185,12 @@ After:
 
 ---
 
+## cSpell
+
+When using cSpell, add project-specific words to `project-words.md` in your project root (one word per line), not to `cSpell.words` in your user or workspace settings. The generated `.vscode/settings.json` configures cSpell to use this shared project dictionary. If you use the quick-fix context menu, choose **Add "word" to dictionary: project-words**.
+
+---
+
 ## Summary
 
 Use this repository as a single source for configs.

package/modules/shared/utils/communication.js

@@ -13,16 +13,21 @@ export async function askTypescript() {
 }
 
 export async function askFramework() {
+	const options = (
+		Object.values(supportedFrameworks)
+		.map((value) => {
+			return {
+				value,
+			};
+		})
+	);
+	options.push({
+		value: "",
+		label: "None of the listed ones (copy only the framework-less)",
+	});
 	return unwrapPrompt(select({
 		message: "Which framework do you use?",
-		options: (
-			Object.values(supportedFrameworks)
-			.map((value) => {
-				return {
-					value,
-				};
-			})
-		),
+		options,
 	}));
 }
 

package/modules/shared/utils/copy-with-override.js

@@ -7,6 +7,10 @@ import {
 import {
 	outputFile,
 } from "fs-extra";
+import {
+	getRecreatedMessage,
+	getUpdatedWithOverrideMessage,
+} from "./messages.js";
 
 export async function copyFile({
 	destFile, srcFileData, fileLabel,
@@ -16,7 +20,7 @@ export async function copyFile({
 		await readFile(destFile, "utf8");
 	} catch {
 		await outputFile(destFile, `${getHeader("#")}${srcFileData}`);
-		console.info(`${fileLabel} пересоздан`);
+		console.info(getRecreatedMessage(fileLabel));
 		return {
 		};
 	}
@@ -28,7 +32,7 @@ export async function copyFile({
 	const match = destFileData.match(overrideRegex);
 	if (!match) {
 		await outputFile(destFile, `${getHeader("#")}${srcFileData}`);
-		console.info(`${fileLabel} пересоздан`);
+		console.info(getRecreatedMessage(fileLabel));
 		return {
 		};
 	}
@@ -59,7 +63,7 @@ export async function copyWithOverride({
 		const newContent = `${srcFileData.trimEnd()}\n\n${preserved.trimStart()}`;
 
 		await outputFile(destFile, `${getHeader("#")}${newContent}`);
-		console.info(`${fileLabel} обновлён с учётом override`);
+		console.info(getUpdatedWithOverrideMessage(fileLabel));
 	} catch (err) {
 		console.error(`Ошибка копирования ${fileLabel}:`, err.message);
 	}

package/modules/shared/utils/file.js

@@ -1,45 +1,63 @@
 import JSON5 from "json5";
+import {
+	supportedFrameworks,
+} from "../constants";
 
 export async function getSrcJSONFileData({
 	fileData,
 	isTs = false,
+	repositoryFramework = "",
 	removeDuplicateKeys = false,
 }) {
-	// Если нет typescript, нет лишних проблем, возвращаем
-	if (!fileData.includes("// typescript")) {
+	const frameworks = Object.values(supportedFrameworks);
+	const markers = [
+		...frameworks,
+		"typescript",
+	];
+	const isFileHaveMarker = markers.some((marker) => {
+		return fileData.includes(`// ${marker}`);
+	});
+	// If there are no typescript and framework comments,
+	// there are no unnecessary problems, we return the source file.
+	if (!isFileHaveMarker) {
 		return fileData;
 	}
 
 	const lines = fileData.split("\n");
-	const result = [];
+	const result = [
+	];
 	let nextLineIsTypescript = false;
 	let nextLineIsTypescriptMultiline = false;
+	let nextLineFramework;
 
 	lines.forEach((line) => {
-		// если следующая строка typescript only
-		if (line.includes("// typescript")) {
-			// если несколько следующих строк typescript only
+		const isLineWithTsComment = line.includes("// typescript");
+		if (isLineWithTsComment) {
 			if (line.includes("// typescript multiline")) {
-				// проверяем это конец multiline typescript комментария, или начало, и в соответствии
-				// с этим ставим флаг
 				nextLineIsTypescriptMultiline = !(line.includes("// typescript multiline end"));
 			} else {
-				nextLineIsTypescript = true; // Следующая строка будет typescript-only
+				nextLineIsTypescript = true;
 			}
-			// флаги проставлены, с этой строкой больше нечего делать, выходим
 			return;
 		}
 
-		if (nextLineIsTypescript || nextLineIsTypescriptMultiline) {
-			// Включаем строку только если нужен typescript
-			if (isTs) {
-				result.push(line);
-			}
-			nextLineIsTypescript = false; // Сбрасываем флаг
-		} else {
-			// Обычная строка - всегда включаем
+		const lineFramework = frameworks.find((framework) => {
+			return line.includes(`// ${framework}`);
+		});
+		if (lineFramework) {
+			nextLineFramework = lineFramework;
+			return;
+		}
+
+		const isTypescriptAllowed = isTs || (!nextLineIsTypescript && !nextLineIsTypescriptMultiline);
+		const isFrameworkAllowed = repositoryFramework === nextLineFramework || !nextLineFramework;
+
+		if (isTypescriptAllowed && isFrameworkAllowed) {
 			result.push(line);
 		}
+
+		nextLineIsTypescript = false;
+		nextLineFramework = undefined;
 	});
 
 	const stringResult = result.join("\n");

package/modules/shared/utils/messages.js

@@ -0,0 +1,7 @@
+export function getUpdatedWithOverrideMessage(fileName) {
+	return `${fileName} updated with override`;
+}
+
+export function getRecreatedMessage(fileName) {
+	return `${fileName} just recreated`;
+}

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@cherepanov.pavel/shareable-config",
 	"description": "setup for new repositories",
-	"version": "2.0.6",
+	"version": "2.0.8",
 	"type": "module",
 	"devEngines": {
 		"packageManager": {