Merge pull request #68 from borulday/master

Fix typo on "getRelativePosition" method

__tests__/getRealtivePosition.test.ts → __tests__/getRelativePosition.test.ts

@@ -1,6 +1,6 @@
 import { set } from 'lodash'
 import { createFigma } from 'figma-api-stub'
-import { getRealtivePosition } from '../src'
+import { getRelativePosition } from '../src'
 
 const GAP = 50
 const X = 'absoluteTransform[0][2]'
@@ -20,7 +20,7 @@ frameNode2.appendChild(frameNode3)
 frameNode1.appendChild(frameNode2)
 pageNode.appendChild(frameNode1)
 
-describe('getRealtivePosition', () => {
+describe('getRelativePosition', () => {
 	beforeEach(() => {
 		set(frameNode1, X, 0)
 		set(frameNode1, Y, 0)
@@ -39,7 +39,7 @@ describe('getRealtivePosition', () => {
 	})
 
 	test('calculations for zero values', () => {
-		expect(getRealtivePosition(textNode)).toEqual({ x: 0, y: 0 })
+		expect(getRelativePosition(textNode)).toEqual({ x: 0, y: 0 })
 	})
 	test('ignore positions of nodes between targets', () => {
 		set(frameNode2, X, GAP * 100)
@@ -50,14 +50,14 @@ describe('getRealtivePosition', () => {
 		set(frameNode3, Y, GAP * 50)
 		set(frameNode4, Y, GAP * 25)
 		set(textNode, Y, GAP * 2)
-		expect(getRealtivePosition(textNode)).toEqual({ x: GAP, y: GAP * 2 })
+		expect(getRelativePosition(textNode)).toEqual({ x: GAP, y: GAP * 2 })
 	})
 	test('calculations should ignore top level node position', () => {
 		set(frameNode1, X, GAP)
 		set(textNode, X, GAP * 3)
 		set(frameNode1, Y, GAP)
 		set(textNode, Y, GAP * 6)
-		expect(getRealtivePosition(textNode)).toEqual({ x: GAP * 3 - GAP, y: GAP * 6 - GAP })
+		expect(getRelativePosition(textNode)).toEqual({ x: GAP * 3 - GAP, y: GAP * 6 - GAP })
 	})
 	test('calculations with provided parent', () => {
 		set(frameNode2, X, GAP * 100)
@@ -68,7 +68,7 @@ describe('getRealtivePosition', () => {
 		set(frameNode3, Y, GAP * 50)
 		set(frameNode4, Y, GAP * 25)
 		set(textNode, Y, GAP * 2)
-		expect(getRealtivePosition(textNode, frameNode3)).toEqual({
+		expect(getRelativePosition(textNode, frameNode3)).toEqual({
 			x: GAP * 50 - GAP,
 			y: GAP * 50 - GAP * 2
 		})

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@figma-plugin/helpers",
-	"version": "0.14.1",
+	"version": "0.14.2",
 	"description": "A collection of helper functions useful when creating Figma plugins",
 	"main": "dist/index.js",
 	"types": "dist/index.d.ts",

src/helpers/getRealtivePosition.ts → src/helpers/getRelativePosition.ts

@@ -24,12 +24,12 @@ export const getTopLevelParent = (node: BaseNode): BaseNode => {
  * // for structure below
  * // Page / Frame / Group1 / Group2 / Text
  *
- * getRealtivePosition(Text, Group1) // will calculate { x, y } based on Group1
+ * getRelativePosition(Text, Group1) // will calculate { x, y } based on Group1
  *
- * getRealtivePosition(Text) // will calculate { x, y } based on Frame
+ * getRelativePosition(Text) // will calculate { x, y } based on Frame
  * ```
  **/
-export const getRealtivePosition = (
+export const getRelativePosition = (
 	node: BaseNode & LayoutMixin,
 	relativeNode?: BaseNode & LayoutMixin
 ) => {

src/index.ts

@@ -14,7 +14,7 @@ import { nodeToObject } from './helpers/nodeToObject'
 import topLevelFrames from './helpers/topLevelFrames'
 import { getTextNodeCSS } from './helpers/getCSSStyles'
 import { findAll } from './helpers/findMethods'
-import { getRealtivePosition, getTopLevelParent } from './helpers/getRealtivePosition'
+import { getRelativePosition, getTopLevelParent } from './helpers/getRelativePosition'
 import {
 	figmaRGBToWebRGB,
 	webRGBToFigmaRGB,
@@ -69,7 +69,7 @@ export {
 	webRGBToFigmaRGB,
 	figmaRGBToHex,
 	hexToFigmaRGB,
-	getRealtivePosition,
+	getRelativePosition,
 	getTopLevelParent,
 	hasChildren,
 	findAll,