@cherepanov.pavel/shareable-config 1.0.26 → 2.0.1

package/.editorconfig-get.js

@@ -6,7 +6,7 @@ import {
 } from "url";
 import {
 	copyWithOverride,
-} from "./utils/copy-with-override.js";
+} from "./modules/shared/utils/copy-with-override.js";
 import {
 	readFile,
 } from "fs/promises";

package/.gitattributes-get.js

@@ -6,7 +6,7 @@ import {
 } from "url";
 import {
 	copyWithOverride,
-} from "./utils/copy-with-override.js";
+} from "./modules/shared/utils/copy-with-override.js";
 import {
 	readFile,
 } from "fs/promises";

package/.gitignore-get.js

@@ -9,10 +9,10 @@ import {
 } from "fs/promises";
 import {
 	copyWithOverride,
-} from "./utils/copy-with-override.js";
+} from "./modules/shared/utils/copy-with-override.js";
 import {
 	getEnvs,
-} from "./utils/env.js";
+} from "./modules/shared/utils/env.js";
 
 const fileName = ".gitignore";
 const destFile = path.join(process.cwd(), fileName);
@@ -30,12 +30,17 @@ async function getGitignoreFileData(framework) {
 		return commonData.trim();
 	}
 
-	const sections = srcFileData.split(/^#\s*/mu).slice(1);
+	const sections = srcFileData.split(/^#\s*/mu)
+	.slice(1);
 	const matchedSection = sections.find((section) => {
 		const [
 			header,
 		] = section.split("\n");
-		return header.trim().toLowerCase() === framework;
+		return (
+			header
+			.trim()
+			.toLowerCase()
+		) === framework;
 	});
 
 	if (matchedSection) {
@@ -43,7 +48,11 @@ async function getGitignoreFileData(framework) {
 			header,
 			...body
 		] = matchedSection.split("\n");
-		return `${commonData.trim()}\n\n# ${header}\n${body.join("\n").trim()}`.trim();
+		return `${commonData.trim()}\n\n# ${header}\n${
+			body
+			.join("\n")
+			.trim()
+		}`.trim();
 	}
 	// Если не найдено — только общий контент
 	return commonData.trim();

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

@@ -9,19 +9,19 @@ import {
 } from "fs-extra";
 import {
 	mergeWithOverride,
-} from "../utils/merge.js";
+} from "../modules/shared/utils/merge.js";
 import {
 	getHeader,
-} from "../utils/file-header.js";
+} from "../modules/shared/utils/file-header.js";
 import {
 	getSrcJSONFileData,
-} from "../utils/file.js";
+} from "../modules/shared/utils/file.js";
 import {
 	getEnvs,
-} from "../utils/env.js";
+} from "../modules/shared/utils/env.js";
 import {
 	eslintFiles,
-} from "../utils/lint.js";
+} from "../modules/shared/utils/lint.js";
 
 const fileNames = [
 	"vue.code-snippets",
@@ -34,8 +34,9 @@ try {
 	} = await getEnvs();
 
 	fileNames.forEach(async (fileName) => {
+		const srcFile = path.join(import.meta.dirname, fileName);
 		const srcFileData = await getSrcJSONFileData({
-			fileName,
+			fileData: await readFile(srcFile, "utf8"),
 			isTs,
 			removeDuplicateKeys: fileName === "vue.code-snippets",
 		});

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

@@ -6,22 +6,22 @@ import {
 } from "fs/promises";
 import {
 	getSrcJSONFileData,
-} from "../utils/file.js";
+} from "../modules/shared/utils/file.js";
 import {
 	mergeWithOverride,
-} from "../utils/merge.js";
+} from "../modules/shared/utils/merge.js";
 import {
 	getHeader,
-} from "../utils/file-header.js";
+} from "../modules/shared/utils/file-header.js";
 import {
 	getEnvs,
-} from "../utils/env.js";
+} from "../modules/shared/utils/env.js";
 import {
 	outputFile,
 } from "fs-extra";
 import {
 	eslintFiles,
-} from "../utils/lint.js";
+} from "../modules/shared/utils/lint.js";
 
 const fileName = "extensions.json";
 const destFile = path.join(process.cwd(), `.vscode/${fileName}`);
