@atomicsmash/smash-config 1.0.2 → 2.0.0-beta.0

package/dist/index.d.ts

@@ -1,16 +1,3 @@
-import type { Options } from "sass";
-export type SCSSAliases = {
-    loadPaths?: Options<"async">["loadPaths"];
-    importers?: Options<"async">["importers"];
-};
-export type SmashConfig = {
-    projectName: string;
-    themePath: string;
-    themeFolderName?: string;
-    assetsOutputFolder?: string;
-    npmInstallPaths?: string[];
-    composerInstallPaths?: string[];
-    scssAliases?: SCSSAliases;
-};
-export { getSmashConfig } from "./utils.js";
+export * from "./types.js";
+export { getSmashConfig } from "./utils/getSmashConfig.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAEpC,MAAM,MAAM,WAAW,GAAG;IACzB,SAAS,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,WAAW,CAAC,CAAC;IAC1C,SAAS,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,WAAW,CAAC,CAAC;CAC1C,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAChC,WAAW,CAAC,EAAE,WAAW,CAAC;CAC1B,CAAC;AAEF,OAAO,EAAE,cAAc,EAAE,MAAM,YAAY,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,YAAY,CAAC;AAE3B,OAAO,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC"}

package/dist/index.js

@@ -1 +1,2 @@
-export { getSmashConfig } from "./utils.js";
+export * from "./types.js";
+export { getSmashConfig } from "./utils/getSmashConfig.js";

package/dist/types.d.ts

@@ -0,0 +1,89 @@
+import type { Options } from "sass";
+export type SCSSAliases = {
+    loadPaths?: Options<"async">["loadPaths"];
+    importers?: Options<"async">["importers"];
+};
+export type SmashConfigV1 = {
+    version?: 1 | undefined;
+    projectName: string;
+    themePath: string;
+    themeFolderName?: string;
+    assetsOutputFolder?: string;
+    npmInstallPaths?: string[];
+    composerInstallPaths?: string[];
+    scssAliases?: SCSSAliases;
+};
+export type SmashConfigV2 = {
+    version: 2;
+    projectName: string;
+    themePath: string;
+    themeFolderName?: string;
+    assetsOutputFolder?: string;
+    npmInstallPaths?: string[];
+    composerInstallPaths?: string[];
+    scssAliases?: SCSSAliases;
+    uploadsPath?: string;
+    cli?: {
+        pullMedia?: {
+            monthsToPull?: number;
+        };
+    };
+    staging: {
+        url: string;
+        webRoot: string;
+        dbPrefix?: string;
+        uploadsPath?: string;
+        ssh: {
+            username: string;
+            host: string;
+            port?: number;
+        };
+        httpAuth?: {
+            username: string;
+            password: string;
+        };
+    };
+};
+export type SmashConfig = SmashConfigV1 | SmashConfigV2;
+export type SmashConfigV1Resolved = {
+    version: 1;
+    projectName: string;
+    themePath: string;
+    themeFolderName: string;
+    assetsOutputFolder: string;
+    npmInstallPaths: string[];
+    composerInstallPaths: string[];
+    scssAliases: SCSSAliases;
+};
+export type SmashConfigV2Resolved = {
+    version: 2;
+    projectName: string;
+    themePath: string;
+    themeFolderName: string;
+    assetsOutputFolder: string;
+    npmInstallPaths: string[];
+    composerInstallPaths: string[];
+    scssAliases: SCSSAliases;
+    uploadsPath: string;
+    cli: {
+        pullMedia: {
+            monthsToPull: number;
+        };
+    };
+    staging: {
+        url: string;
+        webRoot: string;
+        dbPrefix: string;
+        uploadsPath: string;
+        ssh: {
+            username: string;
+            host: string;
+            port?: number;
+        };
+        httpAuth?: {
+            username: string;
+            password: string;
+        };
+    };
+};
+//# sourceMappingURL=types.d.ts.map

