directus-template-cli 0.5.1 → 0.6.0-beta.2

package/README.md

@@ -181,6 +181,18 @@ Using email/password:
 npx directus-template-cli@latest extract -p --templateName="My Template" --templateLocation="./my-template" --userEmail="admin@example.com" --userPassword="admin" --directusUrl="http://localhost:8055"
 ```
 
+Skipping extracting content from sensitive or large collections:
+
+```
+npx directus-template-cli@latest extract -p --templateName="My Template" --templateLocation="./my-template" --directusToken="admin-token-here" --directusUrl="http://localhost:8055" --excludeCollections="posts,globals"
+```
+
+Skipping extracting files and assets:
+
+```
+npx directus-template-cli@latest extract -p --templateName="My Template" --templateLocation="./my-template" --directusToken="admin-token-here" --directusUrl="http://localhost:8055" --skipFiles
+```
+
 Available flags for programmatic mode:
 
 - `--directusUrl`: URL of the Directus instance to extract the template from (required)
@@ -189,6 +201,8 @@ Available flags for programmatic mode:
 - `--userPassword`: Password for Directus authentication (required if not using token)
 - `--templateLocation`: Directory to extract the template to (required)
 - `--templateName`: Name of the template (required)
+- `--excludeCollections`: Comma-separated list of collection names to exclude from extraction
+- `--skipFiles`: Skip extracting files and assets
 
 #### Using Environment Variables
 

package/dist/commands/extract.d.ts

@@ -5,7 +5,9 @@ export default class ExtractCommand extends Command {
     static flags: {
         directusToken: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
         directusUrl: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
+        excludeCollections: import("@oclif/core/lib/interfaces").OptionFlag<string[], import("@oclif/core/lib/interfaces").CustomOptions>;
         programmatic: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        skipFiles: import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
         templateLocation: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
         templateName: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;
         userEmail: import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces").CustomOptions>;

package/dist/commands/extract.js

@@ -30,6 +30,7 @@ class ExtractCommand extends core_1.Command {
      * @returns {Promise<void>} - Returns nothing
      */
     async extractTemplate(templateName, directory, flags) {
+        var _a;
         try {
             if (!node_fs_1.default.existsSync(directory)) {
                 node_fs_1.default.mkdirSync(directory, { recursive: true });
@@ -49,8 +50,14 @@ class ExtractCommand extends core_1.Command {
             });
         }
         core_1.ux.log(constants_1.SEPARATOR);
-        core_1.ux.action.start(`Extracting template - ${core_1.ux.colorize(constants_1.DIRECTUS_PINK, templateName)} from ${core_1.ux.colorize(constants_1.DIRECTUS_PINK, flags.directusUrl)} to ${core_1.ux.colorize(constants_1.DIRECTUS_PINK, directory)}`);
-        await (0, extract_1.default)(directory);
+        const exclusionMessage = ((_a = flags.excludeCollections) === null || _a === void 0 ? void 0 : _a.length)
+            ? ` (excluding ${flags.excludeCollections.join(', ')})`
+            : '';
+        core_1.ux.action.start(`Extracting template - ${core_1.ux.colorize(constants_1.DIRECTUS_PINK, templateName)}${exclusionMessage} from ${core_1.ux.colorize(constants_1.DIRECTUS_PINK, flags.directusUrl)} to ${core_1.ux.colorize(constants_1.DIRECTUS_PINK, directory)}`);
+        await (0, extract_1.default)(directory, {
+            excludeCollections: flags.excludeCollections,
+            skipFiles: flags.skipFiles,
+        });
         core_1.ux.action.stop();
         core_1.ux.log(constants_1.SEPARATOR);
         core_1.ux.log('Template extracted successfully.');
@@ -66,6 +73,12 @@ class ExtractCommand extends core_1.Command {
         const templateName = await core_1.ux.prompt('What is the name of the template you would like to extract?');
         const directory = await core_1.ux.prompt("What directory would you like to extract the template to? If it doesn't exist, it will be created.", { default: `templates/${(0, slugify_1.default)(templateName, { lower: true, strict: true })}` });
         core_1.ux.log(`You selected ${core_1.ux.colorize(constants_1.DIRECTUS_PINK, directory)}`);
+        const excludeCollectionsInput = await core_1.ux.prompt('Enter collection names to exclude (comma-separated) or press enter to skip', { required: false });
+        if (excludeCollectionsInput) {
+            flags.excludeCollections = excludeCollectionsInput.split(',').map(name => name.trim());
+        }
+        const skipFiles = await core_1.ux.confirm('Skip extracting files and assets? (y/N)');
+        flags.skipFiles = skipFiles;
         core_1.ux.log(constants_1.SEPARATOR);
         // Get Directus URL
         const directusUrl = await (0, auth_1.getDirectusUrl)();
@@ -126,11 +139,25 @@ ExtractCommand.description = 'Extract a template from a Directus instance.';
 ExtractCommand.examples = [
     '$ directus-template-cli extract',
     '$ directus-template-cli extract -p --templateName="My Template" --templateLocation="./my-template" --directusToken="admin-token-here" --directusUrl="http://localhost:8055"',
+    '$ directus-template-cli extract -p --templateName="My Template" --templateLocation="./my-template" --directusToken="admin-token-here" --directusUrl="http://localhost:8055" --excludeCollections=collection1,collection2',
 ];
 ExtractCommand.flags = {
     directusToken: customFlags.directusToken,
     directusUrl: customFlags.directusUrl,
+    excludeCollections: core_1.Flags.string({
+        char: 'e',
+        delimiter: ',', // Will split on commas and return an array
+        description: 'Comma-separated list of collection names to exclude from extraction',
+        multiple: true,
+        required: false,
+    }),
     programmatic: customFlags.programmatic,
+    skipFiles: core_1.Flags.boolean({
+        char: 'f',
+        default: false,
+        description: 'Skip extracting files and assets',
+        required: false,
+    }),
     templateLocation: customFlags.templateLocation,
     templateName: customFlags.templateName,
     userEmail: customFlags.userEmail,

package/dist/lib/extract/extract-content.d.ts

@@ -1 +1 @@
-export declare function extractContent(dir: string): Promise<void>;
+export declare function extractContent(dir: string, excludeCollections?: string[]): Promise<void>;

package/dist/lib/extract/extract-content.js

@@ -8,11 +8,12 @@ const constants_1 = require("../constants");
 const sdk_2 = require("../sdk");
 const catch_error_1 = tslib_1.__importDefault(require("../utils/catch-error"));
 const write_to_file_1 = tslib_1.__importDefault(require("../utils/write-to-file"));
-async function getCollections() {
+async function getCollections(excludeCollections) {
     const response = await sdk_2.api.client.request((0, sdk_1.readCollections)());
     return response
         .filter(item => !item.collection.startsWith('directus_', 0))
-        .filter(item => item.schema != null)
+        .filter(item => item.schema !== null)
+        .filter(item => !(excludeCollections === null || excludeCollections === void 0 ? void 0 : excludeCollections.includes(item.collection)))
         .map(i => i.collection);
 }
 async function getDataFromCollection(collection, dir) {
@@ -24,10 +25,13 @@ async function getDataFromCollection(collection, dir) {
         (0, catch_error_1.default)(error);
     }
 }
-async function extractContent(dir) {
-    core_1.ux.action.start(core_1.ux.colorize(constants_1.DIRECTUS_PINK, 'Extracting content'));
+async function extractContent(dir, excludeCollections) {
+    const exclusionMessage = (excludeCollections === null || excludeCollections === void 0 ? void 0 : excludeCollections.length)
+        ? ` (excluding ${excludeCollections.join(', ')})`
+        : '';
+    core_1.ux.action.start(core_1.ux.colorize(constants_1.DIRECTUS_PINK, `Extracting content${exclusionMessage}`));
     try {
-        const collections = await getCollections();
+        const collections = await getCollections(excludeCollections);
         await Promise.all(collections.map(collection => getDataFromCollection(collection, dir)));
     }
     catch (error) {

package/dist/lib/extract/index.d.ts

@@ -1 +1,6 @@
-export default function extract(dir: string): Promise<{}>;
+interface ExtractOptions {
+    excludeCollections?: string[];
+    skipFiles?: boolean;
+}
+export default function extract(dir: string, options?: ExtractOptions): Promise<{}>;
+export {};

package/dist/lib/extract/index.js

@@ -22,7 +22,8 @@ const extract_schema_1 = tslib_1.__importDefault(require("./extract-schema"));
 const extract_settings_1 = tslib_1.__importDefault(require("./extract-settings"));
 const extract_translations_1 = tslib_1.__importDefault(require("./extract-translations"));
 const extract_users_1 = tslib_1.__importDefault(require("./extract-users"));
-async function extract(dir) {
+async function extract(dir, options = {}) {
+    const { excludeCollections, skipFiles = false } = options;
     // Get the destination directory for the actual files
     const destination = dir + '/src';
     // Check if directory exists, if not, then create it.
@@ -34,8 +35,11 @@ async function extract(dir) {
     await (0, extract_collections_1.default)(destination);
     await (0, extract_fields_1.default)(destination);
     await (0, extract_relations_1.default)(destination);
-    await (0, extract_folders_1.default)(destination);
-    await (0, extract_files_1.default)(destination);
+    // Only extract files and folders if skipFiles is false
+    if (!skipFiles) {
+        await (0, extract_folders_1.default)(destination);
+        await (0, extract_files_1.default)(destination);
+    }
     await (0, extract_users_1.default)(destination);
     await (0, extract_roles_1.default)(destination);
     await (0, extract_permissions_1.default)(destination);
@@ -49,8 +53,11 @@ async function extract(dir) {
     await (0, extract_dashboards_1.extractPanels)(destination);
     await (0, extract_settings_1.default)(destination);
     await (0, extract_extensions_1.default)(destination);
-    await (0, extract_content_1.extractContent)(destination);
-    await (0, extract_assets_1.downloadAllFiles)(destination);
+    await (0, extract_content_1.extractContent)(destination, excludeCollections);
+    // Only download files if skipFiles is false
+    if (!skipFiles) {
+        await (0, extract_assets_1.downloadAllFiles)(destination);
+    }
     return {};
 }
 exports.default = extract;

package/oclif.manifest.json

@@ -182,7 +182,8 @@
       "description": "Extract a template from a Directus instance.",
       "examples": [
         "$ directus-template-cli extract",
-        "$ directus-template-cli extract -p --templateName=\"My Template\" --templateLocation=\"./my-template\" --directusToken=\"admin-token-here\" --directusUrl=\"http://localhost:8055\""
+        "$ directus-template-cli extract -p --templateName=\"My Template\" --templateLocation=\"./my-template\" --directusToken=\"admin-token-here\" --directusUrl=\"http://localhost:8055\"",
+        "$ directus-template-cli extract -p --templateName=\"My Template\" --templateLocation=\"./my-template\" --directusToken=\"admin-token-here\" --directusUrl=\"http://localhost:8055\" --excludeCollections=collection1,collection2"
       ],
       "flags": {
         "directusToken": {
@@ -205,6 +206,16 @@
           "multiple": false,
           "type": "option"
         },
+        "excludeCollections": {
+          "char": "e",
+          "description": "Comma-separated list of collection names to exclude from extraction",
+          "name": "excludeCollections",
+          "required": false,
+          "delimiter": ",",
+          "hasDynamicHelp": false,
+          "multiple": true,
+          "type": "option"
+        },
         "programmatic": {
           "char": "p",
           "description": "Run in programmatic mode (non-interactive) for use cases such as CI/CD pipelines.",
@@ -213,6 +224,14 @@
           "allowNo": false,
           "type": "boolean"
         },
+        "skipFiles": {
+          "char": "f",
+          "description": "Skip extracting files and assets",
+          "name": "skipFiles",
+          "required": false,
+          "allowNo": false,
+          "type": "boolean"
+        },
         "templateLocation": {
           "dependsOn": [
             "programmatic"
@@ -280,5 +299,5 @@
       ]
     }
   },
-  "version": "0.5.1"
+  "version": "0.6.0-beta.2"
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "directus-template-cli",
-  "version": "0.5.1",
+  "version": "0.6.0-beta.2",
   "description": "CLI Utility for applying templates to a Directus instance.",
   "author": "bryantgillespie @bryantgillespie",
   "bin": {