@oak-digital/types-4-strapi-2 0.2.5 → 0.2.6

package/README.md

@@ -48,9 +48,15 @@ This can be done with the `--out` flag like in the following example.
 * Support for localization
 * Support if you are using other plugins, such as `url-alias`, which should add extra fields for some interfaces.
 
-## Help
-
-use `t4s --help` to display which options are available for you
+## Flags
+
+| **flag**                    | **Description**                                                                    |
+|-----------------------------|------------------------------------------------------------------------------------|
+| -i, --in <dir>              | The src directory for strapi                                                       |
+| -o, --out <dir>             | The output directory to output the types to                                        |
+| --component-prefix <prefix> | A prefix for components                                                            |
+| -D, --delete-old            | CAUTION: This option is equivalent to running rm -rf on the output directory first |
+| --prettier <file>           | The prettier config file to use for formatting typescript interfaces               |
 
 ## Building
 

package/lib/index.js

@@ -11,13 +11,15 @@ commander_1.program
     .option('-i, --in <dir>', 'The src directory for strapi', './src')
     .option('-o, --out <dir>', 'The output directory to output the types to', './types')
     .option('--component-prefix <prefix>', 'A prefix for components', '')
+    .option('-D, --delete-old', 'CAUTION: This option is equivalent to running rm -rf on the output directory first')
     .option('--prettier <file>', 'The prettier config file to use for formatting typescript interfaces');
 commander_1.program.parse();
 var options = commander_1.program.opts();
-var input = options.in, out = options.out, componentPrefix = options.componentPrefix, prettierFile = options.prettier;
+var input = options.in, out = options.out, componentPrefix = options.componentPrefix, prettierFile = options.prettier, deleteOld = options.deleteOld;
 var manager = new InterfaceManager_1.default(out, input, {
     componentPrefix: componentPrefix,
     prettierFile: prettierFile,
+    deleteOld: deleteOld,
 });
 manager.run().catch(function (err) {
     console.error(err);

package/lib/interface/InterfaceManager.d.ts

@@ -11,6 +11,7 @@ export default class InterfaceManager {
         componentPrefixOverridesPrefix: boolean;
         builtinsPrefix: string;
         builtinsPrefixOverridesPrefix: boolean;
+        deleteOld: boolean;
         prettierFile: any;
     };
     constructor(outRoot: string, strapiSrcRoot: string, options?: any);
@@ -18,6 +19,7 @@ export default class InterfaceManager {
     createInterfaces(): Promise<void>;
     createBuiltinInterfaces(): void;
     injectDependencies(): void;
+    deleteOldFolders(): Promise<void>;
     makeFolders(): Promise<void>;
     writeInterfaces(): Promise<void>;
     writeIndexFile(): Promise<void>;

package/lib/interface/InterfaceManager.js

@@ -140,23 +140,44 @@ var InterfaceManager = /** @class */ (function () {
             inter.setRelations(interfacesToInject);
         });
     };
+    InterfaceManager.prototype.deleteOldFolders = function () {
+        return __awaiter(this, void 0, void 0, function () {
+            return __generator(this, function (_a) {
+                switch (_a.label) {
+                    case 0: return [4 /*yield*/, (0, promises_1.rm)(this.OutRoot, {
+                            force: true,
+                            recursive: true,
+                        })];
+                    case 1:
+                        _a.sent();
+                        return [2 /*return*/];
+                }
+            });
+        });
+    };
     InterfaceManager.prototype.makeFolders = function () {
         return __awaiter(this, void 0, void 0, function () {
             var componentCategories, promises, componentCategoriesPromises, builtinsPath;
             var _this = this;
             return __generator(this, function (_a) {
                 switch (_a.label) {
-                    case 0: return [4 /*yield*/, (0, schemaReader_1.getComponentCategoryFolders)(this.StrapiSrcRoot)];
+                    case 0:
+                        if (!this.Options.deleteOld) return [3 /*break*/, 2];
+                        return [4 /*yield*/, this.deleteOldFolders()];
                     case 1:
+                        _a.sent();
+                        _a.label = 2;
+                    case 2: return [4 /*yield*/, (0, schemaReader_1.getComponentCategoryFolders)(this.StrapiSrcRoot)];
+                    case 3:
                         componentCategories = _a.sent();
-                        if (!!(0, fs_1.existsSync)(this.OutRoot)) return [3 /*break*/, 3];
+                        if (!!(0, fs_1.existsSync)(this.OutRoot)) return [3 /*break*/, 5];
                         return [4 /*yield*/, (0, promises_1.mkdir)(this.OutRoot, {
                                 recursive: true,
                             })];
-                    case 2:
+                    case 4:
                         _a.sent();
-                        _a.label = 3;
-                    case 3:
+                        _a.label = 5;
+                    case 5:
                         promises = [];
                         componentCategoriesPromises = componentCategories.map(function (category) { return __awaiter(_this, void 0, void 0, function () {
                             var path;
@@ -180,7 +201,7 @@ var InterfaceManager = /** @class */ (function () {
                             promises.push((0, promises_1.mkdir)((0, posix_1.join)(this.OutRoot, 'builtins')));
                         }
                         return [4 /*yield*/, Promise.all(promises)];
-                    case 4:
+                    case 6:
                         _a.sent();
                         return [2 /*return*/];
                 }
@@ -279,6 +300,7 @@ var InterfaceManager = /** @class */ (function () {
         componentPrefixOverridesPrefix: false,
         builtinsPrefix: '',
         builtinsPrefixOverridesPrefix: false,
+        deleteOld: false,
         prettierFile: null,
     };
     return InterfaceManager;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oak-digital/types-4-strapi-2",
-  "version": "0.2.5",
+  "version": "0.2.6",
   "description": "Typescript interface generator for Strapi 4 models",
   "bin": {
     "t4s": "./bin/index.js"