@cherepanov.pavel/shareable-config 1.0.0

package/.editorconfig

@@ -0,0 +1,11 @@
+root = true
+
+[*]
+indent_style = tab
+indent_size = tab
+tab_width = 2
+end_of_line = lf
+charset = utf-8
+# set later
+# trim_trailing_whitespace = true
+# insert_final_newline = false

package/.editorconfig-get.js

@@ -0,0 +1,19 @@
+#!/usr/bin/env node
+
+import path from 'path';
+import { fileURLToPath } from 'url';
+import { copyWithOverride } from './utils/copy-with-override.js';
+import { readFile } from 'fs/promises';
+
+const fileName = '.editorconfig';
+const destFile = path.join(process.cwd(), fileName);
+
+const dirname = path.dirname(fileURLToPath(import.meta.url));
+const src = path.join(dirname, fileName);
+const srcFileData = await readFile(src, 'utf8');
+
+copyWithOverride({
+  destFile,
+  srcFileData,
+  fileLabel: fileName,
+});

package/.get-all.js

@@ -0,0 +1,29 @@
+#!/usr/bin/env node
+
+import { spawnSync } from 'child_process';
+import { readFile } from 'fs/promises';
+
+const commands = [
+  'get-editorconfig',
+  'get-gitattributes',
+  'get-gitignore',
+  'get-extensions',
+  'get-settings',
+  'get-code-snippets',
+];
+
+let hasError = false;
+
+const pkg = JSON.parse(await readFile(new URL('./package.json', import.meta.url), 'utf8'));
+
+commands.forEach((cmd) => {
+  const result = spawnSync('npx', ['-p', pkg.name, cmd], { stdio: 'inherit' });
+  if (result.status !== 0) {
+    console.error(`\nОшибка при выполнении команды: ${cmd}`);
+    hasError = true;
+  }
+});
+
+if (hasError) {
+  process.exit(1);
+}

package/.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

package/.gitattributes-get.js

@@ -0,0 +1,19 @@
+#!/usr/bin/env node
+
+import path from 'path';
+import { fileURLToPath } from 'url';
+import { copyWithOverride } from './utils/copy-with-override.js';
+import { readFile } from 'fs/promises';
+
+const fileName = '.gitattributes';
+const destFile = path.join(process.cwd(), fileName);
+
+const dirname = path.dirname(fileURLToPath(import.meta.url));
+const src = path.join(dirname, fileName);
+const srcFileData = await readFile(src, 'utf8');
+
+copyWithOverride({
+  destFile,
+  srcFileData,
+  fileLabel: fileName,
+});

package/.gitignore

@@ -0,0 +1,15 @@
+node_modules
+.idea
+*.local
+
+# vue
+dist
+
+# nuxt
+.output
+.nuxt
+
+# quasar
+dist
+.quasar
+quasar.config.*.temporary.compiled*

package/.gitignore-get.js

