@atomicsmash/smash-config 0.0.1 → 1.0.0

package/dist/index.d.ts

@@ -0,0 +1,16 @@
+import { 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";
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,OAAO,EAAE,MAAM,MAAM,CAAC;AAE/B,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"}

package/dist/index.js

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

package/dist/utils.d.ts

@@ -0,0 +1,3 @@
+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

@@ -0,0 +1 @@
+{"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

@@ -0,0 +1,94 @@
+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");
+}

package/package.json

@@ -1,10 +1,46 @@
 {
-  "name": "@atomicsmash/smash-config",
-  "version": "0.0.1",
-  "description": "OIDC trusted publishing setup package for @atomicsmash/smash-config",
-  "keywords": [
-    "oidc",
-    "trusted-publishing",
-    "setup"
-  ]
+	"name": "@atomicsmash/smash-config",
+	"type": "module",
+	"version": "1.0.0",
+	"description": "",
+	"keywords": [],
+	"homepage": "https://www.atomicsmash.co.uk/",
+	"license": "GPL-3.0-or-later",
+	"author": {
+		"name": "Atomic Smash",
+		"email": "npm@atomicsmash.co.uk",
+		"url": "https://www.atomicsmash.co.uk/"
+	},
+	"repository": {
+		"type": "git",
+		"url": "https://github.com/AtomicSmash/packages",
+		"directory": "packages/smash-config"
+	},
+	"files": [
+		"./dist/**/*"
+	],
+	"main": "./dist/index.js",
+	"types": "./dist/index.d.ts",
+	"publishConfig": {
+		"access": "public"
+	},
+	"scripts": {
+		"dev": "tsc --build --watch tsconfig.build.json",
+		"build": "npm-run-all clean compile",
+		"clean": "del-cli ./dist/ *.tsbuildinfo",
+		"compile": "tsc --build tsconfig.build.json",
+		"test": "TZ=\"Europe/Istanbul\" vitest run",
+		"test:ui": "TZ=\"Europe/Istanbul\" vitest --ui",
+		"test:coverage": "TZ=\"Europe/Istanbul\" vitest run --coverage",
+		"lint": "run-p lint:*",
+		"lint:eslint": "eslint --cache --cache-location ./node_modules/.cache/eslint . --ext .js,.ts,.jsx,.tsx",
+		"lint:types": "tsc"
+	},
+	"peerDependencies": {
+		"dotenv": "^17.2.3",
+		"sass": "^1.97.0"
+	},
+	"dependencies": {
+		"cosmiconfig": "^9.0.0"
+	}
 }

package/README.md

@@ -1,45 +0,0 @@
-# @atomicsmash/smash-config
-
-## ⚠️ IMPORTANT NOTICE ⚠️
-
-**This package is created solely for the purpose of setting up OIDC (OpenID Connect) trusted publishing with npm.**
-
-This is **NOT** a functional package and contains **NO** code or functionality beyond the OIDC setup configuration.
-
-## Purpose
-
-This package exists to:
-1. Configure OIDC trusted publishing for the package name `@atomicsmash/smash-config`
-2. Enable secure, token-less publishing from CI/CD workflows
-3. Establish provenance for packages published under this name
-
-## What is OIDC Trusted Publishing?
-
-OIDC trusted publishing allows package maintainers to publish packages directly from their CI/CD workflows without needing to manage npm access tokens. Instead, it uses OpenID Connect to establish trust between the CI/CD provider (like GitHub Actions) and npm.
-
-## Setup Instructions
-
-To properly configure OIDC trusted publishing for this package:
-
-1. Go to [npmjs.com](https://www.npmjs.com/) and navigate to your package settings
-2. Configure the trusted publisher (e.g., GitHub Actions)
-3. Specify the repository and workflow that should be allowed to publish
-4. Use the configured workflow to publish your actual package
-
-## DO NOT USE THIS PACKAGE
-
-This package is a placeholder for OIDC configuration only. It:
-- Contains no executable code
-- Provides no functionality
-- Should not be installed as a dependency
-- Exists only for administrative purposes
-
-## More Information
-
-For more details about npm's trusted publishing feature, see:
-- [npm Trusted Publishing Documentation](https://docs.npmjs.com/generating-provenance-statements)
-- [GitHub Actions OIDC Documentation](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect)
-
----
-
-**Maintained for OIDC setup purposes only**