@embroider/macros 1.17.0-alpha.4 → 1.17.0-alpha.5

package/README.md

@@ -10,6 +10,45 @@ The [Embroider package spec](../../docs/spec.md) proposes fixing this by making
 
 This package works in both Embroider and Classical builds, so that addon authors can switch to this newer pattern without disruption.
 
+## Setting Configuration: from a babel config
+
+1. Add `@embroider/macros` as `devDependency`.
+2. In your babel config, do:
+
+```js
+const { buildMacros } = require('@embroider/macros/babel'); 
+
+const macros = buildMacros({
+  // this is how you configure your own package
+  setOwnConfig: {
+    // your config goes here
+  },
+  // this is how you can optionally send configuration into your
+  // dependencies, if those dependencies choose to use
+  // @embroider/macros configs.
+  setConfig: {
+    'some-dependency': {
+      // config for some-dependency
+    },
+  },
+});
+
+module.exports = {
+  plugins: [
+   // ... 
+    [
+      "babel-plugin-ember-template-compilation",
+      {
+        compilerPath: "ember-source/dist/ember-template-compiler.js",
+        transforms: [...macros.templateMacros],
+      },
+    ],
+    ...macros.babelMacros,
+  ],
+  // ...
+};
+```
+
 ## Setting Configuration: from an Ember app
 
 1. Add `@embroider/macros` as `devDependency`.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@embroider/macros",
