wuffle 0.71.0 → 0.73.0

package/wuffle.config.example.js

@@ -1,44 +1,36 @@
 /**
  * This defines board specific configuration.
- *
- * ### Name
- *
- * The name of your board, displayed in the board header.
- *
- *
- * ### Description
- *
- * Optional description of the board, will be served with the board front-end
- * for SEO purposes.
- *
- *
- * ### Columns
- *
- * Valid fields for columns are
- *
- *  * name       - unique name
- *  * label      - label, if present on a GitHub issue column will be set
- *  * closed     - if the column issues must be closed
- *  * sorting    - true if column cards should be sorted
- *                 incrementally based on links
- *  * fifo       - true to turn the default column ordering from
- *                 last in first out to first in first out
- *  * states     - a list of board states to map to this column
- *
- * The default column is the column that holds open issues without
- * any label constraints (Inbox in the example below).
- *
- *
- * ### Search Config
- *
- * You may define a default filter to apply to the board if
- * there is no user-defined search query.
  */
 export default {
 
+  /**
+   * The name of your board, displayed in the board header.
+   */
   name: 'My Wuffle Board',
+
+  /**
+   * (Optional) description of the board, will be served with the board
+   * front-end for SEO purposes.
+   */
   description: 'This board organizes all my tasks',
 
+  /**
+   * Definitions of columns to display on the board, and their state.
+   *
+   * Valid fields for columns are
+   *
+   *  * name       - unique name
+   *  * label      - label, if present on a GitHub issue column will be set
+   *  * closed     - if the column issues must be closed
+   *  * sorting    - true if column cards should be sorted
+   *                 incrementally based on links
+   *  * fifo       - true to turn the default column ordering from
+   *                 last in first out to first in first out
+   *  * states     - a list of board states to map to this column
+   *
+   * The default column is the column that holds open issues without
+   * any label constraints (Inbox in the example below).
+   */
   columns: [
     { name: 'Inbox', label: null },
     { name: 'Backlog', label: 'backlog', sorting: true },
@@ -48,5 +40,23 @@ export default {
     { name: 'Done', label: null, closed: true }
   ],
 
-  defaultFilter: '!repo:"some/ignored-repository"'
+  /**
+   * (Optional) default filter to apply to the board if there is no
+   * user-defined search query.
+   */
+  defaultFilter: '!repo:"some/ignored-repository"',
+
+  /**
+   * (Optional) Filter matching issues that shall not be saved.
+   *
+   * Matching issues will not be added. If they were previously on the board
+   * they will be removed as part of an update.
+   */
+  ignoreFilter: 'label:"invalid"',
+
+  /**
+   * Whether or not bots are treated as legitimate reviewers, for review and
+   * approval queries. Defaults to `false`.
+   */
+  treatBotsAsReviewers: false
 };