package/dist/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAEpC,MAAM,MAAM,WAAW,GAAG;IACzB,SAAS,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,WAAW,CAAC,CAAC;IAC1C,SAAS,CAAC,EAAE,OAAO,CAAC,OAAO,CAAC,CAAC,WAAW,CAAC,CAAC;CAC1C,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC3B,OAAO,CAAC,EAAE,CAAC,GAAG,SAAS,CAAC;IACxB,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAChC,WAAW,CAAC,EAAE,WAAW,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC3B,OAAO,EAAE,CAAC,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB,kBAAkB,CAAC,EAAE,MAAM,CAAC;IAC5B,eAAe,CAAC,EAAE,MAAM,EAAE,CAAC;IAC3B,oBAAoB,CAAC,EAAE,MAAM,EAAE,CAAC;IAChC,WAAW,CAAC,EAAE,WAAW,CAAC;IAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,GAAG,CAAC,EAAE;QACL,SAAS,CAAC,EAAE;YACX,YAAY,CAAC,EAAE,MAAM,CAAC;SACtB,CAAC;KACF,CAAC;IACF,OAAO,EAAE;QACR,GAAG,EAAE,MAAM,CAAC;QACZ,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,GAAG,EAAE;YACJ,QAAQ,EAAE,MAAM,CAAC;YACjB,IAAI,EAAE,MAAM,CAAC;YACb,IAAI,CAAC,EAAE,MAAM,CAAC;SACd,CAAC;QACF,QAAQ,CAAC,EAAE;YACV,QAAQ,EAAE,MAAM,CAAC;YACjB,QAAQ,EAAE,MAAM,CAAC;SACjB,CAAC;KACF,CAAC;CACF,CAAC;AAEF,MAAM,MAAM,WAAW,GAAG,aAAa,GAAG,aAAa,CAAC;AAExD,MAAM,MAAM,qBAAqB,GAAG;IACnC,OAAO,EAAE,CAAC,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,MAAM,CAAC;IACxB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,oBAAoB,EAAE,MAAM,EAAE,CAAC;IAC/B,WAAW,EAAE,WAAW,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,qBAAqB,GAAG;IACnC,OAAO,EAAE,CAAC,CAAC;IACX,WAAW,EAAE,MAAM,CAAC;IACpB,SAAS,EAAE,MAAM,CAAC;IAClB,eAAe,EAAE,MAAM,CAAC;IACxB,kBAAkB,EAAE,MAAM,CAAC;IAC3B,eAAe,EAAE,MAAM,EAAE,CAAC;IAC1B,oBAAoB,EAAE,MAAM,EAAE,CAAC;IAC/B,WAAW,EAAE,WAAW,CAAC;IACzB,WAAW,EAAE,MAAM,CAAC;IACpB,GAAG,EAAE;QACJ,SAAS,EAAE;YACV,YAAY,EAAE,MAAM,CAAC;SACrB,CAAC;KACF,CAAC;IACF,OAAO,EAAE;QACR,GAAG,EAAE,MAAM,CAAC;QACZ,OAAO,EAAE,MAAM,CAAC;QAChB,QAAQ,EAAE,MAAM,CAAC;QACjB,WAAW,EAAE,MAAM,CAAC;QACpB,GAAG,EAAE;YACJ,QAAQ,EAAE,MAAM,CAAC;YACjB,IAAI,EAAE,MAAM,CAAC;YACb,IAAI,CAAC,EAAE,MAAM,CAAC;SACd,CAAC;QACF,QAAQ,CAAC,EAAE;YACV,QAAQ,EAAE,MAAM,CAAC;YACjB,QAAQ,EAAE,MAAM,CAAC;SACjB,CAAC;KACF,CAAC;CACF,CAAC"}

package/dist/utils/getSmashConfig.d.ts

@@ -0,0 +1,3 @@
+import type { SmashConfigV1Resolved, SmashConfigV2Resolved } from "../types.js";
+export declare function getSmashConfig<MinVersion extends 1 | 2>(minVersion?: MinVersion): Promise<MinVersion extends 2 ? SmashConfigV2Resolved : SmashConfigV1Resolved | SmashConfigV2Resolved>;
+//# sourceMappingURL=getSmashConfig.d.ts.map

package/dist/utils/getSmashConfig.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"getSmashConfig.d.ts","sourceRoot":"","sources":["../../src/utils/getSmashConfig.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAIX,qBAAqB,EACrB,qBAAqB,EACrB,MAAM,aAAa,CAAC;AA6BrB,wBAAsB,cAAc,CAAC,UAAU,SAAS,CAAC,GAAG,CAAC,EAC5D,UAAU,CAAC,EAAE,UAAU,yGA+EvB"}

package/dist/utils/getSmashConfig.js

