@shoper/cli 0.9.0 → 0.9.2

package/README.md

@@ -2,4 +2,14 @@
 
 # Shoper CLI
 
-Learn more in the [commands docs](https://storefront.developers.shoper.pl/cli/)
+Learn more in the [commands docs](https://storefront.developers.shoper.pl/cli/)
+
+## Features
+
+### .shoperignore
+
+Plik `.shoperignore` pozwala na wykluczenie określonych plików i katalogów z pakowania, uploadowania oraz weryfikacji checksum.
+
+Używa tej samej składni co `.gitignore`. Plik jest automatycznie tworzony podczas inicjalizacji lub pobierania motywu.
+
+Więcej informacji: [SHOPERIGNORE.md](docs/SHOPERIGNORE.md)

package/build/theme/class/checksums/theme_checksums.js

@@ -154,7 +154,8 @@ export class ThemeChecksums {
             join(SHOPER_THEME_METADATA_DIR, THEME_INITIAL_CHECKSUMS_FILE_NAME),
             join(SHOPER_THEME_METADATA_DIR, THEME_INITIAL_CHECKSUMS_VERITY_FILE_NAME)
         ];
-        const filesToComputeChecksums = (await ThemePushUtils.getAllFilesThatAreSendToRemote(this.#themeDir))
+        const allFiles = await ThemePushUtils.getAllFilesThatAreSendToRemote(this.#themeDir);
+        const filesToComputeChecksums = allFiles
             .filter((path) => !filesToIgnoreInChecksums.some((ignorePath) => normalize(path) === ignorePath))
             .map((relativePath) => join(this.#themeDir, relativePath));
         this.#loggerApi?.debug('Computing checksums from file structure.', { details: { count: filesToComputeChecksums.length } });

package/build/theme/features/theme/actions/theme_actions_utils.js

@@ -5,6 +5,7 @@ import globs from 'fast-glob';
 import { THEME_PUSH_WILDCARD_GLOBS_FOR_FILES } from '../push/service/theme_push_service_constants.js';
 import micromatch from 'micromatch';
 import difference from 'lodash/difference.js';
+import { filterFiles, loadShoperIgnore } from '../../../utils/shoperignore/shoperignore_utils.js';
 export class ThemeActionsUtils {
     static getFilesGlobsThatMatchesAction({ filesStructure, actionValue, actionType }) {
         return Object.entries(filesStructure).reduce((acc, [filePath, fileStructureItem]) => {
@@ -38,6 +39,7 @@ export class ThemeActionsUtils {
     static async getFilesRecordsFromActionData({ themeRootDir, themeAction, filesStructure, themeChecksums }) {
         const filesRecords = [];
         const initialChecksums = await themeChecksums.getInitialChecksums();
+        const ignoreInstance = await loadShoperIgnore(themeRootDir);
         for (const [actionKey, actionData] of Object.entries(themeAction.data)) {
             if (actionData.type === THEME_ACTION_DATA_TYPE.file) {
                 const filesGlobs = ThemeActionsUtils.getFilesGlobsThatMatchesAction({
@@ -54,14 +56,15 @@ export class ThemeActionsUtils {
                         onlyFiles: true,
                         cwd: themeRootDir
                     });
+                    const filteredFiles = await filterFiles(files, themeRootDir, ignoreInstance);
                     let processedFileGlob = fileGlob;
                     if (looksLikeDirectory(fileGlob)) {
                         processedFileGlob = fileGlob.endsWith(THEME_PUSH_WILDCARD_GLOBS_FOR_FILES)
                             ? fileGlob.slice(0, fileGlob.length - 2)
                             : fileGlob;
                     }
-                    const deletedFiles = difference(checksumMatchedFiles, files);
-                    for (const filePath of [...files, ...deletedFiles]) {
+                    const deletedFiles = difference(checksumMatchedFiles, filteredFiles);
+                    for (const filePath of [...filteredFiles, ...deletedFiles]) {
                         filesRecords.push({
                             actionData,
                             actionKey,

package/build/theme/features/theme/fetch/service/theme_fetch_service.js

@@ -66,6 +66,8 @@ export class ThemeFetchService {
         }
         this.#loggerApi.debug('Creating .gitignore file.');
         await ThemeMetaDataUtils.createGitIgnoreFile(themeDir);
+        this.#loggerApi.debug('Creating .shoperignore file.');
+        await ThemeMetaDataUtils.createShoperIgnoreFile(themeDir);
         this.#loggerApi.debug('Updating metadata file.');
         await ThemeMetaDataUtils.updateMetadataFileWithWorkUrl(themeDir, credentials.shopUrl);
         this.#loggerApi.debug('Updating theme checksums');

package/build/theme/features/theme/init/service/theme_init_service.js

@@ -52,6 +52,8 @@ export class ThemeInitService {
         }
         this.#loggerApi.debug('Creating .gitignore file.');
         await ThemeMetaDataUtils.createGitIgnoreFile(themeDir);
+        this.#loggerApi.debug('Creating .shoperignore file.');
+        await ThemeMetaDataUtils.createShoperIgnoreFile(themeDir);
         this.#loggerApi.debug('Updating metadata file.');
         await ThemeMetaDataUtils.updateMetadataFileWithWorkUrl(themeDir, credentials.shopUrl);
         this.#loggerApi.debug('Updating theme checksums.');

package/build/theme/features/theme/push/theme_push_utils.js

@@ -3,6 +3,7 @@ import { AppError } from '../../../../cli/utilities/features/logger/logs/app_err
 import { toUnixPath } from '../../../../utils/path_utils.js';
 import { ThemeFilesUtils } from '../utils/files/theme_files_utils.js';
 import { THEME_PUSH_WILDCARD_GLOBS_FOR_FILES } from './service/theme_push_service_constants.js';
+import { filterFiles } from '../../../utils/shoperignore/shoperignore_utils.js';
 export class ThemePushUtils {
     static async getAllFilesThatAreSendToRemote(themeDir) {
         const filesStructure = await ThemeFilesUtils.getThemeFilesStructure(themeDir);
@@ -17,11 +18,13 @@ export class ThemePushUtils {
             .filter((path) => path !== '*');
         //need unix styles globs
         filesToArchive.push('styles/src/**/*');
-        return await globs(filesToArchive, {
-            suppressErrors: true,
+        const allFiles = await globs(filesToArchive, {
             onlyFiles: true,
-            cwd: themeDir
-        }).then((files) => files.sort());
+            cwd: themeDir,
+            suppressErrors: true
+        });
+        const filteredFiles = await filterFiles(allFiles, themeDir);
+        return filteredFiles.sort();
     }
     static _normalizeFileGlob(fileGlob) {
         if (fileGlob.endsWith('/')) {

package/build/theme/features/theme/utils/files/theme_files_utils.js

@@ -8,6 +8,7 @@ import path from 'node:path';
 import { THEME_FILES_LIST_FILE_NAME } from '../../push/theme_push_constants.js';
 import { THEME_ACTIONS_TYPES } from '../../actions/theme_actions_constants.js';
 import { FILE_STATES } from '../../../../../utils/fs/fs_constants.js';
+import { loadShoperIgnore } from '../../../../utils/shoperignore/shoperignore_utils.js';
 export class ThemeFilesUtils {
     static async getThemeFilesStructure(themeDirectory) {
         const filesStructure = await readJSONFile(join(themeDirectory, SHOPER_THEME_METADATA_DIR, THEME_FILES_STRUCTURE_FILE_NAME));
@@ -29,10 +30,12 @@ export class ThemeFilesUtils {
         }, {});
     }
     static async validateThemeDirectoryStructure({ checksums, permissions, rootDirectory }) {
+        const ignoreInstance = await loadShoperIgnore(rootDirectory);
         return await validateDirectory({
             permissions,
             checksums,
-            rootDirectory
+            rootDirectory,
+            ignoreInstance
         });
     }
     static async getThemeRootDirectories(themeDirectory) {
@@ -117,7 +120,7 @@ export class ThemeFilesUtils {
             },
             _links: { [THEME_ACTIONS_TYPES.push]: '*' }
         };
-        ['.gitignore'].forEach((fileName) => {
+        ['.gitignore', '.shoperignore'].forEach((fileName) => {
             fileStructure[fileName] = {
                 permissions: {
                     canAdd: true,

package/build/theme/features/theme/utils/meta_data/theme_meta_data_utils.js

@@ -58,4 +58,32 @@ export class ThemeMetaDataUtils {
             });
         });
     }
+    static async createShoperIgnoreFile(themeDir) {
+        return new Promise((resolve, reject) => {
+            const shoperIgnoreContent = `# .shoperignore
+# Pliki i katalogi wymienione tutaj będą wykluczane z:
+# - pakowania do archiwum podczas publikacji
+# - uploadowania na serwer
+# - weryfikacji checksum
+
+# Przykłady:
+# node_modules/
+# .env
+# .env.*
+# *.log
+# temp/
+# .vscode/
+# .idea/
+`;
+            const writeStream = createWriteStream(join(themeDir, '.shoperignore'));
+            writeStream.write(shoperIgnoreContent);
+            writeStream.end();
+            writeStream.on('error', (err) => {
+                reject(err);
+            });
+            writeStream.on('finish', () => {
+                resolve();
+            });
+        });
+    }
 }

package/build/theme/utils/directory_validator/directory_validator_utils.js

@@ -5,7 +5,7 @@ import { computeFileChecksum } from '../../../utils/checksums/checksums_utils.js
 import { DEFAULT_PERMISSION_FOR_ALL_FILES_KEY, DEFAULT_PERMISSION_FOR_DIRECTORY_KEY, FILES_MODIFICATION_TYPES, PERMISSION_KEY } from './directory_validator_constants.js';
 import { CHECKSUM_KEY } from '../../../utils/checksums/checksums_utils_constants.js';
 import _ from 'lodash';
-export const validateDirectory = async ({ rootDirectory, permissions, checksums }) => {
+export const validateDirectory = async ({ rootDirectory, permissions, checksums, ignoreInstance }) => {
     const unpermittedActions = [];
     await _checkPermissions({
         permissions,
@@ -14,14 +14,15 @@ export const validateDirectory = async ({ rootDirectory, permissions, checksums
         parts: [],
         checksumsPart: checksums,
         rootDirectory,
-        unpermittedActions
+        unpermittedActions,
+        ignoreInstance
     });
     return {
         isValid: !unpermittedActions.length,
         unpermittedActions
     };
 };
-const _checkPermissions = async ({ permissionPart, permissionParts, parts = [], checksumsPart, rootDirectory, unpermittedActions, permissions }) => {
+const _checkPermissions = async ({ permissionPart, permissionParts, parts = [], checksumsPart, rootDirectory, unpermittedActions, permissions, ignoreInstance }) => {
     if (!permissionPart)
         return;
     //TODO required files in a custom module directory
@@ -40,6 +41,11 @@ const _checkPermissions = async ({ permissionPart, permissionParts, parts = [],
         filesInsideCurrentDirectoryObject[path] = true;
     });
     for (const file of files) {
+        const relativePath = join(parentPath, file);
+        // Skip files that are in .shoperignore
+        if (ignoreInstance && ignoreInstance.ignores(relativePath)) {
+            continue;
+        }
         const { permission, permissionKey } = _getPermission({
             path: file,
             fullPath: join(fullPath, file),
@@ -65,7 +71,8 @@ const _checkPermissions = async ({ permissionPart, permissionParts, parts = [],
                 checksumsPart: checksumsPart?.[file] ?? {},
                 rootDirectory,
                 unpermittedActions,
-                permissions
+                permissions,
+                ignoreInstance
             });
         }
     }

package/build/theme/utils/shoperignore/shoperignore_utils.js

@@ -0,0 +1,37 @@
+import { readFile } from 'node:fs/promises';
+import { join } from '../../../utils/path_utils.js';
+import { fileExists } from '../../../utils/fs/fs_utils.js';
+import ignoreModule from 'ignore';
+const ignore = ignoreModule;
+export const SHOPER_IGNORE_FILE_NAME = '.shoperignore';
+export async function loadShoperIgnore(themeRootDir) {
+    const shoperIgnorePath = join(themeRootDir, SHOPER_IGNORE_FILE_NAME);
+    if (!(await fileExists(shoperIgnorePath))) {
+        return null;
+    }
+    try {
+        const content = await readFile(shoperIgnorePath, 'utf-8');
+        const ig = ignore();
+        ig.add('.shoperignore');
+        ig.add('.gitignore');
+        ig.add(content);
+        return ig;
+    }
+    catch {
+        return null;
+    }
+}
+export async function filterFiles(files, themeRootDir, ignoreInstance) {
+    const ig = ignoreInstance !== undefined ? ignoreInstance : await loadShoperIgnore(themeRootDir);
+    if (!ig) {
+        return files;
+    }
+    return files.filter((file) => !ig.ignores(file));
+}
+export async function isIgnored(filePath, themeRootDir, ignoreInstance) {
+    const ig = ignoreInstance !== undefined ? ignoreInstance : await loadShoperIgnore(themeRootDir);
+    if (!ig) {
+        return false;
+    }
+    return ig.ignores(filePath);
+}

package/package.json

@@ -2,7 +2,7 @@
     "name": "@shoper/cli",
     "packageManager": "yarn@3.2.0",
     "sideEffects": false,
-    "version": "0.9.0",
+    "version": "0.9.2",
     "description": "CLI tool for Shoper",
     "author": "Joanna Firek",
     "license": "MIT",
@@ -48,9 +48,11 @@
         "chalk": "5.4.1",
         "conf": "13.1.0",
         "fast-glob": "3.3.3",
+        "figlet": "1.9.4",
         "figures": "6.1.0",
         "fs-extra": "11.3.0",
         "fs-tree-diff": "2.0.1",
+        "ignore": "7.0.5",
         "ink": "6.0.1",
         "ink-link": "4.1.0",
         "ink-gradient": "3.0.0",
@@ -77,7 +79,6 @@
         "micromatch": "4.0.8",
         "walk-sync": "3.0.0",
         "yauzl": "3.2.0",
-        "figlet": "1.9.4",
         "yazl": "3.3.1",
         "puppeteer": "24.31.0",
         "gradient-string": "3.0.0"