wallace 0.10.0 → 0.11.0

package/README.md

@@ -1,6 +1,6 @@
 # Wallace
 
-This package contains the library for the [Wallace](https://github.com/wallace-js/wallace) framework, which you import into your source files:
+This package contains the library for the [Wallace](https://wallace.js.org) framework, which you import into your source files:
 
 ```jsx
 import { mount } from 'wallace';
@@ -26,4 +26,4 @@ npx create-wallace-app
 
 As that sets up your babel and webpack configurations for you.
 
-For more detailed documentation see the [Wallace repository on github](https://github.com/wallace-js/wallace).
+For more detailed documentation see the [Wallace repository on github](https://wallace.js.org/docs/).

package/lib/component.js

@@ -115,10 +115,13 @@ Object.defineProperty(ComponentPrototype, "hidden", {
 });
 
 const ComponentBase = {
-  stubs: {},
   prototype: ComponentPrototype
 };
 
+if (wallaceConfig.flags.useStubs) {
+  ComponentBase.stubs = {};
+}
+
 /**
  *
  * @param {function} ComponentFunction - The Component definition function to add bits to.
@@ -134,15 +137,22 @@ export function initConstructor(ComponentFunction, BaseComponentFunction) {
       }
     }
   ));
-  Object.defineProperty(ComponentFunction, "methods", {
-    set: function (value) {
-      Object.assign(proto, value);
-    },
-    get: function () {
-      return proto;
-    }
-  });
-  ComponentFunction.stubs = Object.assign({}, BaseComponentFunction.stubs);
+
+  if (wallaceConfig.flags.useMethods) {
+    Object.defineProperty(ComponentFunction, "methods", {
+      set: function (value) {
+        Object.assign(proto, value);
+      },
+      get: function () {
+        return proto;
+      }
+    });
+  }
+
+  if (wallaceConfig.flags.useStubs) {
+    ComponentFunction.stubs = Object.assign({}, BaseComponentFunction.stubs);
+  }
+
   return ComponentFunction;
 }
 

package/lib/types.d.ts

@@ -8,6 +8,7 @@
 
 ### Contents
 
+  0. Configuration
   1. Components
   2. JSX
   3. Nesting
@@ -19,7 +20,41 @@
   9. TypeScript
  10. Helpers
 
-For more detailed documentation go to https://github.com/wallace-js/wallace
+For more detailed documentation go to https://wallace.js.org/docs/
+
+
+## 0. Configuration
+
+You need to set flags in your babel config to use certain features:
+
+ 1. useControllers - enables use of `ctrl` in components.
+ 2. useMethods - adds the `methods` helper to components.
+ 3. useStubs - enables the use of stubs.
+
+The types (and therefore tool tips) are unaffected by these flags, and will treat them
+all as being true.
+
+```tsx
+module.exports = {
+  plugins: [
+    [
+      "babel-plugin-wallace",
+      {
+        flags: {
+          useControllers: true,
+          useMethods: true,
+          useStubs: true
+        },
+        directives: [...]
+      }
+    ],
+    "@babel/plugin-syntax-jsx"
+  ],
+  presets: ["@babel/preset-typescript", ...]
+};
+```
+
+The `directives` option lets you override or define new directives. See main docs.
 
 ## 1. Components
 
@@ -1012,9 +1047,11 @@ interface DirectiveAttributes extends AllDomEvents {
   toggle?: string;
 
   /**
-   * Foo
+   * ## Wallace directive: unique
+   *
+   * Performance optimisation that can be applied to a component which is only used once.
    */
-  "class-a"?: string;
+  unique?: boolean;
 }
 
 declare namespace JSX {
@@ -1051,6 +1088,7 @@ declare namespace JSX {
      * - `style:xyz` sets a specific style property.
      * - `toggle:xyz` toggles `xyz` as defined by `class:xyz` on same element, or class
      *   `xyz`.
+     * - `unique` can be set on components which only used once for better performance.
      *
      * You will get more details by hovering on the directive itself, but unfortunetely
      * the tool tip won't display when you use a qualifier, like `class:danger`. To see

package/package.json

@@ -1,8 +1,9 @@
 {
   "name": "wallace",
-  "version": "0.10.0",
+  "version": "0.11.0",
   "author": "Andrew Buchan",
   "description": "An insanely small, fast, intuitive and extendable front-end framework",
+  "homepage": "https://wallace.js.org",
   "license": "ISC",
   "main": "lib/index.js",
   "files": [
@@ -14,8 +15,8 @@
     "test": "jest --clearCache && jest"
   },
   "dependencies": {
-    "babel-plugin-wallace": "^0.10.0",
+    "babel-plugin-wallace": "^0.11.0",
     "browserify": "^17.0.1"
   },
-  "gitHead": "5516e673ca0e4c0a01644701b914ca923e000580"
+  "gitHead": "f145fe3b852025e2c851c27d75e7a104c5ec2bda"
 }