@@ -0,0 +1,109 @@
+import { normaliseStagingURL } from "./normaliseStagingURL.js";
+import { normalize, resolve } from "node:path";
+import { pathToFileURL } from "node:url";
+import { cosmiconfig } from "cosmiconfig";
+const getDefaultSCSSAliases = (themePath) => ({
+    importers: [
+        {
+            findFileUrl(url) {
+                if (!url.startsWith("sitecss:"))
+                    return null;
+                const pathname = url.substring(8);
+                return pathToFileURL(`${resolve(process.cwd(), themePath, "src/styles")}${pathname.startsWith("/") ? pathname : `/${pathname}`}`);
+            },
+        },
+        {
+            findFileUrl(url) {
+                if (!url.startsWith("launchpad:"))
+                    return null;
+                const pathname = url.substring(10);
+                return pathToFileURL(`${resolve(process.cwd(), themePath, "../launchpad/src/styles")}${pathname.startsWith("/") ? pathname : `/${pathname}`}`);
+            },
+        },
+    ],
+});
+export async function getSmashConfig(minVersion) {
+    const explorer = cosmiconfig("smash");
+    const config = await explorer
+        .load(resolve(process.cwd(), "smash.config.ts"))
+        .then((result) => {
+        if (!result || result.isEmpty) {
+            throw new Error("Failed to get config. Please make sure smash.config.ts exists and exports a valid smash config configuration object.");
+        }
+        const config = result.config;
+        if (isValidSmashConfigV2(config)) {
+            const fullConfig = {
+                scssAliases: getDefaultSCSSAliases(config.themePath),
+                themeFolderName: config.projectName,
+                uploadsPath: `public/wp-content/uploads`,
+                ...config,
+                // Normalize and resolve paths to cwd.
+                npmInstallPaths: config.npmInstallPaths?.map((path) => {
+                    return normalize(resolve(process.cwd(), path));
+                }) ?? [],
+                composerInstallPaths: config.composerInstallPaths?.map((path) => {
+                    return normalize(resolve(process.cwd(), path));
+                }) ?? [],
+                assetsOutputFolder: config.assetsOutputFolder
+                    ? normalize(config.assetsOutputFolder)
+                    : "dist",
+                staging: {
+                    uploadsPath: config.uploadsPath ?? `public/wp-content/uploads`,
+                    dbPrefix: "wp_",
+                    ...config.staging,
+                    url: normaliseStagingURL(config.staging.url),
+                },
+                cli: {
+                    ...config.cli,
+                    pullMedia: {
+                        monthsToPull: -1,
+                        ...config.cli?.pullMedia,
+                    },
+                },
+            };
+            return fullConfig;
+        }
+        if (isValidSmashConfigV1(config)) {
+            const fullConfig = {
+                version: 1,
+                scssAliases: getDefaultSCSSAliases(config.themePath),
+                themeFolderName: config.projectName,
+                ...config,
+                // Normalize and resolve paths to cwd.
+                npmInstallPaths: config.npmInstallPaths?.map((path) => {
+                    return normalize(resolve(process.cwd(), path));
+                }) ?? [],
+                composerInstallPaths: config.composerInstallPaths?.map((path) => {
+                    return normalize(resolve(process.cwd(), path));
+                }) ?? [],
+                assetsOutputFolder: config.assetsOutputFolder
+                    ? normalize(config.assetsOutputFolder)
+                    : "dist",
+            };
+            return fullConfig;
+        }
+        throw new Error("Failed to get valid config. Please check that your smash.config.ts exports a valid smash config configuration object.");
+    });
+    if (minVersion && config.version < minVersion) {
+        throw new Error(`A smash config was found but it is not up to date. Please update to at least version ${minVersion.toString()}.`);
+    }
+    return config;
+}
+function isValidSmashConfigV1(config) {
+    return (typeof config === "object" &&
+        config !== null &&
+        "projectName" in config &&
+        typeof config.projectName === "string" &&
+        "themePath" in config &&
+        typeof config.themePath === "string");
+}
+function isValidSmashConfigV2(config) {
+    return (typeof config === "object" &&
+        config !== null &&
+        "version" in config &&
+        config.version === 2 &&
+        "projectName" in config &&
+        typeof config.projectName === "string" &&
+        "themePath" in config &&
+        typeof config.themePath === "string");
+}

package/dist/utils/normaliseStagingURL.d.ts

@@ -0,0 +1,2 @@
+export declare function normaliseStagingURL(stagingURL: string): string;
+//# sourceMappingURL=normaliseStagingURL.d.ts.map

package/dist/utils/normaliseStagingURL.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"normaliseStagingURL.d.ts","sourceRoot":"","sources":["../../src/utils/normaliseStagingURL.ts"],"names":[],"mappings":"AAAA,wBAAgB,mBAAmB,CAAC,UAAU,EAAE,MAAM,GAAG,MAAM,CAK9D"}

package/dist/utils/normaliseStagingURL.js

