Update to 1.1.0

digikid · digikid · commit 16b9ed2e0f60 · 2022-01-28T19:45:00.000+04:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,6 +2,17 @@
 
 Все основные изменения задокументированы в этом файле.
 
+[1.1.0]: https://github.com/digikid/create-project/releases/tag/1.1.0
+
+## [1.1.0] - 2022-01-28
+
+### Добавлено
+- Проверка на запуск от имени администратора для корректного сохранения настроек
+
+### Исправлено
+- Пользовательский файл конфигурации не сохранялся в ОС Mac / Linux
+- Рефакторинг кода, исправление мелких ошибок
+
 [1.0.0]: https://github.com/digikid/create-project/releases/tag/1.0.0
 
 ## [1.0.0] - 2022-01-22
diff --git a/bin/index.js b/bin/index.js
@@ -4,6 +4,7 @@ import init from '#lib/init';
 import configurate from '#lib/configurate';
 import restore from '#lib/restore';
 
+import { dir } from '#lib/utils/path';
 import { scanDirectory, readFileAsync } from '#lib/utils/fs';
 import { isValid } from '#lib/utils/json';
 import { arg } from '#lib/utils/args';
@@ -12,7 +13,7 @@ import { error } from '#lib/utils/log';
 (async () => {
     const config = {};
 
-    const files = scanDirectory('config', {
+    const files = scanDirectory(dir('config'), {
         extensions: ['json']
     });
 
@@ -22,7 +23,7 @@ import { error } from '#lib/utils/log';
 
             const key = name.replace('.json', '');
 
-            const data = await readFileAsync(`config/${name}`);
+            const data = await readFileAsync(dir(`config/${name}`));
             const value = isValid(data) ? JSON.parse(data) : {};
 
             config[key] = value;
diff --git a/config/messages.json b/config/messages.json
@@ -26,5 +26,6 @@
   "COPY_BOILERPLATE_ERROR": "При перемещении дополнительных файлов произошла ошибка",
   "ENVIRONMENT_ERROR": "Невозможно запустить скрипт в текущем окружении",
   "PATH_EXISTS_ERROR": "Папка с таким названием уже существует",
-  "GIT_COMMAND_NOT_FOUND_ERROR": "Не удалось найти команду, установите git по инструкции:\\nhttps://github.com/git-guides/install-git"
+  "GIT_COMMAND_NOT_FOUND_ERROR": "Не удалось найти команду, установите git по инструкции:\\nhttps://github.com/git-guides/install-git",
+  "SUDO_ERROR": "Скрипт может быть запущен только с правами администратора"
 }
diff --git a/config/user.json b/config/user.json
@@ -0,0 +1,172 @@
+{
+  "repo": [
+    {
+      "name": "name",
+      "message": "Название проекта:",
+      "default": "new-project"
+    },
+    {
+      "name": "host",
+      "type": "list",
+      "message": "Хостинг для репозитория:",
+      "default": "gitlab",
+      "choices": [
+        {
+          "name": "GitHub",
+          "value": "github",
+          "short": "GitHub"
+        },
+        {
+          "name": "GitLab",
+          "value": "gitlab",
+          "short": "GitLab"
+        },
+        {
+          "name": "BitBucket",
+          "value": "bitbucket",
+          "short": "BitBucket"
+        }
+      ]
+    },
+    {
+      "name": "owner",
+      "message": "Учетная запись на хостинге:",
+      "default": "Relevant-agency"
+    },
+    {
+      "name": "author",
+      "message": "Имя автора (латиницей):",
+      "default": "Alexander Dovlatov"
+    }
+  ],
+  "contacts": [
+    {
+      "name": "continue",
+      "type": "confirm",
+      "message": "Указать контактные данные?",
+      "default": true
+    },
+    {
+      "name": "name",
+      "message": "Ваше имя (кириллицей):",
+      "default": "Александр Довлатов"
+    },
+    {
+      "name": "telegram",
+      "message": "Аккаунт в телеграме:",
+      "default": "digikid"
+    },
+    {
+      "name": "job",
+      "message": "Должность:",
+      "default": "Frontend-разработчик"
+    }
+  ],
+  "info": [
+    {
+      "name": "continue",
+      "type": "confirm",
+      "message": "Указать информацию о проекте?",
+      "default": true
+    },
+    {
+      "name": "title",
+      "message": "Заголовок проекта:",
+      "default": ""
+    },
+    {
+      "name": "description",
+      "message": "Описание проекта:",
+      "default": ""
+    },
+    {
+      "name": "copyright",
+      "message": "Копирайт:",
+      "default": "Интернет-агентство «Relevant»"
+    }
+  ],
+  "vendor": [
+    {
+      "name": "continue",
+      "type": "confirm",
+      "message": "Установить дополнительные плагины?",
+      "default": true
+    },
+    {
+      "name": "dependencies",
+      "type": "checkbox",
+      "message": "Выберите плагины из списка:",
+      "default": [
+        "*"
+      ],
+      "choices": [
+        {
+          "name": "Выбрать все",
+          "value": "*",
+          "short": "Все"
+        },
+        {
+          "name": "Animate.css (CSS анимации)",
+          "value": "animate",
+          "short": "Animate.css"
+        },
+        {
+          "name": "Air Datepicker (Выбор даты)",
+          "value": "datepicker",
+          "short": "Air Datepicker"
+        },
+        {
+          "name": "Bootstrap (UI компоненты)",
+          "value": "bootstrap",
+          "short": "Bootstrap"
+        },
+        {
+          "name": "Fancybox (Модальные окна)",
+          "value": "fancybox",
+          "short": "Fancybox"
+        },
+        {
+          "name": "jQuery.mask (Валидация телефоннных номеров)",
+          "value": "mask",
+          "short": "jQuery.mask"
+        },
+        {
+          "name": "Lozad (Ленивая загрузка изображений)",
+          "value": "lozad",
+          "short": "Lozad"
+        },
+        {
+          "name": "Simplebar (Кроссплатформенный скроллбар)",
+          "value": "simplebar",
+          "short": "Simplebar"
+        },
+        {
+          "name": "Swiper (Карусель)",
+          "value": "swiper",
+          "short": "Swiper"
+        },
+        {
+          "name": "Tippy (Всплывающие подсказки)",
+          "value": "tippy",
+          "short": "Tippy"
+        }
+      ]
+    }
+  ],
+  "params": [
+    {
+      "name": "es6",
+      "type": "confirm",
+      "message": "Включить импорт ES6 модулей?",
+      "default": true
+    }
+  ],
+  "files": [
+    {
+      "name": "boilerplate",
+      "type": "confirm",
+      "message": "Подготовить структуру проекта?",
+      "default": true
+    }
+  ]
+}
diff --git a/lib/configurate.js b/lib/configurate.js
@@ -1,7 +1,10 @@
 import inquirer from 'inquirer';
 
-import { writeFileAsync } from '#lib/utils/fs';
+import { checkSudo } from 'check-sudo';
+
+import { args, keys } from '#lib/utils/args';
 import { dir } from '#lib/utils/path';
+import { writeFileAsync } from '#lib/utils/fs';
 import { print, error } from '#lib/utils/log';
 
 export default async config => {
@@ -11,6 +14,14 @@ export default async config => {
     print('CONFIGURATE_TEXT');
 
     try {
+        const isSudo = await checkSudo();
+
+        if (!isSudo) {
+            print('SUDO_ERROR');
+
+            process.exit(1);
+        };
+
         const options = JSON.parse(JSON.stringify(prompts));
 
         for (let [id, questions] of Object.entries(prompts)) {
@@ -61,7 +72,7 @@ export default async config => {
             };
         };
 
-        await writeFileAsync('config/user.json', JSON.stringify(options, null, 2));
+        await writeFileAsync(dir('config/user.json'), JSON.stringify(options, null, 2));
 
         print('CONFIGURATE_SUCCESS');
     } catch(e) {
diff --git a/lib/init.js b/lib/init.js
@@ -1,3 +1,4 @@
+import path from 'path';
 import chalk from 'chalk';
 import inquirer from 'inquirer';
 
@@ -6,12 +7,13 @@ import installDeps from '#lib/tasks/installDeps';
 import addConfig from '#lib/tasks/addConfig';
 import copyBoilerplate from '#lib/tasks/copyBoilerplate';
 
+import { cwd } from '#lib/utils/path';
 import { isExistsAsync } from '#lib/utils/fs';
 import { keys, arg } from '#lib/utils/args';
 import { print, error } from '#lib/utils/log';
 
 const checkDirectoryExists = async path => {
-    if (path && await isExistsAsync(`../${path}`)) {
+    if (path && await isExistsAsync(cwd(path))) {
         print('PATH_EXISTS_ERROR');
 
         process.exit(1);
diff --git a/lib/restore.js b/lib/restore.js
@@ -1,5 +1,8 @@
 import inquirer from 'inquirer';
 
+import { checkSudo } from 'check-sudo';
+
+import { dir } from '#lib/utils/path';
 import { removeFileAsync } from '#lib/utils/fs';
 import { print, error } from '#lib/utils/log';
 
@@ -8,6 +11,14 @@ export default async config => {
     print('RESTORE_TEXT');
 
     try {
+        const isSudo = await checkSudo();
+
+        if (!isSudo) {
+            print('SUDO_ERROR');
+
+            process.exit(1);
+        };
+
         const answer = await inquirer.prompt({
             name: 'continue',
             type: 'confirm',
@@ -16,7 +27,7 @@ export default async config => {
         });
 
         if (answer.continue) {
-            await removeFileAsync('config/user.json');
+            await removeFileAsync(dir('config/user.json'));
 
             print('RESTORE_SUCCESS');
         } else {
diff --git a/lib/utils/fs.js b/lib/utils/fs.js
@@ -5,11 +5,9 @@ import replace from 'replace-in-file';
 
 import { access, unlink, writeFile, readFile } from 'fs/promises';
 
-import { dir } from '#lib/utils/path';
-
 export const isExistsAsync = async path => {
     try {
-        const e = await access(dir(path));
+        const e = await access(path);
 
         return !e;
     } catch(e) {
@@ -27,7 +25,7 @@ export const replaceAsync = async (options) => {
 
 export const readFileAsync = async (path, encoding = 'utf-8') => {
     try {
-        const data = await readFile(dir(path), encoding);
+        const data = await readFile(path, encoding);
 
         return data;
     } catch(e) {
@@ -37,7 +35,7 @@ export const readFileAsync = async (path, encoding = 'utf-8') => {
 
 export const writeFileAsync = async (path, data) => {
     try {
-        await writeFile(dir(path), data);
+        await writeFile(path, data);
     } catch(e) {
         return false;
     };
@@ -47,7 +45,7 @@ export const writeFileAsync = async (path, data) => {
 
 export const removeFileAsync = async path => {
     try {
-        await unlink(dir(path));
+        await unlink(path);
     } catch(e) {
         return false;
     };
@@ -81,7 +79,7 @@ export const mergeDirsAsync = (source, dest) => {
 
 export const scanDirectory = (path, options = {}) => {
     try {
-        const result = dree.scan(dir(path), options);
+        const result = dree.scan(path, options);
 
         const tree = (result && ('children' in result)) ? result.children : [];
 
diff --git a/lib/utils/path.js b/lib/utils/path.js
@@ -1,6 +1,9 @@
 import path from 'path';
+
 import { fileURLToPath } from 'url';
 
 export const __dirname = path.dirname(fileURLToPath(import.meta.url));
 
-export const dir = (child = '') => child ? path.join(__dirname, `../../${child}`) : __dirname;
+export const dir = (child = '') => child ? path.join(__dirname, `../../${child}`) : __dirname;
+
+export const cwd = (child = '') => child ? path.join(process.cwd(), child) : process.cwd();
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json

Original file line number	Diff line number	Diff line change
`@@ -26,5 +26,6 @@`
`26`	`26`	`"COPY_BOILERPLATE_ERROR": "При перемещении дополнительных файлов произошла ошибка",`
`27`	`27`	`"ENVIRONMENT_ERROR": "Невозможно запустить скрипт в текущем окружении",`
`28`	`28`	`"PATH_EXISTS_ERROR": "Папка с таким названием уже существует",`
`29`		`- "GIT_COMMAND_NOT_FOUND_ERROR": "Не удалось найти команду, установите git по инструкции:\\nhttps://github.com/git-guides/install-git"`
	`29`	`+ "GIT_COMMAND_NOT_FOUND_ERROR": "Не удалось найти команду, установите git по инструкции:\\nhttps://github.com/git-guides/install-git",`
	`30`	`+ "SUDO_ERROR": "Скрипт может быть запущен только с правами администратора"`
`30`	`31`	`}`