Merge pull request #128 from bluecadet/feat/config-intellisense

Author: claytercek

.changeset/chatty-mirrors-smash.md

@@ -0,0 +1,8 @@
+---
+"@bluecadet/launchpad": minor
+"@bluecadet/launchpad-content": minor
+"@bluecadet/launchpad-monitor": minor
+"@bluecadet/launchpad-utils": minor
+---
+
+Add intellisense support to configs

CONTRIBUTING.md

@@ -41,6 +41,5 @@ npm link
 
 cd ../../my-test-project
 @REM If needed: npm init
-npm link @bluecadet/launchpad
-@REM  If needed for your project: npm i @bluecadet/launchpad
+npm link @bluecadet/launchpad --save
 ```

packages/content/lib/content-options.js

@@ -2,197 +2,90 @@
  * @module launchpad-content/content-options
  */
 
-import { SourceOptions } from './content-sources/content-source.js';
+export const DOWNLOAD_PATH_TOKEN = '%DOWNLOAD_PATH%';
+
+export const TIMESTAMP_TOKEN = '%TIMESTAMP%';
+
+/**
+ * @typedef { import('./content-sources/airtable-source.js').AirtableOptions 
+ *  | import('./content-sources/contentful-source.js').ContentfulOptions
+ *  | import('./content-sources/json-source.js').JsonOptions
+ *  | import('./content-sources/sanity-source.js').SanityOptions
+ *  | import('./content-sources/strapi-source.js').StrapiOptions
+ * } AllSourceOptions
+ */
+
+/**
+ * @typedef ContentOptions
+ * @property {AllSourceOptions[]} [sources] A list of content source options. This defines which content is downloaded from where.
+ * @property {Array<Object<string, number>>} [imageTransforms] A list of image transforms to apply to a copy of each downloaded image.
+ * @property {Object<string, string>} [contentTransforms] A list of content transforms to apply to all donwloaded content.
+ * @property {string} [downloadPath] The path at which to store all downloaded files. Defaults to '.downloads/'.
+ * @property {string} [credentialsPath] The path to the json containing credentials for all content sources. Defaults to '.credentials.json'.
+ * @property {string} [tempPath] Temp file directory path. Defaults to '%DOWNLOAD_PATH%/.tmp/'.
+ * @property {string} [backupPath] Temp directory path where all downloaded content will be backed up before removal. Defaults to '%TIMESTAMP%/.tmp-backup/'.
+ * @property {string} [keep] Which files to keep in `dest` if `clearOldFilesOnSuccess` or `clearOldFilesOnStart` are `true`. E.g. `'*.json|*.csv|*.xml|*.git*'`
+ * @property {string} [strip] Strips this string from all media file paths when saving them locally
+ * @property {boolean} [backupAndRestore] Back up files before downloading and restore originals for all sources on failure of any single source. Defaults to true.
+ * @property {number} [maxConcurrent] Max concurrent downloads. Defaults to 4.
+ * @property {number} [maxTimeout] Max request timeout in ms. Defaults to 30000.
+ * @property {boolean} [clearOldFilesOnSuccess] Remove all existing files in dest dir when downloads succeed. Ignores files that match `keep`. Defaults to true.
+ * @property {boolean} [clearOldFilesOnStart] Will remove all existing files _before_ downloads starts. `false` will ensure that existing files are only deleted after a download succeeds. Defaults to false.
+ * @property {boolean} [ignoreCache] Will always download files regardless of whether they've been cached. Defaults to false.
+ * @property {boolean} [enableIfModifiedSinceCheck] Enables the HTTP if-modified-since check. Disabling this will assume that the local file is the same as the remote file if it already exists. Defaults to true.
+ * @property {boolean} [enableContentLengthCheck] Compares the HTTP header content-length with the local file size. Disabling this will assume that the local file is the same as the remote file if it already exists. Defaults to true.
+ * @property {boolean} [abortOnError] If set to `true`, errors will cause syncing to abort all remaining tasks immediately. Defaults to true.
+ * @property {boolean} [ignoreImageTransformCache] Set to `true` to always re-generate transformed images, even if cached versions of the original and transformed image already exist. Defaults to false.
+ * @property {boolean} [ignoreImageTransformErrors] Set to `false` if you want to abort a content source from downloading if any of the image transforms fail. Leaving this to `true` will allow for non-image files to fail quietly. Defaults to true.
+ * @property {boolean} [forceClearTempFiles] Set to `false` if you want to keep all contents of the tempPath dir before downloading. Defaults to true.
+ */
+
+/**
+ * @type {Required<ContentOptions>}
+ */
+export const CONTENT_OPTION_DEFAULTS = {
+	sources: [],
+	imageTransforms: [],
+	contentTransforms: {},
+	downloadPath: '.downloads/',
+	credentialsPath: '.credentials.json',
+	tempPath: '%DOWNLOAD_PATH%/.tmp/',
+	backupPath: '%TIMESTAMP%/.tmp-backup/',
+	keep: '',
+	strip: '',
+	backupAndRestore: true,
+	maxConcurrent: 4,
+	maxTimeout: 30000,
+	clearOldFilesOnSuccess: true,
+	clearOldFilesOnStart: false,
+	ignoreCache: false,
+	enableIfModifiedSinceCheck: true,
+	enableContentLengthCheck: true,
+	abortOnError: true,
+	ignoreImageTransformCache: false,
+	ignoreImageTransformErrors: true,
+	forceClearTempFiles: true
+};
 
 /**
- * Options for all content and media downloads. Each of these settings can also be configured per `ContentSource`.
+ * Apply defaults to passed content config
+ * @param {ContentOptions} [config]
  */
-export class ContentOptions {
-	static get DOWNLOAD_PATH_TOKEN() {
-		return '%DOWNLOAD_PATH%';
-	}
-	
-	static get TIMESTAMP_TOKEN() {
-		return '%TIMESTAMP%';
-	}
-	
-	/**
-	 * @param {any} options
-	 */
-	constructor({
-		sources = [],
-		imageTransforms = [],
-		contentTransforms = {},
-		downloadPath = '.downloads/',
-		credentialsPath = '.credentials.json',
-		tempPath = `${ContentOptions.DOWNLOAD_PATH_TOKEN}/.tmp/`,
-		backupPath = `${ContentOptions.DOWNLOAD_PATH_TOKEN}/.tmp-backup/`,
-		keep = '',
-		strip = '',
-		backupAndRestore = true,
-		maxConcurrent = 4,
-		maxTimeout = 30000,
-		clearOldFilesOnStart = false,
-		clearOldFilesOnSuccess = true,
-		ignoreCache = false,
-		enableIfModifiedSinceCheck = true,
-		enableContentLengthCheck = true,
-		abortOnError = true,
-		ignoreImageTransformErrors = true,
-		ignoreImageTransformCache = false,
-		forceClearTempFiles = true,
-		...rest // Any additional custom arguments
-	} = {}) {
-		/**
-		 * A list of content source options. This defines which content is downloaded from where.
-		 * @type {Array<SourceOptions>}
-		 * @default []
-		 */
-		this.sources = sources;
-		
-		/**
-		 * A list of image transforms to apply to a copy of each downloaded image.
-		 * @type {Array<Object<string, number>>}
-		 * @default []
-		 */
-		this.imageTransforms = imageTransforms;
-		
-		/**
-		 * A list of content transforms to apply to all donwloaded content.
-		 * @type {Object<string, string>}
-		 * @default {}
-		 */
-		this.contentTransforms = contentTransforms;
-		
-		/**
-		 * The path at which to store all downloaded files.
-		 * @type {string}
-		 * @default '.downloads/'
-		 */
-		this.downloadPath = downloadPath;
-		
-		/**
-		 * The path to the json containing credentials for all content sources.
-		 * @type {string}
-		 * @default '.credentials.json'
-		 */
-		this.credentialsPath = credentialsPath;
-		
-		/**
-		 * Temp file directory path.
-		 * @type {string}
-		 * @default '%DOWNLOAD_PATH%/.tmp/'
-		 */
-		this.tempPath = tempPath;
-		
-		/**
-		 * Temp directory path where all downloaded content will be backed up before removal.
-		 * @type {string}
-		 * @default '%DOWNLOAD_PATH%/.backups/'
-		 */
-		this.backupPath = backupPath;
-		
-		/**
-		 * Which files to keep in `dest` if `clearOldFilesOnSuccess` or `clearOldFilesOnStart` are `true`. E.g. `'*.json|*.csv|*.xml|*.git*'`
-		 * @type {string}
-		 * @default ''
-		 */
-		this.keep = keep;
-		
-		/**
-		 * Strips this string from all media file paths when saving them locally
-		 * @type {string}
-		 * @default ''
-		 */
-		this.strip = strip;
-		
-		/**
-		 * Back up files before downloading and restore originals for all sources on failure of any single source.
-		 * @type {boolean}
-		 * @default true
-		 */
-		this.backupAndRestore = backupAndRestore;
-		
-		/**
-		 * Max concurrent downloads.
-		 * @type {number}
-		 * @default 4
-		 */
-		this.maxConcurrent = maxConcurrent;
-		
-		/**
-		 * Max request timeout in ms.
-		 * @type {number}
-		 * @default 30000
-		 */
-		this.maxTimeout = maxTimeout;
-		
-		/**
-		 * Remove all existing files in dest dir when downloads succeed. Ignores files that match `keep`
-		 * @type {boolean}
-		 * @default true
-		 */
-		this.clearOldFilesOnSuccess = clearOldFilesOnSuccess;
-		
-		/**
-		 * Will remove all existing files _before_ downloads starts. `false` will ensure that existing files are only deleted after a download succeeds.
-		 * @type {boolean}
-		 * @default false
-		 */
-		this.clearOldFilesOnStart = clearOldFilesOnStart;
-		
-		/**
-		 * Will always download files regardless of whether they've been cached
-		 * @type {boolean}
-		 * @default false
-		 */
-		this.ignoreCache = ignoreCache;
-		
-		/**
-		 * Enables the HTTP if-modified-since check. Disabling this will assume that the local file is the same as the remote file if it already exists.
-		 * @type {boolean}
-		 * @default true
-		 */
-		this.enableIfModifiedSinceCheck = enableIfModifiedSinceCheck;
-		
-		/**
-		 * Compares the HTTP header content-length with the local file size. Disabling this will assume that the local file is the same as the remote file if it already exists.
-		 * @type {boolean}
-		 * @default true
-		 */
-		this.enableContentLengthCheck = enableContentLengthCheck;
-		
-		/**
-		 * If set to `true`, errors will cause syncing to abort all remaining tasks immediately
-		 * @type {boolean}
-		 * @default true
-		 */
-		this.abortOnError = abortOnError;
-		
-		/** 
-		 * Set to `true` to always re-generate transformed images, even if cached versions of the original and transformed image already exist.
-		 * @type {boolean}
-		 * @default false
-		 */
-		this.ignoreImageTransformCache = ignoreImageTransformCache;
-		
-		/** 
-		 * Set to `false` if you want to abort a content source from downloading if any of the image transforms fail. Leaving this to `true` will allow for non-image files to fail quietly.
-		 * @type {boolean}
-		 * @default true
-		 */
-		this.ignoreImageTransformErrors = ignoreImageTransformErrors;
-		
-		/**
-		 * Set to `false` if you want to keep all contents of the tempPath dir before downloading
-		 * @type {boolean}
-		 * @default true
-		 */
-		this.forceClearTempFiles = forceClearTempFiles;
-		
-		// Allows for additional properties to be inherited
-		Object.assign(this, rest);
-	}
+export function resolveContentOptions(config) {
+	return {
+		...CONTENT_OPTION_DEFAULTS,
+		...config
+	};
 }
 
-export default ContentOptions;
+/**
+ * @typedef {ReturnType<typeof resolveContentOptions>} ResolvedContentOptions
+ */
+
+/**
+ * @param {ContentOptions} config 
+ * @returns {ContentOptions}
+ */
+export function defineContentConfig(config) {
+	return config;
+}