Skip to content

Latest commit

 

History

History
740 lines (711 loc) · 18.7 KB

README.md

File metadata and controls

740 lines (711 loc) · 18.7 KB

sketch-plugin-boilerplate

sketch-plugin-boilerplate —— 快速创建侧边栏 sketch plugins 开发模版样例。

sketch-plugin-boilerplate

安装

git clone [email protected]:o2team/sketch-plugin-boilerplate.git

使用

安装依赖:

yarn install

link sketch plugin 插件开发目录:

yarn run postinstall

打包构建:

yarn run build

开发调试:

yarn run watch
yarn run start

插件下载体验

sketch-plugin-boilerplate.sketchplugin0.0.2.zip

开发指引

sketch-plugin-boilerplate 使用 skpm 工具进行构建,查看详细 skpm 工作原理,请参考 skpm Readme

Sketch class inheritance diagram

基于 Sketch 48.1, 来源 Sketch.d.ts 48.1

NSResponder
  MSAction
    MSDocumentAction
      MSAddAsLibraryAction
      MSAddExportFormatAction
      MSAutoExpandGroupsAction
      MSBackToInstanceAction
      MSBadgeMenuAction
      MSBaseAlignAction
        MSAlignCenterAction
        MSAlignJustifiedAction
        MSAlignLeftAction
        MSAlignRightAction
      MSBaseAlignLayersAction
        MSAlignLayersBottomAction
        MSAlignLayersCenterAction
        MSAlignLayersLeftAction
        MSAlignLayersMiddleAction
        MSAlignLayersRightAction
        MSAlignLayersTopAction
      MSBaseBooleanAction
        MSDifferenceAction
        MSIntersectAction
        MSResetBooleanAction
        MSSubtractAction
        MSUnionAction
      MSBaseFlipAction
        MSApplyFlipAction
        MSFlipHorizontalAction
        MSFlipVerticalAction
      MSBaseInsertAction
        MSBaseShapeAction
          MSOvalShapeAction
          MSPolygonShapeAction
          MSRectangleShapeAction
          MSRoundedRectangleShapeAction
          MSSpiralShapeAction
          MSStarShapeAction
          MSTriangleShapeAction
        MSInsertArtboardAction
        MSInsertImageAction
        MSInsertLineAction
          MSInsertArrowAction
        MSInsertTextLayerAction
      MSBaseMoveAction
        MSBaseMoveBackwardAction
          MSMoveBackwardAction
          MSMoveToBackAction
        MSBaseMoveForwardAction
          MSMoveForwardAction
          MSMoveToFrontAction
      MSBaseSharedStyleAction
        MSCreateSharedStyleAction
        MSResetSharedStyleAction
        MSSyncSharedStyleAction
      MSBaseStyleAction
        MSAddBorderAction
        MSAddFillAction
        MSAddInnerShadowAction
        MSAddShadowAction
        MSRemoveUnusedStylesAction
        MSShowBorderOptionsAction
        MSShowFillOptionsAction
      MSBooleanMenuAction
      MSCenterLayersInCanvasAction
      MSCenterSelectionInVisibleAreaAction
      MSChangeColorSpaceAction
        MSAssignColorSpaceAction
        MSConvertColorSpaceAction
      MSChangeFontAction
      MSChangePageAction
        MSNextPageAction
        MSPreviousPageAction
      MSClippingMaskAction
      MSClippingMaskModeAction
      MSClosePathAction
      MSCollapseAllGroupsAction
      MSColorInspectorModePickerAction
        MSColorInspectorCircularGradientTabAction
        MSColorInspectorColorTabAction
        MSColorInspectorImageTabAction
        MSColorInspectorLinearGradientTabAction
        MSColorInspectorRadialGradientTabAction
      MSComponentsPanelAction
      MSConstraintAction
        MSConstraintFixHeightAction
        MSConstraintFixWidthAction
        MSConstraintPinBottomAction
        MSConstraintPinLeftAction
        MSConstraintPinRightAction
        MSConstraintPinTopAction
      MSConstraintResetAction
      MSConvertSymbolOrDetachInstancesAction
      MSConvertToOutlinesAction
      MSCopyAction
      MSCopyCSSAttributesAction
      MSCopySVGCodeAction
      MSCopyStyleAction
      MSCreateSymbolAction
      MSCurveModeAdjustAction
        MSCurveModeAsymmetricAction
        MSCurveModeDisconnectedAction
        MSCurveModeMirroredAction
        MSCurveModeStraightAction
      MSCutAction
      MSDefaultStyleAction
      MSDeleteAction
      MSDistributeAction
        MSDistributeHorizontallyAction
        MSDistributeVerticallyAction
      MSDuplicateAction
      MSEditAction
      MSEditColorSpaceAction
      MSEventHandlerAction
        MSRotateAction
        MSRotateClockwiseAction
        MSRotateCounterclockwiseAction
        MSScissorsAction
        MSTransformAction
      MSExportAction
      MSExportPDFBookAction
      MSExportSelectionWithExportFormatsAction
      MSFindLayerAction
      MSFlattenAction
      MSFlattenSelectionAction
      MSGridSettingsAction
      MSGroupAction
      MSHideAllGridsAndLayoutsAction
      MSHideLayerAction
      MSIgnoreClippingMaskAction
      MSImageOriginalSizeAction
      MSIncompatiblePluginsDisabledAction
      MSInsertMenuAction
      MSInsertSliceAction
      MSInsertVectorAction
      MSJoinAction
      MSLayerHeightFocusAction
      MSLayerWidthFocusAction
      MSLayerXFocusAction
      MSLayerYFocusAction
      MSLayoutSettingsAction
      MSLicenseExpiredAction
      MSLicenseSheetAction
      MSLockLayerAction
      MSMagnifierAction
      MSMakeGridAction
      MSManageForeignSymbolAction
      MSMaskWithShapeAction
      MSMoveUpHierarchyAction
      MSNewPageAction
      MSPasteAction
      MSPasteHereAction
      MSPasteOverSelectionAction
      MSPasteStyleAction
      MSPasteWithStyleAction
      MSPencilAction
      MSPopoverAction
        MSCloudAction
        MSMirrorAction
      MSPreviewAtActualSizeAction
      MSPrintAction
      MSReduceFileSizeAction
      MSReduceImageSizeAction
      MSRenameLayerAction
      MSReplaceColorAction
      MSReplaceFontsAction
      MSReplaceImageAction
      MSResetSymbolSizeAction
      MSResizeArtboardToFitAction
      MSRevealInLayerListAction
      MSReversePathAction
      MSRoundToPixelAction
      MSSaveAsTemplateAction
      MSScaleAction
      MSSelectAllAction
      MSSelectAllArtboardsAction
      MSShapeAction
      MSSharedObjectAction
        MSInsertSharedTextAction
        MSSharedSymbolAction
          MSInsertSymbolAction
          MSReplaceWithSymbolAction
      MSShowReplaceColorSheetAction
      MSSmartRotateAction
      MSSplitAction
      MSSyncLibraryAction
      MSTextOnPathAction
      MSTextStyleTouchBarAction
      MSTextTransformAction
        MSMakeLowercaseAction
        MSMakeUppercaseAction
        MSRemoveTextTransformAction
      MSTextVerticalAlignmentAction
        MSAlignBottomAction
        MSAlignMiddleAction
        MSAlignTopAction
      MSToggleBaseAction
        MSToggleGridAction
        MSToggleLayoutAction
      MSToggleInterfaceAction
      MSToggleLayerInteractionAction
      MSTogglePixelGridAction
      MSToggleSliceInteractionAction
      MSToggleStylePartAction
        MSToggleBorderAction
        MSToggleFillAction
      MSToggleViewPreferenceAction
        MSToggleAlignmentGuidesAction
        MSToggleArtboardShadowAction
        MSToggleLayerHighlightAction
        MSTogglePixelLinesAction
        MSToggleSelectionAction
      MSToggleVisibilityAction
        MSToggleInspectorVisibilityAction
        MSToggleLayerListVisibilityAction
        MSToggleRulersAction
        MSToggleToolbarVisibilityAction
      MSToolsMenuAction
      MSTouchBarGroupAction
        MSAlignmentActions
        MSBooleanTouchBarGroupAction
        MSColorInspectorModeBorderTouchBarGroupAction
          MSColorInspectorModeFillTouchBarGroupAction
        MSCurveModeTouchGroupAction
        MSDistributeActions
        MSLayerFocusActions
        MSTextAlignTouchBarGroupAction
        MSZoomActions
      MSUnderlineAction
      MSUndoBaseAction
        MSRedoAction
        MSUndoAction
      MSUngroupAction
      MSUpdatePluginsAction
      MSViewMenuAction
      MSZoomAction
      MSZoomInAction
      MSZoomOutAction
      MSZoomToActualSizeAction
      MSZoomToSelectionAction
    MSFeedbackAction
    MSOpenCloudPreferencesAction
    MSOpenPluginPreferencesAction
    MSOpenPreferencesAction
    MSRevealPluginsAction
    MSRunCustomScriptAction
    MSRunLastScriptAction
    MSRunPluginAction
    MSShowOnlineHelpAction
    MSShowReleaseNotesWindowAction
    MSShowSupportPageAction
    MSSilentCheckForUpdatesAction
      MSCheckForUpdatesAction
      MSQuietCheckForUpdatesAction
    MSToggleHUDAction
    MSVisitDocumentationAction
    MSWelcomeToSketchAction
  MSActionController
  MSEventHandler
    MSBitmapEditEventHandler
    MSDragRectEventHandler
      MSInsertLayerEventHandler
        MSInsertArtboardEventHandler
        MSInsertSliceEventHandler
      MSInsertShapeEventHandler
    MSInsertLineEventHandler
      MSInsertArrowEventHandler
    MSInsertSymbolEventHandler
    MSInsertTextEventHandler
    MSNormalBaseEventHandler
      MSNormalEventHandler
      MSNormalMultipleResizeEventHandler
      MSNormalResizeEventHandler
      MSNormalResizeLineEventHandler
      MSRotateEventHandler
    MSPencilEventHandler
    MSPointsEventHandler
      MSGradientEventHandler
        MSAngularGradientEventHandler
        MSRadialGradientEventHandler
      MSTransformEventHandler
        MSImageTransformEventHandler
      MSZoomBlurEventHandler
    MSScissorsEventHandler
    MSShapeEventHandler
    MSSmartRotateEventHandler
    MSTextLayerEventHandler
  MSUpDownController
