Merge branch 'master' of https://github.com/xeroxinteractive/cf-content-types-generator

Author: phawxby

.eslintrc

@@ -17,7 +17,9 @@
     "indent": [
       "error",
       4
-    ]
+    ],
+    "unicorn/consistent-function-scoping": "off",
+    "unicorn/no-array-callback-reference": "off"
   },
   "extends": [
     "oclif",

README.md

@@ -256,4 +256,3 @@ const stringContent = new CFDefinitionsBuilder()
 ### Browser Usage
 You can use `CFDefinitionsBuilder` also in a browser environment.
 > Example: [TS Content Types Generator App](https://github.com/marcolink/cf-content-types-generator-app)
-

package.json

@@ -26,8 +26,8 @@
     "@oclif/errors": "latest",
     "@oclif/plugin-help": "^3",
     "cli-ux": "^5.5.1",
-    "contentful": "^8.1.7",
-    "contentful-export": "^7.11.6",
+    "contentful": "^9.1.28",
+    "contentful-export": "^7.16.0",
     "fs-extra": "^9.1.0",
     "lodash": "^4.17.15",
     "ts-morph": "9.1.0",
@@ -38,18 +38,15 @@
     "@oclif/dev-cli": "^1",
     "@oclif/test": "^1.2.5",
     "@semantic-release/changelog": "^5.0.1",
-    "@types/chai": "^4",
     "@types/fs-extra": "^9.0.1",
     "@types/lodash": "^4.14.155",
-    "@types/mocha": "^8",
-    "chai": "^4",
-    "eslint": "^7.12",
-    "eslint-config-oclif": "^3.1",
-    "eslint-config-oclif-typescript": "^0.2",
+    "@typescript-eslint/eslint-plugin": "^5.22.0",
+    "eslint": "^8.14.0",
+    "eslint-config-oclif": "^4.0.0",
+    "eslint-config-oclif-typescript": "^1.0.2",
+    "eslint-plugin-unicorn": "^42.0.0",
     "jest-fixtures": "^0.6.0",
-    "mocha": "^5",
-    "nyc": "^15",
-    "semantic-release": "^17.0.7",
+    "semantic-release": "^19.0.2",
     "strip-indent": "^3.0.0",
     "typescript": "4.2.2"
   },
@@ -90,6 +87,11 @@
       "@semantic-release/github"
     ]
   },
+  "resolutions": {
+    "ansi-regex": ">=3.0.1 <6.0.0",
+    "minimist": ">=1.2.6",
+    "path-parse": ">=1.0.7"
+  },
   "publishConfig": {
     "registry": "https://npm.pkg.github.com/xeroxinteractive"
   }

src/cf-definitions-builder.ts

@@ -1,5 +1,5 @@
 import {Field} from 'contentful';
