|
| 1 | +import type { AddonImplementation } from "ember-cli/lib/models/addon"; |
| 2 | + |
| 3 | +/** |
| 4 | + * An ember-cli addon for Ember applications using CSS Blocks in its |
| 5 | + * application code. This addon should be a dependency in Ember applications. |
| 6 | + * |
| 7 | + * This addon is responsible for bundling together all CSS Blocks content |
| 8 | + * from the application, concatenating it into a final artifact, and |
| 9 | + * optimizing its content using OptiCSS. Additionaly, this addon generates a |
| 10 | + * JSON bundle that contains runtime data that templates need to resolve |
| 11 | + * what classes to add to each CSS Blocks-powered component. And, finally, |
| 12 | + * this addon provides a runtime helper to actually write out those classes. |
| 13 | + * |
| 14 | + * This addon expects that all intermediary blocks have already been compiled |
| 15 | + * into their respective Compiled CSS and Definition Files using the |
| 16 | + * @css-blocks/ember addon. Your app should also include this as a dependency, |
| 17 | + * or else this addon won't generate any CSS output! |
| 18 | + * |
| 19 | + * A friendly refresher for those that might've missed this tidbit from |
| 20 | + * @css-blocks/ember... CSS Blocks actually compiles its CSS as part of the |
| 21 | + * Template tree, not the styles tree! This is because CSS Blocks is unique |
| 22 | + * in how it reasons about both your templates and styles together. So, in order |
| 23 | + * to actually reason about both, and, in turn, rewrite your templates for you, |
| 24 | + * both have to be processed when building templates. |
| 25 | + * |
| 26 | + * You can read more about CSS Blocks at... |
| 27 | + * css-blocks.com |
| 28 | + * |
| 29 | + * And you can read up on the Ember build pipeline for CSS Blocks at... |
| 30 | + * <LINK_TBD> |
| 31 | + * |
| 32 | + * @todo: Provide a link for Ember build pipeline readme. |
| 33 | + */ |
| 34 | +const EMBER_ADDON: AddonImplementation = { |
| 35 | + /** |
| 36 | + * The name of this addon. Generally matches the package name in package.json. |
| 37 | + */ |
| 38 | + name: "@css-blocks/ember-app", |
| 39 | + |
| 40 | + /** |
| 41 | + * Initalizes this addon instance for use. |
| 42 | + * @param parent - The project or addon that directly depends on this addon. |
| 43 | + * @param project - The current project (deprecated). |
| 44 | + */ |
| 45 | + init(parent, project) { |
| 46 | + // We must call this._super or weird stuff happens. The Ember CLI docs |
| 47 | + // recommend guarding this call, so we're gonna ask TSLint to chill. |
| 48 | + // tslint:disable-next-line: no-unused-expression |
| 49 | + this._super.init && this._super.init.call(this, parent, project); |
| 50 | + }, |
| 51 | + |
| 52 | + /** |
| 53 | + * This method is called when the addon is included in a build. You would typically |
| 54 | + * use this hook to perform additional imports. |
| 55 | + * @param parent - The parent addon or application this addon is currently working on. |
| 56 | + */ |
| 57 | + included(parent) { |
| 58 | + // We must call this._super or weird stuff happens. |
| 59 | + this._super.included.apply(this, [parent]); |
| 60 | + }, |
| 61 | + |
| 62 | + /** |
| 63 | + * Pre-process a tree. Used for adding/removing files from the build. |
| 64 | + * @param type - What kind of tree. |
| 65 | + * @param tree - The tree that's to be processed. |
| 66 | + * @returns - A tree that's ready to process. |
| 67 | + */ |
| 68 | + preprocessTree(type, tree) { |
| 69 | + if (type !== "template") return tree; |
| 70 | + |
| 71 | + // TODO: Do something in the template tree. |
| 72 | + return tree; |
| 73 | + }, |
| 74 | + |
| 75 | + /** |
| 76 | + * Post-process a tree. Runs after the files in this tree have been built. |
| 77 | + * @param type - What kind of tree. |
| 78 | + * @param tree - The processed tree. |
| 79 | + * @returns - The processed tree. |
| 80 | + */ |
| 81 | + postprocessTree(type, tree) { |
| 82 | + if (type !== "template") return tree; |
| 83 | + |
| 84 | + // TODO: Do something in the template tree. |
| 85 | + return tree; |
| 86 | + }, |
| 87 | + |
| 88 | + /** |
| 89 | + * Used to add preprocessors to the preprocessor registry. This is often used |
| 90 | + * by addons like ember-cli-htmlbars and ember-cli-coffeescript to add a |
| 91 | + * template or js preprocessor to the registry. |
| 92 | + * @param _type - Either "self" or "parent". |
| 93 | + * @param _registry - The registry to be set up. |
| 94 | + */ |
| 95 | + setupPreprocessorRegistry(_type, _registry) { |
| 96 | + // TODO: This hook may not be necessary in this addon. |
| 97 | + }, |
| 98 | +}; |
| 99 | + |
| 100 | +// Aaaaand export the addon implementation! |
| 101 | +module.exports = EMBER_ADDON; |
0 commit comments