@sketch-hq/sketch-assistant-types - npm Package Compare versions

Comparing version 3.0.0-next.2 to 3.0.0-next.3

CHANGELOG.md

 # @sketch-hq/sketch-assistant-types
 
+## 3.0.0-next.3
+
+### Patch Changes
+
+- c0d835b: Make package public
+- 98abfc9: Add `ruleTitle` as an official reserved rule option name
+
 ## 3.0.0-next.2
@@ -4,0 +11,0 @@

dist/types.d.ts

@@ -427,7 +427,8 @@ import { FileFormat3 } from '@sketch-hq/sketch-file-format-ts';
 /**
- * Custom rule options with these names are forbidden.
+ * User-defined rule options with these names are forbidden.
  */
 export declare enum ReservedRuleOptionNames {
     active = "active",
-    severity = "severity"
+    severity = "severity",
+    ruleTitle = "ruleTitle"
 }
@@ -444,8 +445,16 @@ /**
     /**
-     * The severity of any violations reported by the rule.
+     * Optional custom severity for violations reported by the rule. If omitted the default severity is
+     * used instead.
      */
     [ReservedRuleOptionNames.severity]?: ViolationSeverity;
     /**
-     * Rule custom options will also appear mixed into this object.
+     * Optional custom rule title to replace the title defined by the RuleDefinition. Can be used to
+     * supply descriptive rule titles that can only be defined alongside configuration - for example
+     * to title a rule "Page names should start with emojis" alongside regex patterns that enforces
+     * the same.
      */
+    [ReservedRuleOptionNames.ruleTitle]?: string;
+    /**
+     * User-defined rule option are mixed into this object.
+     */
     [key: string]: Maybe<RuleOption>;
@@ -452,0 +461,0 @@ };

dist/types.js

@@ -15,3 +15,3 @@ "use strict";
 /**
- * Custom rule options with these names are forbidden.
+ * User-defined rule options with these names are forbidden.
  */
@@ -22,3 +22,4 @@ var ReservedRuleOptionNames;
     ReservedRuleOptionNames["severity"] = "severity";
+    ReservedRuleOptionNames["ruleTitle"] = "ruleTitle";
 })(ReservedRuleOptionNames = exports.ReservedRuleOptionNames || (exports.ReservedRuleOptionNames = {}));
 //# sourceMappingURL=types.js.map

package.json

 {
   "name": "@sketch-hq/sketch-assistant-types",
-  "version": "3.0.0-next.2",
+  "version": "3.0.0-next.3",
   "main": "dist/types",
@@ -5,0 +5,0 @@ "types": "dist/types",

README.md

@@ -11,7 +11,5 @@ # sketch-assistant-types
 ```sh
-yarn add @sketch-hq/sketch-assistant-types
+yarn add @sketch-hq/sketch-assistant-types@next
 ```
 
-> TODO: Link to documentation about developing Assistants.
-
 ## Development
@@ -18,0 +16,0 @@

No alert changes

Improved metrics

Total package byte prevSize

34513

increased by2.14%

Lines of code

595

increased by1.71%

Worsened metrics

Number of lines in readme file

43

decreased by-4.44%

No dependency changes