@@ -0,0 +1,47 @@
+#!/usr/bin/env node
+
+import path from 'path';
+import { fileURLToPath } from 'url';
+import { readFile } from 'fs/promises';
+import { copyWithOverride } from './utils/copy-with-override.js';
+import { getEnvs } from './utils/env.js';
+
+const fileName = '.gitignore';
+const destFile = path.join(process.cwd(), fileName);
+
+async function getGitignoreFileData(framework) {
+  const dirname = path.dirname(fileURLToPath(import.meta.url));
+  const src = path.join(dirname, '.npmignore');
+  const srcFileData = await readFile(src, 'utf8');
+
+  const [commonData] = srcFileData.split(/^#\s*\w+/mu);
+
+  if (!framework) {
+    return commonData.trim();
+  }
+
+  const sections = srcFileData.split(/^#\s*/mu).slice(1);
+  const matchedSection = sections.find((section) => {
+    const [header] = section.split('\n');
+    return header.trim().toLowerCase() === framework;
+  });
+
+  if (matchedSection) {
+    const [header, ...body] = matchedSection.split('\n');
+    return `${commonData.trim()}\n\n# ${header}\n${body.join('\n').trim()}`.trim();
+  }
+  // Если не найдено — только общий контент
+  return commonData.trim();
+}
+
+try {
+  const { repositoryFramework } = await getEnvs();
+  const srcFileData = await getGitignoreFileData(repositoryFramework);
+  await copyWithOverride({
+    destFile,
+    srcFileData,
+    fileLabel: fileName,
+  });
+} catch (err) {
+  console.error('Ошибка:', err.message);
+}

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

@@ -0,0 +1,49 @@
+#!/usr/bin/env node
+
+import path from 'path';
+import { readFile } from 'fs/promises';
+import { outputFile } from 'fs-extra';
+import { mergeWithOverride } from '../utils/merge.js';
+import { getHeader } from '../utils/file-header.js';
+import { getSrcJSONFileData } from '../utils/file.js';
+import { getEnvs } from '../utils/env.js';
+
+const fileNames = ['vue.code-snippets', 'all-files.code-snippets'];
+
+try {
+  const {
+    isRepositoryUseTypescript: isTs,
+  } = await getEnvs();
+
+  fileNames.forEach(async (fileName) => {
+    const srcFileData = await getSrcJSONFileData({
+      fileName,
+      isTs,
+      removeDuplicateKeys: fileName === 'vue.code-snippets',
+    });
+
+    const destFile = path.join(process.cwd(), `.vscode/${fileName}`);
+    let destFileData;
+    let isDestFileHaveOverride;
+    try {
+      destFileData = await readFile(destFile, 'utf8');
+      isDestFileHaveOverride = destFileData.includes('// override');
+    } catch (err) {}
+
+    let result;
+    if (isDestFileHaveOverride) {
+      result = await mergeWithOverride(srcFileData, destFileData);
+    } else {
+      result = srcFileData;
+    }
+
+    await outputFile(destFile, `${getHeader()}${result}`);
+    if (isDestFileHaveOverride) {
+      console.info(`${fileName} обновлён с учётом override`);
+    } else {
+      console.info(`${fileName} пересоздан`);
+    }
+  });
+} catch (err) {
+  console.error('Ошибка:', err.message);
+}

package/.vscode/all-files.code-snippets

@@ -0,0 +1,18 @@
+{
+	// TODO: delimit the scope in another way
+  "template for todo comments for easy search in project for HTML only": {
+    "scope": "html",
+    "prefix": "t html todo",
+    "body": [
+      "$BLOCK_COMMENT_START TODO:",
+      "$0"
+      "$BLOCK_COMMENT_END"
+    ]
+  },
+  "template for todo comments for easy search in project": {
+    "prefix": "t todo",
+    "body": [
+      "$LINE_COMMENT TODO: ",
+    ]
+  },
+}

package/.vscode/extensions.json

@@ -0,0 +1,25 @@
+{
+  "recommendations": [
+    // "eamodio.gitlens",
+
+    // typescript
+    "johnsoncodehk.vscode-tsconfig-helper",
+    // typescript
+    "yoavbls.pretty-ts-errors",
+    "vue.volar",
+    "mrmlnc.vscode-scss",
+    "ms-azuretools.vscode-containers",
+    // "redhat.vscode-yaml",
+    "savh.json5-kit",
+
+    "editorconfig.editorconfig",
+    "dbaeumer.vscode-eslint",
+    "stylelint.vscode-stylelint",
+
+    "streetsidesoftware.code-spell-checker",
+    "streetsidesoftware.code-spell-checker-russian"
+
+		// need to check that it's working well
+		// iulian-radu-at.find-unused-exports
+  ],
+}

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

@@ -0,0 +1,43 @@
+#!/usr/bin/env node
+
+import path from 'path';
+import { readFile } from 'fs/promises';
+import { getSrcJSONFileData } from '../utils/file.js';
+import { mergeWithOverride } from '../utils/merge.js';
+import { getHeader } from '../utils/file-header.js';
+import { getEnvs } from '../utils/env.js';
+import { outputFile } from 'fs-extra';
+
+const fileName = 'extensions.json';
+const destFile = path.join(process.cwd(), `.vscode/${fileName}`);
+
+try {
+  const {
+    isRepositoryUseTypescript: isTs,
+  } = await getEnvs();
+  const baseContent = await getSrcJSONFileData({
+    fileName,
+    isTs,
+  });
+  let overrideContent;
+  try {
+    const fileData = await readFile(destFile, 'utf8');
+    overrideContent = fileData.includes('// override') ? fileData : undefined;
+  } catch (err) {}
+
+  let result;
+  if (overrideContent) {
+    result = await mergeWithOverride(baseContent, overrideContent);
+  } else {
+    result = baseContent;
+  }
+
+  await outputFile(destFile, `${getHeader()}${result}`);
+  if (overrideContent) {
+    console.info(`${fileName} обновлён с учётом override`);
+  } else {
+    console.info(`${fileName} пересоздан`);
+  }
+} catch (err) {
+  console.error('Ошибка:', err.message);
+}

package/.vscode/settings.json

@@ -0,0 +1,42 @@
+{
+	"editor.linkedEditing": true,
+  "editor.suggestSelection": "recentlyUsed",
+	"git.blame.editorDecoration.enabled": true,
+
+	"explorer.fileNesting.enabled": true,
+	"explorer.fileNesting.patterns": {
+		"frontend-configs.env.json5": "eslint.config.*s, stylelint.config.*s, .editorconfig",
+    ".env.*.local": ".env.*",
+    ".gitignore": ".gitattributes, lefthook.yml",
+    // ".gitlab-ci.yml": "Dockerfile, .releaserc.template.yaml",
+    "package.json": ".npmrc, package-lock.json",
+    "README.md": "*.md",
+    // typescript
+    "tsconfig.json": "tsconfig.*.json, *.d.ts"
+	},
+
+	"javascript.preferences.importModuleSpecifier": "non-relative",
+  // typescript
+  "typescript.preferences.importModuleSpecifier": "non-relative",
+  // typescript
+  "typescript.tsdk": "./node_modules/typescript/lib",
+  // typescript
+  "typescript.enablePromptUseWorkspaceTsdk": true,
+
+	"json.validate.enable": false,
+  "editor.formatOnSave": false,
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "explicit",
+    "source.fixAll.stylelint": "explicit",
+  },
+	// "stylelint.validate": [
+  //   "css",
+  //   "scss",
+  //   "vue"
+  // ],
+
+	"cSpell.words": [
+			"Cherepanov",
+			"Pavel"
+	],
+}

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

@@ -0,0 +1,43 @@
+#!/usr/bin/env node
+
+import path from 'path';
+import { readFile } from 'fs/promises';
+import { getSrcJSONFileData } from '../utils/file.js';
+import { mergeWithOverride } from '../utils/merge.js';
+import { getHeader } from '../utils/file-header.js';
+import { getEnvs } from '../utils/env.js';
+import { outputFile } from 'fs-extra';
+
+const fileName = 'settings.json';
+const destFile = path.join(process.cwd(), `.vscode/${fileName}`);
+
+try {
+  const {
+    isRepositoryUseTypescript: isTs,
+  } = await getEnvs();
+  const baseContent = await getSrcJSONFileData({
+    fileName,
+    isTs,
+  });
+  let overrideContent;
+  try {
+    const fileData = await readFile(destFile, 'utf8');
+    overrideContent = fileData.includes('// override') ? fileData : undefined;
+  } catch (err) {}
+
+  let result;
+  if (overrideContent) {
+    result = await mergeWithOverride(baseContent, overrideContent);
+  } else {
+    result = baseContent;
+  }
+
+  await outputFile(destFile, `${getHeader()}${result}`);
+  if (overrideContent) {
+    console.info(`${fileName} обновлён с учётом override`);
+  } else {
+    console.info(`${fileName} пересоздан`);
+  }
+} catch (err) {
+  console.error('Ошибка:', err.message);
+}

package/.vscode/vue.code-snippets

@@ -0,0 +1,28 @@
+{
+  "template for empty vue file": {
+    "scope": "vue",
+    "prefix": "t vue file",
+    "body": [
+			"<script setup>",
+      "</script>",
+      "",
+      "<template>",
+      "</template>",
+      "",
+      "<style scoped lang=\"scss\">",
+      "</style>"
+    ],
+    // typescript multiline
+    "body": [
+			"<script setup lang=\"ts\">",
+      "</script>",
+      "",
+     	"<template>",
+      "</template>",
+      "",
+      "<style scoped lang=\"scss\">",
+      "</style>"
+    ],
+    // typescript multiline end
+  },
+}

package/README.md

@@ -0,0 +1,10 @@
+# New repositories setup
+The goal of this project is to provide easy creation of new repositories with code linting settings(and not only) that I like.
+I will be glad if it is useful to someone else.
+
+## OS that have been tested and in which correct operation with this setup is guaranteed
+### Windows
+
+## IDEs that have been tested and in which correct operation with this setup is guaranteed
+### Visual studio code(version 1.86.0+)
+You need to install extensions from .vscode/extensions.json

package/env.json5.set.js

@@ -0,0 +1,14 @@
+#!/usr/bin/env node
+
+import { askFramework, askTypescript } from './utils/communication.js';
+import { getEnvs, setEnvs } from './utils/env.js';
+
+let envs = {};
+try {
+  envs = await getEnvs();
+} catch (err) {}
+
+envs.isRepositoryUseTypescript = await askTypescript();
+envs.repositoryFramework = await askFramework();
+
+await setEnvs(envs);

package/jsconfig.json

@@ -0,0 +1,9 @@
+{
+  "compilerOptions": {
+    "baseUrl": ".",
+    "paths": {
+      "@/*": ["./*"]
+    }
+  },
+  "exclude": ["node_modules"]
+}

package/package.json

@@ -0,0 +1,54 @@
+{
+	"name": "@cherepanov.pavel/shareable-config",
+	"description": "setup for new repositories",
+	"version": "1.0.0",
+	"type": "module",
+	"packageManager": "npm@10.9.2",
+	"repository": {
+    "type": "git",
+    "url": "https://github.com/Cherepanov-Pavel/shareable-config"
+  },
+	"files": [
+    "env.json5",
+    "env.json5.set.js",
+    ".editorconfig",
+    ".editorconfig-get.js",
+    ".gitattributes",
+    ".gitattributes-get.js",
+    ".gitignore",
+    ".gitignore-get.js",
+    ".vscode/",
+    "tools/",
+    "utils/",
+    "jsconfig.json"
+  ],
+  "bin": {
+    "set-env": "./env.json5.set.js",
+    "get-all": "./.get-all.js",
+    "get-editorconfig": "./.editorconfig-get.js",
+    "get-gitattributes": "./.gitattributes-get.js",
+    "get-gitignore": "./.gitignore-get.js",
+    "get-extensions": "./.vscode/extensions.json-get.js",
+    "get-settings": "./.vscode/settings.json-get.js",
+    "get-code-snippets": "./.vscode/.code-snippets-get.js"
+  },
+	"dependencies": {
+		"@eslint/compat": "^2.0.5",
+		"@stylistic/eslint-plugin": "^5.1.0",
+		"@stylistic/stylelint-plugin": "^3.1.3",
+		"@typescript-eslint/eslint-plugin": "^8.57.0",
+		"@typescript-eslint/parser": "^8.57.0",
+		"eslint": "^10.0.3",
+		"eslint-plugin-vue": "^10.8.0",
+		"fs-extra": "^11.3.0",
+		"jiti": "^2.4.2",
+		"json5": "^2.2.3",
+		"postcss-html": "^1.8.0",
+		"stylelint": "^16.21.0",
+		"stylelint-config-standard": "^38.0.0",
+		"stylelint-config-standard-scss": "^15.0.1",
+		"stylelint-config-standard-vue": "^1.0.0",
+		"stylelint-order": "^7.0.0",
+		"vue-eslint-parser": "^10.4.0"
+	}
+}

package/tools/eslint-config/configs/global.js

@@ -0,0 +1,26 @@
+import { defineConfig } from 'eslint/config';
+import { includeIgnoreFile } from '@eslint/compat';
+import path from 'path';
+import globals from 'globals';
+
+const gitignorePath = path.join(process.cwd(), '.gitignore');
+
+export default defineConfig([
+  includeIgnoreFile(gitignorePath),
+  {
+    name: 'Additional .gitignore patterns',
+    ignores: [
+      'public/js/*',
+      '**/*.code-snippets'
+    ],
+  },
+  {
+    files: ['**/*.*js', '**/*.*vue'],
+    languageOptions: {
+      globals: {
+        ...globals.browser,
+        ...globals.node,
+      },
+    },
+  },
+]);

package/tools/eslint-config/configs/javascript.js

@@ -0,0 +1,21 @@
+import stylisticPlugin from '@stylistic/eslint-plugin';
+
+import { jsRules } from '../rules/javascript/index.js';
+import { jsFormatting } from '../rules/stylistic/index.js';
+
+export default {
+  files: ['**/*.*js'],
+  plugins: {
+    '@stylistic': stylisticPlugin,
+  },
+  languageOptions: {
+    sourceType: 'module',
+    parserOptions: {
+      sourceType: 'module',
+    },
+  },
+  rules: {
+    ...jsRules,
+    ...jsFormatting,
+  },
+};

package/tools/eslint-config/configs/typescript.js

@@ -0,0 +1,28 @@
+import tsPlugin from '@typescript-eslint/eslint-plugin';
+import stylisticPlugin from '@stylistic/eslint-plugin';
+
+import { tsRules } from '../rules/typescript/index.js';
+import { jsFormatting, tsFormatting } from '../rules/stylistic/index.js';
+
+import tsParser from '@typescript-eslint/parser';
+import { jsRules } from '../rules/javascript/index.js';
+
+export default {
+  files: ['**/*.*ts'],
+  plugins: {
+    '@typescript-eslint': tsPlugin,
+    '@stylistic': stylisticPlugin,
+  },
+  languageOptions: {
+    parser: tsParser,
+    parserOptions: {
+      projectService: true,
+    },
+  },
+  rules: {
+    ...jsRules,
+    ...jsFormatting,
+    ...tsRules,
+    ...tsFormatting,
+  },
+};

package/tools/eslint-config/configs/vue.js

@@ -0,0 +1,43 @@
+import { vueRules } from '../rules/vue/index.js';
+import { jsRules } from '../rules/javascript/index.js';
+import { tsRules } from '../rules/typescript/index.js';
+
+import { jsFormatting, tsFormatting } from '../rules/stylistic/index.js';
+
+import vuePlugin from 'eslint-plugin-vue';
+import tsPlugin from '@typescript-eslint/eslint-plugin';
+import stylisticPlugin from '@stylistic/eslint-plugin';
+
+import vueParser from 'vue-eslint-parser';
+import tsParser from '@typescript-eslint/parser';
+import { getEnvs } from '../../../utils/env.js';
+
+// https://github.com/sveltejs/eslint-plugin-svelte/issues/152#issuecomment-1150803175
+const {
+  isRepositoryUseTypescript: isTs,
+} = await getEnvs();
+
+export default {
+  files: ['**/*.vue'],
+  plugins: {
+    'vue': vuePlugin,
+    '@stylistic': stylisticPlugin,
+
+    ...(isTs ? { '@typescript-eslint': tsPlugin } : {}),
+  },
+  languageOptions: {
+    parser: vueParser,
+    parserOptions: {
+      parser: isTs ? tsParser : 'espree',
+      ...(isTs ? { projectService: true } : {}),
+      extraFileExtensions: ['.vue'],
+    },
+  },
+  rules: {
+    ...jsRules,
+    ...jsFormatting,
+    ...(isTs ? tsRules : {}),
+    ...(isTs ? tsFormatting : {}),
+    ...vueRules,
+  },
+};

package/tools/eslint-config/index.js

@@ -0,0 +1,4 @@
+export { default as globalConfig } from './configs/global.js';
+export { default as vueConfig } from './configs/vue.js';
+export { default as jsConfig } from './configs/javascript.js';
+export { default as tsConfig } from './configs/typescript.js';

package/tools/eslint-config/rules/constants.js

@@ -0,0 +1,15 @@
+export const INDENT_SIZE = 2;
+export const STR_LENGTH = 100;
+
+export const MAX_LEN = {
+  code: STR_LENGTH,
+  tabWidth: INDENT_SIZE,
+
+  ignoreComments: false,
+  ignoreTrailingComments: false,
+
+  ignoreUrls: true,
+  ignoreStrings: true,
+  ignoreTemplateLiterals: true,
+  ignoreRegExpLiterals: true,
+};

package/tools/eslint-config/rules/javascript/index.js

@@ -0,0 +1,7 @@
+import { possibleProblemRules } from './possible-problems.js';
+import { suggestionRules } from './suggestions.js';
+
+export const jsRules = {
+  ...possibleProblemRules,
+  ...suggestionRules,
+};