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

Comparing version 3.0.0-next.0 to 3.0.0-next.1

CHANGELOG.md

 # @sketch-hq/sketch-assistant-types
 
+## 3.0.0-next.1
+
+### Patch Changes
+
+- 8aa3b4a: Include rule name in Assistant RunResult metadata
+
 ## 3.0.0-next.0
@@ -4,0 +10,0 @@

dist/types.d.ts

@@ -124,3 +124,3 @@ import { FileFormat3 } from '@sketch-hq/sketch-file-format-ts';
         rules: {
-            [ruleName: string]: Omit<RuleDefinition, 'rule' | 'getOptions' | 'name'>;
+            [ruleName: string]: Omit<RuleDefinition, 'rule' | 'getOptions'>;
         };
@@ -252,6 +252,35 @@ };
 export declare type AssistantPackageJson = PackageJson & Partial<{
+    /**
+     * The Sketch equivalent to the standard package.json `main` property. Used for indicating the
+     * JavaScript entrypoint Sketch should use when running the Assistant in its JavaScriptCore
+     * environment. Note that unlike a Node environment which supports CommonJS modules via the
+     * `require` function, Sketch's JavaScript environment does not include any module system, so
+     * entrypoints for Sketch referenced via this `sketch` property must be bundled into a single
+     * file in a similar way to a web app, typically using Webpack. Also note that Sketch's
+     * JavaScriptCore environment is based on modern WebKit (minus the browser APIs), so files
+     * should only need to be transpiled down to ES6 at the most.
+     */
+    sketch: string;
+    /**
+     * Object containing configuration specific to the Assistant.
+     */
     'sketch-assistant': Partial<{
+        /**
+         * Human readable Assistant title for display in Sketch.
+         */
         title: string;
+        /**
+         * Human readable Assistant description for display in Sketch.
+         */
         description: string;
+        /**
+         * Assistant icon/image for display in Sketch. Should be a fully qualified uri to a publically
+         * hosted image file.
+         */
         icon: string;
+        /**
+         * Optional object to contain internationalised versions of the above strings. If this object
+         * is present, and contains strings for Sketch's currently active locale, then those will be
+         * used in preference.
+         */
         i18n: Partial<{
@@ -261,2 +290,3 @@ [locale: string]: Partial<{
                 description: string;
+                icon: string;
             }>;
@@ -263,0 +293,0 @@ }>;

package.json

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

No alert changes

Improved metrics

Total package byte prevSize

32867

5.43%

Lines of code

567

5.59%

No dependency changes