Doc and dependency cleanup

Author: bheston

package-lock.json

@@ -33,7 +33,8 @@
   "homepage": "https://github.com/adaptive-web-community/adaptive-web-components#readme",
   "dependencies": {
     "@adaptive-web/adaptive-ui": "^0.12.0",
-    "@microsoft/fast-foundation": "^3.0.0-alpha.31"
+    "@microsoft/fast-foundation": "^3.0.0-alpha.31",
+    "@types/culori": "^2.0.0"
   },
   "devDependencies": {
     "rimraf": "^3.0.2",

packages/adaptive-ui-designer-core/package.json

@@ -27,20 +27,20 @@ export abstract class Controller {
 
     /**
      * Gets a Node from the design tool by ID.
-     * @param id The ID of the node.
+     * @param id - The ID of the node.
      * @returns The PluginNode or null if no node by the provided ID exists.
      */
     public abstract getNode(id: string): Promise<PluginNode | null>;
 
     /**
      * Provides the state object to the UI component and updates the UI.
-     * @param state The UI state object.
+     * @param state - The UI state object.
      */
     protected abstract sendStateToUI(state: PluginUIState): void;
 
     /**
      * Sets the selected node IDs - Setting the IDs will trigger a UI refresh.
-     * @param ids The node IDs.
+     * @param ids - The node IDs.
      */
     public async setSelectedNodes(ids: string[]): Promise<void> {
         Controller.nodeCount = 0;
@@ -60,7 +60,7 @@ export abstract class Controller {
 
     /**
      * Handle the updated state that's posted from the UI.
-     * @param state The state from the UI.
+     * @param state - The state from the UI.
      */
     public async receiveStateFromUI(state: PluginUIState): Promise<void> {
         // console.log("--------------------------------");

packages/adaptive-ui-designer-core/src/controller.ts

@@ -10,7 +10,7 @@ export class DesignTokenRegistry<T extends { name: string } & DesignTokenMetadat
 
     /**
      * Registers a new design token definition.
-     * @param designToken The design token definition to register.
+     * @param designToken - The design token definition to register.
      */
     public register(designToken: T): void {
         const { name } = designToken;
@@ -26,15 +26,15 @@ export class DesignTokenRegistry<T extends { name: string } & DesignTokenMetadat
 
     /**
      * Unregisters a design token definition.
-     * @param name The ID of the design token definition to unregister.
+     * @param name - The ID of the design token definition to unregister.
      */
     public unregister(name: string): void {
         delete this._entries[name];
     }
 
     /**
      * Gets a design token definition by ID.
-     * @param name The ID of the design token definition.
+     * @param name - The ID of the design token definition.
      */
     public get(name: string): T | null {
         if (this.isRegistered(name)) {
@@ -53,15 +53,15 @@ export class DesignTokenRegistry<T extends { name: string } & DesignTokenMetadat
 
     /**
      * Determines if the design token definition has been registered.
-     * @param name The ID of the design token definition.
+     * @param name - The ID of the design token definition.
      */
     public isRegistered(name: string): boolean {
         return this._entries.hasOwnProperty(name);
     }
 
     /**
      * Returns all entries that apply to a given style property type
-     * @param target the style property type to return entries of
+     * @param target - The style property type to return entries of
      */
     public find(target: StyleProperty): T[] {
         return Object.values(this._entries).filter(value => value.intendedFor?.includes(target));

packages/adaptive-ui-designer-core/src/registry/design-token-registry.ts

@@ -11,7 +11,7 @@ figma.showUI(__html__, {
 
 /**
  * Displays a notification when running a function that takes some time.
- * @param callback The function to call
+ * @param callback - The function to call
  */
 function notifyProcessing(callback: () => void) {
     const notify = figma.notify("Processing design tokens", { timeout: Infinity });

packages/adaptive-ui-designer-figma-plugin/src/figma/main.ts

@@ -6,7 +6,7 @@ const ajv = new Ajv();
 export interface ISchemaValidator {
   /**
    * Validates a JSON schema against the validator
-   * @param json the JSON string to validate, or a JavaScript object
+   * @param json - The JSON string to validate, or a JavaScript object
    */
   validate(json: string | object): Promise<boolean | ErrorObject[]>;
 }

packages/adaptive-ui-designer-figma/src/cli/schema-validator.ts

@@ -28,8 +28,8 @@ function hasChildren<T extends FigmaRestAPI.Node>(node: T): node is FigmaRestAPI
 
 /**
  * Convert a Figma REST API node to a {@link PluginUINodeData}
- * @param node 
- * @returns 
+ * @param node - The Figma REST API node.
+ * @returns The corresponding PluginUINodeData.
  */
 export function parseNode(node: FigmaRestAPI.Node): PluginUINodeData {
     const children = hasChildren(node) ? node.children : [];