-  "version": "1.17.0-alpha.4",
+  "version": "1.17.0-alpha.5",
   "private": false,
   "description": "Standardized build-time macros for ember apps.",
   "keywords": [
@@ -14,6 +14,11 @@
   "license": "MIT",
   "author": "Edward Faulkner",
   "main": "src/index.js",
+  "exports": {
+    ".": "./src/index.js",
+    "./babel": "./src/babel.js",
+    "./src/*": "./src/*.js"
+  },
   "files": [
     "src/**/*.js",
     "src/**/*.d.ts",
@@ -54,8 +59,8 @@
     "code-equality-assertions": "^1.0.1",
     "scenario-tester": "^3.0.1",
     "typescript": "^5.4.5",
-    "@embroider/core": "4.0.0-alpha.5",
-    "@embroider/test-support": "0.36.0"
+    "@embroider/test-support": "0.36.0",
+    "@embroider/core": "4.0.0-alpha.6"
   },
   "peerDependencies": {
     "@glint/template": "^1.0.0"

package/src/babel.d.ts

@@ -0,0 +1,46 @@
+import MacrosConfig from './macros-config';
+export interface Options {
+    /**
+     * How you configure your own package / app
+     */
+    setOwnConfig?: object;
+    /**
+     * This is how you can optionally send configuration into
+     * your dependencies, if those dependencies choose to use
+     * @embroider/macros configs.
+     *
+     * @example
+     * ```js
+     * setConfig: {
+     *   'some-dependency': {
+     *      // config for some-dependency
+     *   }
+     * }
+     * ```
+     */
+    setConfig?: Record<string, object>;
+    /**
+     * Callback for further manipulation of the macros' configuration instance.
+     *
+     * Useful for libraries to provide their own config with defaults shared between sub-dependencies of those libraries.
+     */
+    configure?: (macrosInstance: MacrosConfig) => void;
+    /**
+     * Override the default directory used for the MacrosConfig
+     *
+     * defaults to the CWD, via process.cwd()
+     */
+    dir?: string;
+}
+interface ConfiguredMacros {
+    /**
+     * Array of plugins to add to the babel config plugins array
+     */
+    babelMacros: ReturnType<MacrosConfig['babelPluginConfig']>;
+    /**
+     * Array of template transforms to pass to the transforms array of the babel-plugin-ember-template-compilation babel plugin
+     */
+    templateMacros: ReturnType<(typeof MacrosConfig)['transforms']>['plugins'];
+}
+export declare function buildMacros(options?: Options): ConfiguredMacros;
+export {};

package/src/babel.js

@@ -0,0 +1,33 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.buildMacros = buildMacros;
+const macros_config_1 = __importDefault(require("./macros-config"));
+function buildMacros(options = {}) {
+    let root = options.dir || process.cwd();
+    let macros = macros_config_1.default.for({}, root);
+    let transforms = macros_config_1.default.transforms();
+    transforms.setConfig(macros);
+    let { setOwnConfig, setConfig, configure } = options;
+    if (setOwnConfig) {
+        macros.setOwnConfig(root, setOwnConfig);
+    }
+    if (setConfig) {
+        for (let [packageName, config] of Object.entries(setConfig)) {
+            macros.setConfig(root, packageName, config);
+        }
+    }
+    configure === null || configure === void 0 ? void 0 : configure(macros);
+    if (process.env.NODE_ENV === 'development') {
+        macros.enablePackageDevelopment(process.cwd());
+        macros.enableRuntimeMode();
+    }
+    macros.finalize();
+    return {
+        babelMacros: macros.babelPluginConfig(),
+        templateMacros: transforms.plugins,
+    };
+}
+//# sourceMappingURL=babel.js.map

package/src/babel.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"babel.js","sourceRoot":"","sources":["babel.ts"],"names":[],"mappings":";;;;;AAiDA,kCAiCC;AAlFD,oEAA2C;AAiD3C,SAAgB,WAAW,CAAC,UAAmB,EAAE;IAC/C,IAAI,IAAI,GAAG,OAAO,CAAC,GAAG,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;IACxC,IAAI,MAAM,GAAG,uBAAY,CAAC,GAAG,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC;IAExC,IAAI,UAAU,GAAG,uBAAY,CAAC,UAAU,EAAE,CAAC;IAE3C,UAAU,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;IAE7B,IAAI,EAAE,YAAY,EAAE,SAAS,EAAE,SAAS,EAAE,GAAG,OAAO,CAAC;IAErD,IAAI,YAAY,EAAE,CAAC;QACjB,MAAM,CAAC,YAAY,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC;IAC1C,CAAC;IAED,IAAI,SAAS,EAAE,CAAC;QACd,KAAK,IAAI,CAAC,WAAW,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,SAAS,CAAC,EAAE,CAAC;YAC5D,MAAM,CAAC,SAAS,CAAC,IAAI,EAAE,WAAW,EAAE,MAAgB,CAAC,CAAC;QACxD,CAAC;IACH,CAAC;IAED,SAAS,aAAT,SAAS,uBAAT,SAAS,CAAG,MAAM,CAAC,CAAC;IAEpB,IAAI,OAAO,CAAC,GAAG,CAAC,QAAQ,KAAK,aAAa,EAAE,CAAC;QAC3C,MAAM,CAAC,wBAAwB,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,CAAC;QAC/C,MAAM,CAAC,iBAAiB,EAAE,CAAC;IAC7B,CAAC;IAED,MAAM,CAAC,QAAQ,EAAE,CAAC;IAElB,OAAO;QACL,WAAW,EAAE,MAAM,CAAC,iBAAiB,EAAE;QACvC,cAAc,EAAE,UAAU,CAAC,OAAO;KACnC,CAAC;AACJ,CAAC","sourcesContent":["import MacrosConfig from './macros-config';\n\nexport interface Options {\n  /**\n   * How you configure your own package / app\n   */\n  setOwnConfig?: object;\n  /**\n   * This is how you can optionally send configuration into\n   * your dependencies, if those dependencies choose to use\n   * @embroider/macros configs.\n   *\n   * @example\n   * ```js\n   * setConfig: {\n   *   'some-dependency': {\n   *      // config for some-dependency\n   *   }\n   * }\n   * ```\n   */\n  setConfig?: Record<string, object>;\n\n  /**\n   * Callback for further manipulation of the macros' configuration instance.\n   *\n   * Useful for libraries to provide their own config with defaults shared between sub-dependencies of those libraries.\n   */\n  configure?: (macrosInstance: MacrosConfig) => void;\n\n  /**\n   * Override the default directory used for the MacrosConfig\n   *\n   * defaults to the CWD, via process.cwd()\n   */\n  dir?: string;\n}\n\ninterface ConfiguredMacros {\n  /**\n   * Array of plugins to add to the babel config plugins array\n   */\n  babelMacros: ReturnType<MacrosConfig['babelPluginConfig']>;\n  /**\n   * Array of template transforms to pass to the transforms array of the babel-plugin-ember-template-compilation babel plugin\n   */\n  templateMacros: ReturnType<(typeof MacrosConfig)['transforms']>['plugins'];\n}\n\nexport function buildMacros(options: Options = {}): ConfiguredMacros {\n  let root = options.dir || process.cwd();\n  let macros = MacrosConfig.for({}, root);\n\n  let transforms = MacrosConfig.transforms();\n\n  transforms.setConfig(macros);\n\n  let { setOwnConfig, setConfig, configure } = options;\n\n  if (setOwnConfig) {\n    macros.setOwnConfig(root, setOwnConfig);\n  }\n\n  if (setConfig) {\n    for (let [packageName, config] of Object.entries(setConfig)) {\n      macros.setConfig(root, packageName, config as object);\n    }\n  }\n\n  configure?.(macros);\n\n  if (process.env.NODE_ENV === 'development') {\n    macros.enablePackageDevelopment(process.cwd());\n    macros.enableRuntimeMode();\n  }\n\n  macros.finalize();\n\n  return {\n    babelMacros: macros.babelPluginConfig(),\n    templateMacros: transforms.plugins,\n  };\n}\n"]}