@@ -30,8 +30,9 @@ try {
 	const {
 		isRepositoryUseTypescript: isTs,
 	} = await getEnvs();
-	const baseContent = await getSrcJSONFileData({
-		fileName,
+	const srcFile = path.join(import.meta.dirname, fileName);
+	const srcFileData = await getSrcJSONFileData({
+		fileData: await readFile(srcFile, "utf8"),
 		isTs,
 	});
 	let overrideContent;
@@ -42,9 +43,9 @@ try {
 
 	let result;
 	if (overrideContent) {
-		result = await mergeWithOverride(baseContent, overrideContent);
+		result = await mergeWithOverride(srcFileData, overrideContent);
 	} else {
-		result = baseContent;
+		result = srcFileData;
 	}
 
 	await outputFile(destFile, `${getHeader()}${result}`);

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

@@ -6,22 +6,22 @@ import {
 } from "fs/promises";
 import {
 	getSrcJSONFileData,
-} from "../utils/file.js";
+} from "../modules/shared/utils/file.js";
 import {
 	mergeWithOverride,
-} from "../utils/merge.js";
+} from "../modules/shared/utils/merge.js";
 import {
 	getHeader,
-} from "../utils/file-header.js";
+} from "../modules/shared/utils/file-header.js";
 import {
 	getEnvs,
-} from "../utils/env.js";
+} from "../modules/shared/utils/env.js";
 import {
 	outputFile,
 } from "fs-extra";
 import {
 	eslintFiles,
-} from "../utils/lint.js";
+} from "../modules/shared/utils/lint.js";
 
 const fileName = "settings.json";
 const destFile = path.join(process.cwd(), `.vscode/${fileName}`);