NSObject
  MSAnalytics
  MSApplicationMetadata
  MSArchiveHeader
  MSArchivedColor
  MSArtboardOrderSorting
  MSArtboardPreset
  MSArtboardPresetStore
  MSArtboardPresetsCategory
  MSArtboardPresetsSection
  MSArtboardShadow
  MSAssetLibrary
    MSRemoteAssetLibrary
    MSUserAssetLibrary
  MSAssetLibraryController
  MSAssetLibraryUpdater
  MSAssetLibraryUpdatingInfo
  MSAssetMigrationSources
  MSAssetPreferenceItem
  MSAssetSyncSheetHeader
  MSAssetSyncSheetSymbol
  MSAttributeConverter
  MSAttributedString
  MSAvailableOverride
    MSSymbolOverride
  MSBackgroundBlurRendererCG
  MSBadgeController
  MSBaseArchiver
    MSJSONArchiver
      MSJSONDataArchiver
      MSJSONZippedArchiver
    MSKeyedArchiver
  MSBaseUnarchiver
    MSJSONUnarchiver
      MSJSONDataUnarchiver
      MSJSONDictionaryUnarchiver
      MSJSONZippedUnarchiver
    MSKeyedUnarchiver
  MSBezierBuilder
  MSBezierContour
  MSBezierFillet
    MSSmoothBezierFillet
  MSBezierInterpreter
  MSBezierIntersection
  MSBezierJoin
    MSBezierLineCurveJoin
      MSBezierCurveCurveJoin
    MSBezierLineLineJoin
  MSBezierSegment
  MSBitmapBackedRendering
  MSBitmapEditor
    MSBitmapMagicWandEditor
    MSBitmapRectangleEditor
  MSBooleanOperationChain
  MSBooleanOperationChainStep
  MSBooleanOperations
  MSCGContextWrapper
  MSCacheManager
  MSCloudController
  MSCloudShareUploadController
  MSCloudUser
  MSColorArchivingFactory
  MSColorCounter
  MSColorReplacement
  MSColorReplacementConverter
  MSColorSpaceConverter
  MSCommand
  MSComponentsPanelSection
  MSConstantBaselineInfo
  MSCoreImageQueue
  MSCrashLogManager
  MSCurvePointBehaviour
    MSCurvePointAsymmetricBehaviour
    MSCurvePointDisconnectedBehaviour
    MSCurvePointMirroredBehaviour
    MSCurvePointStraightBehaviour
  MSDiff
  MSDocumentImporter
  MSDocumentReader
    MSDocumentZippedJSONReader
    MSLegacyDocumentReader
  MSDocumentTree
  MSDocumentWriter
  MSDocumentationSearchEntry
  MSDocumentationSearcher
  MSDrawingInfo
  MSDuplicateOffsetTracker
  MSEventHandlerManager
  MSExportManager
  MSExportRequest
  MSExporter
    MSEPSExporter
    MSExportRendererWithSVGSupport
    MSJPGExporter
    MSPDFExporter
    MSPNGExporter
    MSTiffExporter
    MSWebPExporter
  MSFastPathBuilder
  MSFeatureAvailability
  MSFillAndBorderColorScreenPicker
  MSFillRendererCG
  MSFlashController
  MSFlattenActionValidator
  MSFolderMonitor
    MSFileMonitor
  MSFontList
  MSForeignSymbolMenuBuilder
  MSFrequentColorTracker
  MSGestureRecognizer
    MSClickGestureRecognizer
    MSDragGestureRecognizer
      MSDragRectGestureRecognizer
      MSDragToMoveOrCopyGestureRecognizer
        MSDragHandleGestureRecognizer
        MSDragLayerGestureRecognizer
      MSDragToSelectGestureRecognizer
      MSResizeGestureRecognizer
    MSSelectVectorHandleGestureRecognizer
  MSGridConstructor
  MSGridRendererCG
    MSLayoutGridRendererCG
    MSSimpleGridRendererCG
  MSHandleDrawing
  MSHighLevelExporter
    MSSelfContainedHighLevelExporter
  MSHistory
  MSHistoryMaker
  MSImageData
  MSImageLayerImporter
  MSImageSizeReducer
  MSImmutableLayerAncestry
  MSInspectorNextResponderFixer
  MSInterfaceColorFactory
  MSJSONArchiveReference
    MSJSONDataReference
      MSJSONOriginalDataReference
    MSJSONFileReference
    MSJSONOriginalFileReference
  MSLayerArray
  MSLayerBuilder
  MSLayerCachedImage
  MSLayerFlattener
  MSLayerInserting
  MSLayerMovement
  MSLayerPaster
  MSLayerPositionDrawing
  MSLayerRendererCG
    MSBitmapRendererCG
    MSGroupRendererCG
      MSArtboardRendererCG
        MSSymbolRendererCG
      MSShapeRendererCG
    MSTextRendererCG
  MSLayerSelectionDrawing
  MSLayerSelector
  MSLayerStylePreviewGenerator
  MSLine
  MSMainSplitViewController
  MSManageForeignSymbolItem
  MSManifestMaker
    MSCloudManifestMaker
  MSMaskWithShape
  MSMenuBuilder
    MSLayerPickerMenuBuilder
    MSReplaceWithSymbolMenuBuilder
  MSMirrorDataProvider
  MSMirrorScaleCalculator
  MSModalInputSheet
  MSModelObjectCacheGeneration
  MSModelObjectCommon
    MSModelObject
        MSAssetCollection
          MSPersistentAssetCollection
        MSBaseGrid
            MSLayoutGrid
            MSSimpleGrid
        MSColor
        MSCurvePoint
        MSDocumentData
        MSExportFormat
        MSExportOptions
        MSExportPreset
        MSForeignSymbol
        MSGradient
        MSGradientStop
        MSGraphicsContextSettings
        MSImageCollection
        MSLayer
            MSShapePathLayer
                MSOvalShape
                MSPolygonShape
                MSRectangleShape
                MSStarShape
                MSTriangleShape
            MSSliceLayer
            MSStyledLayer
                MSBitmapLayer
                MSLayerGroup
                    MSArtboardGroup
                        MSSymbolMaster
                    MSPage
                    MSShapeGroup
                MSSymbolInstance
                MSTextLayer
        MSRect
        MSRulerData
        MSShapePath
        MSSharedObject
            MSSharedStyle
            MSSymbol
        MSSharedObjectContainer
            MSSharedStyleContainer
                MSSharedTextStyleContainer
            MSSymbolContainer
        MSStyle
        MSStylePart
            MSStyleBasicFill
                MSStyleBorder
                MSStyleFill
            MSStyleBlur
            MSStyleBorderOptions
            MSStyleColorControls
            MSStyleShadow
                MSStyleInnerShadow
        MSTextStyle
  MSModelObjectInstanceInfo
  MSMoment
  MSMouseTracker
  MSNetworkHelper
  MSNewsletterSignup
  MSNoise
  MSNormalEventContextualMenuBuilder
  MSNormalEventData
  MSNullRenderer
    MSOptionalRenderer
      MSLayerAnnotationsRenderer
  MSOpacityKeyboardShortcutRecognizer
  MSOverridePoint
  MSPDFBookExporter
  MSPDFImporter
  MSPDFPage
  MSPDFState
  MSPDFTextState
  MSPageOverlayRendererCG
    MSPageOverlayRendererCGDebug
  MSPasteboardFileDataProvider
  MSPasteboardImageWriter
  MSPasteboardImagesReader
    MSPasteboardInternalImageReader
  MSPasteboardLayerArrayEncoder
  MSPasteboardLayers
  MSPasteboardLayersBase
  MSPasteboardLayersReaderWriter
  MSPasteboardManager
  MSPasteboardPDFReader
  MSPasteboardPNGImageDataProvider
  MSPasteboardPathsReader
  MSPasteboardTextReader
  MSPastingViewport
  MSPath
  MSPathController
  MSPathRendererCG
  MSPerspectiveInstructions
  MSPluginBundle
  MSPluginCommand
  MSPluginCommandSpecifier
  MSPluginDebugController
  MSPluginManager
    MSPluginManagerWithActions
  MSPluginManagingState
  MSPluginScript
    MSPluginStandaloneScript
  MSPluginUpdaterImplementation
  MSPluginVersions
  MSPointArray
    MSGradientPointArray
  MSPointInsertion
  MSPointSnapper
  MSPointSnapperWorkings
  MSPointSnappingGuide
  MSPointSnappingResult
  MSPointSnappingTarget
  MSPreferencesPluginInfo
  MSPreviewImageCache
  MSProfilingRenderer
  MSRange
  MSRenderMonitor
    MSAveragingRenderMonitor
  MSRenderingContext
    MSExportRenderingContext
  MSRenderingDriver
    MSRenderingDriverCG
      MSRenderingDriverCGDebug
      MSRenderingDriverCGProfiling
  MSResizeArtboardToFitValidator
  MSRulerGuides
  MSSVGBlendMode
  MSSVGImporter
  MSSavedLayerFrames
  MSShadowRendererCG
  MSShapeChange
    MSClosePathChange
  MSShapeChangeContext
  MSShapeEditingBehavior
  MSShareButtonHandler
  MSSidebarListController
    MSLayerListController
    MSPageListController
  MSSliceTrimming
  MSSnapDrawInstruction
    MSSnapDrawDistanceInstruction
    MSSnapDrawSizeInstruction
  MSSnapDrawing
  MSSnapItem
    MSCompoundSnapItem
    MSRectSnapItem
    MSRotatedSnapItem
    MSTextSnapItem
  MSSnapper
  MSSnapperData
  MSSnapperEdgeHelperBase
    MSSnapperEdgeHelperBaseline
      MSSnapperEdgeHelperMidXHeight
    MSSnapperEdgeHelperBottom
    MSSnapperEdgeHelperLeft
    MSSnapperEdgeHelperMidX
    MSSnapperEdgeHelperMidY
    MSSnapperEdgeHelperRight
    MSSnapperEdgeHelperTop
  MSSortableObjectMenuBuilder
    MSSharedStyleMenuBuilder
    MSSymbolsMenuBuilder
  MSStandardInspectorViewControllers
  MSSubtreeRoot
  MSSymbolCreator
  MSSymbolMasterReference
  MSSymbolMasterReferenceDescriptor
  MSSymbolPreviewGenerator
  MSTextColorProvider
  MSTextLayout
  MSTextStyleMenuPreview
  MSTilePlacer
  MSTiledLayerPile
  MSToolbarConstructor
  MSTrailingLayerInfo
  MSTrailingLayersMover
  MSTransparencyLayerSavedState
  MSTreeDiff
  MSUpdateController
  MSVectorCanvas
  MSVectorHandle
    MSVectorAdjustmentHandle
  MSVectorHandleStateDecider
  MSVectorRounding
  MSVersionedArchive
  MSViewPort
  MSWebExporter
  MSWelcomeCollectionItem
    MSExistingDocumentCollectionItem
    MSNewDocumentCollectionItem
  MSXMLElementWrapper
    MSSVGFilter
    MSSVGImageWrapper
    MSSVGMergeNode
    MSSVGPatternWrapper
    MSSVGUseWrapper
    MSSVGfeFilterPrimitive
      MSSVGColorMatrix
      MSSVGComposite
      MSSVGGaussianBlur
      MSSVGMerge
      MSSVGMorphology
      MSSVGOffset
  MSZoomTool

Sketch Developer Document