-import * as path from 'path';
+import * as path from 'node:path';
 import {
     forEachStructureChild,
     ImportDeclarationStructure,
@@ -52,7 +52,7 @@ export default class CFDefinitionsBuilder {
 
         const interfaceDeclaration = this.createInterfaceDeclaration(file, moduleFieldsName(model.sys.id));
 
-        model.fields.forEach(field => this.addProperty(file, interfaceDeclaration, field));
+        for (const field of model.fields)  this.addProperty(file, interfaceDeclaration, field);
 
         this.addEntryTypeAlias(file, model.sys.id, moduleFieldsName(model.sys.id));
 
@@ -81,34 +81,33 @@ export default class CFDefinitionsBuilder {
         const imports: OptionalKind<ImportDeclarationStructure>[] = [];
         const types: string[] = [];
 
-        this.project.getSourceFiles()
-            .filter(sourceFile => sourceFile.getBaseNameWithoutExtension() !== mergeFileName)
-            .forEach(sourceFile => forEachStructureChild(sourceFile.getStructure(),
-                childStructure => {
-                    switch (childStructure.kind) {
-                    case StructureKind.ImportDeclaration:
-                        imports.push(childStructure);
-                        break;
-                    case StructureKind.Interface:
-                        types.push(childStructure.name);
-                        mergeFile.addInterface(childStructure);
-                        break;
-                    case StructureKind.TypeAlias:
-                        types.push(childStructure.name);
-                        mergeFile.addTypeAlias(childStructure);
-                        break;
-                    default:
-                        throw new Error(`Unhandled node type '${StructureKind[childStructure.kind]}'.`);
-                    }
-                }));
+        for (const sourceFile of this.project.getSourceFiles()
+            .filter(sourceFile => sourceFile.getBaseNameWithoutExtension() !== mergeFileName))  forEachStructureChild(sourceFile.getStructure(),
+            childStructure => {
+                switch (childStructure.kind) {
+                case StructureKind.ImportDeclaration:
+                    imports.push(childStructure);
+                    break;
+                case StructureKind.Interface:
+                    types.push(childStructure.name);
+                    mergeFile.addInterface(childStructure);
+                    break;
+                case StructureKind.TypeAlias:
+                    types.push(childStructure.name);
+                    mergeFile.addTypeAlias(childStructure);
+                    break;
+                default:
+                    throw new Error(`Unhandled node type '${StructureKind[childStructure.kind]}'.`);
+                }
+            });
 
         // only import modules not present in merge file
-        imports.forEach(importD => {
+        for (const importD of imports) {
             const name = importD.moduleSpecifier.slice(2);
             if (!types.includes(name)) {
                 mergeFile.addImportDeclaration(importD);
             }
-        });
+        }
 
         mergeFile.organizeImports({
             ensureNewLineAtEndOfFile: true,
@@ -154,7 +153,7 @@ export default class CFDefinitionsBuilder {
             namedImports: ['CMSManagementEntry'],
         });
 
-        files.forEach(fileName => {
+        for (const fileName of files) {
             indexFile.addImportDeclaration({
                 isTypeOnly: true,
                 namedImports: [moduleName(fileName), moduleFieldsName(fileName)],
@@ -169,7 +168,7 @@ export default class CFDefinitionsBuilder {
                 moduleSpecifier: `./${fileName}`,
             });
             cmsEntries.push(moduleName(fileName));
-        });
+        }
 
         indexFile.addTypeAlias({isExported: true, name: 'CMSEntries', type: renderUnionType(cmsEntries)});
         indexFile.addTypeAlias({isExported: true, name: 'CMSManagementEntries', type: renderUnionType(cmsEntries.map(name => renderGenericType('CMSManagementEntry', name)))});

src/cf-property-imports.ts

@@ -17,10 +17,12 @@ export const propertyImports = (field: Field, ignoreModule?: string): OptionalKi
             .filter(filterIgnoredModule)
             .map(moduleImport) : [{moduleSpecifier: './index', namedImports: ['CMSEntries']}];
     }
+
     if (field.type === 'Array' && field.items) {
         return field.items?.validations?.length > 0 ? linkContentTypeValidations(field.items)
             .filter(filterIgnoredModule)
             .map(moduleImport) : [{moduleSpecifier: './index', namedImports: ['CMSEntries']}];
     }
+
     return [];
 };

src/cf-property-types.ts

@@ -14,8 +14,10 @@ export const anyType = (field: Field): string => {
                 ) {
                     return renderLiteralType;
                 }
+
                 return (value: string) => value.toString();
             };
+
             return renderUnionType(includesValidation.in.map(mapper()));
         }
     }

src/index.ts

@@ -1,9 +1,12 @@
 import {Command, flags} from '@oclif/command';
 import * as fs from 'fs-extra';
 import {writeFile} from 'fs-extra';
-import * as path from 'path';
+import * as path from 'node:path';
 import CFDefinitionsBuilder from './cf-definitions-builder';
 
+// Does not appear to work as an import, not sure why and I'm just clearing up the audit
+// quickly so don't want to spent time messing about if it works.
+// eslint-disable-next-line unicorn/prefer-module
 const contentfulExport = require('contentful-export');
 
 class ContentfulMdg extends Command {
@@ -43,6 +46,7 @@ class ContentfulMdg extends Command {
                 spaceId: flags.spaceId,
                 managementToken: flags.token,
                 environmentId: flags.environment,
+                // https://github.com/contentful/contentful-export/issues/966
                 skipEditorInterfaces: true,
                 skipContent: true,
                 skipRoles: true,
@@ -52,13 +56,16 @@ class ContentfulMdg extends Command {
         }
 
         const builder = new CFDefinitionsBuilder();
+
+        // eslint-disable-next-line unicorn/no-array-for-each
         content.contentTypes.forEach(builder.appendType);
 
         if (flags.out) {
             const outDir = path.resolve(flags.out);
             if (!flags.preserve && fs.existsSync(outDir)) {
                 await fs.remove(outDir);
             }
+
             await fs.ensureDir(outDir);
             await builder.write(flags.out, writeFile);
         } else {

src/renderer/cf-render-prop-array.ts

@@ -19,6 +19,7 @@ export const renderPropArray = (field: Field): string => {
         if (validation?.length > 0) {
             return `(${renderUnionType(validation.map(renderLiteralType))})[]`;
         }
+
         return 'Contentful.EntryFields.Symbol[]';
     }
 

src/renderer/cf-render-prop-link.ts

@@ -11,8 +11,10 @@ export const renderPropLink = (field: Pick<Field, 'validations' | 'linkType'>) =
     if (field.linkType === 'Entry') {
         return linkContentType(field);
     }
+
     if (field.linkType === 'Asset') {
         return 'AssetLink';
     }
+
     return 'Contentful.' + field.linkType!;
 };

src/renderer/render-union-type.ts

@@ -1 +1 @@
-export const renderUnionType = (types: string[]): string => types.join(' | ');
+export const renderUnionType = (types: string[]): string => types.sort().join(' | ');