@@ -30,8 +30,9 @@ try {
 	const {
 		isRepositoryUseTypescript: isTs,
 	} = await getEnvs();
-	const baseContent = await getSrcJSONFileData({
-		fileName,
+	const srcFile = path.join(import.meta.dirname, fileName);
+	const srcFileData = await getSrcJSONFileData({
+		fileData: await readFile(srcFile, "utf8"),
 		isTs,
 	});
 	let overrideContent;
@@ -42,9 +43,9 @@ try {
 
 	let result;
 	if (overrideContent) {
-		result = await mergeWithOverride(baseContent, overrideContent);
+		result = await mergeWithOverride(srcFileData, overrideContent);
 	} else {
-		result = baseContent;
+		result = srcFileData;
 	}
 
 	await outputFile(destFile, `${getHeader()}${result}`);

package/README.md

@@ -2,18 +2,18 @@
 
 👉 **If you want to integrate these configs into Quasar, be sure to read the [Quasar integration specifics](#quasar-integration-notes) section below!**
 
-**This repository is intended to standardize and centralize formatting and linting across all of my projects.**  
+**This repository is intended to standardize and centralize formatting and linting across all of my projects.**
 You can always override any rules to suit a specific project's needs.
 
 ---
 
 ## Quick Start
 
-**IMPORTANT!**  
-Before installing this package, remove `eslint`, `stylelint`, `@stylistic/*`, `@typescript-eslint/*` and any other linting/formatting-related packages from your project.  
+**IMPORTANT!**
+Before installing this package, remove `eslint`, `stylelint`, `@stylistic/*`, `@typescript-eslint/*` and any other linting/formatting-related packages from your project.
 The correct versions of those dependencies will be installed automatically when you install this package.
 
-**IMPORTANT!**  
+**IMPORTANT!**
 As you'll see further down in this README, the project is flexible and supports overrides at every level.
 
 1. **Open the target project.**
@@ -37,11 +37,11 @@ As you'll see further down in this README, the project is flexible and supports
 Before:
 ```js
 import {
-  globalConfig,
-  jsConfig,
-  tsConfig,
-  vueConfig,
-} from './tools/eslint-config/index.js';
+	...
+} from "./modules/eslint-config";
+import {
+	...
+} from "./modules/eslint-config/constants/severity.js";
 ```
 
 After:
@@ -51,17 +51,26 @@ import {
   jsConfig,
   tsConfig,
   vueConfig,
-} from '@cherepanov.pavel/shareable-config/tools/eslint-config/index.js';
+} from '@cherepanov.pavel/shareable-config/eslint-config';
+import {
+ 	OFF,
+	WARN,
+	ERROR,
+} from '@cherepanov.pavel/shareable-config/eslint-config/constants/severity.js';
 ```
 
 Before:
 ```js
-import baseConfig from './tools/stylelint-config/config.js';
+import {
+	baseConfig,
+} from "./modules/stylelint-config";
 ```
 
 After:
 ```js
-import baseConfig from '@cherepanov.pavel/shareable-config/tools/stylelint-config/config.js';
+import {
+	baseConfig
+} from '@cherepanov.pavel/shareable-config/stylelint-config';
 ```
 
 5. **Override rules via the `override` function in your own configs where needed.**
@@ -78,7 +87,7 @@ import baseConfig from '@cherepanov.pavel/shareable-config/tools/stylelint-confi
 - `extensions.json`
 - `settings.json`
 
-After installing the package, run:
+Once you have completed the Quick Start steps, run:
 ```sh
 npx -p "@cherepanov.pavel/shareable-config" set-env
 ```
@@ -177,8 +186,8 @@ After:
 
 ## Summary
 
-Use this repository as a single source for configs.  
-Only override what you need using the override mechanism.  
+Use this repository as a single source for configs.
+Only override what you need using the override mechanism.
 Receive updates without losing your custom changes.
 
 ---
@@ -230,4 +239,4 @@ Quasar projects typically don't have `type: "module"` in `package.json` by defau
   - `stylelint.config.js` → `stylelint.config.mjs`
   - `eslint.config.js` → `eslint.config.mjs`
 
-or use the `.mts` extension for TypeScript-based configs.
+or use the `.mts` extension for TypeScript-based configs.

package/env.json5.set.js

@@ -2,10 +2,13 @@
 
 import {
 	askFramework, askOptionsApi, askTypescript,
-} from "./utils/communication.js";
+} from "./modules/shared/utils/communication.js";
 import {
-	getEnvs, setEnvs,
-} from "./utils/env.js";
+	getEnvs, setEnvs, envFileSrc,
+} from "./modules/shared/utils/env.js";
+import {
+	eslintFiles,
+} from "./modules/shared/utils/lint.js";
 
 let envs = {};
 try {
@@ -17,3 +20,5 @@ envs.repositoryFramework = await askFramework();
 envs.isRepositoryUseOptionsApi = await askOptionsApi();
 
 await setEnvs(envs);
+
+await eslintFiles(envFileSrc);

package/{tools → modules}/eslint-config/configs/json.js

@@ -4,7 +4,7 @@ import {
 import jsonc from "eslint-plugin-jsonc";
 import {
 	ERROR,
-} from "../rules/severity.js";
+} from "../constants/severity.js";
 import {
 	jsFormatting,
 } from "../rules/stylistic/index.js";

package/{tools → modules}/eslint-config/configs/vue.js

@@ -20,7 +20,7 @@ import vueParser from "vue-eslint-parser";
 import tsParser from "@typescript-eslint/parser";
 import {
 	getEnvs,
-} from "../../../utils/env.js";
+} from "../../shared/utils/env.js";
 
 // https://github.com/sveltejs/eslint-plugin-svelte/issues/152#issuecomment-1150803175
 const {

package/{tools → modules}/eslint-config/rules/javascript/possible-problems.js

@@ -1,6 +1,6 @@
 import {
 	ERROR, WARN,
-} from "../severity.js";
+} from "../../constants/severity.js";
 
 export const possibleProblemRules = {
 	"array-callback-return": [

package/{tools → modules}/eslint-config/rules/javascript/suggestions.js

@@ -1,6 +1,6 @@
 import {
 	ERROR, OFF, WARN,
-} from "../severity.js";
+} from "../../constants/severity.js";
 
 export const suggestionRules = {
 	"accessor-pairs": [

package/{tools → modules}/eslint-config/rules/stylistic/jsFormatting.js

@@ -1,9 +1,9 @@
 import {
 	TAB_WIDTH, MAX_LEN, INDENT_SIZE,
-} from "../constants.js";
+} from "../../constants/rules.js";
 import {
 	ERROR, OFF,
-} from "../severity.js";
+} from "../../constants/severity.js";
 
 /* == formatting rules for javascript == */
 export default {

package/{tools → modules}/eslint-config/rules/stylistic/tsFormatting.js

@@ -1,6 +1,6 @@
 import {
 	ERROR,
-} from "../severity.js";
+} from "../../constants/severity.js";
 
 /* == formatting rules for typescript == */
 export default {

package/{tools → modules}/eslint-config/rules/typescript/common.js

@@ -1,6 +1,6 @@
 import {
 	ERROR, OFF, WARN,
-} from "../severity.js";
+} from "../../constants/severity.js";
 
 export const commonRules = {
 	"@typescript-eslint/adjacent-overload-signatures": ERROR,

package/{tools → modules}/eslint-config/rules/typescript/compatibility.js

@@ -1,6 +1,6 @@
 import {
 	ERROR, OFF,
-} from "../severity.js";
+} from "../../constants/severity.js";
 
 export const compatibilityRules = {
 	"constructor-super": OFF, // ts(2335) & ts(2377)

package/{tools → modules}/eslint-config/rules/typescript/extension.js

@@ -1,6 +1,6 @@
 import {
 	OFF,
-} from "../severity.js";
+} from "../../constants/severity.js";
 
 import {
 	suggestionRules,

package/{tools → modules}/eslint-config/rules/vue/base.js

@@ -1,6 +1,6 @@
 import {
 	ERROR, OFF,
-} from "../severity.js";
+} from "../../constants/severity.js";
 
 export const baseRules = {
 	"vue/comment-directive": [

package/{tools → modules}/eslint-config/rules/vue/extension.js

@@ -1,9 +1,9 @@
 import {
 	ERROR, OFF,
-} from "../severity.js";
+} from "../../constants/severity.js";
 import {
 	MAX_LEN,
-} from "../constants.js";
+} from "../../constants/rules.js";
 
 import {
 	possibleProblemRules,

package/{tools → modules}/eslint-config/rules/vue/formatting.js

@@ -1,9 +1,9 @@
 import {
 	INDENT_SIZE,
-} from "../constants.js";
+} from "../../constants/rules.js";
 import {
 	ERROR, OFF,
-} from "../severity.js";
+} from "../../constants/severity.js";
 
 export const formattingRules = {
 	"vue/block-tag-newline": [

package/{tools → modules}/eslint-config/rules/vue/index.js

@@ -15,7 +15,7 @@ import {
 } from "./formatting.js";
 import {
 	getEnvs,
-} from "../../../../utils/env.js";
+} from "../../../shared/utils/env.js";
 import {
 	optionsApiRules,
 } from "./options-api.js";

package/{tools → modules}/eslint-config/rules/vue/options-api.js

@@ -1,7 +1,7 @@
 import {
 	ERROR,
 	OFF,
-} from "../severity.js";
+} from "../../constants/severity.js";
 
 export const optionsApiRules = {
 	"vue/component-api-style": [

package/{tools → modules}/eslint-config/rules/vue/possible-problems.js

@@ -1,6 +1,6 @@
 import {
 	ERROR, OFF, WARN,
-} from "../severity.js";
+} from "../../constants/severity.js";
 
 export const possibleProblemRules = {
 	"vue/attribute-hyphenation": [

package/{tools → modules}/eslint-config/rules/vue/suggestions.js

@@ -3,7 +3,7 @@ import {
 } from "../javascript/possible-problems.js";
 import {
 	ERROR, OFF,
-} from "../severity.js";
+} from "../../constants/severity.js";
 
 export const suggestionRules = {
 	"vue/match-component-import-name": [

package/{utils → modules/shared/utils}/copy-with-override.js

@@ -3,7 +3,7 @@ import {
 } from "fs/promises";
 import {
 	getHeader,
-} from "../utils/file-header.js";
+} from "./file-header.js";
 import {
 	outputFile,
 } from "fs-extra";

package/{utils → modules/shared/utils}/env.js

@@ -7,7 +7,7 @@ import {
 	outputFile,
 } from "fs-extra";
 
-const envFileSrc = path.join(process.cwd(), "frontend-configs.env.json5");
+export const envFileSrc = path.join(process.cwd(), "frontend-configs.env.json5");
 
 export async function getEnvs() {
 	const srcFileData = await readFile(envFileSrc, "utf8");

package/{utils → modules/shared/utils}/file-header.js

@@ -1,8 +1,10 @@
+/* eslint-disable prefer-template */
 import {
 	readFile,
 } from "fs/promises";
 
-const pkg = JSON.parse(await readFile(new URL("../package.json", import.meta.url), "utf8"));
+const pkgJsonFileUrl = new URL("../../../package.json", import.meta.url);
+const pkg = JSON.parse(await readFile(pkgJsonFileUrl, "utf8"));
 
 export function getHeader(comment = "//") {
 	const lines = [
@@ -12,7 +14,11 @@ export function getHeader(comment = "//") {
 		"File may contain override sections, see project README for more details",
 	];
 
-	return `${lines.map((line) => {
-		return `${comment} ${line}`.trim();
-	}).join("\n")}\n`;
+	return (
+		lines.map((line) => {
+			return `${comment} ${line}`.trim();
+		})
+		.join("\n")
+		+ "\n"
+	);
 }

package/{utils → modules/shared/utils}/file.js

@@ -1,37 +1,16 @@
-import {
-	fileURLToPath,
-} from "url";
-import path from "path";
-import {
-	readFile,
-} from "fs/promises";
 import JSON5 from "json5";
 
-export async function getSrcFileData({
-	fileName,
-}) {
-	const dirname = path.dirname(fileURLToPath(import.meta.url));
-	const src = path.join(dirname, "..", ".vscode", fileName);
-	const srcFileData = await readFile(src, "utf8");
-
-	return srcFileData;
-}
-
 export async function getSrcJSONFileData({
-	fileName,
+	fileData,
 	isTs = false,
 	removeDuplicateKeys = false,
 }) {
-	const srcFileData = await getSrcFileData({
-		fileName,
-	});
-
-	// Если есть нет typescript, нет лишних проблем, возвращаем
-	if (!srcFileData.includes("// typescript")) {
-		return srcFileData;
+	// Если нет typescript, нет лишних проблем, возвращаем
+	if (!fileData.includes("// typescript")) {
+		return fileData;
 	}
 
-	const lines = srcFileData.split("\n");
+	const lines = fileData.split("\n");
 	const result = [];
 	let nextLineIsTypescript = false;
 	let nextLineIsTypescriptMultiline = false;

package/{utils → modules/shared/utils}/lint.js

@@ -1,3 +1,6 @@
+/*
+change with execFile carefully later. Cover with tests
+*/
 import {
 	exec,
 } from "node:child_process";
@@ -6,6 +9,7 @@ import {
 } from "node:util";
 
 const execAsync = promisify(exec);
+
 //  filePaths: string | string[]
 export async function eslintFiles(filePaths) {
 	const paths = Array.isArray(filePaths)

package/{tools/stylelint-config/config.js → modules/stylelint-config/index.js}

@@ -10,7 +10,7 @@ const concat = (...arrays) => {
 	return [].concat(...arrays);
 };
 
-export default {
+export const baseConfig = {
 	extends: concat(
 		[
 			"stylelint-config-standard",

package/{tools → modules}/stylelint-config/rules/stylistic.js

@@ -1,6 +1,6 @@
 import {
 	INDENT_SIZE,
-} from "../../eslint-config/rules/constants.js";
+} from "../../eslint-config/constants/rules.js";
 
 const MAX_EMPTY_LINES = 1;
 // const MAX_LINE_LENGTH = 80;

package/modules/utils/index.js

@@ -0,0 +1,51 @@
+import {
+	WARN,
+	OFF,
+} from "../eslint-config/constants/severity.js";
+
+
+// Returns overrides that disable all warning-level rules in the provided ESLint configuration.
+//
+// Usage example:
+// eslintConfig.push({
+// 	files: [
+// 		"test/**/*",
+// 	],
+// 	rules: getDisabledWarningRules(eslintConfig),
+// });
+export function getDisabledWarningRules(eslintConfig) {
+	const warningRules = new Set();
+	eslintConfig.forEach((config) => {
+		if (!config.rules) {
+			return;
+		}
+		(
+			Object.entries(config.rules)
+			.forEach(([
+				ruleName,
+				ruleConfig,
+			]) => {
+				const severity = (() => {
+					if (Array.isArray(ruleConfig)) {
+						return ruleConfig[0];
+					}
+					return ruleConfig;
+				})();
+				if (severity === WARN) {
+					warningRules.add(ruleName);
+				}
+			})
+		);
+	});
+	return Object.fromEntries(
+		[
+			...warningRules,
+		]
+		.map((ruleName) => {
+			return [
+				ruleName,
+				OFF,
+			];
+		}),
+	);
+}

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@cherepanov.pavel/shareable-config",
 	"description": "setup for new repositories",
-	"version": "1.0.26",
+	"version": "2.0.1",
 	"type": "module",
 	"devEngines": {
 		"packageManager": {
@@ -27,9 +27,8 @@
 		".gitignore",
 		".gitignore-get.js",
 		".vscode/",
-		"tools/",
-		"utils/",
-		"jsconfig.json"
+		"jsconfig.json",
+		"modules/"
 	],
 	"bin": {
 		"set-env": "./env.json5.set.js",
@@ -41,6 +40,12 @@
 		"get-settings": "./.vscode/settings.json-get.js",
 		"get-code-snippets": "./.vscode/.code-snippets-get.js"
 	},
+	"exports": {
+		"./eslint-config": "./modules/eslint-config/index.js",
+		"./eslint-config/constants/*": "./modules/eslint-config/constants/*",
+		"./stylelint-config": "./modules/stylelint-config/index.js",
+		"./utils": "./modules/utils/index.js"
+	},
 	"scripts": {
 		"lint": "run-p -lc lint:js lint:css",
 		"lint:fix": "run-p -lc lint:js:fix lint:css:fix",