@c6fc/spellcraft 0.0.8 → 0.0.10

package/README.md

@@ -129,8 +129,8 @@ $ npx spellcraft --help
 Commands:
   spellcraft generate <filename>                Generates files from a configuration
   spellcraft importModule <npmPackage> [name]   Configures the current project to use a SpellCraft module
-  spellcraft aws-identity                       Display the AWS IAM identity of the SpellCraft context
-  spellcraft aws-exportcredentials              Export the current credentials as environment variables
+  spellcraft aws-identity                       Display the AWS IAM identity of the SpellCraft context	# Added by a module
+  spellcraft aws-exportcredentials              Export the current credentials as environment variables	# Added by a module
 ```
 
 ## Programmatic Usage (API)
@@ -139,10 +139,9 @@ For more advanced workflows, such as integration into larger automation scripts,
 
 The typical flow is:
 1.  Instantiate `SpellFrame`.
-2.  Load necessary modules.
-3.  (Optional) Run module initializers with `init()`.
-4.  Render the Jsonnet file with `render()`.
-5.  Write the resulting object to disk with `write()`.
+2.  Run module initializers with `init()`.
+3.  Render the Jsonnet file with `render()`.
+4.  Write the resulting object to disk with `write()`.
 
 ```javascript
 // my-automation-script.js
@@ -157,33 +156,38 @@ const frame = new SpellFrame({
 });
 
 (async () => {
-  try {
-    // 2. Load modules programmatically (this assumes they are in package.json)
-    // This loads modules listed in 'spellcraft_modules/packages.json'
-    // and from the local 'spellcraft_modules/' directory.
-    // frame.loadModuleByName('my-module-key', 'my-npm-package');
-
-    // 3. Initialize modules (if any modules registered an init function)
+    
+    // 2. Initialize modules before rendering.
     await frame.init();
 
-    // 4. Render the master Jsonnet file
+    // 3. Render the master Jsonnet file
     const manifest = await frame.render(path.resolve('./manifest.jsonnet'));
 
     // The result is available in memory
     console.log('Rendered Manifest:', JSON.stringify(manifest, null, 2));
 
-    // 5. Write the manifest object to the filesystem
-    frame.write(manifest);
+    // 4. Write the manifest object to the filesystem. Defaults to the contents of
+    // the most recent 'render'.
+    frame.write();
 
     console.log('Successfully wrote files to the dist/ directory!');
 
-  } catch (error) {
-    console.error('An error occurred during the SpellCraft process:', error);
-    process.exit(1);
-  }
 })();
 ```
 
-## Creating Your Own Spells (Modules)
+## Top-tier spellframe extensions by SpellCraft authors:
+
+It can be hard to conceptualize what SpellCraft is capable of by just looking at the engine itself. Here are a set of SpellCraft modules that demonstrate the extensibility of the engine:
+
+|Package|Description|
+|---|---|
+|[**@c6fc/spellcraft-aws-auth**](https://www.npmjs.com/package/@c6fc/spellcraft-aws-auth)|Exposes the full power of the AWS SDK for JavaScript to your SpellFrames, including native support for common AWS credential sources and role-chaining.|
+|[**@c6fc/spellcraft-terraform**](https://www.npmjs.com/package/@c6fc/spellcraft-terraform)|Brings Terraform into your SpellCraft CLI and SpellFrames, allowing you to directly deploy the results of your Spells.|
+|[**@c6fc/spellcraft-packer**](https://www.npmjs.com/package/@c6fc/spellcraft-packer)|Brings Packer into SpellCraft CLI and SpellFrames, allowing you to run builds against the results of your Spells.|
+|[**@c6fc/spellcraft-aws-terraform**](https://www.npmjs.com/package/@c6fc/spellcraft-aws-terraform)|Contains shortcuts for common use-cases when using Terraform to deploy configurations to AWS. Including backend bootstrapping, artifact repositories, and remote state access. It also demonstrates how modules can build on the capabilities of other modules.|
+|[**@c6fc/spellcraft-aws-s3**](https://www.npmjs.com/package/@c6fc/spellcraft-aws-s3)|A simple but powerful module for creating AWS S3 buckets. It uses secure defaults, exposes common use-cases as optional 'types', and grants extensive control with minimal code.|
+
+
+## Creating Your Own Modules
 
 When you're ready to start writing your own modules and unleashing the true power of SpellCraft, check out **[create-spellcraft-module](https://www.npmjs.com/package/@c6fc/spellcraft)**

package/package.json

@@ -8,7 +8,7 @@
   },
   "name": "@c6fc/spellcraft",
   "description": "Extensible JSonnet CLI platform",
-  "version": "0.0.8",
+  "version": "0.0.10",
   "main": "src/index.js",
   "directories": {
     "lib": "lib"