@@ -0,0 +1,6 @@
+export function normaliseStagingURL(stagingURL) {
+    return stagingURL
+        .replace(/^https?:\/\//, "")
+        .replace(/^\/\//, "")
+        .replace(/\/$/, "");
+}

package/package.json

@@ -1,7 +1,7 @@
 {
 	"name": "@atomicsmash/smash-config",
 	"type": "module",
-	"version": "1.0.2",
+	"version": "2.0.0-beta.0",
 	"description": "",
 	"keywords": [],
 	"homepage": "https://www.atomicsmash.co.uk/",
@@ -37,10 +37,9 @@
 		"lint:types": "tsc"
 	},
 	"peerDependencies": {
-		"dotenv": "^17.3.1",
-		"sass": "^1.98.0"
+		"sass": "^1.101.0"
 	},
 	"dependencies": {
-		"cosmiconfig": "^9.0.1"
+		"cosmiconfig": "^9.0.2"
 	}
 }

package/dist/utils.d.ts

@@ -1,3 +0,0 @@
-import type { SmashConfig } from "./index.js";
-export declare function getSmashConfig(): Promise<Required<SmashConfig> | null>;
-//# sourceMappingURL=utils.d.ts.map

package/dist/utils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../src/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAe,WAAW,EAAE,MAAM,YAAY,CAAC;AA4B3D,wBAAsB,cAAc,IAAI,OAAO,CAAC,QAAQ,CAAC,WAAW,CAAC,GAAG,IAAI,CAAC,CAoE5E"}

package/dist/utils.js

@@ -1,94 +0,0 @@
-import { normalize, resolve } from "node:path";
-import { pathToFileURL } from "node:url";
-import { cosmiconfig } from "cosmiconfig";
-const getDefaultSCSSAliases = (themePath) => ({
-    importers: [
-        {
-            findFileUrl(url) {
-                if (!url.startsWith("sitecss:"))
-                    return null;
-                const pathname = url.substring(8);
-                return pathToFileURL(`${resolve(process.cwd(), themePath, "src/styles")}${pathname.startsWith("/") ? pathname : `/${pathname}`}`);
-            },
-        },
-        {
-            findFileUrl(url) {
-                if (!url.startsWith("launchpad:"))
-                    return null;
-                const pathname = url.substring(10);
-                return pathToFileURL(`${resolve(process.cwd(), themePath, "../launchpad/src/styles")}${pathname.startsWith("/") ? pathname : `/${pathname}`}`);
-            },
-        },
-    ],
-});
-export async function getSmashConfig() {
-    const explorer = cosmiconfig("smash");
-    const config = await explorer
-        .load(resolve(process.cwd(), "smash.config.ts"))
-        .then((result) => {
-        if (!result || result.isEmpty) {
-            throw new Error("Return default config.");
-        }
-        const config = result.config;
-        if (isValidSmashConfig(config)) {
-            const fullConfig = {
-                scssAliases: getDefaultSCSSAliases(config.themePath),
-                themeFolderName: config.projectName,
-                ...config,
-                // Normalize and resolve paths to cwd.
-                npmInstallPaths: config.npmInstallPaths?.map((path) => {
-                    return normalize(resolve(process.cwd(), path));
-                }) ?? [],
-                composerInstallPaths: config.composerInstallPaths?.map((path) => {
-                    return normalize(resolve(process.cwd(), path));
-                }) ?? [],
-                assetsOutputFolder: config.assetsOutputFolder
-                    ? normalize(config.assetsOutputFolder)
-                    : "dist",
-            };
-            return fullConfig;
-        }
-        throw new Error("Return default config.");
-    })
-        .catch(async () => {
-        const { themeName, themePath } = await import("dotenv")
-            .then((dotenv) => {
-            dotenv.config();
-            const themeName = process.env.THEME_NAME ?? process.env.npm_package_config_theme_name;
-            const themePath = process.env.THEME_PATH ?? process.env.npm_package_config_theme_path;
-            return {
-                themeName,
-                themePath,
-            };
-        })
-            .catch(() => {
-            return {
-                themeName: false,
-                themePath: false,
-            };
-        });
-        if (!themeName || !themePath) {
-            return null;
-        }
-        console.warn("Using env vars for theme name and path is deprecated and will be removed in a future version. Create a smash.config.ts file with the relevant properties in it instead.");
-        const defaultConfig = {
-            projectName: themeName,
-            themePath,
-            themeFolderName: themeName,
-            assetsOutputFolder: "dist",
-            npmInstallPaths: [],
-            composerInstallPaths: [],
-            scssAliases: getDefaultSCSSAliases(themePath),
-        };
-        return defaultConfig;
-    });
-    return config;
-}
-function isValidSmashConfig(config) {
-    return (typeof config === "object" &&
-        config !== null &&
-        "projectName" in config &&
-        typeof config.projectName === "string" &&
-        "themePath" in config &&
-        typeof config.themePath === "string");
-}